From 16d411ae69d64d590701a08bb2d2cf836795e741 Mon Sep 17 00:00:00 2001 From: Jimmy Luong Date: Mon, 6 Jul 2026 23:28:29 +1000 Subject: [PATCH] feat(monorepo): merge data connectors into a single data-connector Consolidates the accounts, example, and questionnaires Firebase Data Connect connectors into one connector at data/connector, generating combined @generated/data-connector-admin and @generated/data-connector-web (with a react subpackage) SDKs. As a result, account operations are now also available through the web SDK, alongside questionnaires. Operations are split into domain-scoped .gql files (accounts, projects, quotes, reminders, users, questionnaires) within the single connector, and the UserSettings type moves from data/schemas/accounts.gql into its own data/schemas/users.gql to match. Since there is only one connector now, the getDataConnect() caching workaround added in #151 (constructing a DataConnect instance per connector to dodge firebase-admin's location/serviceId-keyed cache) is no longer needed, so functions/plaster-calculator-functions/src/data-connect.ts is removed; call sites let the generated functions resolve the connector implicitly. Generated-SDK imports across functions, apps, and libraries now use `import * as DataConnector` namespace imports instead of aliased named imports, avoiding renames like `createAccount as dcCreateAccount`. Co-Authored-By: Claude Sonnet 5 --- .../deploy-plaster-calculator-functions.yml | 2 +- apps/plaster-calculator-web/package.json | 2 +- .../questionnaires/templates/page.hooks.ts | 61 +- apps/storybook-web/package.json | 2 +- ...nnaire-template-card-grid-list.stories.tsx | 4 +- .../accounts.mutations.gql} | 0 .../accounts.queries.gql} | 0 data/connector/connector.yaml | 9 + data/connector/projects.mutations.gql | 190 + .../projects.queries.gql} | 65 - .../questionnaires.mutations.gql} | 0 .../questionnaires.queries.gql} | 0 data/connector/quotes.mutations.gql | 234 + data/connector/reminders.mutations.gql | 44 + data/connector/reminders.queries.gql | 54 + data/connector/users.mutations.gql | 14 + data/connector/users.queries.gql | 9 + data/connectors/accounts/connector.yaml | 5 - data/connectors/example/connector.yaml | 5 - data/connectors/example/mutations.gql | 485 -- data/connectors/questionnaires/connector.yaml | 9 - data/schemas/accounts.gql | 8 - data/schemas/users.gql | 7 + dataconnect.yaml | 4 +- .../plaster-calculator-functions/package.json | 3 +- .../src/accounts.ts | 42 +- .../src/data-connect.ts | 33 - .../src/floorplan-pages.ts | 19 +- .../src/ownership.ts | 24 +- .../src/page-analysis.ts | 7 +- .../src/processing-pages.ts | 7 +- .../src/processing.ts | 14 +- .../src/projects.ts | 37 +- .../src/quote-follow-up.ts | 17 +- .../src/reminders.ts | 20 +- .../src/settings.ts | 12 +- .../plaster-calculator-functions/src/types.ts | 46 +- .../esm/index.esm.js | 74 - .../index.cjs.js | 86 - .../accounts-data-connector-admin/index.d.ts | 304 - .../package.json | 25 - .../esm/index.esm.js | 208 +- .../esm/package.json | 0 .../index.cjs.js | 259 +- .../index.d.ts | 454 +- .../package.json | 4 +- .../.guides/config.json | 0 .../.guides/setup.md | 2 +- generated/data-connector-web/.guides/usage.md | 109 + generated/data-connector-web/README.md | 7101 +++++++++++++++++ generated/data-connector-web/esm/index.esm.js | 718 ++ .../esm/package.json | 0 generated/data-connector-web/index.cjs.js | 835 ++ generated/data-connector-web/index.d.ts | 1610 ++++ .../package.json | 4 +- generated/data-connector-web/react/README.md | 5962 ++++++++++++++ .../data-connector-web/react/esm/index.esm.js | 438 + .../react}/esm/package.json | 0 .../data-connector-web/react/index.cjs.js | 438 + generated/data-connector-web/react/index.d.ts | 180 + .../react/package.json | 4 +- .../esm/index.esm.js | 68 - .../index.cjs.js | 79 - .../index.d.ts | 258 - .../package.json | 25 - .../.guides/usage.md | 109 - .../README.md | 1229 --- .../esm/index.esm.js | 129 - .../esm/package.json | 1 - .../index.cjs.js | 150 - .../index.d.ts | 330 - .../react/README.md | 1102 --- .../react/esm/index.esm.js | 80 - .../react/esm/package.json | 1 - .../react/index.cjs.js | 80 - .../react/index.d.ts | 36 - libraries/plaster-calculator-ui/package.json | 2 +- ...uestionnaire-template-drawer.component.tsx | 4 +- .../questionnaire-template-card.component.tsx | 4 +- .../plaster-calculator-web-core/package.json | 2 +- .../src/firebase/firebase.service.ts | 4 +- pnpm-lock.yaml | 39 +- 82 files changed, 18886 insertions(+), 5155 deletions(-) rename data/{connectors/accounts/mutations.gql => connector/accounts.mutations.gql} (100%) rename data/{connectors/accounts/queries.gql => connector/accounts.queries.gql} (100%) create mode 100644 data/connector/connector.yaml create mode 100644 data/connector/projects.mutations.gql rename data/{connectors/example/queries.gql => connector/projects.queries.gql} (71%) rename data/{connectors/questionnaires/mutations.gql => connector/questionnaires.mutations.gql} (100%) rename data/{connectors/questionnaires/queries.gql => connector/questionnaires.queries.gql} (100%) create mode 100644 data/connector/quotes.mutations.gql create mode 100644 data/connector/reminders.mutations.gql create mode 100644 data/connector/reminders.queries.gql create mode 100644 data/connector/users.mutations.gql create mode 100644 data/connector/users.queries.gql delete mode 100644 data/connectors/accounts/connector.yaml delete mode 100644 data/connectors/example/connector.yaml delete mode 100644 data/connectors/example/mutations.gql delete mode 100644 data/connectors/questionnaires/connector.yaml create mode 100644 data/schemas/users.gql delete mode 100644 functions/plaster-calculator-functions/src/data-connect.ts delete mode 100644 generated/accounts-data-connector-admin/esm/index.esm.js delete mode 100644 generated/accounts-data-connector-admin/index.cjs.js delete mode 100644 generated/accounts-data-connector-admin/index.d.ts delete mode 100644 generated/accounts-data-connector-admin/package.json rename generated/{example-data-connector => data-connector-admin}/esm/index.esm.js (63%) rename generated/{accounts-data-connector-admin => data-connector-admin}/esm/package.json (100%) rename generated/{example-data-connector => data-connector-admin}/index.cjs.js (62%) rename generated/{example-data-connector => data-connector-admin}/index.d.ts (65%) rename generated/{example-data-connector => data-connector-admin}/package.json (83%) rename generated/{questionnaires-data-connector-web => data-connector-web}/.guides/config.json (100%) rename generated/{questionnaires-data-connector-web => data-connector-web}/.guides/setup.md (96%) create mode 100644 generated/data-connector-web/.guides/usage.md create mode 100644 generated/data-connector-web/README.md create mode 100644 generated/data-connector-web/esm/index.esm.js rename generated/{example-data-connector => data-connector-web}/esm/package.json (100%) create mode 100644 generated/data-connector-web/index.cjs.js create mode 100644 generated/data-connector-web/index.d.ts rename generated/{questionnaires-data-connector-web => data-connector-web}/package.json (87%) create mode 100644 generated/data-connector-web/react/README.md create mode 100644 generated/data-connector-web/react/esm/index.esm.js rename generated/{questionnaires-data-connector-admin => data-connector-web/react}/esm/package.json (100%) create mode 100644 generated/data-connector-web/react/index.cjs.js create mode 100644 generated/data-connector-web/react/index.d.ts rename generated/{questionnaires-data-connector-web => data-connector-web}/react/package.json (76%) delete mode 100644 generated/questionnaires-data-connector-admin/esm/index.esm.js delete mode 100644 generated/questionnaires-data-connector-admin/index.cjs.js delete mode 100644 generated/questionnaires-data-connector-admin/index.d.ts delete mode 100644 generated/questionnaires-data-connector-admin/package.json delete mode 100644 generated/questionnaires-data-connector-web/.guides/usage.md delete mode 100644 generated/questionnaires-data-connector-web/README.md delete mode 100644 generated/questionnaires-data-connector-web/esm/index.esm.js delete mode 100644 generated/questionnaires-data-connector-web/esm/package.json delete mode 100644 generated/questionnaires-data-connector-web/index.cjs.js delete mode 100644 generated/questionnaires-data-connector-web/index.d.ts delete mode 100644 generated/questionnaires-data-connector-web/react/README.md delete mode 100644 generated/questionnaires-data-connector-web/react/esm/index.esm.js delete mode 100644 generated/questionnaires-data-connector-web/react/esm/package.json delete mode 100644 generated/questionnaires-data-connector-web/react/index.cjs.js delete mode 100644 generated/questionnaires-data-connector-web/react/index.d.ts diff --git a/.github/workflows/deploy-plaster-calculator-functions.yml b/.github/workflows/deploy-plaster-calculator-functions.yml index 8bd123d..58a8d1c 100644 --- a/.github/workflows/deploy-plaster-calculator-functions.yml +++ b/.github/workflows/deploy-plaster-calculator-functions.yml @@ -7,7 +7,7 @@ on: - main paths: - functions/plaster-calculator-functions/** - - generated/example-data-connector/** + - generated/data-connector-admin/** concurrency: group: deploy-plaster-calculator-functions diff --git a/apps/plaster-calculator-web/package.json b/apps/plaster-calculator-web/package.json index 6b4a8f2..20e1bbb 100644 --- a/apps/plaster-calculator-web/package.json +++ b/apps/plaster-calculator-web/package.json @@ -11,7 +11,7 @@ "start": "next start" }, "dependencies": { - "@generated/questionnaires-data-connector-web": "workspace:*", + "@generated/data-connector-web": "workspace:*", "@libraries/plaster-calculator-common": "workspace:*", "@libraries/plaster-calculator-ui": "workspace:*", "@libraries/plaster-calculator-web-core": "workspace:*", diff --git a/apps/plaster-calculator-web/src/app/app/questionnaires/templates/page.hooks.ts b/apps/plaster-calculator-web/src/app/app/questionnaires/templates/page.hooks.ts index 4960de3..9b58dc3 100644 --- a/apps/plaster-calculator-web/src/app/app/questionnaires/templates/page.hooks.ts +++ b/apps/plaster-calculator-web/src/app/app/questionnaires/templates/page.hooks.ts @@ -1,19 +1,5 @@ -import { - connectorConfig, - getQuestionnaireTemplateRef, - listQuestionnaireTemplates, - listQuestionnaireTemplatesRef, -} from "@generated/questionnaires-data-connector-web"; -import { - useCreateQuestionnaireTemplate, - useCreateQuestionnaireTemplateQuestion, - useDeleteQuestionnaireTemplate, - useDeleteQuestionnaireTemplateQuestion, - useGetQuestionnaireTemplate, - useListQuestionnaireTemplates, - useUpdateQuestionnaireTemplateName, - useUpdateQuestionnaireTemplateQuestion, -} from "@generated/questionnaires-data-connector-web/react"; +import * as DataConnector from "@generated/data-connector-web"; +import * as DataConnectorReact from "@generated/data-connector-web/react"; import { FirebaseService } from "@libraries/plaster-calculator-web-core"; import { useNotificationsManager } from "@libraries/uikit-web"; import { useQueryClient } from "@tanstack/react-query"; @@ -36,11 +22,15 @@ type UpdateTemplate = ( ) => Promise; type PageDispatch = Dispatch; -const dataConnect = FirebaseService.getDataConnect(connectorConfig); -const questionnaireTemplatesRef = listQuestionnaireTemplatesRef(dataConnect); +const dataConnect = FirebaseService.getDataConnect( + DataConnector.connectorConfig, +); +const questionnaireTemplatesRef = + DataConnector.listQuestionnaireTemplatesRef(dataConnect); export function useQuestionnaireTemplates() { - const { data } = useListQuestionnaireTemplates(dataConnect); + const { data } = + DataConnectorReact.useListQuestionnaireTemplates(dataConnect); return data?.questionnaireTemplates ?? []; } @@ -48,10 +38,10 @@ export function useRefreshQuestionnaireTemplatesCallback(): RefreshTemplates { const queryClient = useQueryClient(); return useCallback(async () => { - const refreshedTemplates = await listQuestionnaireTemplates( - dataConnect, - { fetchPolicy: QueryFetchPolicy.SERVER_ONLY }, - ); + const refreshedTemplates = + await DataConnector.listQuestionnaireTemplates(dataConnect, { + fetchPolicy: QueryFetchPolicy.SERVER_ONLY, + }); queryClient.setQueryData( [ questionnaireTemplatesRef.name, @@ -67,9 +57,9 @@ export function useCreateQuestionnaireTemplateCallback( dispatch: PageDispatch, ) { const { mutateAsync: createTemplate } = - useCreateQuestionnaireTemplate(dataConnect); + DataConnectorReact.useCreateQuestionnaireTemplate(dataConnect); const { mutateAsync: createQuestion } = - useCreateQuestionnaireTemplateQuestion(dataConnect); + DataConnectorReact.useCreateQuestionnaireTemplateQuestion(dataConnect); const { notify } = useNotificationsManager(); return useCallback( @@ -117,7 +107,7 @@ export function useDeleteQuestionnaireTemplateCallback( dispatch: PageDispatch, ) { const { mutateAsync: deleteTemplate } = - useDeleteQuestionnaireTemplate(dataConnect); + DataConnectorReact.useDeleteQuestionnaireTemplate(dataConnect); const { notify } = useNotificationsManager(); return useCallback( @@ -161,7 +151,7 @@ export function useQuestionnaireTemplateDetails(templateId: string | null): { readonly template: QuestionnaireTemplateDetails | null; readonly isLoading: boolean; } { - const { data, isLoading } = useGetQuestionnaireTemplate( + const { data, isLoading } = DataConnectorReact.useGetQuestionnaireTemplate( dataConnect, { id: templateId ?? "" }, { enabled: templateId !== null }, @@ -178,13 +168,13 @@ export function useUpdateQuestionnaireTemplateCallback( dispatch: PageDispatch, ): UpdateTemplate { const { mutateAsync: updateName } = - useUpdateQuestionnaireTemplateName(dataConnect); + DataConnectorReact.useUpdateQuestionnaireTemplateName(dataConnect); const { mutateAsync: updateQuestion } = - useUpdateQuestionnaireTemplateQuestion(dataConnect); + DataConnectorReact.useUpdateQuestionnaireTemplateQuestion(dataConnect); const { mutateAsync: createQuestion } = - useCreateQuestionnaireTemplateQuestion(dataConnect); + DataConnectorReact.useCreateQuestionnaireTemplateQuestion(dataConnect); const { mutateAsync: deleteQuestion } = - useDeleteQuestionnaireTemplateQuestion(dataConnect); + DataConnectorReact.useDeleteQuestionnaireTemplateQuestion(dataConnect); const { notify } = useNotificationsManager(); const queryClient = useQueryClient(); @@ -235,9 +225,12 @@ export function useUpdateQuestionnaireTemplateCallback( ), ); - const templateRef = getQuestionnaireTemplateRef(dataConnect, { - id: template.id, - }); + const templateRef = DataConnector.getQuestionnaireTemplateRef( + dataConnect, + { + id: template.id, + }, + ); await queryClient.invalidateQueries({ queryKey: [templateRef.name, templateRef.variables ?? null], }); diff --git a/apps/storybook-web/package.json b/apps/storybook-web/package.json index 339e4b1..61cba33 100644 --- a/apps/storybook-web/package.json +++ b/apps/storybook-web/package.json @@ -10,7 +10,7 @@ "storybook": "storybook dev --port 6006" }, "dependencies": { - "@generated/questionnaires-data-connector-web": "workspace:*", + "@generated/data-connector-web": "workspace:*", "@libraries/plaster-calculator-common": "workspace:*", "@libraries/plaster-calculator-ui": "workspace:*", "@libraries/uikit-web": "workspace:*", diff --git a/apps/storybook-web/src/stories/questionnaires/questionnaire-template-card-grid-list.stories.tsx b/apps/storybook-web/src/stories/questionnaires/questionnaire-template-card-grid-list.stories.tsx index dce5a65..bce4e0e 100644 --- a/apps/storybook-web/src/stories/questionnaires/questionnaire-template-card-grid-list.stories.tsx +++ b/apps/storybook-web/src/stories/questionnaires/questionnaire-template-card-grid-list.stories.tsx @@ -1,4 +1,4 @@ -import { useListQuestionnaireTemplates } from "@generated/questionnaires-data-connector-web/react"; +import * as DataConnectorReact from "@generated/data-connector-web/react"; import { QuestionnaireTemplateCardGridList } from "@libraries/plaster-calculator-ui"; import { fn } from "storybook/test"; @@ -47,7 +47,7 @@ export const FromDataConnectHook: Story = { }, }, render: () => { - const { data } = useListQuestionnaireTemplates({ + const { data } = DataConnectorReact.useListQuestionnaireTemplates({ enabled: false, initialData: { questionnaireTemplates: [...questionnaireTemplates], diff --git a/data/connectors/accounts/mutations.gql b/data/connector/accounts.mutations.gql similarity index 100% rename from data/connectors/accounts/mutations.gql rename to data/connector/accounts.mutations.gql diff --git a/data/connectors/accounts/queries.gql b/data/connector/accounts.queries.gql similarity index 100% rename from data/connectors/accounts/queries.gql rename to data/connector/accounts.queries.gql diff --git a/data/connector/connector.yaml b/data/connector/connector.yaml new file mode 100644 index 0000000..539f2d6 --- /dev/null +++ b/data/connector/connector.yaml @@ -0,0 +1,9 @@ +connectorId: data-connector +generate: + adminNodeSdk: + - package: "@generated/data-connector-admin" + outputDir: ../../generated/data-connector-admin + javascriptSdk: + - package: "@generated/data-connector-web" + outputDir: ../../generated/data-connector-web + react: true diff --git a/data/connector/projects.mutations.gql b/data/connector/projects.mutations.gql new file mode 100644 index 0000000..bbb2167 --- /dev/null +++ b/data/connector/projects.mutations.gql @@ -0,0 +1,190 @@ +mutation CreateProjectFromUpload( + $id: UUID! + $ownerId: String! + $accountId: UUID + $name: String! + $address: String + $originalFileName: String! + $uploadType: String! + $originalPath: String! + $status: String! + $salesStatus: String = "QUOTING" + $pageCount: Int! +) @auth(level: NO_ACCESS) { + project_insert( + data: { + id: $id + ownerId: $ownerId + accountId: $accountId + name: $name + address: $address + originalFileName: $originalFileName + uploadType: $uploadType + originalPath: $originalPath + status: $status + salesStatus: $salesStatus + pageCount: $pageCount + createdAt_expr: "request.time" + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateProject( + $id: UUID! + $name: String + $accountId: UUID + $address: String + $salesStatus: String +) @auth(level: NO_ACCESS) { + project_update( + id: $id + data: { + name: $name + accountId: $accountId + address: $address + salesStatus: $salesStatus + updatedAt_expr: "request.time" + } + ) +} + +mutation RenameProject($id: UUID!, $name: String!) @auth(level: NO_ACCESS) { + project_update( + id: $id + data: { name: $name, updatedAt_expr: "request.time" } + ) +} + +mutation TouchProject($id: UUID!, $status: String, $processingError: String) +@auth(level: NO_ACCESS) { + project_update( + id: $id + data: { + status: $status + processingError: $processingError + updatedAt_expr: "request.time" + } + ) +} + +mutation DeleteFloorplanPages($projectId: UUID!) @auth(level: NO_ACCESS) { + floorplanPage_deleteMany(where: { projectId: { eq: $projectId } }) +} + +mutation DeleteProject($id: UUID!) @auth(level: NO_ACCESS) { + project_delete(id: $id) +} + +mutation CreateFloorplanPage( + $projectId: UUID! + $pageNumber: Int! + $status: String! + $processingError: String + $sourceImagePath: String + $previewImagePath: String + $rawJsonPath: String + $rawFloorplanPath: String + $overlayJson: String + $scaleMmPerPx: Float + $ceilingHeightMm: Float + $referencePointsJson: String + $referenceLengthMm: Float + $processingStrategy: String + $processingMetadataJson: String +) @auth(level: NO_ACCESS) { + floorplanPage_insert( + data: { + projectId: $projectId + pageNumber: $pageNumber + status: $status + processingError: $processingError + sourceImagePath: $sourceImagePath + previewImagePath: $previewImagePath + rawJsonPath: $rawJsonPath + rawFloorplanPath: $rawFloorplanPath + overlayJson: $overlayJson + scaleMmPerPx: $scaleMmPerPx + ceilingHeightMm: $ceilingHeightMm + referencePointsJson: $referencePointsJson + referenceLengthMm: $referenceLengthMm + processingStrategy: $processingStrategy + processingMetadataJson: $processingMetadataJson + createdAt_expr: "request.time" + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateFloorplanPageAnalysis( + $id: UUID! + $status: String! + $processingError: String + $sourceImagePath: String + $previewImagePath: String + $rawJsonPath: String + $rawFloorplanPath: String + $overlayJson: String + $scaleMmPerPx: Float + $ceilingHeightMm: Float + $referencePointsJson: String + $referenceLengthMm: Float + $processingStrategy: String + $processingMetadataJson: String +) @auth(level: NO_ACCESS) { + floorplanPage_update( + id: $id + data: { + status: $status + processingError: $processingError + sourceImagePath: $sourceImagePath + previewImagePath: $previewImagePath + rawJsonPath: $rawJsonPath + rawFloorplanPath: $rawFloorplanPath + overlayJson: $overlayJson + scaleMmPerPx: $scaleMmPerPx + ceilingHeightMm: $ceilingHeightMm + referencePointsJson: $referencePointsJson + referenceLengthMm: $referenceLengthMm + processingStrategy: $processingStrategy + processingMetadataJson: $processingMetadataJson + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateFloorplanPage( + $id: UUID! + $overlayJson: String + $scaleMmPerPx: Float + $ceilingHeightMm: Float + $referencePointsJson: String + $referenceLengthMm: Float +) @auth(level: NO_ACCESS) { + floorplanPage_update( + id: $id + data: { + overlayJson: $overlayJson + scaleMmPerPx: $scaleMmPerPx + ceilingHeightMm: $ceilingHeightMm + referencePointsJson: $referencePointsJson + referenceLengthMm: $referenceLengthMm + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateFloorplanPages( + $projectId: UUID! + $scaleMmPerPx: Float + $ceilingHeightMm: Float +) @auth(level: NO_ACCESS) { + floorplanPage_updateMany( + where: { projectId: { eq: $projectId } } + data: { + scaleMmPerPx: $scaleMmPerPx + ceilingHeightMm: $ceilingHeightMm + updatedAt_expr: "request.time" + } + ) +} diff --git a/data/connectors/example/queries.gql b/data/connector/projects.queries.gql similarity index 71% rename from data/connectors/example/queries.gql rename to data/connector/projects.queries.gql index d47323c..8c2a43c 100644 --- a/data/connectors/example/queries.gql +++ b/data/connector/projects.queries.gql @@ -150,68 +150,3 @@ query GetFloorplanPageById($projectId: UUID!, $pageId: UUID!) updatedAt } } - -query GetUserSettings($ownerId: String!) @auth(level: NO_ACCESS) { - userSettings(key: { ownerId: $ownerId }) { - ownerId - quoteFollowUpEnabled - quoteFollowUpDays - createdAt - updatedAt - } -} - -query ListDueReminders($ownerId: String!) @auth(level: NO_ACCESS) { - reminders( - where: { - ownerId: { eq: $ownerId } - status: { eq: "OPEN" } - dueAt: { le_expr: "request.time" } - } - orderBy: [{ dueAt: ASC }] - ) { - id - ownerId - projectId - accountId - name - status - dueAt - completedAt - createdAt - updatedAt - } -} - -query ListProjectReminders($projectId: UUID!) @auth(level: NO_ACCESS) { - reminders( - where: { projectId: { eq: $projectId } } - orderBy: [{ dueAt: ASC }] - ) { - id - ownerId - projectId - accountId - name - status - dueAt - completedAt - createdAt - updatedAt - } -} - -query GetReminderById($id: UUID!) @auth(level: NO_ACCESS) { - reminder(id: $id) { - id - ownerId - projectId - accountId - name - status - dueAt - completedAt - createdAt - updatedAt - } -} diff --git a/data/connectors/questionnaires/mutations.gql b/data/connector/questionnaires.mutations.gql similarity index 100% rename from data/connectors/questionnaires/mutations.gql rename to data/connector/questionnaires.mutations.gql diff --git a/data/connectors/questionnaires/queries.gql b/data/connector/questionnaires.queries.gql similarity index 100% rename from data/connectors/questionnaires/queries.gql rename to data/connector/questionnaires.queries.gql diff --git a/data/connector/quotes.mutations.gql b/data/connector/quotes.mutations.gql new file mode 100644 index 0000000..84e3f59 --- /dev/null +++ b/data/connector/quotes.mutations.gql @@ -0,0 +1,234 @@ +mutation CreateQuantitySource( + $id: UUID! + $measurementSource: String! + $measurementPlasterType: String +) @auth(level: NO_ACCESS) { + quantitySource_insert( + data: { + id: $id + measurementSource: $measurementSource + measurementPlasterType: $measurementPlasterType + createdAt_expr: "request.time" + updatedAt_expr: "request.time" + } + ) +} + +mutation CreateQuoteItemTemplate( + $id: UUID! + $ownerId: String + $scope: String! + $systemKey: String + $name: String! + $hasKeywords: Boolean! + $keywords: [String!]! + $quantitySourceId: UUID + $sortOrder: Int! +) @auth(level: NO_ACCESS) { + quoteItemTemplate_insert( + data: { + id: $id + ownerId: $ownerId + scope: $scope + systemKey: $systemKey + name: $name + hasKeywords: $hasKeywords + keywords: $keywords + quantitySourceId: $quantitySourceId + sortOrder: $sortOrder + createdAt_expr: "request.time" + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateQuoteItemTemplate( + $id: UUID! + $name: String + $hasKeywords: Boolean + $keywords: [String!] + $quantitySourceId: UUID + $sortOrder: Int +) @auth(level: NO_ACCESS) { + quoteItemTemplate_update( + id: $id + data: { + name: $name + hasKeywords: $hasKeywords + keywords: $keywords + quantitySourceId: $quantitySourceId + sortOrder: $sortOrder + updatedAt_expr: "request.time" + } + ) +} + +mutation DeleteQuoteItemTemplate($id: UUID!) @auth(level: NO_ACCESS) { + quoteItemTemplate_delete(id: $id) +} + +mutation UpsertQuoteItemTemplateConfig( + $ownerId: String! + $templateId: UUID! + $enabled: Boolean! + $unitPriceCents: Int! + $materialUnitPriceCents: Int! + $labourUnitPriceCents: Int! +) @auth(level: NO_ACCESS) { + quoteItemTemplateConfig_upsert( + data: { + ownerId: $ownerId + templateId: $templateId + enabled: $enabled + unitPriceCents: $unitPriceCents + materialUnitPriceCents: $materialUnitPriceCents + labourUnitPriceCents: $labourUnitPriceCents + updatedAt_expr: "request.time" + } + ) +} + +mutation CreateSupplier($id: UUID!, $ownerId: String!, $name: String!) +@auth(level: NO_ACCESS) { + supplier_insert( + data: { + id: $id + ownerId: $ownerId + name: $name + createdAt_expr: "request.time" + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateSupplier($id: UUID!, $name: String) @auth(level: NO_ACCESS) { + supplier_update( + id: $id + data: { name: $name, updatedAt_expr: "request.time" } + ) +} + +mutation DeleteSupplier($id: UUID!) @auth(level: NO_ACCESS) { + supplier_delete(id: $id) +} + +mutation UpsertSupplierQuoteItemPrice( + $ownerId: String! + $supplierId: UUID! + $templateId: UUID! + $materialUnitPriceCents: Int! +) @auth(level: NO_ACCESS) { + supplierQuoteItemPrice_upsert( + data: { + ownerId: $ownerId + supplierId: $supplierId + templateId: $templateId + materialUnitPriceCents: $materialUnitPriceCents + updatedAt_expr: "request.time" + } + ) +} + +mutation DeleteSupplierQuoteItemPrice($supplierId: UUID!, $templateId: UUID!) +@auth(level: NO_ACCESS) { + supplierQuoteItemPrice_delete( + key: { supplierId: $supplierId, templateId: $templateId } + ) +} + +mutation CreateQuote( + $id: UUID! + $ownerId: String! + $projectId: UUID! + $supplierId: UUID + $status: String! +) @auth(level: NO_ACCESS) { + quote_insert( + data: { + id: $id + ownerId: $ownerId + projectId: $projectId + supplierId: $supplierId + status: $status + createdAt_expr: "request.time" + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateQuote($id: UUID!, $supplierId: UUID, $status: String) +@auth(level: NO_ACCESS) { + quote_update( + id: $id + data: { + supplierId: $supplierId + status: $status + updatedAt_expr: "request.time" + } + ) +} + +mutation DeleteQuoteItems($quoteId: UUID!) @auth(level: NO_ACCESS) { + quoteItem_deleteMany(where: { quoteId: { eq: $quoteId } }) +} + +mutation CreateQuoteItem( + $id: UUID! + $ownerId: String! + $quoteId: UUID! + $sourceTemplateId: UUID + $displayOrder: Int! + $name: String! + $quantity: Float! + $quantitySourceId: UUID + $unitPriceCents: Int! + $materialUnitPriceCents: Int! + $labourUnitPriceCents: Int! + $matchedKeywords: [String!]! +) @auth(level: NO_ACCESS) { + quoteItem_insert( + data: { + id: $id + ownerId: $ownerId + quoteId: $quoteId + sourceTemplateId: $sourceTemplateId + displayOrder: $displayOrder + name: $name + quantity: $quantity + quantitySourceId: $quantitySourceId + unitPriceCents: $unitPriceCents + materialUnitPriceCents: $materialUnitPriceCents + labourUnitPriceCents: $labourUnitPriceCents + matchedKeywords: $matchedKeywords + createdAt_expr: "request.time" + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateQuoteItem( + $id: UUID! + $displayOrder: Int + $name: String + $quantity: Float + $quantitySourceId: UUID + $unitPriceCents: Int + $materialUnitPriceCents: Int + $labourUnitPriceCents: Int + $matchedKeywords: [String!] +) @auth(level: NO_ACCESS) { + quoteItem_update( + id: $id + data: { + displayOrder: $displayOrder + name: $name + quantity: $quantity + quantitySourceId: $quantitySourceId + unitPriceCents: $unitPriceCents + materialUnitPriceCents: $materialUnitPriceCents + labourUnitPriceCents: $labourUnitPriceCents + matchedKeywords: $matchedKeywords + updatedAt_expr: "request.time" + } + ) +} diff --git a/data/connector/reminders.mutations.gql b/data/connector/reminders.mutations.gql new file mode 100644 index 0000000..5e31de6 --- /dev/null +++ b/data/connector/reminders.mutations.gql @@ -0,0 +1,44 @@ +mutation CreateReminder( + $id: UUID! + $ownerId: String! + $projectId: UUID! + $accountId: UUID + $name: String! + $status: String! + $dueAt: Timestamp! +) @auth(level: NO_ACCESS) { + reminder_insert( + data: { + id: $id + ownerId: $ownerId + projectId: $projectId + accountId: $accountId + name: $name + status: $status + dueAt: $dueAt + createdAt_expr: "request.time" + updatedAt_expr: "request.time" + } + ) +} + +mutation UpdateReminder( + $id: UUID! + $accountId: UUID + $name: String + $status: String + $dueAt: Timestamp + $completedAt: Timestamp +) @auth(level: NO_ACCESS) { + reminder_update( + id: $id + data: { + accountId: $accountId + name: $name + status: $status + dueAt: $dueAt + completedAt: $completedAt + updatedAt_expr: "request.time" + } + ) +} diff --git a/data/connector/reminders.queries.gql b/data/connector/reminders.queries.gql new file mode 100644 index 0000000..fee4d6a --- /dev/null +++ b/data/connector/reminders.queries.gql @@ -0,0 +1,54 @@ +query ListDueReminders($ownerId: String!) @auth(level: NO_ACCESS) { + reminders( + where: { + ownerId: { eq: $ownerId } + status: { eq: "OPEN" } + dueAt: { le_expr: "request.time" } + } + orderBy: [{ dueAt: ASC }] + ) { + id + ownerId + projectId + accountId + name + status + dueAt + completedAt + createdAt + updatedAt + } +} + +query ListProjectReminders($projectId: UUID!) @auth(level: NO_ACCESS) { + reminders( + where: { projectId: { eq: $projectId } } + orderBy: [{ dueAt: ASC }] + ) { + id + ownerId + projectId + accountId + name + status + dueAt + completedAt + createdAt + updatedAt + } +} + +query GetReminderById($id: UUID!) @auth(level: NO_ACCESS) { + reminder(id: $id) { + id + ownerId + projectId + accountId + name + status + dueAt + completedAt + createdAt + updatedAt + } +} diff --git a/data/connector/users.mutations.gql b/data/connector/users.mutations.gql new file mode 100644 index 0000000..388e143 --- /dev/null +++ b/data/connector/users.mutations.gql @@ -0,0 +1,14 @@ +mutation UpsertUserSettings( + $ownerId: String! + $quoteFollowUpEnabled: Boolean! + $quoteFollowUpDays: Int! +) @auth(level: NO_ACCESS) { + userSettings_upsert( + data: { + ownerId: $ownerId + quoteFollowUpEnabled: $quoteFollowUpEnabled + quoteFollowUpDays: $quoteFollowUpDays + updatedAt_expr: "request.time" + } + ) +} diff --git a/data/connector/users.queries.gql b/data/connector/users.queries.gql new file mode 100644 index 0000000..f380d62 --- /dev/null +++ b/data/connector/users.queries.gql @@ -0,0 +1,9 @@ +query GetUserSettings($ownerId: String!) @auth(level: NO_ACCESS) { + userSettings(key: { ownerId: $ownerId }) { + ownerId + quoteFollowUpEnabled + quoteFollowUpDays + createdAt + updatedAt + } +} diff --git a/data/connectors/accounts/connector.yaml b/data/connectors/accounts/connector.yaml deleted file mode 100644 index b96635a..0000000 --- a/data/connectors/accounts/connector.yaml +++ /dev/null @@ -1,5 +0,0 @@ -connectorId: accounts -generate: - adminNodeSdk: - - package: "@generated/accounts-data-connector-admin" - outputDir: ../../../generated/accounts-data-connector-admin diff --git a/data/connectors/example/connector.yaml b/data/connectors/example/connector.yaml deleted file mode 100644 index e6a0aa0..0000000 --- a/data/connectors/example/connector.yaml +++ /dev/null @@ -1,5 +0,0 @@ -connectorId: example -generate: - adminNodeSdk: - - package: "@generated/example-data-connector" - outputDir: ../../../generated/example-data-connector diff --git a/data/connectors/example/mutations.gql b/data/connectors/example/mutations.gql deleted file mode 100644 index ed6b49f..0000000 --- a/data/connectors/example/mutations.gql +++ /dev/null @@ -1,485 +0,0 @@ -mutation CreateProjectFromUpload( - $id: UUID! - $ownerId: String! - $accountId: UUID - $name: String! - $address: String - $originalFileName: String! - $uploadType: String! - $originalPath: String! - $status: String! - $salesStatus: String = "QUOTING" - $pageCount: Int! -) @auth(level: NO_ACCESS) { - project_insert( - data: { - id: $id - ownerId: $ownerId - accountId: $accountId - name: $name - address: $address - originalFileName: $originalFileName - uploadType: $uploadType - originalPath: $originalPath - status: $status - salesStatus: $salesStatus - pageCount: $pageCount - createdAt_expr: "request.time" - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateProject( - $id: UUID! - $name: String - $accountId: UUID - $address: String - $salesStatus: String -) @auth(level: NO_ACCESS) { - project_update( - id: $id - data: { - name: $name - accountId: $accountId - address: $address - salesStatus: $salesStatus - updatedAt_expr: "request.time" - } - ) -} - -mutation RenameProject($id: UUID!, $name: String!) @auth(level: NO_ACCESS) { - project_update( - id: $id - data: { name: $name, updatedAt_expr: "request.time" } - ) -} - -mutation TouchProject($id: UUID!, $status: String, $processingError: String) -@auth(level: NO_ACCESS) { - project_update( - id: $id - data: { - status: $status - processingError: $processingError - updatedAt_expr: "request.time" - } - ) -} - -mutation DeleteFloorplanPages($projectId: UUID!) @auth(level: NO_ACCESS) { - floorplanPage_deleteMany(where: { projectId: { eq: $projectId } }) -} - -mutation DeleteProject($id: UUID!) @auth(level: NO_ACCESS) { - project_delete(id: $id) -} - -mutation UpsertUserSettings( - $ownerId: String! - $quoteFollowUpEnabled: Boolean! - $quoteFollowUpDays: Int! -) @auth(level: NO_ACCESS) { - userSettings_upsert( - data: { - ownerId: $ownerId - quoteFollowUpEnabled: $quoteFollowUpEnabled - quoteFollowUpDays: $quoteFollowUpDays - updatedAt_expr: "request.time" - } - ) -} - -mutation CreateReminder( - $id: UUID! - $ownerId: String! - $projectId: UUID! - $accountId: UUID - $name: String! - $status: String! - $dueAt: Timestamp! -) @auth(level: NO_ACCESS) { - reminder_insert( - data: { - id: $id - ownerId: $ownerId - projectId: $projectId - accountId: $accountId - name: $name - status: $status - dueAt: $dueAt - createdAt_expr: "request.time" - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateReminder( - $id: UUID! - $accountId: UUID - $name: String - $status: String - $dueAt: Timestamp - $completedAt: Timestamp -) @auth(level: NO_ACCESS) { - reminder_update( - id: $id - data: { - accountId: $accountId - name: $name - status: $status - dueAt: $dueAt - completedAt: $completedAt - updatedAt_expr: "request.time" - } - ) -} - -mutation CreateFloorplanPage( - $projectId: UUID! - $pageNumber: Int! - $status: String! - $processingError: String - $sourceImagePath: String - $previewImagePath: String - $rawJsonPath: String - $rawFloorplanPath: String - $overlayJson: String - $scaleMmPerPx: Float - $ceilingHeightMm: Float - $referencePointsJson: String - $referenceLengthMm: Float - $processingStrategy: String - $processingMetadataJson: String -) @auth(level: NO_ACCESS) { - floorplanPage_insert( - data: { - projectId: $projectId - pageNumber: $pageNumber - status: $status - processingError: $processingError - sourceImagePath: $sourceImagePath - previewImagePath: $previewImagePath - rawJsonPath: $rawJsonPath - rawFloorplanPath: $rawFloorplanPath - overlayJson: $overlayJson - scaleMmPerPx: $scaleMmPerPx - ceilingHeightMm: $ceilingHeightMm - referencePointsJson: $referencePointsJson - referenceLengthMm: $referenceLengthMm - processingStrategy: $processingStrategy - processingMetadataJson: $processingMetadataJson - createdAt_expr: "request.time" - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateFloorplanPageAnalysis( - $id: UUID! - $status: String! - $processingError: String - $sourceImagePath: String - $previewImagePath: String - $rawJsonPath: String - $rawFloorplanPath: String - $overlayJson: String - $scaleMmPerPx: Float - $ceilingHeightMm: Float - $referencePointsJson: String - $referenceLengthMm: Float - $processingStrategy: String - $processingMetadataJson: String -) @auth(level: NO_ACCESS) { - floorplanPage_update( - id: $id - data: { - status: $status - processingError: $processingError - sourceImagePath: $sourceImagePath - previewImagePath: $previewImagePath - rawJsonPath: $rawJsonPath - rawFloorplanPath: $rawFloorplanPath - overlayJson: $overlayJson - scaleMmPerPx: $scaleMmPerPx - ceilingHeightMm: $ceilingHeightMm - referencePointsJson: $referencePointsJson - referenceLengthMm: $referenceLengthMm - processingStrategy: $processingStrategy - processingMetadataJson: $processingMetadataJson - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateFloorplanPage( - $id: UUID! - $overlayJson: String - $scaleMmPerPx: Float - $ceilingHeightMm: Float - $referencePointsJson: String - $referenceLengthMm: Float -) @auth(level: NO_ACCESS) { - floorplanPage_update( - id: $id - data: { - overlayJson: $overlayJson - scaleMmPerPx: $scaleMmPerPx - ceilingHeightMm: $ceilingHeightMm - referencePointsJson: $referencePointsJson - referenceLengthMm: $referenceLengthMm - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateFloorplanPages( - $projectId: UUID! - $scaleMmPerPx: Float - $ceilingHeightMm: Float -) @auth(level: NO_ACCESS) { - floorplanPage_updateMany( - where: { projectId: { eq: $projectId } } - data: { - scaleMmPerPx: $scaleMmPerPx - ceilingHeightMm: $ceilingHeightMm - updatedAt_expr: "request.time" - } - ) -} - -mutation CreateQuantitySource( - $id: UUID! - $measurementSource: String! - $measurementPlasterType: String -) @auth(level: NO_ACCESS) { - quantitySource_insert( - data: { - id: $id - measurementSource: $measurementSource - measurementPlasterType: $measurementPlasterType - createdAt_expr: "request.time" - updatedAt_expr: "request.time" - } - ) -} - -mutation CreateQuoteItemTemplate( - $id: UUID! - $ownerId: String - $scope: String! - $systemKey: String - $name: String! - $hasKeywords: Boolean! - $keywords: [String!]! - $quantitySourceId: UUID - $sortOrder: Int! -) @auth(level: NO_ACCESS) { - quoteItemTemplate_insert( - data: { - id: $id - ownerId: $ownerId - scope: $scope - systemKey: $systemKey - name: $name - hasKeywords: $hasKeywords - keywords: $keywords - quantitySourceId: $quantitySourceId - sortOrder: $sortOrder - createdAt_expr: "request.time" - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateQuoteItemTemplate( - $id: UUID! - $name: String - $hasKeywords: Boolean - $keywords: [String!] - $quantitySourceId: UUID - $sortOrder: Int -) @auth(level: NO_ACCESS) { - quoteItemTemplate_update( - id: $id - data: { - name: $name - hasKeywords: $hasKeywords - keywords: $keywords - quantitySourceId: $quantitySourceId - sortOrder: $sortOrder - updatedAt_expr: "request.time" - } - ) -} - -mutation DeleteQuoteItemTemplate($id: UUID!) @auth(level: NO_ACCESS) { - quoteItemTemplate_delete(id: $id) -} - -mutation UpsertQuoteItemTemplateConfig( - $ownerId: String! - $templateId: UUID! - $enabled: Boolean! - $unitPriceCents: Int! - $materialUnitPriceCents: Int! - $labourUnitPriceCents: Int! -) @auth(level: NO_ACCESS) { - quoteItemTemplateConfig_upsert( - data: { - ownerId: $ownerId - templateId: $templateId - enabled: $enabled - unitPriceCents: $unitPriceCents - materialUnitPriceCents: $materialUnitPriceCents - labourUnitPriceCents: $labourUnitPriceCents - updatedAt_expr: "request.time" - } - ) -} - -mutation CreateSupplier($id: UUID!, $ownerId: String!, $name: String!) -@auth(level: NO_ACCESS) { - supplier_insert( - data: { - id: $id - ownerId: $ownerId - name: $name - createdAt_expr: "request.time" - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateSupplier($id: UUID!, $name: String) @auth(level: NO_ACCESS) { - supplier_update( - id: $id - data: { name: $name, updatedAt_expr: "request.time" } - ) -} - -mutation DeleteSupplier($id: UUID!) @auth(level: NO_ACCESS) { - supplier_delete(id: $id) -} - -mutation UpsertSupplierQuoteItemPrice( - $ownerId: String! - $supplierId: UUID! - $templateId: UUID! - $materialUnitPriceCents: Int! -) @auth(level: NO_ACCESS) { - supplierQuoteItemPrice_upsert( - data: { - ownerId: $ownerId - supplierId: $supplierId - templateId: $templateId - materialUnitPriceCents: $materialUnitPriceCents - updatedAt_expr: "request.time" - } - ) -} - -mutation DeleteSupplierQuoteItemPrice($supplierId: UUID!, $templateId: UUID!) -@auth(level: NO_ACCESS) { - supplierQuoteItemPrice_delete( - key: { supplierId: $supplierId, templateId: $templateId } - ) -} - -mutation CreateQuote( - $id: UUID! - $ownerId: String! - $projectId: UUID! - $supplierId: UUID - $status: String! -) @auth(level: NO_ACCESS) { - quote_insert( - data: { - id: $id - ownerId: $ownerId - projectId: $projectId - supplierId: $supplierId - status: $status - createdAt_expr: "request.time" - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateQuote($id: UUID!, $supplierId: UUID, $status: String) -@auth(level: NO_ACCESS) { - quote_update( - id: $id - data: { - supplierId: $supplierId - status: $status - updatedAt_expr: "request.time" - } - ) -} - -mutation DeleteQuoteItems($quoteId: UUID!) @auth(level: NO_ACCESS) { - quoteItem_deleteMany(where: { quoteId: { eq: $quoteId } }) -} - -mutation CreateQuoteItem( - $id: UUID! - $ownerId: String! - $quoteId: UUID! - $sourceTemplateId: UUID - $displayOrder: Int! - $name: String! - $quantity: Float! - $quantitySourceId: UUID - $unitPriceCents: Int! - $materialUnitPriceCents: Int! - $labourUnitPriceCents: Int! - $matchedKeywords: [String!]! -) @auth(level: NO_ACCESS) { - quoteItem_insert( - data: { - id: $id - ownerId: $ownerId - quoteId: $quoteId - sourceTemplateId: $sourceTemplateId - displayOrder: $displayOrder - name: $name - quantity: $quantity - quantitySourceId: $quantitySourceId - unitPriceCents: $unitPriceCents - materialUnitPriceCents: $materialUnitPriceCents - labourUnitPriceCents: $labourUnitPriceCents - matchedKeywords: $matchedKeywords - createdAt_expr: "request.time" - updatedAt_expr: "request.time" - } - ) -} - -mutation UpdateQuoteItem( - $id: UUID! - $displayOrder: Int - $name: String - $quantity: Float - $quantitySourceId: UUID - $unitPriceCents: Int - $materialUnitPriceCents: Int - $labourUnitPriceCents: Int - $matchedKeywords: [String!] -) @auth(level: NO_ACCESS) { - quoteItem_update( - id: $id - data: { - displayOrder: $displayOrder - name: $name - quantity: $quantity - quantitySourceId: $quantitySourceId - unitPriceCents: $unitPriceCents - materialUnitPriceCents: $materialUnitPriceCents - labourUnitPriceCents: $labourUnitPriceCents - matchedKeywords: $matchedKeywords - updatedAt_expr: "request.time" - } - ) -} diff --git a/data/connectors/questionnaires/connector.yaml b/data/connectors/questionnaires/connector.yaml deleted file mode 100644 index 3964566..0000000 --- a/data/connectors/questionnaires/connector.yaml +++ /dev/null @@ -1,9 +0,0 @@ -connectorId: questionnaires -generate: - adminNodeSdk: - - package: "@generated/questionnaires-data-connector-admin" - outputDir: ../../../generated/questionnaires-data-connector-admin - javascriptSdk: - - package: "@generated/questionnaires-data-connector-web" - outputDir: ../../../generated/questionnaires-data-connector-web - react: true diff --git a/data/schemas/accounts.gql b/data/schemas/accounts.gql index d74ba39..6b68df3 100644 --- a/data/schemas/accounts.gql +++ b/data/schemas/accounts.gql @@ -26,11 +26,3 @@ type AccountContact createdAt: Timestamp! @default(expr: "request.time") updatedAt: Timestamp! @default(expr: "request.time") } - -type UserSettings @table(key: "ownerId") { - ownerId: String! - quoteFollowUpEnabled: Boolean! @default(value: true) - quoteFollowUpDays: Int! @default(value: 3) - createdAt: Timestamp! @default(expr: "request.time") - updatedAt: Timestamp! @default(expr: "request.time") -} diff --git a/data/schemas/users.gql b/data/schemas/users.gql new file mode 100644 index 0000000..1e2098a --- /dev/null +++ b/data/schemas/users.gql @@ -0,0 +1,7 @@ +type UserSettings @table(key: "ownerId") { + ownerId: String! + quoteFollowUpEnabled: Boolean! @default(value: true) + quoteFollowUpDays: Int! @default(value: 3) + createdAt: Timestamp! @default(expr: "request.time") + updatedAt: Timestamp! @default(expr: "request.time") +} diff --git a/dataconnect.yaml b/dataconnect.yaml index 8026d1c..57ad16d 100644 --- a/dataconnect.yaml +++ b/dataconnect.yaml @@ -10,6 +10,4 @@ schemas: instanceId: "plaster-calculator" schemaValidation: "STRICT" connectorDirs: - - ./data/connectors/example - - ./data/connectors/accounts - - ./data/connectors/questionnaires + - ./data/connector diff --git a/functions/plaster-calculator-functions/package.json b/functions/plaster-calculator-functions/package.json index 5c2b506..be36629 100644 --- a/functions/plaster-calculator-functions/package.json +++ b/functions/plaster-calculator-functions/package.json @@ -11,8 +11,7 @@ "logs": "firebase functions:log" }, "dependencies": { - "@generated/accounts-data-connector-admin": "workspace:*", - "@generated/example-data-connector": "workspace:*", + "@generated/data-connector-admin": "workspace:*", "firebase-admin": "^13.10.0", "firebase-functions": "^7.2.5", "google-auth-library": "^10.9.0", diff --git a/functions/plaster-calculator-functions/src/accounts.ts b/functions/plaster-calculator-functions/src/accounts.ts index 98f0823..821cac7 100644 --- a/functions/plaster-calculator-functions/src/accounts.ts +++ b/functions/plaster-calculator-functions/src/accounts.ts @@ -2,21 +2,10 @@ import "./bootstrap.js"; import { randomUUID } from "node:crypto"; -import { - createAccount as dcCreateAccount, - createAccountContact as dcCreateAccountContact, - deleteAccount as dcDeleteAccount, - deleteAccountContact as dcDeleteAccountContact, - deleteAccountContacts as dcDeleteAccountContacts, - listAccountContactsByAccountId as dcListAccountContactsByAccountId, - listAccountsByOwner, - updateAccount as dcUpdateAccount, - updateAccountContact as dcUpdateAccountContact, -} from "@generated/accounts-data-connector-admin"; +import * as DataConnector from "@generated/data-connector-admin"; import { onCall } from "firebase-functions/https"; import { requireAuth } from "./auth.js"; -import { accountsDataConnect } from "./data-connect.js"; import { toAccountContact, toAccountDetail, @@ -49,7 +38,7 @@ export const listAccounts = onCall< Promise<{ accounts: AccountSummary[] }> >(async (request) => { const auth = requireAuth(request); - const response = await listAccountsByOwner(accountsDataConnect, { + const response = await DataConnector.listAccountsByOwner({ ownerId: auth.uid, }); return { accounts: response.data.accounts.map(toAccountSummary) }; @@ -74,10 +63,9 @@ export const listAccountContactsByAccountId = onCall< const auth = requireAuth(request); const accountId = readRequiredString(request.data.accountId, "Account ID"); await requireOwnedAccount(accountId, auth.uid); - const response = await dcListAccountContactsByAccountId( - accountsDataConnect, - { accountId }, - ); + const response = await DataConnector.listAccountContactsByAccountId({ + accountId, + }); return { contacts: response.data.accountContacts.map(toAccountContact) }; }); @@ -87,7 +75,7 @@ export const createAccount = onCall< >(async (request) => { const auth = requireAuth(request); const accountId = randomUUID(); - await dcCreateAccount(accountsDataConnect, { + await DataConnector.createAccount({ id: accountId, ownerId: auth.uid, companyName: readRequiredString( @@ -126,7 +114,7 @@ export const updateAccount = onCall< await requireOwnedAccountContact(accountId, primaryContactId, auth.uid); } - await dcUpdateAccount(accountsDataConnect, { + await DataConnector.updateAccount({ id: accountId, companyName: hasField(data, "companyName") ? readRequiredString(data.companyName, "Company name") @@ -151,8 +139,8 @@ export const deleteAccount = onCall>( "Account ID", ); await requireOwnedAccount(accountId, auth.uid); - await dcDeleteAccountContacts(accountsDataConnect, { accountId }); - await dcDeleteAccount(accountsDataConnect, { id: accountId }); + await DataConnector.deleteAccountContacts({ accountId }); + await DataConnector.deleteAccount({ id: accountId }); return { ok: true }; }, ); @@ -165,7 +153,7 @@ export const createAccountContact = onCall< const accountId = readRequiredString(request.data.accountId, "Account ID"); const account = await requireOwnedAccount(accountId, auth.uid); const contactId = randomUUID(); - await dcCreateAccountContact(accountsDataConnect, { + await DataConnector.createAccountContact({ id: contactId, accountId, name: readRequiredString(request.data.name, "Contact name"), @@ -176,7 +164,7 @@ export const createAccountContact = onCall< ), role: readOptionalNullableString(request.data.role, "Role"), }); - await dcUpdateAccount(accountsDataConnect, { + await DataConnector.updateAccount({ id: accountId, companyName: account.companyName, businessNumber: account.businessNumber ?? null, @@ -203,7 +191,7 @@ export const updateAccountContact = onCall< ); const data = request.data; - await dcUpdateAccountContact(accountsDataConnect, { + await DataConnector.updateAccountContact({ id: contactId, name: hasField(data, "name") ? readRequiredString(data.name, "Contact name") @@ -233,7 +221,7 @@ export const deleteAccountContact = onCall< await requireOwnedAccountContact(accountId, contactId, auth.uid); if (account.primaryContactId === contactId) { - await dcUpdateAccount(accountsDataConnect, { + await DataConnector.updateAccount({ id: accountId, companyName: account.companyName, businessNumber: account.businessNumber ?? null, @@ -242,7 +230,7 @@ export const deleteAccountContact = onCall< }); } - await dcDeleteAccountContact(accountsDataConnect, { id: contactId }); + await DataConnector.deleteAccountContact({ id: contactId }); return toAccountDetail(await requireOwnedAccount(accountId, auth.uid)); }); @@ -255,7 +243,7 @@ export const setPrimaryAccountContact = onCall< const contactId = readRequiredString(request.data.contactId, "Contact ID"); const account = await requireOwnedAccount(accountId, auth.uid); await requireOwnedAccountContact(accountId, contactId, auth.uid); - await dcUpdateAccount(accountsDataConnect, { + await DataConnector.updateAccount({ id: accountId, companyName: account.companyName, businessNumber: account.businessNumber ?? null, diff --git a/functions/plaster-calculator-functions/src/data-connect.ts b/functions/plaster-calculator-functions/src/data-connect.ts deleted file mode 100644 index e9d2d97..0000000 --- a/functions/plaster-calculator-functions/src/data-connect.ts +++ /dev/null @@ -1,33 +0,0 @@ -import "./bootstrap.js"; - -import { connectorConfig as accountsConnectorConfig } from "@generated/accounts-data-connector-admin"; -import { connectorConfig as exampleConnectorConfig } from "@generated/example-data-connector"; -import { getApp, type App } from "firebase-admin/app"; -import { DataConnect, type ConnectorConfig } from "firebase-admin/data-connect"; - -const app = getApp(); - -// The public .d.ts hides DataConnect's constructor (it's @internal-tagged), -// but the runtime class does accept (connectorConfig, app) - see -// firebase-admin/lib/data-connect/data-connect.js. Cast to restore the real -// signature so we can construct instances ourselves. -const DataConnectCtor = DataConnect as unknown as new ( - connectorConfig: ConnectorConfig, - app: App, -) => DataConnect; - -// firebase-admin's getDataConnect() caches instances keyed only by -// `${location}-${serviceId}`, ignoring the connector name, so two connectors -// sharing a service silently collide and route operations to whichever -// connector's client was constructed first in the process. Constructing our -// own instances per connector bypasses that shared cache. Fixed upstream in -// https://github.com/firebase/firebase-admin-node/pull/3055 - once a release -// containing that fix is out, this workaround can be removed. -export const accountsDataConnect = new DataConnectCtor( - accountsConnectorConfig, - app, -); -export const exampleDataConnect = new DataConnectCtor( - exampleConnectorConfig, - app, -); diff --git a/functions/plaster-calculator-functions/src/floorplan-pages.ts b/functions/plaster-calculator-functions/src/floorplan-pages.ts index abb7440..017bac6 100644 --- a/functions/plaster-calculator-functions/src/floorplan-pages.ts +++ b/functions/plaster-calculator-functions/src/floorplan-pages.ts @@ -1,14 +1,9 @@ import "./bootstrap.js"; -import { - createFloorplanPage as dcCreateFloorplanPage, - touchProject, - updateFloorplanPage as dcUpdateFloorplanPage, -} from "@generated/example-data-connector"; +import * as DataConnector from "@generated/data-connector-admin"; import { HttpsError, onCall } from "firebase-functions/https"; import { requireAuth } from "./auth.js"; -import { exampleDataConnect } from "./data-connect.js"; import { toDetail, toPage } from "./mappers.js"; import { requireFloorplanPage, requireOwnedProject } from "./ownership.js"; import { @@ -67,7 +62,7 @@ export const updateFloorplanPage = onCall< } const nextValues = nextFloorplanPageValues(request.data, page); - await dcUpdateFloorplanPage(exampleDataConnect, { + await DataConnector.updateFloorplanPage({ id: page.id, overlayJson: nextValues.overlayJson, scaleMmPerPx: nextValues.scaleMmPerPx, @@ -75,7 +70,7 @@ export const updateFloorplanPage = onCall< referencePointsJson: nextValues.referencePointsJson, referenceLengthMm: nextValues.referenceLengthMm, }); - await touchProject(exampleDataConnect, { id: projectId }); + await DataConnector.touchProject({ id: projectId }); return toPage(await requireFloorplanPage(projectId, page.id)); }); @@ -127,7 +122,7 @@ export const initializeFloorplanPages = onCall< } await requireStorageImage(entry.path); const sourceImageUrl = await ensureFileDownloadUrl(entry.path); - await dcCreateFloorplanPage(exampleDataConnect, { + await DataConnector.createFloorplanPage({ projectId, pageNumber: entry.pageNumber, status: "READY", @@ -147,7 +142,7 @@ export const initializeFloorplanPages = onCall< }); } - await touchProject(exampleDataConnect, { + await DataConnector.touchProject({ id: projectId, status: "READY", processingError: null, @@ -211,7 +206,7 @@ export const updateFloorplanPages = onCall< for (const page of project.pages) { const nextValues = nextBatchPageValues(data, page); - await dcUpdateFloorplanPage(exampleDataConnect, { + await DataConnector.updateFloorplanPage({ id: page.id, overlayJson: page.overlayJson ?? null, scaleMmPerPx: nextValues.scaleMmPerPx, @@ -221,7 +216,7 @@ export const updateFloorplanPages = onCall< }); } - await touchProject(exampleDataConnect, { id: projectId }); + await DataConnector.touchProject({ id: projectId }); return toDetail(await requireOwnedProject(projectId, auth.uid)); }); diff --git a/functions/plaster-calculator-functions/src/ownership.ts b/functions/plaster-calculator-functions/src/ownership.ts index 6374282..75eaefa 100644 --- a/functions/plaster-calculator-functions/src/ownership.ts +++ b/functions/plaster-calculator-functions/src/ownership.ts @@ -1,20 +1,12 @@ -import { - getAccountById, - getAccountContactById, -} from "@generated/accounts-data-connector-admin"; -import { - getFloorplanPageById, - getProjectDetailsById, - getReminderById, -} from "@generated/example-data-connector"; -import { HttpsError } from "firebase-functions/https"; +import "./bootstrap.js"; -import { accountsDataConnect, exampleDataConnect } from "./data-connect.js"; +import * as DataConnector from "@generated/data-connector-admin"; +import { HttpsError } from "firebase-functions/https"; export async function requireOwnedProject(projectId: string, ownerId: string) { // TODO: Add a lightweight ownership helper backed by getProjectById for // callsites that do not need floorplan pages. - const response = await getProjectDetailsById(exampleDataConnect, { + const response = await DataConnector.getProjectDetailsById({ id: projectId, }); const project = response.data.project; @@ -26,7 +18,7 @@ export async function requireOwnedProject(projectId: string, ownerId: string) { } export async function requireOwnedAccount(accountId: string, ownerId: string) { - const response = await getAccountById(accountsDataConnect, { + const response = await DataConnector.getAccountById({ id: accountId, }); const account = response.data.account; @@ -43,7 +35,7 @@ export async function requireOwnedAccountContact( ownerId: string, ) { await requireOwnedAccount(accountId, ownerId); - const response = await getAccountContactById(accountsDataConnect, { + const response = await DataConnector.getAccountContactById({ accountId, contactId, }); @@ -59,7 +51,7 @@ export async function requireOwnedReminder( reminderId: string, ownerId: string, ) { - const response = await getReminderById(exampleDataConnect, { + const response = await DataConnector.getReminderById({ id: reminderId, }); const reminder = response.data.reminder; @@ -70,7 +62,7 @@ export async function requireOwnedReminder( return reminder; } export async function requireFloorplanPage(projectId: string, pageId: string) { - const response = await getFloorplanPageById(exampleDataConnect, { + const response = await DataConnector.getFloorplanPageById({ projectId, pageId, }); diff --git a/functions/plaster-calculator-functions/src/page-analysis.ts b/functions/plaster-calculator-functions/src/page-analysis.ts index 69f1835..580c08d 100644 --- a/functions/plaster-calculator-functions/src/page-analysis.ts +++ b/functions/plaster-calculator-functions/src/page-analysis.ts @@ -1,11 +1,10 @@ import "./bootstrap.js"; -import { updateFloorplanPageAnalysis } from "@generated/example-data-connector"; +import * as DataConnector from "@generated/data-connector-admin"; import { HttpsError, onCall } from "firebase-functions/https"; import * as logger from "firebase-functions/logger"; import { requireAuth } from "./auth.js"; -import { exampleDataConnect } from "./data-connect.js"; import { toDetail } from "./mappers.js"; import { requireFloorplanPage, requireOwnedProject } from "./ownership.js"; import { analyzePageImage } from "./processing-pages.js"; @@ -67,7 +66,7 @@ export const analyzeFloorplanPage = onCall< imageBytes: source, strategy, }); - await updateFloorplanPageAnalysis(exampleDataConnect, { + await DataConnector.updateFloorplanPageAnalysis({ id: page.id, status: "READY", processingError: null, @@ -131,7 +130,7 @@ async function writeAnalysisState( status: "PROCESSING" | "FAILED", processingError: string | null, ): Promise { - await updateFloorplanPageAnalysis(exampleDataConnect, { + await DataConnector.updateFloorplanPageAnalysis({ id: page.id, status, processingError, diff --git a/functions/plaster-calculator-functions/src/processing-pages.ts b/functions/plaster-calculator-functions/src/processing-pages.ts index 08fd806..3a4ce00 100644 --- a/functions/plaster-calculator-functions/src/processing-pages.ts +++ b/functions/plaster-calculator-functions/src/processing-pages.ts @@ -1,11 +1,12 @@ -import { createFloorplanPage as dcCreateFloorplanPage } from "@generated/example-data-connector"; +import "./bootstrap.js"; + +import * as DataConnector from "@generated/data-connector-admin"; import { HttpsError } from "firebase-functions/https"; import { buildOverlayFromAnalyzerResult, callFloorplanAnalyzer, } from "./analyzer.js"; -import { exampleDataConnect } from "./data-connect.js"; import { fetchStorageImage, storageProjectId, @@ -122,7 +123,7 @@ async function analysePage( strategy, }); - await dcCreateFloorplanPage(exampleDataConnect, { + await DataConnector.createFloorplanPage({ projectId, pageNumber, status: "READY", diff --git a/functions/plaster-calculator-functions/src/processing.ts b/functions/plaster-calculator-functions/src/processing.ts index 275a96e..396d674 100644 --- a/functions/plaster-calculator-functions/src/processing.ts +++ b/functions/plaster-calculator-functions/src/processing.ts @@ -1,14 +1,10 @@ import "./bootstrap.js"; -import { - deleteFloorplanPages as dcDeleteFloorplanPages, - touchProject, -} from "@generated/example-data-connector"; +import * as DataConnector from "@generated/data-connector-admin"; import { HttpsError, onCall } from "firebase-functions/https"; import * as logger from "firebase-functions/logger"; import { requireAuth } from "./auth.js"; -import { exampleDataConnect } from "./data-connect.js"; import { toDetail } from "./mappers.js"; import { requireOwnedProject } from "./ownership.js"; import { analyseProjectPages } from "./processing-pages.js"; @@ -71,12 +67,12 @@ export const processProject = onCall< ) : new Map(); - await touchProject(exampleDataConnect, { + await DataConnector.touchProject({ id: projectId, status: "PROCESSING", processingError: null, }); - await dcDeleteFloorplanPages(exampleDataConnect, { projectId }); + await DataConnector.deleteFloorplanPages({ projectId }); try { await analyseProjectPages( @@ -92,7 +88,7 @@ export const processProject = onCall< ? error.message : "Floorplan analysis failed."; logger.error("processProject failed", { projectId, message }); - await touchProject(exampleDataConnect, { + await DataConnector.touchProject({ id: projectId, status: "FAILED", processingError: message, @@ -102,7 +98,7 @@ export const processProject = onCall< : new HttpsError("internal", message); } - await touchProject(exampleDataConnect, { + await DataConnector.touchProject({ id: projectId, status: "READY", processingError: null, diff --git a/functions/plaster-calculator-functions/src/projects.ts b/functions/plaster-calculator-functions/src/projects.ts index 00518c0..bcce13c 100644 --- a/functions/plaster-calculator-functions/src/projects.ts +++ b/functions/plaster-calculator-functions/src/projects.ts @@ -1,21 +1,11 @@ import "./bootstrap.js"; -import { - createFloorplanPage as dcCreateFloorplanPage, - createProjectFromUpload as dcCreateProjectFromUpload, - deleteFloorplanPages as dcDeleteFloorplanPages, - deleteProject as dcDeleteProject, - getProjectById, - listProjectsByAccount as dcListProjectsByAccount, - listProjectsByOwnerAndSalesStatus, - updateProject as dcUpdateProject, -} from "@generated/example-data-connector"; +import * as DataConnector from "@generated/data-connector-admin"; import { getStorage } from "firebase-admin/storage"; import { HttpsError, onCall } from "firebase-functions/https"; import { requireAuth } from "./auth.js"; import { buildProjectCsv, csvFileNamePart } from "./csv-export.js"; -import { exampleDataConnect } from "./data-connect.js"; import { toDetail, toDetailWithDownloadUrls, toSummary } from "./mappers.js"; import { requireOwnedAccount, requireOwnedProject } from "./ownership.js"; import { @@ -63,13 +53,10 @@ export const listProjects = onCall< const auth = requireAuth(request); const data = request.data ?? {}; const salesStatus = readSalesStatus(data.salesStatus); - const response = await listProjectsByOwnerAndSalesStatus( - exampleDataConnect, - { - ownerId: auth.uid, - salesStatus, - }, - ); + const response = await DataConnector.listProjectsByOwnerAndSalesStatus({ + ownerId: auth.uid, + salesStatus, + }); return { projects: response.data.projects.map(toSummary) }; }); @@ -80,7 +67,7 @@ export const listProjectsByAccount = onCall< const auth = requireAuth(request); const accountId = readRequiredString(request.data.accountId, "Account ID"); await requireOwnedAccount(accountId, auth.uid); - const response = await dcListProjectsByAccount(exampleDataConnect, { + const response = await DataConnector.listProjectsByAccount({ accountId, }); return { projects: response.data.projects.map(toSummary) }; @@ -133,7 +120,7 @@ export const createProjectFromUpload = onCall< const uploadType = inferUploadType(originalFileName, contentType); const pageCount = uploadType === "PDF" ? readPdfPageCount(request.data.pageCount) : 1; - await dcCreateProjectFromUpload(exampleDataConnect, { + await DataConnector.createProjectFromUpload({ id: projectId, ownerId: auth.uid, accountId, @@ -148,7 +135,7 @@ export const createProjectFromUpload = onCall< }); if (uploadType === "IMAGE") { - await dcCreateFloorplanPage(exampleDataConnect, { + await DataConnector.createFloorplanPage({ projectId, pageNumber: 1, status: "READY", @@ -192,7 +179,7 @@ export const getProjectStatus = onCall< Promise >(async (request) => { const auth = requireAuth(request); - const response = await getProjectById(exampleDataConnect, { + const response = await DataConnector.getProjectById({ id: readRequiredString(request.data.projectId, "Project ID"), }); const project = response.data.project; @@ -263,8 +250,8 @@ export const deleteProject = onCall>( const project = await requireOwnedProject(projectId, auth.uid); await deleteOwnedProjectStorage(project, auth.uid, projectId); - await dcDeleteFloorplanPages(exampleDataConnect, { projectId }); - await dcDeleteProject(exampleDataConnect, { id: projectId }); + await DataConnector.deleteFloorplanPages({ projectId }); + await DataConnector.deleteProject({ id: projectId }); return { ok: true }; }, @@ -305,7 +292,7 @@ async function updateOwnedProject( const nextSalesStatus = nextSalesStatusFor(updates, project.salesStatus); - await dcUpdateProject(exampleDataConnect, { + await DataConnector.updateProject({ id: projectId, name: updates.name ?? project.name, accountId: nextAccountId, diff --git a/functions/plaster-calculator-functions/src/quote-follow-up.ts b/functions/plaster-calculator-functions/src/quote-follow-up.ts index 8c9fd3e..ea30ed7 100644 --- a/functions/plaster-calculator-functions/src/quote-follow-up.ts +++ b/functions/plaster-calculator-functions/src/quote-follow-up.ts @@ -1,12 +1,9 @@ +import "./bootstrap.js"; + import { randomUUID } from "node:crypto"; -import { - createReminder as dcCreateReminder, - listProjectReminders as dcListProjectReminders, - updateReminder as dcUpdateReminder, -} from "@generated/example-data-connector"; +import * as DataConnector from "@generated/data-connector-admin"; -import { exampleDataConnect } from "./data-connect.js"; import { getUserSettingsOrDefault } from "./settings.js"; import { toReminderStatus } from "./validation.js"; @@ -28,7 +25,7 @@ export async function upsertAutoQuoteReminder( const existing = await findOpenProjectReminder(project.id, ownerId); if (existing && existing.ownerId === ownerId) { - await dcUpdateReminder(exampleDataConnect, { + await DataConnector.updateReminder({ id: existing.id, accountId: project.accountId ?? null, name, @@ -39,7 +36,7 @@ export async function upsertAutoQuoteReminder( return; } - await dcCreateReminder(exampleDataConnect, { + await DataConnector.createReminder({ id: randomUUID(), ownerId, projectId: project.id, @@ -59,7 +56,7 @@ export async function cancelOpenProjectReminder( return; } - await dcUpdateReminder(exampleDataConnect, { + await DataConnector.updateReminder({ id: reminder.id, accountId: reminder.accountId ?? null, name: reminder.name, @@ -73,7 +70,7 @@ export async function findOpenProjectReminder( projectId: string, ownerId: string, ) { - const response = await dcListProjectReminders(exampleDataConnect, { + const response = await DataConnector.listProjectReminders({ projectId, }); return ( diff --git a/functions/plaster-calculator-functions/src/reminders.ts b/functions/plaster-calculator-functions/src/reminders.ts index f8cd9bd..8fc0c45 100644 --- a/functions/plaster-calculator-functions/src/reminders.ts +++ b/functions/plaster-calculator-functions/src/reminders.ts @@ -2,16 +2,10 @@ import "./bootstrap.js"; import { randomUUID } from "node:crypto"; -import { - createReminder as dcCreateReminder, - listDueReminders as dcListDueReminders, - listProjectReminders as dcListProjectReminders, - updateReminder as dcUpdateReminder, -} from "@generated/example-data-connector"; +import * as DataConnector from "@generated/data-connector-admin"; import { onCall } from "firebase-functions/https"; import { requireAuth } from "./auth.js"; -import { exampleDataConnect } from "./data-connect.js"; import { toReminder } from "./mappers.js"; import { requireOwnedAccount, @@ -40,7 +34,7 @@ export const listDueReminders = onCall< Promise<{ reminders: Reminder[] }> >(async (request) => { const auth = requireAuth(request); - const response = await dcListDueReminders(exampleDataConnect, { + const response = await DataConnector.listDueReminders({ ownerId: auth.uid, }); return { reminders: response.data.reminders.map(toReminder) }; @@ -53,7 +47,7 @@ export const listProjectReminders = onCall< const auth = requireAuth(request); const projectId = readRequiredString(request.data.projectId, "Project ID"); await requireOwnedProject(projectId, auth.uid); - const response = await dcListProjectReminders(exampleDataConnect, { + const response = await DataConnector.listProjectReminders({ projectId, }); return { @@ -78,7 +72,7 @@ export const createReminder = onCall>( } const reminderId = randomUUID(); - await dcCreateReminder(exampleDataConnect, { + await DataConnector.createReminder({ id: reminderId, ownerId: auth.uid, projectId: project.id, @@ -108,7 +102,7 @@ export const updateReminder = onCall>( await requireOwnedAccount(accountId, auth.uid); } - await dcUpdateReminder(exampleDataConnect, { + await DataConnector.updateReminder({ id: reminder.id, accountId, name: hasField(data, "name") @@ -137,7 +131,7 @@ export const completeReminder = onCall>( readRequiredString(request.data.reminderId, "Reminder ID"), auth.uid, ); - await dcUpdateReminder(exampleDataConnect, { + await DataConnector.updateReminder({ id: reminder.id, accountId: reminder.accountId ?? null, name: reminder.name, @@ -156,7 +150,7 @@ export const cancelReminder = onCall>( readRequiredString(request.data.reminderId, "Reminder ID"), auth.uid, ); - await dcUpdateReminder(exampleDataConnect, { + await DataConnector.updateReminder({ id: reminder.id, accountId: reminder.accountId ?? null, name: reminder.name, diff --git a/functions/plaster-calculator-functions/src/settings.ts b/functions/plaster-calculator-functions/src/settings.ts index 9c30b9e..52af7a7 100644 --- a/functions/plaster-calculator-functions/src/settings.ts +++ b/functions/plaster-calculator-functions/src/settings.ts @@ -1,13 +1,9 @@ import "./bootstrap.js"; -import { - getUserSettings, - upsertUserSettings, -} from "@generated/example-data-connector"; +import * as DataConnector from "@generated/data-connector-admin"; import { onCall } from "firebase-functions/https"; import { requireAuth } from "./auth.js"; -import { exampleDataConnect } from "./data-connect.js"; import { readOptionalBoolean, readOptionalPositiveInteger, @@ -42,7 +38,7 @@ export const updateSettings = onCall< "Quote follow-up days", ) ?? settings.quoteFollowUpDays; - await upsertUserSettings(exampleDataConnect, { + await DataConnector.upsertUserSettings({ ownerId: auth.uid, quoteFollowUpEnabled, quoteFollowUpDays, @@ -54,8 +50,8 @@ export const updateSettings = onCall< export async function getUserSettingsOrDefault( ownerId: string, ): Promise { - const settings = (await getUserSettings(exampleDataConnect, { ownerId })) - .data.userSettings; + const settings = (await DataConnector.getUserSettings({ ownerId })).data + .userSettings; if (!settings) { return { ownerId, diff --git a/functions/plaster-calculator-functions/src/types.ts b/functions/plaster-calculator-functions/src/types.ts index 4164585..7036b7f 100644 --- a/functions/plaster-calculator-functions/src/types.ts +++ b/functions/plaster-calculator-functions/src/types.ts @@ -1,38 +1,32 @@ -import type { - GetAccountByIdData, - GetAccountContactByIdData, - ListAccountContactsByAccountIdData, - ListAccountsByOwnerData, -} from "@generated/accounts-data-connector-admin"; -import type { - GetFloorplanPageByIdData, - GetProjectByIdData, - GetProjectDetailsByIdData, - GetReminderByIdData, - ListProjectsByAccountData, - ListProjectsByOwnerAndSalesStatusData, - ListProjectRemindersData, -} from "@generated/example-data-connector"; +import type * as DataConnector from "@generated/data-connector-admin"; export type ProjectListRow = - | ListProjectsByOwnerAndSalesStatusData["projects"][number] - | ListProjectsByAccountData["projects"][number]; + | DataConnector.ListProjectsByOwnerAndSalesStatusData["projects"][number] + | DataConnector.ListProjectsByAccountData["projects"][number]; export type ProjectWithPages = NonNullable< - GetProjectDetailsByIdData["project"] + DataConnector.GetProjectDetailsByIdData["project"] +>; +export type ProjectDetailsRow = NonNullable< + DataConnector.GetProjectByIdData["project"] >; -export type ProjectDetailsRow = NonNullable; export type FloorplanPageRow = NonNullable< - GetFloorplanPageByIdData["floorplanPage"] + DataConnector.GetFloorplanPageByIdData["floorplanPage"] +>; +export type AccountListRow = + DataConnector.ListAccountsByOwnerData["accounts"][number]; +export type AccountWithContacts = NonNullable< + DataConnector.GetAccountByIdData["account"] >; -export type AccountListRow = ListAccountsByOwnerData["accounts"][number]; -export type AccountWithContacts = NonNullable; export type AccountContactRow = NonNullable< - GetAccountContactByIdData["accountContact"] + DataConnector.GetAccountContactByIdData["accountContact"] >; export type AccountContactListRow = - ListAccountContactsByAccountIdData["accountContacts"][number]; -export type ReminderRow = NonNullable; -export type ProjectReminderRow = ListProjectRemindersData["reminders"][number]; + DataConnector.ListAccountContactsByAccountIdData["accountContacts"][number]; +export type ReminderRow = NonNullable< + DataConnector.GetReminderByIdData["reminder"] +>; +export type ProjectReminderRow = + DataConnector.ListProjectRemindersData["reminders"][number]; export type UploadType = "PDF" | "IMAGE"; export type ProjectStatus = "DRAFT" | "PROCESSING" | "READY" | "FAILED"; diff --git a/generated/accounts-data-connector-admin/esm/index.esm.js b/generated/accounts-data-connector-admin/esm/index.esm.js deleted file mode 100644 index 5a79af6..0000000 --- a/generated/accounts-data-connector-admin/esm/index.esm.js +++ /dev/null @@ -1,74 +0,0 @@ -import { validateAdminArgs } from 'firebase-admin/data-connect'; - -export const connectorConfig = { - connector: 'accounts', - serviceId: 'plaster-calculator', - location: 'us-west1' -}; - -export function createAccount(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateAccount', inputVars, inputOpts); -} - -export function updateAccount(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateAccount', inputVars, inputOpts); -} - -export function deleteAccountContacts(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteAccountContacts', inputVars, inputOpts); -} - -export function deleteAccount(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteAccount', inputVars, inputOpts); -} - -export function createAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateAccountContact', inputVars, inputOpts); -} - -export function updateAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateAccountContact', inputVars, inputOpts); -} - -export function deleteAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteAccountContact', inputVars, inputOpts); -} - -export function listAccountsByOwner(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListAccountsByOwner', inputVars, inputOpts); -} - -export function getAccountById(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('GetAccountById', inputVars, inputOpts); -} - -export function listAccountContactsByAccountId(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListAccountContactsByAccountId', inputVars, inputOpts); -} - -export function getAccountContactById(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('GetAccountContactById', inputVars, inputOpts); -} - diff --git a/generated/accounts-data-connector-admin/index.cjs.js b/generated/accounts-data-connector-admin/index.cjs.js deleted file mode 100644 index afb0853..0000000 --- a/generated/accounts-data-connector-admin/index.cjs.js +++ /dev/null @@ -1,86 +0,0 @@ -const { validateAdminArgs } = require('firebase-admin/data-connect'); - -const connectorConfig = { - connector: 'accounts', - serviceId: 'plaster-calculator', - location: 'us-west1' -}; -exports.connectorConfig = connectorConfig; - -function createAccount(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateAccount', inputVars, inputOpts); -} -exports.createAccount = createAccount; - -function updateAccount(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateAccount', inputVars, inputOpts); -} -exports.updateAccount = updateAccount; - -function deleteAccountContacts(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteAccountContacts', inputVars, inputOpts); -} -exports.deleteAccountContacts = deleteAccountContacts; - -function deleteAccount(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteAccount', inputVars, inputOpts); -} -exports.deleteAccount = deleteAccount; - -function createAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateAccountContact', inputVars, inputOpts); -} -exports.createAccountContact = createAccountContact; - -function updateAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateAccountContact', inputVars, inputOpts); -} -exports.updateAccountContact = updateAccountContact; - -function deleteAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteAccountContact', inputVars, inputOpts); -} -exports.deleteAccountContact = deleteAccountContact; - -function listAccountsByOwner(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListAccountsByOwner', inputVars, inputOpts); -} -exports.listAccountsByOwner = listAccountsByOwner; - -function getAccountById(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('GetAccountById', inputVars, inputOpts); -} -exports.getAccountById = getAccountById; - -function listAccountContactsByAccountId(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListAccountContactsByAccountId', inputVars, inputOpts); -} -exports.listAccountContactsByAccountId = listAccountContactsByAccountId; - -function getAccountContactById(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('GetAccountContactById', inputVars, inputOpts); -} -exports.getAccountContactById = getAccountContactById; - diff --git a/generated/accounts-data-connector-admin/index.d.ts b/generated/accounts-data-connector-admin/index.d.ts deleted file mode 100644 index 6b07da8..0000000 --- a/generated/accounts-data-connector-admin/index.d.ts +++ /dev/null @@ -1,304 +0,0 @@ -import { ConnectorConfig, DataConnect, OperationOptions, ExecuteOperationResponse } from 'firebase-admin/data-connect'; - -export const connectorConfig: ConnectorConfig; - -export type TimestampString = string; -export type UUIDString = string; -export type Int64String = string; -export type DateString = string; - - -export interface AccountContact_Key { - id: UUIDString; - __typename?: 'AccountContact_Key'; -} - -export interface Account_Key { - id: UUIDString; - __typename?: 'Account_Key'; -} - -export interface CreateAccountContactData { - accountContact_insert: AccountContact_Key; -} - -export interface CreateAccountContactVariables { - id: UUIDString; - accountId: UUIDString; - name: string; - email?: string | null; - phoneNumber?: string | null; - role?: string | null; -} - -export interface CreateAccountData { - account_insert: Account_Key; -} - -export interface CreateAccountVariables { - id: UUIDString; - ownerId: string; - companyName: string; - businessNumber?: string | null; - phoneNumber?: string | null; -} - -export interface DeleteAccountContactData { - accountContact_delete?: AccountContact_Key | null; -} - -export interface DeleteAccountContactVariables { - id: UUIDString; -} - -export interface DeleteAccountContactsData { - accountContact_deleteMany: number; -} - -export interface DeleteAccountContactsVariables { - accountId: UUIDString; -} - -export interface DeleteAccountData { - account_delete?: Account_Key | null; -} - -export interface DeleteAccountVariables { - id: UUIDString; -} - -export interface FloorplanPage_Key { - id: UUIDString; - __typename?: 'FloorplanPage_Key'; -} - -export interface GetAccountByIdData { - account?: { - id: UUIDString; - ownerId: string; - companyName: string; - businessNumber?: string | null; - phoneNumber?: string | null; - primaryContactId?: UUIDString | null; - createdAt: TimestampString; - updatedAt: TimestampString; - contacts: ({ - id: UUIDString; - accountId: UUIDString; - name: string; - email?: string | null; - phoneNumber?: string | null; - role?: string | null; - createdAt: TimestampString; - updatedAt: TimestampString; - } & AccountContact_Key)[]; - } & Account_Key; -} - -export interface GetAccountByIdVariables { - id: UUIDString; -} - -export interface GetAccountContactByIdData { - accountContact?: { - id: UUIDString; - accountId: UUIDString; - name: string; - email?: string | null; - phoneNumber?: string | null; - role?: string | null; - createdAt: TimestampString; - updatedAt: TimestampString; - } & AccountContact_Key; -} - -export interface GetAccountContactByIdVariables { - accountId: UUIDString; - contactId: UUIDString; -} - -export interface ListAccountContactsByAccountIdData { - accountContacts: ({ - id: UUIDString; - accountId: UUIDString; - name: string; - email?: string | null; - phoneNumber?: string | null; - role?: string | null; - createdAt: TimestampString; - updatedAt: TimestampString; - } & AccountContact_Key)[]; -} - -export interface ListAccountContactsByAccountIdVariables { - accountId: UUIDString; -} - -export interface ListAccountsByOwnerData { - accounts: ({ - id: UUIDString; - ownerId: string; - companyName: string; - businessNumber?: string | null; - phoneNumber?: string | null; - primaryContactId?: UUIDString | null; - createdAt: TimestampString; - updatedAt: TimestampString; - } & Account_Key)[]; -} - -export interface ListAccountsByOwnerVariables { - ownerId: string; -} - -export interface ProjectQuestionnaireAnswer_Key { - id: UUIDString; - __typename?: 'ProjectQuestionnaireAnswer_Key'; -} - -export interface ProjectQuestionnaire_Key { - id: UUIDString; - __typename?: 'ProjectQuestionnaire_Key'; -} - -export interface Project_Key { - id: UUIDString; - __typename?: 'Project_Key'; -} - -export interface QuantitySource_Key { - id: UUIDString; - __typename?: 'QuantitySource_Key'; -} - -export interface QuestionnaireTemplateQuestion_Key { - id: UUIDString; - __typename?: 'QuestionnaireTemplateQuestion_Key'; -} - -export interface QuestionnaireTemplate_Key { - id: UUIDString; - __typename?: 'QuestionnaireTemplate_Key'; -} - -export interface QuoteItemTemplateConfig_Key { - ownerId: string; - templateId: UUIDString; - __typename?: 'QuoteItemTemplateConfig_Key'; -} - -export interface QuoteItemTemplate_Key { - id: UUIDString; - __typename?: 'QuoteItemTemplate_Key'; -} - -export interface QuoteItem_Key { - id: UUIDString; - __typename?: 'QuoteItem_Key'; -} - -export interface Quote_Key { - id: UUIDString; - __typename?: 'Quote_Key'; -} - -export interface Reminder_Key { - id: UUIDString; - __typename?: 'Reminder_Key'; -} - -export interface SupplierQuoteItemPrice_Key { - supplierId: UUIDString; - templateId: UUIDString; - __typename?: 'SupplierQuoteItemPrice_Key'; -} - -export interface Supplier_Key { - id: UUIDString; - __typename?: 'Supplier_Key'; -} - -export interface UpdateAccountContactData { - accountContact_update?: AccountContact_Key | null; -} - -export interface UpdateAccountContactVariables { - id: UUIDString; - name?: string | null; - email?: string | null; - phoneNumber?: string | null; - role?: string | null; -} - -export interface UpdateAccountData { - account_update?: Account_Key | null; -} - -export interface UpdateAccountVariables { - id: UUIDString; - companyName?: string | null; - businessNumber?: string | null; - phoneNumber?: string | null; - primaryContactId?: UUIDString | null; -} - -export interface UserSettings_Key { - ownerId: string; - __typename?: 'UserSettings_Key'; -} - -/** Generated Node Admin SDK operation action function for the 'CreateAccount' Mutation. Allow users to execute without passing in DataConnect. */ -export function createAccount(dc: DataConnect, vars: CreateAccountVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'CreateAccount' Mutation. Allow users to pass in custom DataConnect instances. */ -export function createAccount(vars: CreateAccountVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'UpdateAccount' Mutation. Allow users to execute without passing in DataConnect. */ -export function updateAccount(dc: DataConnect, vars: UpdateAccountVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'UpdateAccount' Mutation. Allow users to pass in custom DataConnect instances. */ -export function updateAccount(vars: UpdateAccountVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'DeleteAccountContacts' Mutation. Allow users to execute without passing in DataConnect. */ -export function deleteAccountContacts(dc: DataConnect, vars: DeleteAccountContactsVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'DeleteAccountContacts' Mutation. Allow users to pass in custom DataConnect instances. */ -export function deleteAccountContacts(vars: DeleteAccountContactsVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'DeleteAccount' Mutation. Allow users to execute without passing in DataConnect. */ -export function deleteAccount(dc: DataConnect, vars: DeleteAccountVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'DeleteAccount' Mutation. Allow users to pass in custom DataConnect instances. */ -export function deleteAccount(vars: DeleteAccountVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'CreateAccountContact' Mutation. Allow users to execute without passing in DataConnect. */ -export function createAccountContact(dc: DataConnect, vars: CreateAccountContactVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'CreateAccountContact' Mutation. Allow users to pass in custom DataConnect instances. */ -export function createAccountContact(vars: CreateAccountContactVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'UpdateAccountContact' Mutation. Allow users to execute without passing in DataConnect. */ -export function updateAccountContact(dc: DataConnect, vars: UpdateAccountContactVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'UpdateAccountContact' Mutation. Allow users to pass in custom DataConnect instances. */ -export function updateAccountContact(vars: UpdateAccountContactVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'DeleteAccountContact' Mutation. Allow users to execute without passing in DataConnect. */ -export function deleteAccountContact(dc: DataConnect, vars: DeleteAccountContactVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'DeleteAccountContact' Mutation. Allow users to pass in custom DataConnect instances. */ -export function deleteAccountContact(vars: DeleteAccountContactVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'ListAccountsByOwner' Query. Allow users to execute without passing in DataConnect. */ -export function listAccountsByOwner(dc: DataConnect, vars: ListAccountsByOwnerVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'ListAccountsByOwner' Query. Allow users to pass in custom DataConnect instances. */ -export function listAccountsByOwner(vars: ListAccountsByOwnerVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'GetAccountById' Query. Allow users to execute without passing in DataConnect. */ -export function getAccountById(dc: DataConnect, vars: GetAccountByIdVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'GetAccountById' Query. Allow users to pass in custom DataConnect instances. */ -export function getAccountById(vars: GetAccountByIdVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'ListAccountContactsByAccountId' Query. Allow users to execute without passing in DataConnect. */ -export function listAccountContactsByAccountId(dc: DataConnect, vars: ListAccountContactsByAccountIdVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'ListAccountContactsByAccountId' Query. Allow users to pass in custom DataConnect instances. */ -export function listAccountContactsByAccountId(vars: ListAccountContactsByAccountIdVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'GetAccountContactById' Query. Allow users to execute without passing in DataConnect. */ -export function getAccountContactById(dc: DataConnect, vars: GetAccountContactByIdVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'GetAccountContactById' Query. Allow users to pass in custom DataConnect instances. */ -export function getAccountContactById(vars: GetAccountContactByIdVariables, options?: OperationOptions): Promise>; - diff --git a/generated/accounts-data-connector-admin/package.json b/generated/accounts-data-connector-admin/package.json deleted file mode 100644 index 48ad3a1..0000000 --- a/generated/accounts-data-connector-admin/package.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "name": "@generated/accounts-data-connector-admin", - "version": "0.0.1", - "author": "Firebase (https://firebase.google.com/)", - "description": "Generated Admin SDK For accounts", - "license": "Apache-2.0", - "engines": { - "node": " >=18.0" - }, - "typings": "index.d.ts", - "module": "esm/index.esm.js", - "main": "index.cjs.js", - "browser": "esm/index.esm.js", - "exports": { - ".": { - "types": "./index.d.ts", - "require": "./index.cjs.js", - "default": "./esm/index.esm.js" - }, - "./package.json": "./package.json" - }, - "peerDependencies": { - "firebase-admin": "^13.4.0" - } -} \ No newline at end of file diff --git a/generated/example-data-connector/esm/index.esm.js b/generated/data-connector-admin/esm/index.esm.js similarity index 63% rename from generated/example-data-connector/esm/index.esm.js rename to generated/data-connector-admin/esm/index.esm.js index 0ed6f5b..de03116 100644 --- a/generated/example-data-connector/esm/index.esm.js +++ b/generated/data-connector-admin/esm/index.esm.js @@ -1,11 +1,77 @@ import { validateAdminArgs } from 'firebase-admin/data-connect'; export const connectorConfig = { - connector: 'example', + connector: 'data-connector', serviceId: 'plaster-calculator', location: 'us-west1' }; +export function createAccount(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateAccount', inputVars, inputOpts); +} + +export function updateAccount(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpdateAccount', inputVars, inputOpts); +} + +export function deleteAccountContacts(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteAccountContacts', inputVars, inputOpts); +} + +export function deleteAccount(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteAccount', inputVars, inputOpts); +} + +export function createAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateAccountContact', inputVars, inputOpts); +} + +export function updateAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpdateAccountContact', inputVars, inputOpts); +} + +export function deleteAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteAccountContact', inputVars, inputOpts); +} + +export function listAccountsByOwner(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('ListAccountsByOwner', inputVars, inputOpts); +} + +export function getAccountById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetAccountById', inputVars, inputOpts); +} + +export function listAccountContactsByAccountId(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('ListAccountContactsByAccountId', inputVars, inputOpts); +} + +export function getAccountContactById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetAccountContactById', inputVars, inputOpts); +} + export function createProjectFromUpload(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); @@ -42,46 +108,118 @@ export function deleteProject(dcOrVarsOrOptions, varsOrOptions, options) { return dcInstance.executeMutation('DeleteProject', inputVars, inputOpts); } -export function upsertUserSettings(dcOrVarsOrOptions, varsOrOptions, options) { +export function createFloorplanPage(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeMutation('UpsertUserSettings', inputVars, inputOpts); + return dcInstance.executeMutation('CreateFloorplanPage', inputVars, inputOpts); } -export function createReminder(dcOrVarsOrOptions, varsOrOptions, options) { +export function updateFloorplanPageAnalysis(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeMutation('CreateReminder', inputVars, inputOpts); + return dcInstance.executeMutation('UpdateFloorplanPageAnalysis', inputVars, inputOpts); } -export function updateReminder(dcOrVarsOrOptions, varsOrOptions, options) { +export function updateFloorplanPage(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateReminder', inputVars, inputOpts); + return dcInstance.executeMutation('UpdateFloorplanPage', inputVars, inputOpts); } -export function createFloorplanPage(dcOrVarsOrOptions, varsOrOptions, options) { +export function updateFloorplanPages(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeMutation('CreateFloorplanPage', inputVars, inputOpts); + return dcInstance.executeMutation('UpdateFloorplanPages', inputVars, inputOpts); } -export function updateFloorplanPageAnalysis(dcOrVarsOrOptions, varsOrOptions, options) { +export function listProjectsByOwnerAndSalesStatus(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateFloorplanPageAnalysis', inputVars, inputOpts); + return dcInstance.executeQuery('ListProjectsByOwnerAndSalesStatus', inputVars, inputOpts); } -export function updateFloorplanPage(dcOrVarsOrOptions, varsOrOptions, options) { +export function listProjectsByAccount(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateFloorplanPage', inputVars, inputOpts); + return dcInstance.executeQuery('ListProjectsByAccount', inputVars, inputOpts); } -export function updateFloorplanPages(dcOrVarsOrOptions, varsOrOptions, options) { +export function getProjectDetailsById(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateFloorplanPages', inputVars, inputOpts); + return dcInstance.executeQuery('GetProjectDetailsById', inputVars, inputOpts); +} + +export function getProjectById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetProjectById', inputVars, inputOpts); +} + +export function getFloorplanPageById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetFloorplanPageById', inputVars, inputOpts); +} + +export function createQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateQuestionnaireTemplate', inputVars, inputOpts); +} + +export function createQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateQuestionnaireTemplateQuestion', inputVars, inputOpts); +} + +export function updateQuestionnaireTemplateName(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpdateQuestionnaireTemplateName', inputVars, inputOpts); +} + +export function updateQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpdateQuestionnaireTemplateQuestion', inputVars, inputOpts); +} + +export function deleteQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteQuestionnaireTemplateQuestion', inputVars, inputOpts); +} + +export function deleteQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteQuestionnaireTemplate', inputVars, inputOpts); +} + +export function createProjectQuestionnaire(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateProjectQuestionnaire', inputVars, inputOpts); +} + +export function createProjectQuestionnaireAnswer(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateProjectQuestionnaireAnswer', inputVars, inputOpts); +} + +export function listQuestionnaireTemplates(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrOptions, options, undefined); + dcInstance.useGen(true); + return dcInstance.executeQuery('ListQuestionnaireTemplates', undefined, inputOpts); +} + +export function getQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetQuestionnaireTemplate', inputVars, inputOpts); } export function createQuantitySource(dcOrVarsOrOptions, varsOrOptions, options) { @@ -174,57 +312,45 @@ export function updateQuoteItem(dcOrVarsOrOptions, varsOrOptions, options) { return dcInstance.executeMutation('UpdateQuoteItem', inputVars, inputOpts); } -export function listProjectsByOwnerAndSalesStatus(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListProjectsByOwnerAndSalesStatus', inputVars, inputOpts); -} - -export function listProjectsByAccount(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListProjectsByAccount', inputVars, inputOpts); -} - -export function getProjectDetailsById(dcOrVarsOrOptions, varsOrOptions, options) { +export function createReminder(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('GetProjectDetailsById', inputVars, inputOpts); + return dcInstance.executeMutation('CreateReminder', inputVars, inputOpts); } -export function getProjectById(dcOrVarsOrOptions, varsOrOptions, options) { +export function updateReminder(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('GetProjectById', inputVars, inputOpts); + return dcInstance.executeMutation('UpdateReminder', inputVars, inputOpts); } -export function getFloorplanPageById(dcOrVarsOrOptions, varsOrOptions, options) { +export function listDueReminders(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('GetFloorplanPageById', inputVars, inputOpts); + return dcInstance.executeQuery('ListDueReminders', inputVars, inputOpts); } -export function getUserSettings(dcOrVarsOrOptions, varsOrOptions, options) { +export function listProjectReminders(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('GetUserSettings', inputVars, inputOpts); + return dcInstance.executeQuery('ListProjectReminders', inputVars, inputOpts); } -export function listDueReminders(dcOrVarsOrOptions, varsOrOptions, options) { +export function getReminderById(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('ListDueReminders', inputVars, inputOpts); + return dcInstance.executeQuery('GetReminderById', inputVars, inputOpts); } -export function listProjectReminders(dcOrVarsOrOptions, varsOrOptions, options) { +export function upsertUserSettings(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('ListProjectReminders', inputVars, inputOpts); + return dcInstance.executeMutation('UpsertUserSettings', inputVars, inputOpts); } -export function getReminderById(dcOrVarsOrOptions, varsOrOptions, options) { +export function getUserSettings(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('GetReminderById', inputVars, inputOpts); + return dcInstance.executeQuery('GetUserSettings', inputVars, inputOpts); } diff --git a/generated/accounts-data-connector-admin/esm/package.json b/generated/data-connector-admin/esm/package.json similarity index 100% rename from generated/accounts-data-connector-admin/esm/package.json rename to generated/data-connector-admin/esm/package.json diff --git a/generated/example-data-connector/index.cjs.js b/generated/data-connector-admin/index.cjs.js similarity index 62% rename from generated/example-data-connector/index.cjs.js rename to generated/data-connector-admin/index.cjs.js index 272c294..4f2af37 100644 --- a/generated/example-data-connector/index.cjs.js +++ b/generated/data-connector-admin/index.cjs.js @@ -1,12 +1,89 @@ const { validateAdminArgs } = require('firebase-admin/data-connect'); const connectorConfig = { - connector: 'example', + connector: 'data-connector', serviceId: 'plaster-calculator', location: 'us-west1' }; exports.connectorConfig = connectorConfig; +function createAccount(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateAccount', inputVars, inputOpts); +} +exports.createAccount = createAccount; + +function updateAccount(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpdateAccount', inputVars, inputOpts); +} +exports.updateAccount = updateAccount; + +function deleteAccountContacts(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteAccountContacts', inputVars, inputOpts); +} +exports.deleteAccountContacts = deleteAccountContacts; + +function deleteAccount(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteAccount', inputVars, inputOpts); +} +exports.deleteAccount = deleteAccount; + +function createAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateAccountContact', inputVars, inputOpts); +} +exports.createAccountContact = createAccountContact; + +function updateAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpdateAccountContact', inputVars, inputOpts); +} +exports.updateAccountContact = updateAccountContact; + +function deleteAccountContact(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteAccountContact', inputVars, inputOpts); +} +exports.deleteAccountContact = deleteAccountContact; + +function listAccountsByOwner(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('ListAccountsByOwner', inputVars, inputOpts); +} +exports.listAccountsByOwner = listAccountsByOwner; + +function getAccountById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetAccountById', inputVars, inputOpts); +} +exports.getAccountById = getAccountById; + +function listAccountContactsByAccountId(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('ListAccountContactsByAccountId', inputVars, inputOpts); +} +exports.listAccountContactsByAccountId = listAccountContactsByAccountId; + +function getAccountContactById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetAccountContactById', inputVars, inputOpts); +} +exports.getAccountContactById = getAccountContactById; + function createProjectFromUpload(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); @@ -49,27 +126,6 @@ function deleteProject(dcOrVarsOrOptions, varsOrOptions, options) { } exports.deleteProject = deleteProject; -function upsertUserSettings(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpsertUserSettings', inputVars, inputOpts); -} -exports.upsertUserSettings = upsertUserSettings; - -function createReminder(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateReminder', inputVars, inputOpts); -} -exports.createReminder = createReminder; - -function updateReminder(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateReminder', inputVars, inputOpts); -} -exports.updateReminder = updateReminder; - function createFloorplanPage(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); @@ -98,6 +154,111 @@ function updateFloorplanPages(dcOrVarsOrOptions, varsOrOptions, options) { } exports.updateFloorplanPages = updateFloorplanPages; +function listProjectsByOwnerAndSalesStatus(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('ListProjectsByOwnerAndSalesStatus', inputVars, inputOpts); +} +exports.listProjectsByOwnerAndSalesStatus = listProjectsByOwnerAndSalesStatus; + +function listProjectsByAccount(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('ListProjectsByAccount', inputVars, inputOpts); +} +exports.listProjectsByAccount = listProjectsByAccount; + +function getProjectDetailsById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetProjectDetailsById', inputVars, inputOpts); +} +exports.getProjectDetailsById = getProjectDetailsById; + +function getProjectById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetProjectById', inputVars, inputOpts); +} +exports.getProjectById = getProjectById; + +function getFloorplanPageById(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetFloorplanPageById', inputVars, inputOpts); +} +exports.getFloorplanPageById = getFloorplanPageById; + +function createQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateQuestionnaireTemplate', inputVars, inputOpts); +} +exports.createQuestionnaireTemplate = createQuestionnaireTemplate; + +function createQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateQuestionnaireTemplateQuestion', inputVars, inputOpts); +} +exports.createQuestionnaireTemplateQuestion = createQuestionnaireTemplateQuestion; + +function updateQuestionnaireTemplateName(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpdateQuestionnaireTemplateName', inputVars, inputOpts); +} +exports.updateQuestionnaireTemplateName = updateQuestionnaireTemplateName; + +function updateQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpdateQuestionnaireTemplateQuestion', inputVars, inputOpts); +} +exports.updateQuestionnaireTemplateQuestion = updateQuestionnaireTemplateQuestion; + +function deleteQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteQuestionnaireTemplateQuestion', inputVars, inputOpts); +} +exports.deleteQuestionnaireTemplateQuestion = deleteQuestionnaireTemplateQuestion; + +function deleteQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('DeleteQuestionnaireTemplate', inputVars, inputOpts); +} +exports.deleteQuestionnaireTemplate = deleteQuestionnaireTemplate; + +function createProjectQuestionnaire(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateProjectQuestionnaire', inputVars, inputOpts); +} +exports.createProjectQuestionnaire = createProjectQuestionnaire; + +function createProjectQuestionnaireAnswer(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('CreateProjectQuestionnaireAnswer', inputVars, inputOpts); +} +exports.createProjectQuestionnaireAnswer = createProjectQuestionnaireAnswer; + +function listQuestionnaireTemplates(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrOptions, options, undefined); + dcInstance.useGen(true); + return dcInstance.executeQuery('ListQuestionnaireTemplates', undefined, inputOpts); +} +exports.listQuestionnaireTemplates = listQuestionnaireTemplates; + +function getQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetQuestionnaireTemplate', inputVars, inputOpts); +} +exports.getQuestionnaireTemplate = getQuestionnaireTemplate; + function createQuantitySource(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); @@ -203,47 +364,19 @@ function updateQuoteItem(dcOrVarsOrOptions, varsOrOptions, options) { } exports.updateQuoteItem = updateQuoteItem; -function listProjectsByOwnerAndSalesStatus(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListProjectsByOwnerAndSalesStatus', inputVars, inputOpts); -} -exports.listProjectsByOwnerAndSalesStatus = listProjectsByOwnerAndSalesStatus; - -function listProjectsByAccount(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListProjectsByAccount', inputVars, inputOpts); -} -exports.listProjectsByAccount = listProjectsByAccount; - -function getProjectDetailsById(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('GetProjectDetailsById', inputVars, inputOpts); -} -exports.getProjectDetailsById = getProjectDetailsById; - -function getProjectById(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('GetProjectById', inputVars, inputOpts); -} -exports.getProjectById = getProjectById; - -function getFloorplanPageById(dcOrVarsOrOptions, varsOrOptions, options) { +function createReminder(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('GetFloorplanPageById', inputVars, inputOpts); + return dcInstance.executeMutation('CreateReminder', inputVars, inputOpts); } -exports.getFloorplanPageById = getFloorplanPageById; +exports.createReminder = createReminder; -function getUserSettings(dcOrVarsOrOptions, varsOrOptions, options) { +function updateReminder(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); dcInstance.useGen(true); - return dcInstance.executeQuery('GetUserSettings', inputVars, inputOpts); + return dcInstance.executeMutation('UpdateReminder', inputVars, inputOpts); } -exports.getUserSettings = getUserSettings; +exports.updateReminder = updateReminder; function listDueReminders(dcOrVarsOrOptions, varsOrOptions, options) { const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); @@ -266,3 +399,17 @@ function getReminderById(dcOrVarsOrOptions, varsOrOptions, options) { } exports.getReminderById = getReminderById; +function upsertUserSettings(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeMutation('UpsertUserSettings', inputVars, inputOpts); +} +exports.upsertUserSettings = upsertUserSettings; + +function getUserSettings(dcOrVarsOrOptions, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); + dcInstance.useGen(true); + return dcInstance.executeQuery('GetUserSettings', inputVars, inputOpts); +} +exports.getUserSettings = getUserSettings; + diff --git a/generated/example-data-connector/index.d.ts b/generated/data-connector-admin/index.d.ts similarity index 65% rename from generated/example-data-connector/index.d.ts rename to generated/data-connector-admin/index.d.ts index 0761fcb..acce232 100644 --- a/generated/example-data-connector/index.d.ts +++ b/generated/data-connector-admin/index.d.ts @@ -18,6 +18,31 @@ export interface Account_Key { __typename?: 'Account_Key'; } +export interface CreateAccountContactData { + accountContact_insert: AccountContact_Key; +} + +export interface CreateAccountContactVariables { + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; +} + +export interface CreateAccountData { + account_insert: Account_Key; +} + +export interface CreateAccountVariables { + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; +} + export interface CreateFloorplanPageData { floorplanPage_insert: FloorplanPage_Key; } @@ -58,6 +83,28 @@ export interface CreateProjectFromUploadVariables { pageCount: number; } +export interface CreateProjectQuestionnaireAnswerData { + projectQuestionnaireAnswer_insert: ProjectQuestionnaireAnswer_Key; +} + +export interface CreateProjectQuestionnaireAnswerVariables { + id: UUIDString; + projectQuestionnaireId: UUIDString; + questionId: UUIDString; + position: number; + answer?: string | null; +} + +export interface CreateProjectQuestionnaireData { + projectQuestionnaire_insert: ProjectQuestionnaire_Key; +} + +export interface CreateProjectQuestionnaireVariables { + id: UUIDString; + projectId: UUIDString; + sourceTemplateId?: UUIDString | null; +} + export interface CreateQuantitySourceData { quantitySource_insert: QuantitySource_Key; } @@ -68,6 +115,27 @@ export interface CreateQuantitySourceVariables { measurementPlasterType?: string | null; } +export interface CreateQuestionnaireTemplateData { + questionnaireTemplate_insert: QuestionnaireTemplate_Key; +} + +export interface CreateQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_insert: QuestionnaireTemplateQuestion_Key; +} + +export interface CreateQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; + label: string; + position: number; + description?: string | null; +} + +export interface CreateQuestionnaireTemplateVariables { + id: UUIDString; + name: string; +} + export interface CreateQuoteData { quote_insert: Quote_Key; } @@ -139,6 +207,30 @@ export interface CreateSupplierVariables { name: string; } +export interface DeleteAccountContactData { + accountContact_delete?: AccountContact_Key | null; +} + +export interface DeleteAccountContactVariables { + id: UUIDString; +} + +export interface DeleteAccountContactsData { + accountContact_deleteMany: number; +} + +export interface DeleteAccountContactsVariables { + accountId: UUIDString; +} + +export interface DeleteAccountData { + account_delete?: Account_Key | null; +} + +export interface DeleteAccountVariables { + id: UUIDString; +} + export interface DeleteFloorplanPagesData { floorplanPage_deleteMany: number; } @@ -155,6 +247,24 @@ export interface DeleteProjectVariables { id: UUIDString; } +export interface DeleteQuestionnaireTemplateData { + questionnaireTemplateQuestion_deleteMany: number; + questionnaireTemplate_delete?: QuestionnaireTemplate_Key | null; +} + +export interface DeleteQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_delete?: QuestionnaireTemplateQuestion_Key | null; +} + +export interface DeleteQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; +} + +export interface DeleteQuestionnaireTemplateVariables { + id: UUIDString; +} + export interface DeleteQuoteItemTemplateData { quoteItemTemplate_delete?: QuoteItemTemplate_Key | null; } @@ -193,6 +303,51 @@ export interface FloorplanPage_Key { __typename?: 'FloorplanPage_Key'; } +export interface GetAccountByIdData { + account?: { + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + contacts: ({ + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key)[]; + } & Account_Key; +} + +export interface GetAccountByIdVariables { + id: UUIDString; +} + +export interface GetAccountContactByIdData { + accountContact?: { + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key; +} + +export interface GetAccountContactByIdVariables { + accountId: UUIDString; + contactId: UUIDString; +} + export interface GetFloorplanPageByIdData { floorplanPage?: { id: UUIDString; @@ -287,6 +442,26 @@ export interface GetProjectDetailsByIdVariables { id: UUIDString; } +export interface GetQuestionnaireTemplateData { + questionnaireTemplate?: { + id: UUIDString; + ownerId: string; + name: string; + createdAt: TimestampString; + updatedAt: TimestampString; + questions: ({ + id: UUIDString; + label: string; + description?: string | null; + position: number; + } & QuestionnaireTemplateQuestion_Key)[]; + } & QuestionnaireTemplate_Key; +} + +export interface GetQuestionnaireTemplateVariables { + id: UUIDString; +} + export interface GetReminderByIdData { reminder?: { id: UUIDString; @@ -320,6 +495,40 @@ export interface GetUserSettingsVariables { ownerId: string; } +export interface ListAccountContactsByAccountIdData { + accountContacts: ({ + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key)[]; +} + +export interface ListAccountContactsByAccountIdVariables { + accountId: UUIDString; +} + +export interface ListAccountsByOwnerData { + accounts: ({ + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Account_Key)[]; +} + +export interface ListAccountsByOwnerVariables { + ownerId: string; +} + export interface ListDueRemindersData { reminders: ({ id: UUIDString; @@ -405,6 +614,15 @@ export interface ListProjectsByOwnerAndSalesStatusVariables { salesStatus: string; } +export interface ListQuestionnaireTemplatesData { + questionnaireTemplates: ({ + id: UUIDString; + name: string; + createdAt: TimestampString; + updatedAt: TimestampString; + } & QuestionnaireTemplate_Key)[]; +} + export interface ProjectQuestionnaireAnswer_Key { id: UUIDString; __typename?: 'ProjectQuestionnaireAnswer_Key'; @@ -491,6 +709,30 @@ export interface TouchProjectVariables { processingError?: string | null; } +export interface UpdateAccountContactData { + accountContact_update?: AccountContact_Key | null; +} + +export interface UpdateAccountContactVariables { + id: UUIDString; + name?: string | null; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; +} + +export interface UpdateAccountData { + account_update?: Account_Key | null; +} + +export interface UpdateAccountVariables { + id: UUIDString; + companyName?: string | null; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; +} + export interface UpdateFloorplanPageAnalysisData { floorplanPage_update?: FloorplanPage_Key | null; } @@ -547,6 +789,27 @@ export interface UpdateProjectVariables { salesStatus?: string | null; } +export interface UpdateQuestionnaireTemplateNameData { + questionnaireTemplate_update?: QuestionnaireTemplate_Key | null; +} + +export interface UpdateQuestionnaireTemplateNameVariables { + id: UUIDString; + name: string; +} + +export interface UpdateQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_update?: QuestionnaireTemplateQuestion_Key | null; +} + +export interface UpdateQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; + label: string; + position: number; + description?: string | null; +} + export interface UpdateQuoteData { quote_update?: Quote_Key | null; } @@ -647,6 +910,61 @@ export interface UserSettings_Key { __typename?: 'UserSettings_Key'; } +/** Generated Node Admin SDK operation action function for the 'CreateAccount' Mutation. Allow users to execute without passing in DataConnect. */ +export function createAccount(dc: DataConnect, vars: CreateAccountVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'CreateAccount' Mutation. Allow users to pass in custom DataConnect instances. */ +export function createAccount(vars: CreateAccountVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'UpdateAccount' Mutation. Allow users to execute without passing in DataConnect. */ +export function updateAccount(dc: DataConnect, vars: UpdateAccountVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'UpdateAccount' Mutation. Allow users to pass in custom DataConnect instances. */ +export function updateAccount(vars: UpdateAccountVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'DeleteAccountContacts' Mutation. Allow users to execute without passing in DataConnect. */ +export function deleteAccountContacts(dc: DataConnect, vars: DeleteAccountContactsVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'DeleteAccountContacts' Mutation. Allow users to pass in custom DataConnect instances. */ +export function deleteAccountContacts(vars: DeleteAccountContactsVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'DeleteAccount' Mutation. Allow users to execute without passing in DataConnect. */ +export function deleteAccount(dc: DataConnect, vars: DeleteAccountVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'DeleteAccount' Mutation. Allow users to pass in custom DataConnect instances. */ +export function deleteAccount(vars: DeleteAccountVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'CreateAccountContact' Mutation. Allow users to execute without passing in DataConnect. */ +export function createAccountContact(dc: DataConnect, vars: CreateAccountContactVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'CreateAccountContact' Mutation. Allow users to pass in custom DataConnect instances. */ +export function createAccountContact(vars: CreateAccountContactVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'UpdateAccountContact' Mutation. Allow users to execute without passing in DataConnect. */ +export function updateAccountContact(dc: DataConnect, vars: UpdateAccountContactVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'UpdateAccountContact' Mutation. Allow users to pass in custom DataConnect instances. */ +export function updateAccountContact(vars: UpdateAccountContactVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'DeleteAccountContact' Mutation. Allow users to execute without passing in DataConnect. */ +export function deleteAccountContact(dc: DataConnect, vars: DeleteAccountContactVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'DeleteAccountContact' Mutation. Allow users to pass in custom DataConnect instances. */ +export function deleteAccountContact(vars: DeleteAccountContactVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'ListAccountsByOwner' Query. Allow users to execute without passing in DataConnect. */ +export function listAccountsByOwner(dc: DataConnect, vars: ListAccountsByOwnerVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'ListAccountsByOwner' Query. Allow users to pass in custom DataConnect instances. */ +export function listAccountsByOwner(vars: ListAccountsByOwnerVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'GetAccountById' Query. Allow users to execute without passing in DataConnect. */ +export function getAccountById(dc: DataConnect, vars: GetAccountByIdVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'GetAccountById' Query. Allow users to pass in custom DataConnect instances. */ +export function getAccountById(vars: GetAccountByIdVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'ListAccountContactsByAccountId' Query. Allow users to execute without passing in DataConnect. */ +export function listAccountContactsByAccountId(dc: DataConnect, vars: ListAccountContactsByAccountIdVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'ListAccountContactsByAccountId' Query. Allow users to pass in custom DataConnect instances. */ +export function listAccountContactsByAccountId(vars: ListAccountContactsByAccountIdVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'GetAccountContactById' Query. Allow users to execute without passing in DataConnect. */ +export function getAccountContactById(dc: DataConnect, vars: GetAccountContactByIdVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'GetAccountContactById' Query. Allow users to pass in custom DataConnect instances. */ +export function getAccountContactById(vars: GetAccountContactByIdVariables, options?: OperationOptions): Promise>; + /** Generated Node Admin SDK operation action function for the 'CreateProjectFromUpload' Mutation. Allow users to execute without passing in DataConnect. */ export function createProjectFromUpload(dc: DataConnect, vars: CreateProjectFromUploadVariables, options?: OperationOptions): Promise>; /** Generated Node Admin SDK operation action function for the 'CreateProjectFromUpload' Mutation. Allow users to pass in custom DataConnect instances. */ @@ -677,21 +995,6 @@ export function deleteProject(dc: DataConnect, vars: DeleteProjectVariables, opt /** Generated Node Admin SDK operation action function for the 'DeleteProject' Mutation. Allow users to pass in custom DataConnect instances. */ export function deleteProject(vars: DeleteProjectVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'UpsertUserSettings' Mutation. Allow users to execute without passing in DataConnect. */ -export function upsertUserSettings(dc: DataConnect, vars: UpsertUserSettingsVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'UpsertUserSettings' Mutation. Allow users to pass in custom DataConnect instances. */ -export function upsertUserSettings(vars: UpsertUserSettingsVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'CreateReminder' Mutation. Allow users to execute without passing in DataConnect. */ -export function createReminder(dc: DataConnect, vars: CreateReminderVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'CreateReminder' Mutation. Allow users to pass in custom DataConnect instances. */ -export function createReminder(vars: CreateReminderVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'UpdateReminder' Mutation. Allow users to execute without passing in DataConnect. */ -export function updateReminder(dc: DataConnect, vars: UpdateReminderVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'UpdateReminder' Mutation. Allow users to pass in custom DataConnect instances. */ -export function updateReminder(vars: UpdateReminderVariables, options?: OperationOptions): Promise>; - /** Generated Node Admin SDK operation action function for the 'CreateFloorplanPage' Mutation. Allow users to execute without passing in DataConnect. */ export function createFloorplanPage(dc: DataConnect, vars: CreateFloorplanPageVariables, options?: OperationOptions): Promise>; /** Generated Node Admin SDK operation action function for the 'CreateFloorplanPage' Mutation. Allow users to pass in custom DataConnect instances. */ @@ -712,6 +1015,81 @@ export function updateFloorplanPages(dc: DataConnect, vars: UpdateFloorplanPages /** Generated Node Admin SDK operation action function for the 'UpdateFloorplanPages' Mutation. Allow users to pass in custom DataConnect instances. */ export function updateFloorplanPages(vars: UpdateFloorplanPagesVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'ListProjectsByOwnerAndSalesStatus' Query. Allow users to execute without passing in DataConnect. */ +export function listProjectsByOwnerAndSalesStatus(dc: DataConnect, vars: ListProjectsByOwnerAndSalesStatusVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'ListProjectsByOwnerAndSalesStatus' Query. Allow users to pass in custom DataConnect instances. */ +export function listProjectsByOwnerAndSalesStatus(vars: ListProjectsByOwnerAndSalesStatusVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'ListProjectsByAccount' Query. Allow users to execute without passing in DataConnect. */ +export function listProjectsByAccount(dc: DataConnect, vars: ListProjectsByAccountVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'ListProjectsByAccount' Query. Allow users to pass in custom DataConnect instances. */ +export function listProjectsByAccount(vars: ListProjectsByAccountVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'GetProjectDetailsById' Query. Allow users to execute without passing in DataConnect. */ +export function getProjectDetailsById(dc: DataConnect, vars: GetProjectDetailsByIdVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'GetProjectDetailsById' Query. Allow users to pass in custom DataConnect instances. */ +export function getProjectDetailsById(vars: GetProjectDetailsByIdVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'GetProjectById' Query. Allow users to execute without passing in DataConnect. */ +export function getProjectById(dc: DataConnect, vars: GetProjectByIdVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'GetProjectById' Query. Allow users to pass in custom DataConnect instances. */ +export function getProjectById(vars: GetProjectByIdVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'GetFloorplanPageById' Query. Allow users to execute without passing in DataConnect. */ +export function getFloorplanPageById(dc: DataConnect, vars: GetFloorplanPageByIdVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'GetFloorplanPageById' Query. Allow users to pass in custom DataConnect instances. */ +export function getFloorplanPageById(vars: GetFloorplanPageByIdVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'CreateQuestionnaireTemplate' Mutation. Allow users to execute without passing in DataConnect. */ +export function createQuestionnaireTemplate(dc: DataConnect, vars: CreateQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'CreateQuestionnaireTemplate' Mutation. Allow users to pass in custom DataConnect instances. */ +export function createQuestionnaireTemplate(vars: CreateQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'CreateQuestionnaireTemplateQuestion' Mutation. Allow users to execute without passing in DataConnect. */ +export function createQuestionnaireTemplateQuestion(dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'CreateQuestionnaireTemplateQuestion' Mutation. Allow users to pass in custom DataConnect instances. */ +export function createQuestionnaireTemplateQuestion(vars: CreateQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'UpdateQuestionnaireTemplateName' Mutation. Allow users to execute without passing in DataConnect. */ +export function updateQuestionnaireTemplateName(dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'UpdateQuestionnaireTemplateName' Mutation. Allow users to pass in custom DataConnect instances. */ +export function updateQuestionnaireTemplateName(vars: UpdateQuestionnaireTemplateNameVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'UpdateQuestionnaireTemplateQuestion' Mutation. Allow users to execute without passing in DataConnect. */ +export function updateQuestionnaireTemplateQuestion(dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'UpdateQuestionnaireTemplateQuestion' Mutation. Allow users to pass in custom DataConnect instances. */ +export function updateQuestionnaireTemplateQuestion(vars: UpdateQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'DeleteQuestionnaireTemplateQuestion' Mutation. Allow users to execute without passing in DataConnect. */ +export function deleteQuestionnaireTemplateQuestion(dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'DeleteQuestionnaireTemplateQuestion' Mutation. Allow users to pass in custom DataConnect instances. */ +export function deleteQuestionnaireTemplateQuestion(vars: DeleteQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'DeleteQuestionnaireTemplate' Mutation. Allow users to execute without passing in DataConnect. */ +export function deleteQuestionnaireTemplate(dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'DeleteQuestionnaireTemplate' Mutation. Allow users to pass in custom DataConnect instances. */ +export function deleteQuestionnaireTemplate(vars: DeleteQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'CreateProjectQuestionnaire' Mutation. Allow users to execute without passing in DataConnect. */ +export function createProjectQuestionnaire(dc: DataConnect, vars: CreateProjectQuestionnaireVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'CreateProjectQuestionnaire' Mutation. Allow users to pass in custom DataConnect instances. */ +export function createProjectQuestionnaire(vars: CreateProjectQuestionnaireVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'CreateProjectQuestionnaireAnswer' Mutation. Allow users to execute without passing in DataConnect. */ +export function createProjectQuestionnaireAnswer(dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'CreateProjectQuestionnaireAnswer' Mutation. Allow users to pass in custom DataConnect instances. */ +export function createProjectQuestionnaireAnswer(vars: CreateProjectQuestionnaireAnswerVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'ListQuestionnaireTemplates' Query. Allow users to execute without passing in DataConnect. */ +export function listQuestionnaireTemplates(dc: DataConnect, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'ListQuestionnaireTemplates' Query. Allow users to pass in custom DataConnect instances. */ +export function listQuestionnaireTemplates(options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'GetQuestionnaireTemplate' Query. Allow users to execute without passing in DataConnect. */ +export function getQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'GetQuestionnaireTemplate' Query. Allow users to pass in custom DataConnect instances. */ +export function getQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; + /** Generated Node Admin SDK operation action function for the 'CreateQuantitySource' Mutation. Allow users to execute without passing in DataConnect. */ export function createQuantitySource(dc: DataConnect, vars: CreateQuantitySourceVariables, options?: OperationOptions): Promise>; /** Generated Node Admin SDK operation action function for the 'CreateQuantitySource' Mutation. Allow users to pass in custom DataConnect instances. */ @@ -787,35 +1165,15 @@ export function updateQuoteItem(dc: DataConnect, vars: UpdateQuoteItemVariables, /** Generated Node Admin SDK operation action function for the 'UpdateQuoteItem' Mutation. Allow users to pass in custom DataConnect instances. */ export function updateQuoteItem(vars: UpdateQuoteItemVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'ListProjectsByOwnerAndSalesStatus' Query. Allow users to execute without passing in DataConnect. */ -export function listProjectsByOwnerAndSalesStatus(dc: DataConnect, vars: ListProjectsByOwnerAndSalesStatusVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'ListProjectsByOwnerAndSalesStatus' Query. Allow users to pass in custom DataConnect instances. */ -export function listProjectsByOwnerAndSalesStatus(vars: ListProjectsByOwnerAndSalesStatusVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'ListProjectsByAccount' Query. Allow users to execute without passing in DataConnect. */ -export function listProjectsByAccount(dc: DataConnect, vars: ListProjectsByAccountVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'ListProjectsByAccount' Query. Allow users to pass in custom DataConnect instances. */ -export function listProjectsByAccount(vars: ListProjectsByAccountVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'GetProjectDetailsById' Query. Allow users to execute without passing in DataConnect. */ -export function getProjectDetailsById(dc: DataConnect, vars: GetProjectDetailsByIdVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'GetProjectDetailsById' Query. Allow users to pass in custom DataConnect instances. */ -export function getProjectDetailsById(vars: GetProjectDetailsByIdVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'GetProjectById' Query. Allow users to execute without passing in DataConnect. */ -export function getProjectById(dc: DataConnect, vars: GetProjectByIdVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'GetProjectById' Query. Allow users to pass in custom DataConnect instances. */ -export function getProjectById(vars: GetProjectByIdVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'GetFloorplanPageById' Query. Allow users to execute without passing in DataConnect. */ -export function getFloorplanPageById(dc: DataConnect, vars: GetFloorplanPageByIdVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'GetFloorplanPageById' Query. Allow users to pass in custom DataConnect instances. */ -export function getFloorplanPageById(vars: GetFloorplanPageByIdVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'CreateReminder' Mutation. Allow users to execute without passing in DataConnect. */ +export function createReminder(dc: DataConnect, vars: CreateReminderVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'CreateReminder' Mutation. Allow users to pass in custom DataConnect instances. */ +export function createReminder(vars: CreateReminderVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'GetUserSettings' Query. Allow users to execute without passing in DataConnect. */ -export function getUserSettings(dc: DataConnect, vars: GetUserSettingsVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'GetUserSettings' Query. Allow users to pass in custom DataConnect instances. */ -export function getUserSettings(vars: GetUserSettingsVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'UpdateReminder' Mutation. Allow users to execute without passing in DataConnect. */ +export function updateReminder(dc: DataConnect, vars: UpdateReminderVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'UpdateReminder' Mutation. Allow users to pass in custom DataConnect instances. */ +export function updateReminder(vars: UpdateReminderVariables, options?: OperationOptions): Promise>; /** Generated Node Admin SDK operation action function for the 'ListDueReminders' Query. Allow users to execute without passing in DataConnect. */ export function listDueReminders(dc: DataConnect, vars: ListDueRemindersVariables, options?: OperationOptions): Promise>; @@ -832,3 +1190,13 @@ export function getReminderById(dc: DataConnect, vars: GetReminderByIdVariables, /** Generated Node Admin SDK operation action function for the 'GetReminderById' Query. Allow users to pass in custom DataConnect instances. */ export function getReminderById(vars: GetReminderByIdVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'UpsertUserSettings' Mutation. Allow users to execute without passing in DataConnect. */ +export function upsertUserSettings(dc: DataConnect, vars: UpsertUserSettingsVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'UpsertUserSettings' Mutation. Allow users to pass in custom DataConnect instances. */ +export function upsertUserSettings(vars: UpsertUserSettingsVariables, options?: OperationOptions): Promise>; + +/** Generated Node Admin SDK operation action function for the 'GetUserSettings' Query. Allow users to execute without passing in DataConnect. */ +export function getUserSettings(dc: DataConnect, vars: GetUserSettingsVariables, options?: OperationOptions): Promise>; +/** Generated Node Admin SDK operation action function for the 'GetUserSettings' Query. Allow users to pass in custom DataConnect instances. */ +export function getUserSettings(vars: GetUserSettingsVariables, options?: OperationOptions): Promise>; + diff --git a/generated/example-data-connector/package.json b/generated/data-connector-admin/package.json similarity index 83% rename from generated/example-data-connector/package.json rename to generated/data-connector-admin/package.json index 800d520..664e1d7 100644 --- a/generated/example-data-connector/package.json +++ b/generated/data-connector-admin/package.json @@ -1,8 +1,8 @@ { - "name": "@generated/example-data-connector", + "name": "@generated/data-connector-admin", "version": "0.0.1", "author": "Firebase (https://firebase.google.com/)", - "description": "Generated Admin SDK For example", + "description": "Generated Admin SDK For data-connector", "license": "Apache-2.0", "engines": { "node": " >=18.0" diff --git a/generated/questionnaires-data-connector-web/.guides/config.json b/generated/data-connector-web/.guides/config.json similarity index 100% rename from generated/questionnaires-data-connector-web/.guides/config.json rename to generated/data-connector-web/.guides/config.json diff --git a/generated/questionnaires-data-connector-web/.guides/setup.md b/generated/data-connector-web/.guides/setup.md similarity index 96% rename from generated/questionnaires-data-connector-web/.guides/setup.md rename to generated/data-connector-web/.guides/setup.md index 46fdd35..be66636 100644 --- a/generated/questionnaires-data-connector-web/.guides/setup.md +++ b/generated/data-connector-web/.guides/setup.md @@ -13,7 +13,7 @@ initializeApp({ Then, you can run the SDK as needed. ```ts -import { ... } from '@generated/questionnaires-data-connector-web'; +import { ... } from '@generated/data-connector-web'; ``` diff --git a/generated/data-connector-web/.guides/usage.md b/generated/data-connector-web/.guides/usage.md new file mode 100644 index 0000000..5f6e93c --- /dev/null +++ b/generated/data-connector-web/.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 { useCreateAccount, useUpdateAccount, useDeleteAccountContacts, useDeleteAccount, useCreateAccountContact, useUpdateAccountContact, useDeleteAccountContact, useListAccountsByOwner, useGetAccountById, useListAccountContactsByAccountId } from '@generated/data-connector-web/react'; +// The types of these hooks are available in react/index.d.ts + +const { data, isPending, isSuccess, isError, error } = useCreateAccount(createAccountVars); + +const { data, isPending, isSuccess, isError, error } = useUpdateAccount(updateAccountVars); + +const { data, isPending, isSuccess, isError, error } = useDeleteAccountContacts(deleteAccountContactsVars); + +const { data, isPending, isSuccess, isError, error } = useDeleteAccount(deleteAccountVars); + +const { data, isPending, isSuccess, isError, error } = useCreateAccountContact(createAccountContactVars); + +const { data, isPending, isSuccess, isError, error } = useUpdateAccountContact(updateAccountContactVars); + +const { data, isPending, isSuccess, isError, error } = useDeleteAccountContact(deleteAccountContactVars); + +const { data, isPending, isSuccess, isError, error } = useListAccountsByOwner(listAccountsByOwnerVars); + +const { data, isPending, isSuccess, isError, error } = useGetAccountById(getAccountByIdVars); + +const { data, isPending, isSuccess, isError, error } = useListAccountContactsByAccountId(listAccountContactsByAccountIdVars); + +``` + +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 { createAccount, updateAccount, deleteAccountContacts, deleteAccount, createAccountContact, updateAccountContact, deleteAccountContact, listAccountsByOwner, getAccountById, listAccountContactsByAccountId } from '@generated/data-connector-web'; + + +// Operation CreateAccount: For variables, look at type CreateAccountVars in ../index.d.ts +const { data } = await CreateAccount(dataConnect, createAccountVars); + +// Operation UpdateAccount: For variables, look at type UpdateAccountVars in ../index.d.ts +const { data } = await UpdateAccount(dataConnect, updateAccountVars); + +// Operation DeleteAccountContacts: For variables, look at type DeleteAccountContactsVars in ../index.d.ts +const { data } = await DeleteAccountContacts(dataConnect, deleteAccountContactsVars); + +// Operation DeleteAccount: For variables, look at type DeleteAccountVars in ../index.d.ts +const { data } = await DeleteAccount(dataConnect, deleteAccountVars); + +// Operation CreateAccountContact: For variables, look at type CreateAccountContactVars in ../index.d.ts +const { data } = await CreateAccountContact(dataConnect, createAccountContactVars); + +// Operation UpdateAccountContact: For variables, look at type UpdateAccountContactVars in ../index.d.ts +const { data } = await UpdateAccountContact(dataConnect, updateAccountContactVars); + +// Operation DeleteAccountContact: For variables, look at type DeleteAccountContactVars in ../index.d.ts +const { data } = await DeleteAccountContact(dataConnect, deleteAccountContactVars); + +// Operation ListAccountsByOwner: For variables, look at type ListAccountsByOwnerVars in ../index.d.ts +const { data } = await ListAccountsByOwner(dataConnect, listAccountsByOwnerVars); + +// Operation GetAccountById: For variables, look at type GetAccountByIdVars in ../index.d.ts +const { data } = await GetAccountById(dataConnect, getAccountByIdVars); + +// Operation ListAccountContactsByAccountId: For variables, look at type ListAccountContactsByAccountIdVars in ../index.d.ts +const { data } = await ListAccountContactsByAccountId(dataConnect, listAccountContactsByAccountIdVars); + + +``` \ No newline at end of file diff --git a/generated/data-connector-web/README.md b/generated/data-connector-web/README.md new file mode 100644 index 0000000..f48b3da --- /dev/null +++ b/generated/data-connector-web/README.md @@ -0,0 +1,7101 @@ +# Generated TypeScript README +This README will guide you through the process of using the generated JavaScript SDK package for the connector `data-connector`. It will also provide examples on how to use your generated SDK to call your Data Connect queries and mutations. + +**If you're looking for the `React README`, you can find it at [`data-connector-web/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) + - [*ListAccountsByOwner*](#listaccountsbyowner) + - [*GetAccountById*](#getaccountbyid) + - [*ListAccountContactsByAccountId*](#listaccountcontactsbyaccountid) + - [*GetAccountContactById*](#getaccountcontactbyid) + - [*ListProjectsByOwnerAndSalesStatus*](#listprojectsbyownerandsalesstatus) + - [*ListProjectsByAccount*](#listprojectsbyaccount) + - [*GetProjectDetailsById*](#getprojectdetailsbyid) + - [*GetProjectById*](#getprojectbyid) + - [*GetFloorplanPageById*](#getfloorplanpagebyid) + - [*ListQuestionnaireTemplates*](#listquestionnairetemplates) + - [*GetQuestionnaireTemplate*](#getquestionnairetemplate) + - [*ListDueReminders*](#listduereminders) + - [*ListProjectReminders*](#listprojectreminders) + - [*GetReminderById*](#getreminderbyid) + - [*GetUserSettings*](#getusersettings) +- [**Mutations**](#mutations) + - [*CreateAccount*](#createaccount) + - [*UpdateAccount*](#updateaccount) + - [*DeleteAccountContacts*](#deleteaccountcontacts) + - [*DeleteAccount*](#deleteaccount) + - [*CreateAccountContact*](#createaccountcontact) + - [*UpdateAccountContact*](#updateaccountcontact) + - [*DeleteAccountContact*](#deleteaccountcontact) + - [*CreateProjectFromUpload*](#createprojectfromupload) + - [*UpdateProject*](#updateproject) + - [*RenameProject*](#renameproject) + - [*TouchProject*](#touchproject) + - [*DeleteFloorplanPages*](#deletefloorplanpages) + - [*DeleteProject*](#deleteproject) + - [*CreateFloorplanPage*](#createfloorplanpage) + - [*UpdateFloorplanPageAnalysis*](#updatefloorplanpageanalysis) + - [*UpdateFloorplanPage*](#updatefloorplanpage) + - [*UpdateFloorplanPages*](#updatefloorplanpages) + - [*CreateQuestionnaireTemplate*](#createquestionnairetemplate) + - [*CreateQuestionnaireTemplateQuestion*](#createquestionnairetemplatequestion) + - [*UpdateQuestionnaireTemplateName*](#updatequestionnairetemplatename) + - [*UpdateQuestionnaireTemplateQuestion*](#updatequestionnairetemplatequestion) + - [*DeleteQuestionnaireTemplateQuestion*](#deletequestionnairetemplatequestion) + - [*DeleteQuestionnaireTemplate*](#deletequestionnairetemplate) + - [*CreateProjectQuestionnaire*](#createprojectquestionnaire) + - [*CreateProjectQuestionnaireAnswer*](#createprojectquestionnaireanswer) + - [*CreateQuantitySource*](#createquantitysource) + - [*CreateQuoteItemTemplate*](#createquoteitemtemplate) + - [*UpdateQuoteItemTemplate*](#updatequoteitemtemplate) + - [*DeleteQuoteItemTemplate*](#deletequoteitemtemplate) + - [*UpsertQuoteItemTemplateConfig*](#upsertquoteitemtemplateconfig) + - [*CreateSupplier*](#createsupplier) + - [*UpdateSupplier*](#updatesupplier) + - [*DeleteSupplier*](#deletesupplier) + - [*UpsertSupplierQuoteItemPrice*](#upsertsupplierquoteitemprice) + - [*DeleteSupplierQuoteItemPrice*](#deletesupplierquoteitemprice) + - [*CreateQuote*](#createquote) + - [*UpdateQuote*](#updatequote) + - [*DeleteQuoteItems*](#deletequoteitems) + - [*CreateQuoteItem*](#createquoteitem) + - [*UpdateQuoteItem*](#updatequoteitem) + - [*CreateReminder*](#createreminder) + - [*UpdateReminder*](#updatereminder) + - [*UpsertUserSettings*](#upsertusersettings) + +# 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 `data-connector`. You can find more information about connectors in the [Data Connect documentation](https://firebase.google.com/docs/data-connect#how-does). + +You can use this generated SDK by importing from the package `@generated/data-connector-web` 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 '@generated/data-connector-web'; + +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 '@generated/data-connector-web'; + +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 `data-connector` connector's generated functions to execute each query. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#using-queries). + +## ListAccountsByOwner +You can execute the `ListAccountsByOwner` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +listAccountsByOwner(vars: ListAccountsByOwnerVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListAccountsByOwnerRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: ListAccountsByOwnerVariables): QueryRef; +} +export const listAccountsByOwnerRef: ListAccountsByOwnerRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listAccountsByOwner(dc: DataConnect, vars: ListAccountsByOwnerVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListAccountsByOwnerRef { + ... + (dc: DataConnect, vars: ListAccountsByOwnerVariables): QueryRef; +} +export const listAccountsByOwnerRef: ListAccountsByOwnerRef; +``` + +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 listAccountsByOwnerRef: +```typescript +const name = listAccountsByOwnerRef.operationName; +console.log(name); +``` + +### Variables +The `ListAccountsByOwner` query requires an argument of type `ListAccountsByOwnerVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface ListAccountsByOwnerVariables { + ownerId: string; +} +``` +### Return Type +Recall that executing the `ListAccountsByOwner` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListAccountsByOwnerData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListAccountsByOwnerData { + accounts: ({ + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Account_Key)[]; +} +``` +### Using `ListAccountsByOwner`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listAccountsByOwner, ListAccountsByOwnerVariables } from '@generated/data-connector-web'; + +// The `ListAccountsByOwner` query requires an argument of type `ListAccountsByOwnerVariables`: +const listAccountsByOwnerVars: ListAccountsByOwnerVariables = { + ownerId: ..., +}; + +// Call the `listAccountsByOwner()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listAccountsByOwner(listAccountsByOwnerVars); +// Variables can be defined inline as well. +const { data } = await listAccountsByOwner({ ownerId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listAccountsByOwner(dataConnect, listAccountsByOwnerVars); + +console.log(data.accounts); + +// Or, you can use the `Promise` API. +listAccountsByOwner(listAccountsByOwnerVars).then((response) => { + const data = response.data; + console.log(data.accounts); +}); +``` + +### Using `ListAccountsByOwner`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listAccountsByOwnerRef, ListAccountsByOwnerVariables } from '@generated/data-connector-web'; + +// The `ListAccountsByOwner` query requires an argument of type `ListAccountsByOwnerVariables`: +const listAccountsByOwnerVars: ListAccountsByOwnerVariables = { + ownerId: ..., +}; + +// Call the `listAccountsByOwnerRef()` function to get a reference to the query. +const ref = listAccountsByOwnerRef(listAccountsByOwnerVars); +// Variables can be defined inline as well. +const ref = listAccountsByOwnerRef({ ownerId: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listAccountsByOwnerRef(dataConnect, listAccountsByOwnerVars); + +// 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 [data-connector-web/index.d.ts](./index.d.ts): +```typescript +getAccountById(vars: GetAccountByIdVariables, options?: ExecuteQueryOptions): 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, options?: ExecuteQueryOptions): 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 [data-connector-web/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 [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetAccountByIdData { + account?: { + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + contacts: ({ + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key)[]; + } & Account_Key; +} +``` +### Using `GetAccountById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getAccountById, GetAccountByIdVariables } from '@generated/data-connector-web'; + +// 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 '@generated/data-connector-web'; + +// 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); +}); +``` + +## ListAccountContactsByAccountId +You can execute the `ListAccountContactsByAccountId` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +listAccountContactsByAccountId(vars: ListAccountContactsByAccountIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListAccountContactsByAccountIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: ListAccountContactsByAccountIdVariables): QueryRef; +} +export const listAccountContactsByAccountIdRef: ListAccountContactsByAccountIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listAccountContactsByAccountId(dc: DataConnect, vars: ListAccountContactsByAccountIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListAccountContactsByAccountIdRef { + ... + (dc: DataConnect, vars: ListAccountContactsByAccountIdVariables): QueryRef; +} +export const listAccountContactsByAccountIdRef: ListAccountContactsByAccountIdRef; +``` + +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 listAccountContactsByAccountIdRef: +```typescript +const name = listAccountContactsByAccountIdRef.operationName; +console.log(name); +``` + +### Variables +The `ListAccountContactsByAccountId` query requires an argument of type `ListAccountContactsByAccountIdVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface ListAccountContactsByAccountIdVariables { + accountId: UUIDString; +} +``` +### Return Type +Recall that executing the `ListAccountContactsByAccountId` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListAccountContactsByAccountIdData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListAccountContactsByAccountIdData { + accountContacts: ({ + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key)[]; +} +``` +### Using `ListAccountContactsByAccountId`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listAccountContactsByAccountId, ListAccountContactsByAccountIdVariables } from '@generated/data-connector-web'; + +// The `ListAccountContactsByAccountId` query requires an argument of type `ListAccountContactsByAccountIdVariables`: +const listAccountContactsByAccountIdVars: ListAccountContactsByAccountIdVariables = { + accountId: ..., +}; + +// Call the `listAccountContactsByAccountId()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listAccountContactsByAccountId(listAccountContactsByAccountIdVars); +// Variables can be defined inline as well. +const { data } = await listAccountContactsByAccountId({ accountId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listAccountContactsByAccountId(dataConnect, listAccountContactsByAccountIdVars); + +console.log(data.accountContacts); + +// Or, you can use the `Promise` API. +listAccountContactsByAccountId(listAccountContactsByAccountIdVars).then((response) => { + const data = response.data; + console.log(data.accountContacts); +}); +``` + +### Using `ListAccountContactsByAccountId`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listAccountContactsByAccountIdRef, ListAccountContactsByAccountIdVariables } from '@generated/data-connector-web'; + +// The `ListAccountContactsByAccountId` query requires an argument of type `ListAccountContactsByAccountIdVariables`: +const listAccountContactsByAccountIdVars: ListAccountContactsByAccountIdVariables = { + accountId: ..., +}; + +// Call the `listAccountContactsByAccountIdRef()` function to get a reference to the query. +const ref = listAccountContactsByAccountIdRef(listAccountContactsByAccountIdVars); +// Variables can be defined inline as well. +const ref = listAccountContactsByAccountIdRef({ accountId: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listAccountContactsByAccountIdRef(dataConnect, listAccountContactsByAccountIdVars); + +// 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.accountContacts); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.accountContacts); +}); +``` + +## GetAccountContactById +You can execute the `GetAccountContactById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +getAccountContactById(vars: GetAccountContactByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetAccountContactByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetAccountContactByIdVariables): QueryRef; +} +export const getAccountContactByIdRef: GetAccountContactByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getAccountContactById(dc: DataConnect, vars: GetAccountContactByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetAccountContactByIdRef { + ... + (dc: DataConnect, vars: GetAccountContactByIdVariables): QueryRef; +} +export const getAccountContactByIdRef: GetAccountContactByIdRef; +``` + +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 getAccountContactByIdRef: +```typescript +const name = getAccountContactByIdRef.operationName; +console.log(name); +``` + +### Variables +The `GetAccountContactById` query requires an argument of type `GetAccountContactByIdVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetAccountContactByIdVariables { + accountId: UUIDString; + contactId: UUIDString; +} +``` +### Return Type +Recall that executing the `GetAccountContactById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetAccountContactByIdData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetAccountContactByIdData { + accountContact?: { + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key; +} +``` +### Using `GetAccountContactById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getAccountContactById, GetAccountContactByIdVariables } from '@generated/data-connector-web'; + +// The `GetAccountContactById` query requires an argument of type `GetAccountContactByIdVariables`: +const getAccountContactByIdVars: GetAccountContactByIdVariables = { + accountId: ..., + contactId: ..., +}; + +// Call the `getAccountContactById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getAccountContactById(getAccountContactByIdVars); +// Variables can be defined inline as well. +const { data } = await getAccountContactById({ accountId: ..., contactId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getAccountContactById(dataConnect, getAccountContactByIdVars); + +console.log(data.accountContact); + +// Or, you can use the `Promise` API. +getAccountContactById(getAccountContactByIdVars).then((response) => { + const data = response.data; + console.log(data.accountContact); +}); +``` + +### Using `GetAccountContactById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getAccountContactByIdRef, GetAccountContactByIdVariables } from '@generated/data-connector-web'; + +// The `GetAccountContactById` query requires an argument of type `GetAccountContactByIdVariables`: +const getAccountContactByIdVars: GetAccountContactByIdVariables = { + accountId: ..., + contactId: ..., +}; + +// Call the `getAccountContactByIdRef()` function to get a reference to the query. +const ref = getAccountContactByIdRef(getAccountContactByIdVars); +// Variables can be defined inline as well. +const ref = getAccountContactByIdRef({ accountId: ..., contactId: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getAccountContactByIdRef(dataConnect, getAccountContactByIdVars); + +// 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.accountContact); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.accountContact); +}); +``` + +## ListProjectsByOwnerAndSalesStatus +You can execute the `ListProjectsByOwnerAndSalesStatus` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +listProjectsByOwnerAndSalesStatus(vars: ListProjectsByOwnerAndSalesStatusVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListProjectsByOwnerAndSalesStatusRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: ListProjectsByOwnerAndSalesStatusVariables): QueryRef; +} +export const listProjectsByOwnerAndSalesStatusRef: ListProjectsByOwnerAndSalesStatusRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listProjectsByOwnerAndSalesStatus(dc: DataConnect, vars: ListProjectsByOwnerAndSalesStatusVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListProjectsByOwnerAndSalesStatusRef { + ... + (dc: DataConnect, vars: ListProjectsByOwnerAndSalesStatusVariables): QueryRef; +} +export const listProjectsByOwnerAndSalesStatusRef: ListProjectsByOwnerAndSalesStatusRef; +``` + +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 listProjectsByOwnerAndSalesStatusRef: +```typescript +const name = listProjectsByOwnerAndSalesStatusRef.operationName; +console.log(name); +``` + +### Variables +The `ListProjectsByOwnerAndSalesStatus` query requires an argument of type `ListProjectsByOwnerAndSalesStatusVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface ListProjectsByOwnerAndSalesStatusVariables { + ownerId: string; + salesStatus: string; +} +``` +### Return Type +Recall that executing the `ListProjectsByOwnerAndSalesStatus` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListProjectsByOwnerAndSalesStatusData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListProjectsByOwnerAndSalesStatusData { + projects: ({ + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key)[]; +} +``` +### Using `ListProjectsByOwnerAndSalesStatus`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listProjectsByOwnerAndSalesStatus, ListProjectsByOwnerAndSalesStatusVariables } from '@generated/data-connector-web'; + +// The `ListProjectsByOwnerAndSalesStatus` query requires an argument of type `ListProjectsByOwnerAndSalesStatusVariables`: +const listProjectsByOwnerAndSalesStatusVars: ListProjectsByOwnerAndSalesStatusVariables = { + ownerId: ..., + salesStatus: ..., +}; + +// Call the `listProjectsByOwnerAndSalesStatus()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listProjectsByOwnerAndSalesStatus(listProjectsByOwnerAndSalesStatusVars); +// Variables can be defined inline as well. +const { data } = await listProjectsByOwnerAndSalesStatus({ ownerId: ..., salesStatus: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listProjectsByOwnerAndSalesStatus(dataConnect, listProjectsByOwnerAndSalesStatusVars); + +console.log(data.projects); + +// Or, you can use the `Promise` API. +listProjectsByOwnerAndSalesStatus(listProjectsByOwnerAndSalesStatusVars).then((response) => { + const data = response.data; + console.log(data.projects); +}); +``` + +### Using `ListProjectsByOwnerAndSalesStatus`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listProjectsByOwnerAndSalesStatusRef, ListProjectsByOwnerAndSalesStatusVariables } from '@generated/data-connector-web'; + +// The `ListProjectsByOwnerAndSalesStatus` query requires an argument of type `ListProjectsByOwnerAndSalesStatusVariables`: +const listProjectsByOwnerAndSalesStatusVars: ListProjectsByOwnerAndSalesStatusVariables = { + ownerId: ..., + salesStatus: ..., +}; + +// Call the `listProjectsByOwnerAndSalesStatusRef()` function to get a reference to the query. +const ref = listProjectsByOwnerAndSalesStatusRef(listProjectsByOwnerAndSalesStatusVars); +// Variables can be defined inline as well. +const ref = listProjectsByOwnerAndSalesStatusRef({ ownerId: ..., salesStatus: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listProjectsByOwnerAndSalesStatusRef(dataConnect, listProjectsByOwnerAndSalesStatusVars); + +// 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.projects); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.projects); +}); +``` + +## ListProjectsByAccount +You can execute the `ListProjectsByAccount` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +listProjectsByAccount(vars: ListProjectsByAccountVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListProjectsByAccountRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: ListProjectsByAccountVariables): QueryRef; +} +export const listProjectsByAccountRef: ListProjectsByAccountRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listProjectsByAccount(dc: DataConnect, vars: ListProjectsByAccountVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListProjectsByAccountRef { + ... + (dc: DataConnect, vars: ListProjectsByAccountVariables): QueryRef; +} +export const listProjectsByAccountRef: ListProjectsByAccountRef; +``` + +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 listProjectsByAccountRef: +```typescript +const name = listProjectsByAccountRef.operationName; +console.log(name); +``` + +### Variables +The `ListProjectsByAccount` query requires an argument of type `ListProjectsByAccountVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface ListProjectsByAccountVariables { + accountId: UUIDString; +} +``` +### Return Type +Recall that executing the `ListProjectsByAccount` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListProjectsByAccountData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListProjectsByAccountData { + projects: ({ + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key)[]; +} +``` +### Using `ListProjectsByAccount`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listProjectsByAccount, ListProjectsByAccountVariables } from '@generated/data-connector-web'; + +// The `ListProjectsByAccount` query requires an argument of type `ListProjectsByAccountVariables`: +const listProjectsByAccountVars: ListProjectsByAccountVariables = { + accountId: ..., +}; + +// Call the `listProjectsByAccount()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listProjectsByAccount(listProjectsByAccountVars); +// Variables can be defined inline as well. +const { data } = await listProjectsByAccount({ accountId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listProjectsByAccount(dataConnect, listProjectsByAccountVars); + +console.log(data.projects); + +// Or, you can use the `Promise` API. +listProjectsByAccount(listProjectsByAccountVars).then((response) => { + const data = response.data; + console.log(data.projects); +}); +``` + +### Using `ListProjectsByAccount`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listProjectsByAccountRef, ListProjectsByAccountVariables } from '@generated/data-connector-web'; + +// The `ListProjectsByAccount` query requires an argument of type `ListProjectsByAccountVariables`: +const listProjectsByAccountVars: ListProjectsByAccountVariables = { + accountId: ..., +}; + +// Call the `listProjectsByAccountRef()` function to get a reference to the query. +const ref = listProjectsByAccountRef(listProjectsByAccountVars); +// Variables can be defined inline as well. +const ref = listProjectsByAccountRef({ accountId: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listProjectsByAccountRef(dataConnect, listProjectsByAccountVars); + +// 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.projects); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.projects); +}); +``` + +## GetProjectDetailsById +You can execute the `GetProjectDetailsById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +getProjectDetailsById(vars: GetProjectDetailsByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetProjectDetailsByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetProjectDetailsByIdVariables): QueryRef; +} +export const getProjectDetailsByIdRef: GetProjectDetailsByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getProjectDetailsById(dc: DataConnect, vars: GetProjectDetailsByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetProjectDetailsByIdRef { + ... + (dc: DataConnect, vars: GetProjectDetailsByIdVariables): QueryRef; +} +export const getProjectDetailsByIdRef: GetProjectDetailsByIdRef; +``` + +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 getProjectDetailsByIdRef: +```typescript +const name = getProjectDetailsByIdRef.operationName; +console.log(name); +``` + +### Variables +The `GetProjectDetailsById` query requires an argument of type `GetProjectDetailsByIdVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetProjectDetailsByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `GetProjectDetailsById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetProjectDetailsByIdData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetProjectDetailsByIdData { + project?: { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + pages: ({ + id: UUIDString; + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & FloorplanPage_Key)[]; + } & Project_Key; +} +``` +### Using `GetProjectDetailsById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getProjectDetailsById, GetProjectDetailsByIdVariables } from '@generated/data-connector-web'; + +// The `GetProjectDetailsById` query requires an argument of type `GetProjectDetailsByIdVariables`: +const getProjectDetailsByIdVars: GetProjectDetailsByIdVariables = { + id: ..., +}; + +// Call the `getProjectDetailsById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getProjectDetailsById(getProjectDetailsByIdVars); +// Variables can be defined inline as well. +const { data } = await getProjectDetailsById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getProjectDetailsById(dataConnect, getProjectDetailsByIdVars); + +console.log(data.project); + +// Or, you can use the `Promise` API. +getProjectDetailsById(getProjectDetailsByIdVars).then((response) => { + const data = response.data; + console.log(data.project); +}); +``` + +### Using `GetProjectDetailsById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getProjectDetailsByIdRef, GetProjectDetailsByIdVariables } from '@generated/data-connector-web'; + +// The `GetProjectDetailsById` query requires an argument of type `GetProjectDetailsByIdVariables`: +const getProjectDetailsByIdVars: GetProjectDetailsByIdVariables = { + id: ..., +}; + +// Call the `getProjectDetailsByIdRef()` function to get a reference to the query. +const ref = getProjectDetailsByIdRef(getProjectDetailsByIdVars); +// Variables can be defined inline as well. +const ref = getProjectDetailsByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getProjectDetailsByIdRef(dataConnect, getProjectDetailsByIdVars); + +// 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.project); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.project); +}); +``` + +## GetProjectById +You can execute the `GetProjectById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +getProjectById(vars: GetProjectByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetProjectByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetProjectByIdVariables): QueryRef; +} +export const getProjectByIdRef: GetProjectByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getProjectById(dc: DataConnect, vars: GetProjectByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetProjectByIdRef { + ... + (dc: DataConnect, vars: GetProjectByIdVariables): QueryRef; +} +export const getProjectByIdRef: GetProjectByIdRef; +``` + +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 getProjectByIdRef: +```typescript +const name = getProjectByIdRef.operationName; +console.log(name); +``` + +### Variables +The `GetProjectById` query requires an argument of type `GetProjectByIdVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetProjectByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `GetProjectById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetProjectByIdData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetProjectByIdData { + project?: { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key; +} +``` +### Using `GetProjectById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getProjectById, GetProjectByIdVariables } from '@generated/data-connector-web'; + +// The `GetProjectById` query requires an argument of type `GetProjectByIdVariables`: +const getProjectByIdVars: GetProjectByIdVariables = { + id: ..., +}; + +// Call the `getProjectById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getProjectById(getProjectByIdVars); +// Variables can be defined inline as well. +const { data } = await getProjectById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getProjectById(dataConnect, getProjectByIdVars); + +console.log(data.project); + +// Or, you can use the `Promise` API. +getProjectById(getProjectByIdVars).then((response) => { + const data = response.data; + console.log(data.project); +}); +``` + +### Using `GetProjectById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getProjectByIdRef, GetProjectByIdVariables } from '@generated/data-connector-web'; + +// The `GetProjectById` query requires an argument of type `GetProjectByIdVariables`: +const getProjectByIdVars: GetProjectByIdVariables = { + id: ..., +}; + +// Call the `getProjectByIdRef()` function to get a reference to the query. +const ref = getProjectByIdRef(getProjectByIdVars); +// Variables can be defined inline as well. +const ref = getProjectByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getProjectByIdRef(dataConnect, getProjectByIdVars); + +// 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.project); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.project); +}); +``` + +## GetFloorplanPageById +You can execute the `GetFloorplanPageById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +getFloorplanPageById(vars: GetFloorplanPageByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetFloorplanPageByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetFloorplanPageByIdVariables): QueryRef; +} +export const getFloorplanPageByIdRef: GetFloorplanPageByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getFloorplanPageById(dc: DataConnect, vars: GetFloorplanPageByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetFloorplanPageByIdRef { + ... + (dc: DataConnect, vars: GetFloorplanPageByIdVariables): QueryRef; +} +export const getFloorplanPageByIdRef: GetFloorplanPageByIdRef; +``` + +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 getFloorplanPageByIdRef: +```typescript +const name = getFloorplanPageByIdRef.operationName; +console.log(name); +``` + +### Variables +The `GetFloorplanPageById` query requires an argument of type `GetFloorplanPageByIdVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetFloorplanPageByIdVariables { + projectId: UUIDString; + pageId: UUIDString; +} +``` +### Return Type +Recall that executing the `GetFloorplanPageById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetFloorplanPageByIdData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetFloorplanPageByIdData { + floorplanPage?: { + id: UUIDString; + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & FloorplanPage_Key; +} +``` +### Using `GetFloorplanPageById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getFloorplanPageById, GetFloorplanPageByIdVariables } from '@generated/data-connector-web'; + +// The `GetFloorplanPageById` query requires an argument of type `GetFloorplanPageByIdVariables`: +const getFloorplanPageByIdVars: GetFloorplanPageByIdVariables = { + projectId: ..., + pageId: ..., +}; + +// Call the `getFloorplanPageById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getFloorplanPageById(getFloorplanPageByIdVars); +// Variables can be defined inline as well. +const { data } = await getFloorplanPageById({ projectId: ..., pageId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getFloorplanPageById(dataConnect, getFloorplanPageByIdVars); + +console.log(data.floorplanPage); + +// Or, you can use the `Promise` API. +getFloorplanPageById(getFloorplanPageByIdVars).then((response) => { + const data = response.data; + console.log(data.floorplanPage); +}); +``` + +### Using `GetFloorplanPageById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getFloorplanPageByIdRef, GetFloorplanPageByIdVariables } from '@generated/data-connector-web'; + +// The `GetFloorplanPageById` query requires an argument of type `GetFloorplanPageByIdVariables`: +const getFloorplanPageByIdVars: GetFloorplanPageByIdVariables = { + projectId: ..., + pageId: ..., +}; + +// Call the `getFloorplanPageByIdRef()` function to get a reference to the query. +const ref = getFloorplanPageByIdRef(getFloorplanPageByIdVars); +// Variables can be defined inline as well. +const ref = getFloorplanPageByIdRef({ projectId: ..., pageId: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getFloorplanPageByIdRef(dataConnect, getFloorplanPageByIdVars); + +// 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.floorplanPage); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.floorplanPage); +}); +``` + +## ListQuestionnaireTemplates +You can execute the `ListQuestionnaireTemplates` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +listQuestionnaireTemplates(options?: ExecuteQueryOptions): QueryPromise; + +interface ListQuestionnaireTemplatesRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (): QueryRef; +} +export const listQuestionnaireTemplatesRef: ListQuestionnaireTemplatesRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listQuestionnaireTemplates(dc: DataConnect, options?: ExecuteQueryOptions): QueryPromise; + +interface ListQuestionnaireTemplatesRef { + ... + (dc: DataConnect): QueryRef; +} +export const listQuestionnaireTemplatesRef: ListQuestionnaireTemplatesRef; +``` + +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 listQuestionnaireTemplatesRef: +```typescript +const name = listQuestionnaireTemplatesRef.operationName; +console.log(name); +``` + +### Variables +The `ListQuestionnaireTemplates` query has no variables. +### Return Type +Recall that executing the `ListQuestionnaireTemplates` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListQuestionnaireTemplatesData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListQuestionnaireTemplatesData { + questionnaireTemplates: ({ + id: UUIDString; + name: string; + createdAt: TimestampString; + updatedAt: TimestampString; + } & QuestionnaireTemplate_Key)[]; +} +``` +### Using `ListQuestionnaireTemplates`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listQuestionnaireTemplates } from '@generated/data-connector-web'; + + +// Call the `listQuestionnaireTemplates()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listQuestionnaireTemplates(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listQuestionnaireTemplates(dataConnect); + +console.log(data.questionnaireTemplates); + +// Or, you can use the `Promise` API. +listQuestionnaireTemplates().then((response) => { + const data = response.data; + console.log(data.questionnaireTemplates); +}); +``` + +### Using `ListQuestionnaireTemplates`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listQuestionnaireTemplatesRef } from '@generated/data-connector-web'; + + +// Call the `listQuestionnaireTemplatesRef()` function to get a reference to the query. +const ref = listQuestionnaireTemplatesRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listQuestionnaireTemplatesRef(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.questionnaireTemplates); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplates); +}); +``` + +## GetQuestionnaireTemplate +You can execute the `GetQuestionnaireTemplate` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +getQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetQuestionnaireTemplateRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetQuestionnaireTemplateVariables): QueryRef; +} +export const getQuestionnaireTemplateRef: GetQuestionnaireTemplateRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetQuestionnaireTemplateRef { + ... + (dc: DataConnect, vars: GetQuestionnaireTemplateVariables): QueryRef; +} +export const getQuestionnaireTemplateRef: GetQuestionnaireTemplateRef; +``` + +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 getQuestionnaireTemplateRef: +```typescript +const name = getQuestionnaireTemplateRef.operationName; +console.log(name); +``` + +### Variables +The `GetQuestionnaireTemplate` query requires an argument of type `GetQuestionnaireTemplateVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetQuestionnaireTemplateVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `GetQuestionnaireTemplate` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetQuestionnaireTemplateData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetQuestionnaireTemplateData { + questionnaireTemplate?: { + id: UUIDString; + ownerId: string; + name: string; + createdAt: TimestampString; + updatedAt: TimestampString; + questions: ({ + id: UUIDString; + label: string; + description?: string | null; + position: number; + } & QuestionnaireTemplateQuestion_Key)[]; + } & QuestionnaireTemplate_Key; +} +``` +### Using `GetQuestionnaireTemplate`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getQuestionnaireTemplate, GetQuestionnaireTemplateVariables } from '@generated/data-connector-web'; + +// The `GetQuestionnaireTemplate` query requires an argument of type `GetQuestionnaireTemplateVariables`: +const getQuestionnaireTemplateVars: GetQuestionnaireTemplateVariables = { + id: ..., +}; + +// Call the `getQuestionnaireTemplate()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getQuestionnaireTemplate(getQuestionnaireTemplateVars); +// Variables can be defined inline as well. +const { data } = await getQuestionnaireTemplate({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getQuestionnaireTemplate(dataConnect, getQuestionnaireTemplateVars); + +console.log(data.questionnaireTemplate); + +// Or, you can use the `Promise` API. +getQuestionnaireTemplate(getQuestionnaireTemplateVars).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplate); +}); +``` + +### Using `GetQuestionnaireTemplate`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getQuestionnaireTemplateRef, GetQuestionnaireTemplateVariables } from '@generated/data-connector-web'; + +// The `GetQuestionnaireTemplate` query requires an argument of type `GetQuestionnaireTemplateVariables`: +const getQuestionnaireTemplateVars: GetQuestionnaireTemplateVariables = { + id: ..., +}; + +// Call the `getQuestionnaireTemplateRef()` function to get a reference to the query. +const ref = getQuestionnaireTemplateRef(getQuestionnaireTemplateVars); +// Variables can be defined inline as well. +const ref = getQuestionnaireTemplateRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getQuestionnaireTemplateRef(dataConnect, getQuestionnaireTemplateVars); + +// 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.questionnaireTemplate); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplate); +}); +``` + +## ListDueReminders +You can execute the `ListDueReminders` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +listDueReminders(vars: ListDueRemindersVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListDueRemindersRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: ListDueRemindersVariables): QueryRef; +} +export const listDueRemindersRef: ListDueRemindersRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listDueReminders(dc: DataConnect, vars: ListDueRemindersVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListDueRemindersRef { + ... + (dc: DataConnect, vars: ListDueRemindersVariables): QueryRef; +} +export const listDueRemindersRef: ListDueRemindersRef; +``` + +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 listDueRemindersRef: +```typescript +const name = listDueRemindersRef.operationName; +console.log(name); +``` + +### Variables +The `ListDueReminders` query requires an argument of type `ListDueRemindersVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface ListDueRemindersVariables { + ownerId: string; +} +``` +### Return Type +Recall that executing the `ListDueReminders` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListDueRemindersData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListDueRemindersData { + reminders: ({ + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key)[]; +} +``` +### Using `ListDueReminders`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listDueReminders, ListDueRemindersVariables } from '@generated/data-connector-web'; + +// The `ListDueReminders` query requires an argument of type `ListDueRemindersVariables`: +const listDueRemindersVars: ListDueRemindersVariables = { + ownerId: ..., +}; + +// Call the `listDueReminders()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listDueReminders(listDueRemindersVars); +// Variables can be defined inline as well. +const { data } = await listDueReminders({ ownerId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listDueReminders(dataConnect, listDueRemindersVars); + +console.log(data.reminders); + +// Or, you can use the `Promise` API. +listDueReminders(listDueRemindersVars).then((response) => { + const data = response.data; + console.log(data.reminders); +}); +``` + +### Using `ListDueReminders`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listDueRemindersRef, ListDueRemindersVariables } from '@generated/data-connector-web'; + +// The `ListDueReminders` query requires an argument of type `ListDueRemindersVariables`: +const listDueRemindersVars: ListDueRemindersVariables = { + ownerId: ..., +}; + +// Call the `listDueRemindersRef()` function to get a reference to the query. +const ref = listDueRemindersRef(listDueRemindersVars); +// Variables can be defined inline as well. +const ref = listDueRemindersRef({ ownerId: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listDueRemindersRef(dataConnect, listDueRemindersVars); + +// 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.reminders); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.reminders); +}); +``` + +## ListProjectReminders +You can execute the `ListProjectReminders` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +listProjectReminders(vars: ListProjectRemindersVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListProjectRemindersRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: ListProjectRemindersVariables): QueryRef; +} +export const listProjectRemindersRef: ListProjectRemindersRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listProjectReminders(dc: DataConnect, vars: ListProjectRemindersVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListProjectRemindersRef { + ... + (dc: DataConnect, vars: ListProjectRemindersVariables): QueryRef; +} +export const listProjectRemindersRef: ListProjectRemindersRef; +``` + +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 listProjectRemindersRef: +```typescript +const name = listProjectRemindersRef.operationName; +console.log(name); +``` + +### Variables +The `ListProjectReminders` query requires an argument of type `ListProjectRemindersVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface ListProjectRemindersVariables { + projectId: UUIDString; +} +``` +### Return Type +Recall that executing the `ListProjectReminders` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListProjectRemindersData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListProjectRemindersData { + reminders: ({ + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key)[]; +} +``` +### Using `ListProjectReminders`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listProjectReminders, ListProjectRemindersVariables } from '@generated/data-connector-web'; + +// The `ListProjectReminders` query requires an argument of type `ListProjectRemindersVariables`: +const listProjectRemindersVars: ListProjectRemindersVariables = { + projectId: ..., +}; + +// Call the `listProjectReminders()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listProjectReminders(listProjectRemindersVars); +// Variables can be defined inline as well. +const { data } = await listProjectReminders({ projectId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listProjectReminders(dataConnect, listProjectRemindersVars); + +console.log(data.reminders); + +// Or, you can use the `Promise` API. +listProjectReminders(listProjectRemindersVars).then((response) => { + const data = response.data; + console.log(data.reminders); +}); +``` + +### Using `ListProjectReminders`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listProjectRemindersRef, ListProjectRemindersVariables } from '@generated/data-connector-web'; + +// The `ListProjectReminders` query requires an argument of type `ListProjectRemindersVariables`: +const listProjectRemindersVars: ListProjectRemindersVariables = { + projectId: ..., +}; + +// Call the `listProjectRemindersRef()` function to get a reference to the query. +const ref = listProjectRemindersRef(listProjectRemindersVars); +// Variables can be defined inline as well. +const ref = listProjectRemindersRef({ projectId: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listProjectRemindersRef(dataConnect, listProjectRemindersVars); + +// 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.reminders); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.reminders); +}); +``` + +## GetReminderById +You can execute the `GetReminderById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +getReminderById(vars: GetReminderByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetReminderByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetReminderByIdVariables): QueryRef; +} +export const getReminderByIdRef: GetReminderByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getReminderById(dc: DataConnect, vars: GetReminderByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetReminderByIdRef { + ... + (dc: DataConnect, vars: GetReminderByIdVariables): QueryRef; +} +export const getReminderByIdRef: GetReminderByIdRef; +``` + +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 getReminderByIdRef: +```typescript +const name = getReminderByIdRef.operationName; +console.log(name); +``` + +### Variables +The `GetReminderById` query requires an argument of type `GetReminderByIdVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetReminderByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `GetReminderById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetReminderByIdData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetReminderByIdData { + reminder?: { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key; +} +``` +### Using `GetReminderById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getReminderById, GetReminderByIdVariables } from '@generated/data-connector-web'; + +// The `GetReminderById` query requires an argument of type `GetReminderByIdVariables`: +const getReminderByIdVars: GetReminderByIdVariables = { + id: ..., +}; + +// Call the `getReminderById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getReminderById(getReminderByIdVars); +// Variables can be defined inline as well. +const { data } = await getReminderById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getReminderById(dataConnect, getReminderByIdVars); + +console.log(data.reminder); + +// Or, you can use the `Promise` API. +getReminderById(getReminderByIdVars).then((response) => { + const data = response.data; + console.log(data.reminder); +}); +``` + +### Using `GetReminderById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getReminderByIdRef, GetReminderByIdVariables } from '@generated/data-connector-web'; + +// The `GetReminderById` query requires an argument of type `GetReminderByIdVariables`: +const getReminderByIdVars: GetReminderByIdVariables = { + id: ..., +}; + +// Call the `getReminderByIdRef()` function to get a reference to the query. +const ref = getReminderByIdRef(getReminderByIdVars); +// Variables can be defined inline as well. +const ref = getReminderByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getReminderByIdRef(dataConnect, getReminderByIdVars); + +// 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.reminder); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.reminder); +}); +``` + +## GetUserSettings +You can execute the `GetUserSettings` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +getUserSettings(vars: GetUserSettingsVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetUserSettingsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetUserSettingsVariables): QueryRef; +} +export const getUserSettingsRef: GetUserSettingsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getUserSettings(dc: DataConnect, vars: GetUserSettingsVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetUserSettingsRef { + ... + (dc: DataConnect, vars: GetUserSettingsVariables): QueryRef; +} +export const getUserSettingsRef: GetUserSettingsRef; +``` + +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 getUserSettingsRef: +```typescript +const name = getUserSettingsRef.operationName; +console.log(name); +``` + +### Variables +The `GetUserSettings` query requires an argument of type `GetUserSettingsVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetUserSettingsVariables { + ownerId: string; +} +``` +### Return Type +Recall that executing the `GetUserSettings` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetUserSettingsData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetUserSettingsData { + userSettings?: { + ownerId: string; + quoteFollowUpEnabled: boolean; + quoteFollowUpDays: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & UserSettings_Key; +} +``` +### Using `GetUserSettings`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getUserSettings, GetUserSettingsVariables } from '@generated/data-connector-web'; + +// The `GetUserSettings` query requires an argument of type `GetUserSettingsVariables`: +const getUserSettingsVars: GetUserSettingsVariables = { + ownerId: ..., +}; + +// Call the `getUserSettings()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getUserSettings(getUserSettingsVars); +// Variables can be defined inline as well. +const { data } = await getUserSettings({ ownerId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getUserSettings(dataConnect, getUserSettingsVars); + +console.log(data.userSettings); + +// Or, you can use the `Promise` API. +getUserSettings(getUserSettingsVars).then((response) => { + const data = response.data; + console.log(data.userSettings); +}); +``` + +### Using `GetUserSettings`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getUserSettingsRef, GetUserSettingsVariables } from '@generated/data-connector-web'; + +// The `GetUserSettings` query requires an argument of type `GetUserSettingsVariables`: +const getUserSettingsVars: GetUserSettingsVariables = { + ownerId: ..., +}; + +// Call the `getUserSettingsRef()` function to get a reference to the query. +const ref = getUserSettingsRef(getUserSettingsVars); +// Variables can be defined inline as well. +const ref = getUserSettingsRef({ ownerId: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getUserSettingsRef(dataConnect, getUserSettingsVars); + +// 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.userSettings); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.userSettings); +}); +``` + +# Mutations + +There are two ways to execute a Data Connect Mutation using the generated Web SDK: +- Using a Mutation Reference function, which returns a `MutationRef` + - The `MutationRef` can be used as an argument to `executeMutation()`, which will execute the Mutation and return a `MutationPromise` +- Using an action shortcut function, which returns a `MutationPromise` + - Calling the action shortcut function will execute the Mutation and return a `MutationPromise` + +The following is true for both the action shortcut function and the `MutationRef` function: +- The `MutationPromise` returned will resolve to the result of the Mutation once it has finished executing +- If the Mutation accepts arguments, both the action shortcut function and the `MutationRef` function accept a single argument: an object that contains all the required variables (and the optional variables) for the Mutation +- 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 `data-connector` connector's generated functions to execute each mutation. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#using-mutations). + +## CreateAccount +You can execute the `CreateAccount` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createAccount(vars: CreateAccountVariables): MutationPromise; + +interface CreateAccountRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateAccountVariables): MutationRef; +} +export const createAccountRef: CreateAccountRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createAccount(dc: DataConnect, vars: CreateAccountVariables): MutationPromise; + +interface CreateAccountRef { + ... + (dc: DataConnect, vars: CreateAccountVariables): MutationRef; +} +export const createAccountRef: CreateAccountRef; +``` + +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 createAccountRef: +```typescript +const name = createAccountRef.operationName; +console.log(name); +``` + +### Variables +The `CreateAccount` mutation requires an argument of type `CreateAccountVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateAccountVariables { + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; +} +``` +### Return Type +Recall that executing the `CreateAccount` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateAccountData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateAccountData { + account_insert: Account_Key; +} +``` +### Using `CreateAccount`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createAccount, CreateAccountVariables } from '@generated/data-connector-web'; + +// The `CreateAccount` mutation requires an argument of type `CreateAccountVariables`: +const createAccountVars: CreateAccountVariables = { + id: ..., + ownerId: ..., + companyName: ..., + businessNumber: ..., // optional + phoneNumber: ..., // optional +}; + +// Call the `createAccount()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createAccount(createAccountVars); +// Variables can be defined inline as well. +const { data } = await createAccount({ id: ..., ownerId: ..., companyName: ..., businessNumber: ..., phoneNumber: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createAccount(dataConnect, createAccountVars); + +console.log(data.account_insert); + +// Or, you can use the `Promise` API. +createAccount(createAccountVars).then((response) => { + const data = response.data; + console.log(data.account_insert); +}); +``` + +### Using `CreateAccount`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createAccountRef, CreateAccountVariables } from '@generated/data-connector-web'; + +// The `CreateAccount` mutation requires an argument of type `CreateAccountVariables`: +const createAccountVars: CreateAccountVariables = { + id: ..., + ownerId: ..., + companyName: ..., + businessNumber: ..., // optional + phoneNumber: ..., // optional +}; + +// Call the `createAccountRef()` function to get a reference to the mutation. +const ref = createAccountRef(createAccountVars); +// Variables can be defined inline as well. +const ref = createAccountRef({ id: ..., ownerId: ..., companyName: ..., businessNumber: ..., phoneNumber: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createAccountRef(dataConnect, createAccountVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.account_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.account_insert); +}); +``` + +## UpdateAccount +You can execute the `UpdateAccount` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateAccount(vars: UpdateAccountVariables): MutationPromise; + +interface UpdateAccountRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateAccountVariables): MutationRef; +} +export const updateAccountRef: UpdateAccountRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateAccount(dc: DataConnect, vars: UpdateAccountVariables): MutationPromise; + +interface UpdateAccountRef { + ... + (dc: DataConnect, vars: UpdateAccountVariables): MutationRef; +} +export const updateAccountRef: UpdateAccountRef; +``` + +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 updateAccountRef: +```typescript +const name = updateAccountRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateAccount` mutation requires an argument of type `UpdateAccountVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateAccountVariables { + id: UUIDString; + companyName?: string | null; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; +} +``` +### Return Type +Recall that executing the `UpdateAccount` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateAccountData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateAccountData { + account_update?: Account_Key | null; +} +``` +### Using `UpdateAccount`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateAccount, UpdateAccountVariables } from '@generated/data-connector-web'; + +// The `UpdateAccount` mutation requires an argument of type `UpdateAccountVariables`: +const updateAccountVars: UpdateAccountVariables = { + id: ..., + companyName: ..., // optional + businessNumber: ..., // optional + phoneNumber: ..., // optional + primaryContactId: ..., // optional +}; + +// Call the `updateAccount()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateAccount(updateAccountVars); +// Variables can be defined inline as well. +const { data } = await updateAccount({ id: ..., companyName: ..., businessNumber: ..., phoneNumber: ..., primaryContactId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateAccount(dataConnect, updateAccountVars); + +console.log(data.account_update); + +// Or, you can use the `Promise` API. +updateAccount(updateAccountVars).then((response) => { + const data = response.data; + console.log(data.account_update); +}); +``` + +### Using `UpdateAccount`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateAccountRef, UpdateAccountVariables } from '@generated/data-connector-web'; + +// The `UpdateAccount` mutation requires an argument of type `UpdateAccountVariables`: +const updateAccountVars: UpdateAccountVariables = { + id: ..., + companyName: ..., // optional + businessNumber: ..., // optional + phoneNumber: ..., // optional + primaryContactId: ..., // optional +}; + +// Call the `updateAccountRef()` function to get a reference to the mutation. +const ref = updateAccountRef(updateAccountVars); +// Variables can be defined inline as well. +const ref = updateAccountRef({ id: ..., companyName: ..., businessNumber: ..., phoneNumber: ..., primaryContactId: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateAccountRef(dataConnect, updateAccountVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.account_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.account_update); +}); +``` + +## DeleteAccountContacts +You can execute the `DeleteAccountContacts` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteAccountContacts(vars: DeleteAccountContactsVariables): MutationPromise; + +interface DeleteAccountContactsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteAccountContactsVariables): MutationRef; +} +export const deleteAccountContactsRef: DeleteAccountContactsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteAccountContacts(dc: DataConnect, vars: DeleteAccountContactsVariables): MutationPromise; + +interface DeleteAccountContactsRef { + ... + (dc: DataConnect, vars: DeleteAccountContactsVariables): MutationRef; +} +export const deleteAccountContactsRef: DeleteAccountContactsRef; +``` + +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 deleteAccountContactsRef: +```typescript +const name = deleteAccountContactsRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteAccountContacts` mutation requires an argument of type `DeleteAccountContactsVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteAccountContactsVariables { + accountId: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteAccountContacts` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteAccountContactsData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteAccountContactsData { + accountContact_deleteMany: number; +} +``` +### Using `DeleteAccountContacts`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteAccountContacts, DeleteAccountContactsVariables } from '@generated/data-connector-web'; + +// The `DeleteAccountContacts` mutation requires an argument of type `DeleteAccountContactsVariables`: +const deleteAccountContactsVars: DeleteAccountContactsVariables = { + accountId: ..., +}; + +// Call the `deleteAccountContacts()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteAccountContacts(deleteAccountContactsVars); +// Variables can be defined inline as well. +const { data } = await deleteAccountContacts({ accountId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteAccountContacts(dataConnect, deleteAccountContactsVars); + +console.log(data.accountContact_deleteMany); + +// Or, you can use the `Promise` API. +deleteAccountContacts(deleteAccountContactsVars).then((response) => { + const data = response.data; + console.log(data.accountContact_deleteMany); +}); +``` + +### Using `DeleteAccountContacts`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteAccountContactsRef, DeleteAccountContactsVariables } from '@generated/data-connector-web'; + +// The `DeleteAccountContacts` mutation requires an argument of type `DeleteAccountContactsVariables`: +const deleteAccountContactsVars: DeleteAccountContactsVariables = { + accountId: ..., +}; + +// Call the `deleteAccountContactsRef()` function to get a reference to the mutation. +const ref = deleteAccountContactsRef(deleteAccountContactsVars); +// Variables can be defined inline as well. +const ref = deleteAccountContactsRef({ accountId: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteAccountContactsRef(dataConnect, deleteAccountContactsVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.accountContact_deleteMany); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.accountContact_deleteMany); +}); +``` + +## DeleteAccount +You can execute the `DeleteAccount` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteAccount(vars: DeleteAccountVariables): MutationPromise; + +interface DeleteAccountRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteAccountVariables): MutationRef; +} +export const deleteAccountRef: DeleteAccountRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteAccount(dc: DataConnect, vars: DeleteAccountVariables): MutationPromise; + +interface DeleteAccountRef { + ... + (dc: DataConnect, vars: DeleteAccountVariables): MutationRef; +} +export const deleteAccountRef: DeleteAccountRef; +``` + +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 deleteAccountRef: +```typescript +const name = deleteAccountRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteAccount` mutation requires an argument of type `DeleteAccountVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteAccountVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteAccount` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteAccountData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteAccountData { + account_delete?: Account_Key | null; +} +``` +### Using `DeleteAccount`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteAccount, DeleteAccountVariables } from '@generated/data-connector-web'; + +// The `DeleteAccount` mutation requires an argument of type `DeleteAccountVariables`: +const deleteAccountVars: DeleteAccountVariables = { + id: ..., +}; + +// Call the `deleteAccount()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteAccount(deleteAccountVars); +// Variables can be defined inline as well. +const { data } = await deleteAccount({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteAccount(dataConnect, deleteAccountVars); + +console.log(data.account_delete); + +// Or, you can use the `Promise` API. +deleteAccount(deleteAccountVars).then((response) => { + const data = response.data; + console.log(data.account_delete); +}); +``` + +### Using `DeleteAccount`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteAccountRef, DeleteAccountVariables } from '@generated/data-connector-web'; + +// The `DeleteAccount` mutation requires an argument of type `DeleteAccountVariables`: +const deleteAccountVars: DeleteAccountVariables = { + id: ..., +}; + +// Call the `deleteAccountRef()` function to get a reference to the mutation. +const ref = deleteAccountRef(deleteAccountVars); +// Variables can be defined inline as well. +const ref = deleteAccountRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteAccountRef(dataConnect, deleteAccountVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.account_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.account_delete); +}); +``` + +## CreateAccountContact +You can execute the `CreateAccountContact` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createAccountContact(vars: CreateAccountContactVariables): MutationPromise; + +interface CreateAccountContactRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateAccountContactVariables): MutationRef; +} +export const createAccountContactRef: CreateAccountContactRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createAccountContact(dc: DataConnect, vars: CreateAccountContactVariables): MutationPromise; + +interface CreateAccountContactRef { + ... + (dc: DataConnect, vars: CreateAccountContactVariables): MutationRef; +} +export const createAccountContactRef: CreateAccountContactRef; +``` + +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 createAccountContactRef: +```typescript +const name = createAccountContactRef.operationName; +console.log(name); +``` + +### Variables +The `CreateAccountContact` mutation requires an argument of type `CreateAccountContactVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateAccountContactVariables { + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; +} +``` +### Return Type +Recall that executing the `CreateAccountContact` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateAccountContactData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateAccountContactData { + accountContact_insert: AccountContact_Key; +} +``` +### Using `CreateAccountContact`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createAccountContact, CreateAccountContactVariables } from '@generated/data-connector-web'; + +// The `CreateAccountContact` mutation requires an argument of type `CreateAccountContactVariables`: +const createAccountContactVars: CreateAccountContactVariables = { + id: ..., + accountId: ..., + name: ..., + email: ..., // optional + phoneNumber: ..., // optional + role: ..., // optional +}; + +// Call the `createAccountContact()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createAccountContact(createAccountContactVars); +// Variables can be defined inline as well. +const { data } = await createAccountContact({ id: ..., accountId: ..., name: ..., email: ..., phoneNumber: ..., role: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createAccountContact(dataConnect, createAccountContactVars); + +console.log(data.accountContact_insert); + +// Or, you can use the `Promise` API. +createAccountContact(createAccountContactVars).then((response) => { + const data = response.data; + console.log(data.accountContact_insert); +}); +``` + +### Using `CreateAccountContact`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createAccountContactRef, CreateAccountContactVariables } from '@generated/data-connector-web'; + +// The `CreateAccountContact` mutation requires an argument of type `CreateAccountContactVariables`: +const createAccountContactVars: CreateAccountContactVariables = { + id: ..., + accountId: ..., + name: ..., + email: ..., // optional + phoneNumber: ..., // optional + role: ..., // optional +}; + +// Call the `createAccountContactRef()` function to get a reference to the mutation. +const ref = createAccountContactRef(createAccountContactVars); +// Variables can be defined inline as well. +const ref = createAccountContactRef({ id: ..., accountId: ..., name: ..., email: ..., phoneNumber: ..., role: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createAccountContactRef(dataConnect, createAccountContactVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.accountContact_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.accountContact_insert); +}); +``` + +## UpdateAccountContact +You can execute the `UpdateAccountContact` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateAccountContact(vars: UpdateAccountContactVariables): MutationPromise; + +interface UpdateAccountContactRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateAccountContactVariables): MutationRef; +} +export const updateAccountContactRef: UpdateAccountContactRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateAccountContact(dc: DataConnect, vars: UpdateAccountContactVariables): MutationPromise; + +interface UpdateAccountContactRef { + ... + (dc: DataConnect, vars: UpdateAccountContactVariables): MutationRef; +} +export const updateAccountContactRef: UpdateAccountContactRef; +``` + +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 updateAccountContactRef: +```typescript +const name = updateAccountContactRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateAccountContact` mutation requires an argument of type `UpdateAccountContactVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateAccountContactVariables { + id: UUIDString; + name?: string | null; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; +} +``` +### Return Type +Recall that executing the `UpdateAccountContact` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateAccountContactData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateAccountContactData { + accountContact_update?: AccountContact_Key | null; +} +``` +### Using `UpdateAccountContact`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateAccountContact, UpdateAccountContactVariables } from '@generated/data-connector-web'; + +// The `UpdateAccountContact` mutation requires an argument of type `UpdateAccountContactVariables`: +const updateAccountContactVars: UpdateAccountContactVariables = { + id: ..., + name: ..., // optional + email: ..., // optional + phoneNumber: ..., // optional + role: ..., // optional +}; + +// Call the `updateAccountContact()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateAccountContact(updateAccountContactVars); +// Variables can be defined inline as well. +const { data } = await updateAccountContact({ id: ..., name: ..., email: ..., phoneNumber: ..., role: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateAccountContact(dataConnect, updateAccountContactVars); + +console.log(data.accountContact_update); + +// Or, you can use the `Promise` API. +updateAccountContact(updateAccountContactVars).then((response) => { + const data = response.data; + console.log(data.accountContact_update); +}); +``` + +### Using `UpdateAccountContact`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateAccountContactRef, UpdateAccountContactVariables } from '@generated/data-connector-web'; + +// The `UpdateAccountContact` mutation requires an argument of type `UpdateAccountContactVariables`: +const updateAccountContactVars: UpdateAccountContactVariables = { + id: ..., + name: ..., // optional + email: ..., // optional + phoneNumber: ..., // optional + role: ..., // optional +}; + +// Call the `updateAccountContactRef()` function to get a reference to the mutation. +const ref = updateAccountContactRef(updateAccountContactVars); +// Variables can be defined inline as well. +const ref = updateAccountContactRef({ id: ..., name: ..., email: ..., phoneNumber: ..., role: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateAccountContactRef(dataConnect, updateAccountContactVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.accountContact_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.accountContact_update); +}); +``` + +## DeleteAccountContact +You can execute the `DeleteAccountContact` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteAccountContact(vars: DeleteAccountContactVariables): MutationPromise; + +interface DeleteAccountContactRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteAccountContactVariables): MutationRef; +} +export const deleteAccountContactRef: DeleteAccountContactRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteAccountContact(dc: DataConnect, vars: DeleteAccountContactVariables): MutationPromise; + +interface DeleteAccountContactRef { + ... + (dc: DataConnect, vars: DeleteAccountContactVariables): MutationRef; +} +export const deleteAccountContactRef: DeleteAccountContactRef; +``` + +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 deleteAccountContactRef: +```typescript +const name = deleteAccountContactRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteAccountContact` mutation requires an argument of type `DeleteAccountContactVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteAccountContactVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteAccountContact` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteAccountContactData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteAccountContactData { + accountContact_delete?: AccountContact_Key | null; +} +``` +### Using `DeleteAccountContact`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteAccountContact, DeleteAccountContactVariables } from '@generated/data-connector-web'; + +// The `DeleteAccountContact` mutation requires an argument of type `DeleteAccountContactVariables`: +const deleteAccountContactVars: DeleteAccountContactVariables = { + id: ..., +}; + +// Call the `deleteAccountContact()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteAccountContact(deleteAccountContactVars); +// Variables can be defined inline as well. +const { data } = await deleteAccountContact({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteAccountContact(dataConnect, deleteAccountContactVars); + +console.log(data.accountContact_delete); + +// Or, you can use the `Promise` API. +deleteAccountContact(deleteAccountContactVars).then((response) => { + const data = response.data; + console.log(data.accountContact_delete); +}); +``` + +### Using `DeleteAccountContact`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteAccountContactRef, DeleteAccountContactVariables } from '@generated/data-connector-web'; + +// The `DeleteAccountContact` mutation requires an argument of type `DeleteAccountContactVariables`: +const deleteAccountContactVars: DeleteAccountContactVariables = { + id: ..., +}; + +// Call the `deleteAccountContactRef()` function to get a reference to the mutation. +const ref = deleteAccountContactRef(deleteAccountContactVars); +// Variables can be defined inline as well. +const ref = deleteAccountContactRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteAccountContactRef(dataConnect, deleteAccountContactVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.accountContact_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.accountContact_delete); +}); +``` + +## CreateProjectFromUpload +You can execute the `CreateProjectFromUpload` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createProjectFromUpload(vars: CreateProjectFromUploadVariables): MutationPromise; + +interface CreateProjectFromUploadRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateProjectFromUploadVariables): MutationRef; +} +export const createProjectFromUploadRef: CreateProjectFromUploadRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createProjectFromUpload(dc: DataConnect, vars: CreateProjectFromUploadVariables): MutationPromise; + +interface CreateProjectFromUploadRef { + ... + (dc: DataConnect, vars: CreateProjectFromUploadVariables): MutationRef; +} +export const createProjectFromUploadRef: CreateProjectFromUploadRef; +``` + +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 createProjectFromUploadRef: +```typescript +const name = createProjectFromUploadRef.operationName; +console.log(name); +``` + +### Variables +The `CreateProjectFromUpload` mutation requires an argument of type `CreateProjectFromUploadVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateProjectFromUploadVariables { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus?: string | null; + pageCount: number; +} +``` +### Return Type +Recall that executing the `CreateProjectFromUpload` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateProjectFromUploadData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateProjectFromUploadData { + project_insert: Project_Key; +} +``` +### Using `CreateProjectFromUpload`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createProjectFromUpload, CreateProjectFromUploadVariables } from '@generated/data-connector-web'; + +// The `CreateProjectFromUpload` mutation requires an argument of type `CreateProjectFromUploadVariables`: +const createProjectFromUploadVars: CreateProjectFromUploadVariables = { + id: ..., + ownerId: ..., + accountId: ..., // optional + name: ..., + address: ..., // optional + originalFileName: ..., + uploadType: ..., + originalPath: ..., + status: ..., + salesStatus: ..., // optional + pageCount: ..., +}; + +// Call the `createProjectFromUpload()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createProjectFromUpload(createProjectFromUploadVars); +// Variables can be defined inline as well. +const { data } = await createProjectFromUpload({ id: ..., ownerId: ..., accountId: ..., name: ..., address: ..., originalFileName: ..., uploadType: ..., originalPath: ..., status: ..., salesStatus: ..., pageCount: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createProjectFromUpload(dataConnect, createProjectFromUploadVars); + +console.log(data.project_insert); + +// Or, you can use the `Promise` API. +createProjectFromUpload(createProjectFromUploadVars).then((response) => { + const data = response.data; + console.log(data.project_insert); +}); +``` + +### Using `CreateProjectFromUpload`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createProjectFromUploadRef, CreateProjectFromUploadVariables } from '@generated/data-connector-web'; + +// The `CreateProjectFromUpload` mutation requires an argument of type `CreateProjectFromUploadVariables`: +const createProjectFromUploadVars: CreateProjectFromUploadVariables = { + id: ..., + ownerId: ..., + accountId: ..., // optional + name: ..., + address: ..., // optional + originalFileName: ..., + uploadType: ..., + originalPath: ..., + status: ..., + salesStatus: ..., // optional + pageCount: ..., +}; + +// Call the `createProjectFromUploadRef()` function to get a reference to the mutation. +const ref = createProjectFromUploadRef(createProjectFromUploadVars); +// Variables can be defined inline as well. +const ref = createProjectFromUploadRef({ id: ..., ownerId: ..., accountId: ..., name: ..., address: ..., originalFileName: ..., uploadType: ..., originalPath: ..., status: ..., salesStatus: ..., pageCount: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createProjectFromUploadRef(dataConnect, createProjectFromUploadVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.project_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.project_insert); +}); +``` + +## UpdateProject +You can execute the `UpdateProject` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateProject(vars: UpdateProjectVariables): MutationPromise; + +interface UpdateProjectRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateProjectVariables): MutationRef; +} +export const updateProjectRef: UpdateProjectRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateProject(dc: DataConnect, vars: UpdateProjectVariables): MutationPromise; + +interface UpdateProjectRef { + ... + (dc: DataConnect, vars: UpdateProjectVariables): MutationRef; +} +export const updateProjectRef: UpdateProjectRef; +``` + +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 updateProjectRef: +```typescript +const name = updateProjectRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateProject` mutation requires an argument of type `UpdateProjectVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateProjectVariables { + id: UUIDString; + name?: string | null; + accountId?: UUIDString | null; + address?: string | null; + salesStatus?: string | null; +} +``` +### Return Type +Recall that executing the `UpdateProject` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateProjectData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateProjectData { + project_update?: Project_Key | null; +} +``` +### Using `UpdateProject`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateProject, UpdateProjectVariables } from '@generated/data-connector-web'; + +// The `UpdateProject` mutation requires an argument of type `UpdateProjectVariables`: +const updateProjectVars: UpdateProjectVariables = { + id: ..., + name: ..., // optional + accountId: ..., // optional + address: ..., // optional + salesStatus: ..., // optional +}; + +// Call the `updateProject()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateProject(updateProjectVars); +// Variables can be defined inline as well. +const { data } = await updateProject({ id: ..., name: ..., accountId: ..., address: ..., salesStatus: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateProject(dataConnect, updateProjectVars); + +console.log(data.project_update); + +// Or, you can use the `Promise` API. +updateProject(updateProjectVars).then((response) => { + const data = response.data; + console.log(data.project_update); +}); +``` + +### Using `UpdateProject`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateProjectRef, UpdateProjectVariables } from '@generated/data-connector-web'; + +// The `UpdateProject` mutation requires an argument of type `UpdateProjectVariables`: +const updateProjectVars: UpdateProjectVariables = { + id: ..., + name: ..., // optional + accountId: ..., // optional + address: ..., // optional + salesStatus: ..., // optional +}; + +// Call the `updateProjectRef()` function to get a reference to the mutation. +const ref = updateProjectRef(updateProjectVars); +// Variables can be defined inline as well. +const ref = updateProjectRef({ id: ..., name: ..., accountId: ..., address: ..., salesStatus: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateProjectRef(dataConnect, updateProjectVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.project_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.project_update); +}); +``` + +## RenameProject +You can execute the `RenameProject` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +renameProject(vars: RenameProjectVariables): MutationPromise; + +interface RenameProjectRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: RenameProjectVariables): MutationRef; +} +export const renameProjectRef: RenameProjectRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +renameProject(dc: DataConnect, vars: RenameProjectVariables): MutationPromise; + +interface RenameProjectRef { + ... + (dc: DataConnect, vars: RenameProjectVariables): MutationRef; +} +export const renameProjectRef: RenameProjectRef; +``` + +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 renameProjectRef: +```typescript +const name = renameProjectRef.operationName; +console.log(name); +``` + +### Variables +The `RenameProject` mutation requires an argument of type `RenameProjectVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface RenameProjectVariables { + id: UUIDString; + name: string; +} +``` +### Return Type +Recall that executing the `RenameProject` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `RenameProjectData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface RenameProjectData { + project_update?: Project_Key | null; +} +``` +### Using `RenameProject`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, renameProject, RenameProjectVariables } from '@generated/data-connector-web'; + +// The `RenameProject` mutation requires an argument of type `RenameProjectVariables`: +const renameProjectVars: RenameProjectVariables = { + id: ..., + name: ..., +}; + +// Call the `renameProject()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await renameProject(renameProjectVars); +// Variables can be defined inline as well. +const { data } = await renameProject({ id: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await renameProject(dataConnect, renameProjectVars); + +console.log(data.project_update); + +// Or, you can use the `Promise` API. +renameProject(renameProjectVars).then((response) => { + const data = response.data; + console.log(data.project_update); +}); +``` + +### Using `RenameProject`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, renameProjectRef, RenameProjectVariables } from '@generated/data-connector-web'; + +// The `RenameProject` mutation requires an argument of type `RenameProjectVariables`: +const renameProjectVars: RenameProjectVariables = { + id: ..., + name: ..., +}; + +// Call the `renameProjectRef()` function to get a reference to the mutation. +const ref = renameProjectRef(renameProjectVars); +// Variables can be defined inline as well. +const ref = renameProjectRef({ id: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = renameProjectRef(dataConnect, renameProjectVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.project_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.project_update); +}); +``` + +## TouchProject +You can execute the `TouchProject` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +touchProject(vars: TouchProjectVariables): MutationPromise; + +interface TouchProjectRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: TouchProjectVariables): MutationRef; +} +export const touchProjectRef: TouchProjectRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +touchProject(dc: DataConnect, vars: TouchProjectVariables): MutationPromise; + +interface TouchProjectRef { + ... + (dc: DataConnect, vars: TouchProjectVariables): MutationRef; +} +export const touchProjectRef: TouchProjectRef; +``` + +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 touchProjectRef: +```typescript +const name = touchProjectRef.operationName; +console.log(name); +``` + +### Variables +The `TouchProject` mutation requires an argument of type `TouchProjectVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface TouchProjectVariables { + id: UUIDString; + status?: string | null; + processingError?: string | null; +} +``` +### Return Type +Recall that executing the `TouchProject` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `TouchProjectData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface TouchProjectData { + project_update?: Project_Key | null; +} +``` +### Using `TouchProject`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, touchProject, TouchProjectVariables } from '@generated/data-connector-web'; + +// The `TouchProject` mutation requires an argument of type `TouchProjectVariables`: +const touchProjectVars: TouchProjectVariables = { + id: ..., + status: ..., // optional + processingError: ..., // optional +}; + +// Call the `touchProject()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await touchProject(touchProjectVars); +// Variables can be defined inline as well. +const { data } = await touchProject({ id: ..., status: ..., processingError: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await touchProject(dataConnect, touchProjectVars); + +console.log(data.project_update); + +// Or, you can use the `Promise` API. +touchProject(touchProjectVars).then((response) => { + const data = response.data; + console.log(data.project_update); +}); +``` + +### Using `TouchProject`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, touchProjectRef, TouchProjectVariables } from '@generated/data-connector-web'; + +// The `TouchProject` mutation requires an argument of type `TouchProjectVariables`: +const touchProjectVars: TouchProjectVariables = { + id: ..., + status: ..., // optional + processingError: ..., // optional +}; + +// Call the `touchProjectRef()` function to get a reference to the mutation. +const ref = touchProjectRef(touchProjectVars); +// Variables can be defined inline as well. +const ref = touchProjectRef({ id: ..., status: ..., processingError: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = touchProjectRef(dataConnect, touchProjectVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.project_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.project_update); +}); +``` + +## DeleteFloorplanPages +You can execute the `DeleteFloorplanPages` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteFloorplanPages(vars: DeleteFloorplanPagesVariables): MutationPromise; + +interface DeleteFloorplanPagesRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteFloorplanPagesVariables): MutationRef; +} +export const deleteFloorplanPagesRef: DeleteFloorplanPagesRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteFloorplanPages(dc: DataConnect, vars: DeleteFloorplanPagesVariables): MutationPromise; + +interface DeleteFloorplanPagesRef { + ... + (dc: DataConnect, vars: DeleteFloorplanPagesVariables): MutationRef; +} +export const deleteFloorplanPagesRef: DeleteFloorplanPagesRef; +``` + +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 deleteFloorplanPagesRef: +```typescript +const name = deleteFloorplanPagesRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteFloorplanPages` mutation requires an argument of type `DeleteFloorplanPagesVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteFloorplanPagesVariables { + projectId: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteFloorplanPages` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteFloorplanPagesData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteFloorplanPagesData { + floorplanPage_deleteMany: number; +} +``` +### Using `DeleteFloorplanPages`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteFloorplanPages, DeleteFloorplanPagesVariables } from '@generated/data-connector-web'; + +// The `DeleteFloorplanPages` mutation requires an argument of type `DeleteFloorplanPagesVariables`: +const deleteFloorplanPagesVars: DeleteFloorplanPagesVariables = { + projectId: ..., +}; + +// Call the `deleteFloorplanPages()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteFloorplanPages(deleteFloorplanPagesVars); +// Variables can be defined inline as well. +const { data } = await deleteFloorplanPages({ projectId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteFloorplanPages(dataConnect, deleteFloorplanPagesVars); + +console.log(data.floorplanPage_deleteMany); + +// Or, you can use the `Promise` API. +deleteFloorplanPages(deleteFloorplanPagesVars).then((response) => { + const data = response.data; + console.log(data.floorplanPage_deleteMany); +}); +``` + +### Using `DeleteFloorplanPages`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteFloorplanPagesRef, DeleteFloorplanPagesVariables } from '@generated/data-connector-web'; + +// The `DeleteFloorplanPages` mutation requires an argument of type `DeleteFloorplanPagesVariables`: +const deleteFloorplanPagesVars: DeleteFloorplanPagesVariables = { + projectId: ..., +}; + +// Call the `deleteFloorplanPagesRef()` function to get a reference to the mutation. +const ref = deleteFloorplanPagesRef(deleteFloorplanPagesVars); +// Variables can be defined inline as well. +const ref = deleteFloorplanPagesRef({ projectId: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteFloorplanPagesRef(dataConnect, deleteFloorplanPagesVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.floorplanPage_deleteMany); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.floorplanPage_deleteMany); +}); +``` + +## DeleteProject +You can execute the `DeleteProject` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteProject(vars: DeleteProjectVariables): MutationPromise; + +interface DeleteProjectRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteProjectVariables): MutationRef; +} +export const deleteProjectRef: DeleteProjectRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteProject(dc: DataConnect, vars: DeleteProjectVariables): MutationPromise; + +interface DeleteProjectRef { + ... + (dc: DataConnect, vars: DeleteProjectVariables): MutationRef; +} +export const deleteProjectRef: DeleteProjectRef; +``` + +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 deleteProjectRef: +```typescript +const name = deleteProjectRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteProject` mutation requires an argument of type `DeleteProjectVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteProjectVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteProject` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteProjectData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteProjectData { + project_delete?: Project_Key | null; +} +``` +### Using `DeleteProject`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteProject, DeleteProjectVariables } from '@generated/data-connector-web'; + +// The `DeleteProject` mutation requires an argument of type `DeleteProjectVariables`: +const deleteProjectVars: DeleteProjectVariables = { + id: ..., +}; + +// Call the `deleteProject()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteProject(deleteProjectVars); +// Variables can be defined inline as well. +const { data } = await deleteProject({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteProject(dataConnect, deleteProjectVars); + +console.log(data.project_delete); + +// Or, you can use the `Promise` API. +deleteProject(deleteProjectVars).then((response) => { + const data = response.data; + console.log(data.project_delete); +}); +``` + +### Using `DeleteProject`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteProjectRef, DeleteProjectVariables } from '@generated/data-connector-web'; + +// The `DeleteProject` mutation requires an argument of type `DeleteProjectVariables`: +const deleteProjectVars: DeleteProjectVariables = { + id: ..., +}; + +// Call the `deleteProjectRef()` function to get a reference to the mutation. +const ref = deleteProjectRef(deleteProjectVars); +// Variables can be defined inline as well. +const ref = deleteProjectRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteProjectRef(dataConnect, deleteProjectVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.project_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.project_delete); +}); +``` + +## CreateFloorplanPage +You can execute the `CreateFloorplanPage` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createFloorplanPage(vars: CreateFloorplanPageVariables): MutationPromise; + +interface CreateFloorplanPageRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateFloorplanPageVariables): MutationRef; +} +export const createFloorplanPageRef: CreateFloorplanPageRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createFloorplanPage(dc: DataConnect, vars: CreateFloorplanPageVariables): MutationPromise; + +interface CreateFloorplanPageRef { + ... + (dc: DataConnect, vars: CreateFloorplanPageVariables): MutationRef; +} +export const createFloorplanPageRef: CreateFloorplanPageRef; +``` + +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 createFloorplanPageRef: +```typescript +const name = createFloorplanPageRef.operationName; +console.log(name); +``` + +### Variables +The `CreateFloorplanPage` mutation requires an argument of type `CreateFloorplanPageVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateFloorplanPageVariables { + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; +} +``` +### Return Type +Recall that executing the `CreateFloorplanPage` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateFloorplanPageData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateFloorplanPageData { + floorplanPage_insert: FloorplanPage_Key; +} +``` +### Using `CreateFloorplanPage`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createFloorplanPage, CreateFloorplanPageVariables } from '@generated/data-connector-web'; + +// The `CreateFloorplanPage` mutation requires an argument of type `CreateFloorplanPageVariables`: +const createFloorplanPageVars: CreateFloorplanPageVariables = { + projectId: ..., + pageNumber: ..., + status: ..., + processingError: ..., // optional + sourceImagePath: ..., // optional + previewImagePath: ..., // optional + rawJsonPath: ..., // optional + rawFloorplanPath: ..., // optional + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional + processingStrategy: ..., // optional + processingMetadataJson: ..., // optional +}; + +// Call the `createFloorplanPage()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createFloorplanPage(createFloorplanPageVars); +// Variables can be defined inline as well. +const { data } = await createFloorplanPage({ projectId: ..., pageNumber: ..., status: ..., processingError: ..., sourceImagePath: ..., previewImagePath: ..., rawJsonPath: ..., rawFloorplanPath: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., processingStrategy: ..., processingMetadataJson: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createFloorplanPage(dataConnect, createFloorplanPageVars); + +console.log(data.floorplanPage_insert); + +// Or, you can use the `Promise` API. +createFloorplanPage(createFloorplanPageVars).then((response) => { + const data = response.data; + console.log(data.floorplanPage_insert); +}); +``` + +### Using `CreateFloorplanPage`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createFloorplanPageRef, CreateFloorplanPageVariables } from '@generated/data-connector-web'; + +// The `CreateFloorplanPage` mutation requires an argument of type `CreateFloorplanPageVariables`: +const createFloorplanPageVars: CreateFloorplanPageVariables = { + projectId: ..., + pageNumber: ..., + status: ..., + processingError: ..., // optional + sourceImagePath: ..., // optional + previewImagePath: ..., // optional + rawJsonPath: ..., // optional + rawFloorplanPath: ..., // optional + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional + processingStrategy: ..., // optional + processingMetadataJson: ..., // optional +}; + +// Call the `createFloorplanPageRef()` function to get a reference to the mutation. +const ref = createFloorplanPageRef(createFloorplanPageVars); +// Variables can be defined inline as well. +const ref = createFloorplanPageRef({ projectId: ..., pageNumber: ..., status: ..., processingError: ..., sourceImagePath: ..., previewImagePath: ..., rawJsonPath: ..., rawFloorplanPath: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., processingStrategy: ..., processingMetadataJson: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createFloorplanPageRef(dataConnect, createFloorplanPageVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.floorplanPage_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.floorplanPage_insert); +}); +``` + +## UpdateFloorplanPageAnalysis +You can execute the `UpdateFloorplanPageAnalysis` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateFloorplanPageAnalysis(vars: UpdateFloorplanPageAnalysisVariables): MutationPromise; + +interface UpdateFloorplanPageAnalysisRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateFloorplanPageAnalysisVariables): MutationRef; +} +export const updateFloorplanPageAnalysisRef: UpdateFloorplanPageAnalysisRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateFloorplanPageAnalysis(dc: DataConnect, vars: UpdateFloorplanPageAnalysisVariables): MutationPromise; + +interface UpdateFloorplanPageAnalysisRef { + ... + (dc: DataConnect, vars: UpdateFloorplanPageAnalysisVariables): MutationRef; +} +export const updateFloorplanPageAnalysisRef: UpdateFloorplanPageAnalysisRef; +``` + +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 updateFloorplanPageAnalysisRef: +```typescript +const name = updateFloorplanPageAnalysisRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateFloorplanPageAnalysis` mutation requires an argument of type `UpdateFloorplanPageAnalysisVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateFloorplanPageAnalysisVariables { + id: UUIDString; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; +} +``` +### Return Type +Recall that executing the `UpdateFloorplanPageAnalysis` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateFloorplanPageAnalysisData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateFloorplanPageAnalysisData { + floorplanPage_update?: FloorplanPage_Key | null; +} +``` +### Using `UpdateFloorplanPageAnalysis`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateFloorplanPageAnalysis, UpdateFloorplanPageAnalysisVariables } from '@generated/data-connector-web'; + +// The `UpdateFloorplanPageAnalysis` mutation requires an argument of type `UpdateFloorplanPageAnalysisVariables`: +const updateFloorplanPageAnalysisVars: UpdateFloorplanPageAnalysisVariables = { + id: ..., + status: ..., + processingError: ..., // optional + sourceImagePath: ..., // optional + previewImagePath: ..., // optional + rawJsonPath: ..., // optional + rawFloorplanPath: ..., // optional + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional + processingStrategy: ..., // optional + processingMetadataJson: ..., // optional +}; + +// Call the `updateFloorplanPageAnalysis()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateFloorplanPageAnalysis(updateFloorplanPageAnalysisVars); +// Variables can be defined inline as well. +const { data } = await updateFloorplanPageAnalysis({ id: ..., status: ..., processingError: ..., sourceImagePath: ..., previewImagePath: ..., rawJsonPath: ..., rawFloorplanPath: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., processingStrategy: ..., processingMetadataJson: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateFloorplanPageAnalysis(dataConnect, updateFloorplanPageAnalysisVars); + +console.log(data.floorplanPage_update); + +// Or, you can use the `Promise` API. +updateFloorplanPageAnalysis(updateFloorplanPageAnalysisVars).then((response) => { + const data = response.data; + console.log(data.floorplanPage_update); +}); +``` + +### Using `UpdateFloorplanPageAnalysis`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateFloorplanPageAnalysisRef, UpdateFloorplanPageAnalysisVariables } from '@generated/data-connector-web'; + +// The `UpdateFloorplanPageAnalysis` mutation requires an argument of type `UpdateFloorplanPageAnalysisVariables`: +const updateFloorplanPageAnalysisVars: UpdateFloorplanPageAnalysisVariables = { + id: ..., + status: ..., + processingError: ..., // optional + sourceImagePath: ..., // optional + previewImagePath: ..., // optional + rawJsonPath: ..., // optional + rawFloorplanPath: ..., // optional + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional + processingStrategy: ..., // optional + processingMetadataJson: ..., // optional +}; + +// Call the `updateFloorplanPageAnalysisRef()` function to get a reference to the mutation. +const ref = updateFloorplanPageAnalysisRef(updateFloorplanPageAnalysisVars); +// Variables can be defined inline as well. +const ref = updateFloorplanPageAnalysisRef({ id: ..., status: ..., processingError: ..., sourceImagePath: ..., previewImagePath: ..., rawJsonPath: ..., rawFloorplanPath: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., processingStrategy: ..., processingMetadataJson: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateFloorplanPageAnalysisRef(dataConnect, updateFloorplanPageAnalysisVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.floorplanPage_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.floorplanPage_update); +}); +``` + +## UpdateFloorplanPage +You can execute the `UpdateFloorplanPage` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateFloorplanPage(vars: UpdateFloorplanPageVariables): MutationPromise; + +interface UpdateFloorplanPageRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateFloorplanPageVariables): MutationRef; +} +export const updateFloorplanPageRef: UpdateFloorplanPageRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateFloorplanPage(dc: DataConnect, vars: UpdateFloorplanPageVariables): MutationPromise; + +interface UpdateFloorplanPageRef { + ... + (dc: DataConnect, vars: UpdateFloorplanPageVariables): MutationRef; +} +export const updateFloorplanPageRef: UpdateFloorplanPageRef; +``` + +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 updateFloorplanPageRef: +```typescript +const name = updateFloorplanPageRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateFloorplanPage` mutation requires an argument of type `UpdateFloorplanPageVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateFloorplanPageVariables { + id: UUIDString; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; +} +``` +### Return Type +Recall that executing the `UpdateFloorplanPage` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateFloorplanPageData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateFloorplanPageData { + floorplanPage_update?: FloorplanPage_Key | null; +} +``` +### Using `UpdateFloorplanPage`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateFloorplanPage, UpdateFloorplanPageVariables } from '@generated/data-connector-web'; + +// The `UpdateFloorplanPage` mutation requires an argument of type `UpdateFloorplanPageVariables`: +const updateFloorplanPageVars: UpdateFloorplanPageVariables = { + id: ..., + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional +}; + +// Call the `updateFloorplanPage()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateFloorplanPage(updateFloorplanPageVars); +// Variables can be defined inline as well. +const { data } = await updateFloorplanPage({ id: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateFloorplanPage(dataConnect, updateFloorplanPageVars); + +console.log(data.floorplanPage_update); + +// Or, you can use the `Promise` API. +updateFloorplanPage(updateFloorplanPageVars).then((response) => { + const data = response.data; + console.log(data.floorplanPage_update); +}); +``` + +### Using `UpdateFloorplanPage`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateFloorplanPageRef, UpdateFloorplanPageVariables } from '@generated/data-connector-web'; + +// The `UpdateFloorplanPage` mutation requires an argument of type `UpdateFloorplanPageVariables`: +const updateFloorplanPageVars: UpdateFloorplanPageVariables = { + id: ..., + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional +}; + +// Call the `updateFloorplanPageRef()` function to get a reference to the mutation. +const ref = updateFloorplanPageRef(updateFloorplanPageVars); +// Variables can be defined inline as well. +const ref = updateFloorplanPageRef({ id: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateFloorplanPageRef(dataConnect, updateFloorplanPageVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.floorplanPage_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.floorplanPage_update); +}); +``` + +## UpdateFloorplanPages +You can execute the `UpdateFloorplanPages` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateFloorplanPages(vars: UpdateFloorplanPagesVariables): MutationPromise; + +interface UpdateFloorplanPagesRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateFloorplanPagesVariables): MutationRef; +} +export const updateFloorplanPagesRef: UpdateFloorplanPagesRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateFloorplanPages(dc: DataConnect, vars: UpdateFloorplanPagesVariables): MutationPromise; + +interface UpdateFloorplanPagesRef { + ... + (dc: DataConnect, vars: UpdateFloorplanPagesVariables): MutationRef; +} +export const updateFloorplanPagesRef: UpdateFloorplanPagesRef; +``` + +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 updateFloorplanPagesRef: +```typescript +const name = updateFloorplanPagesRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateFloorplanPages` mutation requires an argument of type `UpdateFloorplanPagesVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateFloorplanPagesVariables { + projectId: UUIDString; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; +} +``` +### Return Type +Recall that executing the `UpdateFloorplanPages` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateFloorplanPagesData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateFloorplanPagesData { + floorplanPage_updateMany: number; +} +``` +### Using `UpdateFloorplanPages`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateFloorplanPages, UpdateFloorplanPagesVariables } from '@generated/data-connector-web'; + +// The `UpdateFloorplanPages` mutation requires an argument of type `UpdateFloorplanPagesVariables`: +const updateFloorplanPagesVars: UpdateFloorplanPagesVariables = { + projectId: ..., + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional +}; + +// Call the `updateFloorplanPages()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateFloorplanPages(updateFloorplanPagesVars); +// Variables can be defined inline as well. +const { data } = await updateFloorplanPages({ projectId: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateFloorplanPages(dataConnect, updateFloorplanPagesVars); + +console.log(data.floorplanPage_updateMany); + +// Or, you can use the `Promise` API. +updateFloorplanPages(updateFloorplanPagesVars).then((response) => { + const data = response.data; + console.log(data.floorplanPage_updateMany); +}); +``` + +### Using `UpdateFloorplanPages`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateFloorplanPagesRef, UpdateFloorplanPagesVariables } from '@generated/data-connector-web'; + +// The `UpdateFloorplanPages` mutation requires an argument of type `UpdateFloorplanPagesVariables`: +const updateFloorplanPagesVars: UpdateFloorplanPagesVariables = { + projectId: ..., + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional +}; + +// Call the `updateFloorplanPagesRef()` function to get a reference to the mutation. +const ref = updateFloorplanPagesRef(updateFloorplanPagesVars); +// Variables can be defined inline as well. +const ref = updateFloorplanPagesRef({ projectId: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateFloorplanPagesRef(dataConnect, updateFloorplanPagesVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.floorplanPage_updateMany); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.floorplanPage_updateMany); +}); +``` + +## CreateQuestionnaireTemplate +You can execute the `CreateQuestionnaireTemplate` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createQuestionnaireTemplate(vars: CreateQuestionnaireTemplateVariables): MutationPromise; + +interface CreateQuestionnaireTemplateRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuestionnaireTemplateVariables): MutationRef; +} +export const createQuestionnaireTemplateRef: CreateQuestionnaireTemplateRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createQuestionnaireTemplate(dc: DataConnect, vars: CreateQuestionnaireTemplateVariables): MutationPromise; + +interface CreateQuestionnaireTemplateRef { + ... + (dc: DataConnect, vars: CreateQuestionnaireTemplateVariables): MutationRef; +} +export const createQuestionnaireTemplateRef: CreateQuestionnaireTemplateRef; +``` + +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 createQuestionnaireTemplateRef: +```typescript +const name = createQuestionnaireTemplateRef.operationName; +console.log(name); +``` + +### Variables +The `CreateQuestionnaireTemplate` mutation requires an argument of type `CreateQuestionnaireTemplateVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateQuestionnaireTemplateVariables { + id: UUIDString; + name: string; +} +``` +### Return Type +Recall that executing the `CreateQuestionnaireTemplate` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateQuestionnaireTemplateData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateQuestionnaireTemplateData { + questionnaireTemplate_insert: QuestionnaireTemplate_Key; +} +``` +### Using `CreateQuestionnaireTemplate`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createQuestionnaireTemplate, CreateQuestionnaireTemplateVariables } from '@generated/data-connector-web'; + +// The `CreateQuestionnaireTemplate` mutation requires an argument of type `CreateQuestionnaireTemplateVariables`: +const createQuestionnaireTemplateVars: CreateQuestionnaireTemplateVariables = { + id: ..., + name: ..., +}; + +// Call the `createQuestionnaireTemplate()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createQuestionnaireTemplate(createQuestionnaireTemplateVars); +// Variables can be defined inline as well. +const { data } = await createQuestionnaireTemplate({ id: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createQuestionnaireTemplate(dataConnect, createQuestionnaireTemplateVars); + +console.log(data.questionnaireTemplate_insert); + +// Or, you can use the `Promise` API. +createQuestionnaireTemplate(createQuestionnaireTemplateVars).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplate_insert); +}); +``` + +### Using `CreateQuestionnaireTemplate`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createQuestionnaireTemplateRef, CreateQuestionnaireTemplateVariables } from '@generated/data-connector-web'; + +// The `CreateQuestionnaireTemplate` mutation requires an argument of type `CreateQuestionnaireTemplateVariables`: +const createQuestionnaireTemplateVars: CreateQuestionnaireTemplateVariables = { + id: ..., + name: ..., +}; + +// Call the `createQuestionnaireTemplateRef()` function to get a reference to the mutation. +const ref = createQuestionnaireTemplateRef(createQuestionnaireTemplateVars); +// Variables can be defined inline as well. +const ref = createQuestionnaireTemplateRef({ id: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createQuestionnaireTemplateRef(dataConnect, createQuestionnaireTemplateVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.questionnaireTemplate_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplate_insert); +}); +``` + +## CreateQuestionnaireTemplateQuestion +You can execute the `CreateQuestionnaireTemplateQuestion` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createQuestionnaireTemplateQuestion(vars: CreateQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface CreateQuestionnaireTemplateQuestionRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuestionnaireTemplateQuestionVariables): MutationRef; +} +export const createQuestionnaireTemplateQuestionRef: CreateQuestionnaireTemplateQuestionRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createQuestionnaireTemplateQuestion(dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface CreateQuestionnaireTemplateQuestionRef { + ... + (dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables): MutationRef; +} +export const createQuestionnaireTemplateQuestionRef: CreateQuestionnaireTemplateQuestionRef; +``` + +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 createQuestionnaireTemplateQuestionRef: +```typescript +const name = createQuestionnaireTemplateQuestionRef.operationName; +console.log(name); +``` + +### Variables +The `CreateQuestionnaireTemplateQuestion` mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; + label: string; + position: number; + description?: string | null; +} +``` +### Return Type +Recall that executing the `CreateQuestionnaireTemplateQuestion` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateQuestionnaireTemplateQuestionData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_insert: QuestionnaireTemplateQuestion_Key; +} +``` +### Using `CreateQuestionnaireTemplateQuestion`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createQuestionnaireTemplateQuestion, CreateQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; + +// The `CreateQuestionnaireTemplateQuestion` mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`: +const createQuestionnaireTemplateQuestionVars: CreateQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., + label: ..., + position: ..., + description: ..., // optional +}; + +// Call the `createQuestionnaireTemplateQuestion()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createQuestionnaireTemplateQuestion(createQuestionnaireTemplateQuestionVars); +// Variables can be defined inline as well. +const { data } = await createQuestionnaireTemplateQuestion({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createQuestionnaireTemplateQuestion(dataConnect, createQuestionnaireTemplateQuestionVars); + +console.log(data.questionnaireTemplateQuestion_insert); + +// Or, you can use the `Promise` API. +createQuestionnaireTemplateQuestion(createQuestionnaireTemplateQuestionVars).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplateQuestion_insert); +}); +``` + +### Using `CreateQuestionnaireTemplateQuestion`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createQuestionnaireTemplateQuestionRef, CreateQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; + +// The `CreateQuestionnaireTemplateQuestion` mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`: +const createQuestionnaireTemplateQuestionVars: CreateQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., + label: ..., + position: ..., + description: ..., // optional +}; + +// Call the `createQuestionnaireTemplateQuestionRef()` function to get a reference to the mutation. +const ref = createQuestionnaireTemplateQuestionRef(createQuestionnaireTemplateQuestionVars); +// Variables can be defined inline as well. +const ref = createQuestionnaireTemplateQuestionRef({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createQuestionnaireTemplateQuestionRef(dataConnect, createQuestionnaireTemplateQuestionVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.questionnaireTemplateQuestion_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplateQuestion_insert); +}); +``` + +## UpdateQuestionnaireTemplateName +You can execute the `UpdateQuestionnaireTemplateName` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateQuestionnaireTemplateName(vars: UpdateQuestionnaireTemplateNameVariables): MutationPromise; + +interface UpdateQuestionnaireTemplateNameRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuestionnaireTemplateNameVariables): MutationRef; +} +export const updateQuestionnaireTemplateNameRef: UpdateQuestionnaireTemplateNameRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateQuestionnaireTemplateName(dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables): MutationPromise; + +interface UpdateQuestionnaireTemplateNameRef { + ... + (dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables): MutationRef; +} +export const updateQuestionnaireTemplateNameRef: UpdateQuestionnaireTemplateNameRef; +``` + +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 updateQuestionnaireTemplateNameRef: +```typescript +const name = updateQuestionnaireTemplateNameRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateQuestionnaireTemplateName` mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateQuestionnaireTemplateNameVariables { + id: UUIDString; + name: string; +} +``` +### Return Type +Recall that executing the `UpdateQuestionnaireTemplateName` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateQuestionnaireTemplateNameData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateQuestionnaireTemplateNameData { + questionnaireTemplate_update?: QuestionnaireTemplate_Key | null; +} +``` +### Using `UpdateQuestionnaireTemplateName`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateQuestionnaireTemplateName, UpdateQuestionnaireTemplateNameVariables } from '@generated/data-connector-web'; + +// The `UpdateQuestionnaireTemplateName` mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`: +const updateQuestionnaireTemplateNameVars: UpdateQuestionnaireTemplateNameVariables = { + id: ..., + name: ..., +}; + +// Call the `updateQuestionnaireTemplateName()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateQuestionnaireTemplateName(updateQuestionnaireTemplateNameVars); +// Variables can be defined inline as well. +const { data } = await updateQuestionnaireTemplateName({ id: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateQuestionnaireTemplateName(dataConnect, updateQuestionnaireTemplateNameVars); + +console.log(data.questionnaireTemplate_update); + +// Or, you can use the `Promise` API. +updateQuestionnaireTemplateName(updateQuestionnaireTemplateNameVars).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplate_update); +}); +``` + +### Using `UpdateQuestionnaireTemplateName`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateQuestionnaireTemplateNameRef, UpdateQuestionnaireTemplateNameVariables } from '@generated/data-connector-web'; + +// The `UpdateQuestionnaireTemplateName` mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`: +const updateQuestionnaireTemplateNameVars: UpdateQuestionnaireTemplateNameVariables = { + id: ..., + name: ..., +}; + +// Call the `updateQuestionnaireTemplateNameRef()` function to get a reference to the mutation. +const ref = updateQuestionnaireTemplateNameRef(updateQuestionnaireTemplateNameVars); +// Variables can be defined inline as well. +const ref = updateQuestionnaireTemplateNameRef({ id: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateQuestionnaireTemplateNameRef(dataConnect, updateQuestionnaireTemplateNameVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.questionnaireTemplate_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplate_update); +}); +``` + +## UpdateQuestionnaireTemplateQuestion +You can execute the `UpdateQuestionnaireTemplateQuestion` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateQuestionnaireTemplateQuestion(vars: UpdateQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface UpdateQuestionnaireTemplateQuestionRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuestionnaireTemplateQuestionVariables): MutationRef; +} +export const updateQuestionnaireTemplateQuestionRef: UpdateQuestionnaireTemplateQuestionRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateQuestionnaireTemplateQuestion(dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface UpdateQuestionnaireTemplateQuestionRef { + ... + (dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables): MutationRef; +} +export const updateQuestionnaireTemplateQuestionRef: UpdateQuestionnaireTemplateQuestionRef; +``` + +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 updateQuestionnaireTemplateQuestionRef: +```typescript +const name = updateQuestionnaireTemplateQuestionRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateQuestionnaireTemplateQuestion` mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; + label: string; + position: number; + description?: string | null; +} +``` +### Return Type +Recall that executing the `UpdateQuestionnaireTemplateQuestion` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateQuestionnaireTemplateQuestionData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_update?: QuestionnaireTemplateQuestion_Key | null; +} +``` +### Using `UpdateQuestionnaireTemplateQuestion`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateQuestionnaireTemplateQuestion, UpdateQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; + +// The `UpdateQuestionnaireTemplateQuestion` mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`: +const updateQuestionnaireTemplateQuestionVars: UpdateQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., + label: ..., + position: ..., + description: ..., // optional +}; + +// Call the `updateQuestionnaireTemplateQuestion()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateQuestionnaireTemplateQuestion(updateQuestionnaireTemplateQuestionVars); +// Variables can be defined inline as well. +const { data } = await updateQuestionnaireTemplateQuestion({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateQuestionnaireTemplateQuestion(dataConnect, updateQuestionnaireTemplateQuestionVars); + +console.log(data.questionnaireTemplateQuestion_update); + +// Or, you can use the `Promise` API. +updateQuestionnaireTemplateQuestion(updateQuestionnaireTemplateQuestionVars).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplateQuestion_update); +}); +``` + +### Using `UpdateQuestionnaireTemplateQuestion`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateQuestionnaireTemplateQuestionRef, UpdateQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; + +// The `UpdateQuestionnaireTemplateQuestion` mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`: +const updateQuestionnaireTemplateQuestionVars: UpdateQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., + label: ..., + position: ..., + description: ..., // optional +}; + +// Call the `updateQuestionnaireTemplateQuestionRef()` function to get a reference to the mutation. +const ref = updateQuestionnaireTemplateQuestionRef(updateQuestionnaireTemplateQuestionVars); +// Variables can be defined inline as well. +const ref = updateQuestionnaireTemplateQuestionRef({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateQuestionnaireTemplateQuestionRef(dataConnect, updateQuestionnaireTemplateQuestionVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.questionnaireTemplateQuestion_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplateQuestion_update); +}); +``` + +## DeleteQuestionnaireTemplateQuestion +You can execute the `DeleteQuestionnaireTemplateQuestion` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteQuestionnaireTemplateQuestion(vars: DeleteQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface DeleteQuestionnaireTemplateQuestionRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteQuestionnaireTemplateQuestionVariables): MutationRef; +} +export const deleteQuestionnaireTemplateQuestionRef: DeleteQuestionnaireTemplateQuestionRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteQuestionnaireTemplateQuestion(dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface DeleteQuestionnaireTemplateQuestionRef { + ... + (dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables): MutationRef; +} +export const deleteQuestionnaireTemplateQuestionRef: DeleteQuestionnaireTemplateQuestionRef; +``` + +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 deleteQuestionnaireTemplateQuestionRef: +```typescript +const name = deleteQuestionnaireTemplateQuestionRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteQuestionnaireTemplateQuestion` mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteQuestionnaireTemplateQuestion` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteQuestionnaireTemplateQuestionData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_delete?: QuestionnaireTemplateQuestion_Key | null; +} +``` +### Using `DeleteQuestionnaireTemplateQuestion`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteQuestionnaireTemplateQuestion, DeleteQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; + +// The `DeleteQuestionnaireTemplateQuestion` mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`: +const deleteQuestionnaireTemplateQuestionVars: DeleteQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., +}; + +// Call the `deleteQuestionnaireTemplateQuestion()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteQuestionnaireTemplateQuestion(deleteQuestionnaireTemplateQuestionVars); +// Variables can be defined inline as well. +const { data } = await deleteQuestionnaireTemplateQuestion({ id: ..., templateId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteQuestionnaireTemplateQuestion(dataConnect, deleteQuestionnaireTemplateQuestionVars); + +console.log(data.questionnaireTemplateQuestion_delete); + +// Or, you can use the `Promise` API. +deleteQuestionnaireTemplateQuestion(deleteQuestionnaireTemplateQuestionVars).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplateQuestion_delete); +}); +``` + +### Using `DeleteQuestionnaireTemplateQuestion`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteQuestionnaireTemplateQuestionRef, DeleteQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; + +// The `DeleteQuestionnaireTemplateQuestion` mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`: +const deleteQuestionnaireTemplateQuestionVars: DeleteQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., +}; + +// Call the `deleteQuestionnaireTemplateQuestionRef()` function to get a reference to the mutation. +const ref = deleteQuestionnaireTemplateQuestionRef(deleteQuestionnaireTemplateQuestionVars); +// Variables can be defined inline as well. +const ref = deleteQuestionnaireTemplateQuestionRef({ id: ..., templateId: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteQuestionnaireTemplateQuestionRef(dataConnect, deleteQuestionnaireTemplateQuestionVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.questionnaireTemplateQuestion_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplateQuestion_delete); +}); +``` + +## DeleteQuestionnaireTemplate +You can execute the `DeleteQuestionnaireTemplate` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteQuestionnaireTemplate(vars: DeleteQuestionnaireTemplateVariables): MutationPromise; + +interface DeleteQuestionnaireTemplateRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteQuestionnaireTemplateVariables): MutationRef; +} +export const deleteQuestionnaireTemplateRef: DeleteQuestionnaireTemplateRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteQuestionnaireTemplate(dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables): MutationPromise; + +interface DeleteQuestionnaireTemplateRef { + ... + (dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables): MutationRef; +} +export const deleteQuestionnaireTemplateRef: DeleteQuestionnaireTemplateRef; +``` + +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 deleteQuestionnaireTemplateRef: +```typescript +const name = deleteQuestionnaireTemplateRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteQuestionnaireTemplate` mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteQuestionnaireTemplateVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteQuestionnaireTemplate` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteQuestionnaireTemplateData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteQuestionnaireTemplateData { + questionnaireTemplateQuestion_deleteMany: number; + questionnaireTemplate_delete?: QuestionnaireTemplate_Key | null; +} +``` +### Using `DeleteQuestionnaireTemplate`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteQuestionnaireTemplate, DeleteQuestionnaireTemplateVariables } from '@generated/data-connector-web'; + +// The `DeleteQuestionnaireTemplate` mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`: +const deleteQuestionnaireTemplateVars: DeleteQuestionnaireTemplateVariables = { + id: ..., +}; + +// Call the `deleteQuestionnaireTemplate()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteQuestionnaireTemplate(deleteQuestionnaireTemplateVars); +// Variables can be defined inline as well. +const { data } = await deleteQuestionnaireTemplate({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteQuestionnaireTemplate(dataConnect, deleteQuestionnaireTemplateVars); + +console.log(data.questionnaireTemplateQuestion_deleteMany); +console.log(data.questionnaireTemplate_delete); + +// Or, you can use the `Promise` API. +deleteQuestionnaireTemplate(deleteQuestionnaireTemplateVars).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplateQuestion_deleteMany); + console.log(data.questionnaireTemplate_delete); +}); +``` + +### Using `DeleteQuestionnaireTemplate`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteQuestionnaireTemplateRef, DeleteQuestionnaireTemplateVariables } from '@generated/data-connector-web'; + +// The `DeleteQuestionnaireTemplate` mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`: +const deleteQuestionnaireTemplateVars: DeleteQuestionnaireTemplateVariables = { + id: ..., +}; + +// Call the `deleteQuestionnaireTemplateRef()` function to get a reference to the mutation. +const ref = deleteQuestionnaireTemplateRef(deleteQuestionnaireTemplateVars); +// Variables can be defined inline as well. +const ref = deleteQuestionnaireTemplateRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteQuestionnaireTemplateRef(dataConnect, deleteQuestionnaireTemplateVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.questionnaireTemplateQuestion_deleteMany); +console.log(data.questionnaireTemplate_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.questionnaireTemplateQuestion_deleteMany); + console.log(data.questionnaireTemplate_delete); +}); +``` + +## CreateProjectQuestionnaire +You can execute the `CreateProjectQuestionnaire` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createProjectQuestionnaire(vars: CreateProjectQuestionnaireVariables): MutationPromise; + +interface CreateProjectQuestionnaireRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateProjectQuestionnaireVariables): MutationRef; +} +export const createProjectQuestionnaireRef: CreateProjectQuestionnaireRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createProjectQuestionnaire(dc: DataConnect, vars: CreateProjectQuestionnaireVariables): MutationPromise; + +interface CreateProjectQuestionnaireRef { + ... + (dc: DataConnect, vars: CreateProjectQuestionnaireVariables): MutationRef; +} +export const createProjectQuestionnaireRef: CreateProjectQuestionnaireRef; +``` + +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 createProjectQuestionnaireRef: +```typescript +const name = createProjectQuestionnaireRef.operationName; +console.log(name); +``` + +### Variables +The `CreateProjectQuestionnaire` mutation requires an argument of type `CreateProjectQuestionnaireVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateProjectQuestionnaireVariables { + id: UUIDString; + projectId: UUIDString; + sourceTemplateId?: UUIDString | null; +} +``` +### Return Type +Recall that executing the `CreateProjectQuestionnaire` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateProjectQuestionnaireData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateProjectQuestionnaireData { + projectQuestionnaire_insert: ProjectQuestionnaire_Key; +} +``` +### Using `CreateProjectQuestionnaire`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createProjectQuestionnaire, CreateProjectQuestionnaireVariables } from '@generated/data-connector-web'; + +// The `CreateProjectQuestionnaire` mutation requires an argument of type `CreateProjectQuestionnaireVariables`: +const createProjectQuestionnaireVars: CreateProjectQuestionnaireVariables = { + id: ..., + projectId: ..., + sourceTemplateId: ..., // optional +}; + +// Call the `createProjectQuestionnaire()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createProjectQuestionnaire(createProjectQuestionnaireVars); +// Variables can be defined inline as well. +const { data } = await createProjectQuestionnaire({ id: ..., projectId: ..., sourceTemplateId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createProjectQuestionnaire(dataConnect, createProjectQuestionnaireVars); + +console.log(data.projectQuestionnaire_insert); + +// Or, you can use the `Promise` API. +createProjectQuestionnaire(createProjectQuestionnaireVars).then((response) => { + const data = response.data; + console.log(data.projectQuestionnaire_insert); +}); +``` + +### Using `CreateProjectQuestionnaire`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createProjectQuestionnaireRef, CreateProjectQuestionnaireVariables } from '@generated/data-connector-web'; + +// The `CreateProjectQuestionnaire` mutation requires an argument of type `CreateProjectQuestionnaireVariables`: +const createProjectQuestionnaireVars: CreateProjectQuestionnaireVariables = { + id: ..., + projectId: ..., + sourceTemplateId: ..., // optional +}; + +// Call the `createProjectQuestionnaireRef()` function to get a reference to the mutation. +const ref = createProjectQuestionnaireRef(createProjectQuestionnaireVars); +// Variables can be defined inline as well. +const ref = createProjectQuestionnaireRef({ id: ..., projectId: ..., sourceTemplateId: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createProjectQuestionnaireRef(dataConnect, createProjectQuestionnaireVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.projectQuestionnaire_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.projectQuestionnaire_insert); +}); +``` + +## CreateProjectQuestionnaireAnswer +You can execute the `CreateProjectQuestionnaireAnswer` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createProjectQuestionnaireAnswer(vars: CreateProjectQuestionnaireAnswerVariables): MutationPromise; + +interface CreateProjectQuestionnaireAnswerRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateProjectQuestionnaireAnswerVariables): MutationRef; +} +export const createProjectQuestionnaireAnswerRef: CreateProjectQuestionnaireAnswerRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createProjectQuestionnaireAnswer(dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables): MutationPromise; + +interface CreateProjectQuestionnaireAnswerRef { + ... + (dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables): MutationRef; +} +export const createProjectQuestionnaireAnswerRef: CreateProjectQuestionnaireAnswerRef; +``` + +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 createProjectQuestionnaireAnswerRef: +```typescript +const name = createProjectQuestionnaireAnswerRef.operationName; +console.log(name); +``` + +### Variables +The `CreateProjectQuestionnaireAnswer` mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateProjectQuestionnaireAnswerVariables { + id: UUIDString; + projectQuestionnaireId: UUIDString; + questionId: UUIDString; + position: number; + answer?: string | null; +} +``` +### Return Type +Recall that executing the `CreateProjectQuestionnaireAnswer` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateProjectQuestionnaireAnswerData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateProjectQuestionnaireAnswerData { + projectQuestionnaireAnswer_insert: ProjectQuestionnaireAnswer_Key; +} +``` +### Using `CreateProjectQuestionnaireAnswer`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createProjectQuestionnaireAnswer, CreateProjectQuestionnaireAnswerVariables } from '@generated/data-connector-web'; + +// The `CreateProjectQuestionnaireAnswer` mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`: +const createProjectQuestionnaireAnswerVars: CreateProjectQuestionnaireAnswerVariables = { + id: ..., + projectQuestionnaireId: ..., + questionId: ..., + position: ..., + answer: ..., // optional +}; + +// Call the `createProjectQuestionnaireAnswer()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createProjectQuestionnaireAnswer(createProjectQuestionnaireAnswerVars); +// Variables can be defined inline as well. +const { data } = await createProjectQuestionnaireAnswer({ id: ..., projectQuestionnaireId: ..., questionId: ..., position: ..., answer: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createProjectQuestionnaireAnswer(dataConnect, createProjectQuestionnaireAnswerVars); + +console.log(data.projectQuestionnaireAnswer_insert); + +// Or, you can use the `Promise` API. +createProjectQuestionnaireAnswer(createProjectQuestionnaireAnswerVars).then((response) => { + const data = response.data; + console.log(data.projectQuestionnaireAnswer_insert); +}); +``` + +### Using `CreateProjectQuestionnaireAnswer`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createProjectQuestionnaireAnswerRef, CreateProjectQuestionnaireAnswerVariables } from '@generated/data-connector-web'; + +// The `CreateProjectQuestionnaireAnswer` mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`: +const createProjectQuestionnaireAnswerVars: CreateProjectQuestionnaireAnswerVariables = { + id: ..., + projectQuestionnaireId: ..., + questionId: ..., + position: ..., + answer: ..., // optional +}; + +// Call the `createProjectQuestionnaireAnswerRef()` function to get a reference to the mutation. +const ref = createProjectQuestionnaireAnswerRef(createProjectQuestionnaireAnswerVars); +// Variables can be defined inline as well. +const ref = createProjectQuestionnaireAnswerRef({ id: ..., projectQuestionnaireId: ..., questionId: ..., position: ..., answer: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createProjectQuestionnaireAnswerRef(dataConnect, createProjectQuestionnaireAnswerVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.projectQuestionnaireAnswer_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.projectQuestionnaireAnswer_insert); +}); +``` + +## CreateQuantitySource +You can execute the `CreateQuantitySource` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createQuantitySource(vars: CreateQuantitySourceVariables): MutationPromise; + +interface CreateQuantitySourceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuantitySourceVariables): MutationRef; +} +export const createQuantitySourceRef: CreateQuantitySourceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createQuantitySource(dc: DataConnect, vars: CreateQuantitySourceVariables): MutationPromise; + +interface CreateQuantitySourceRef { + ... + (dc: DataConnect, vars: CreateQuantitySourceVariables): MutationRef; +} +export const createQuantitySourceRef: CreateQuantitySourceRef; +``` + +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 createQuantitySourceRef: +```typescript +const name = createQuantitySourceRef.operationName; +console.log(name); +``` + +### Variables +The `CreateQuantitySource` mutation requires an argument of type `CreateQuantitySourceVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateQuantitySourceVariables { + id: UUIDString; + measurementSource: string; + measurementPlasterType?: string | null; +} +``` +### Return Type +Recall that executing the `CreateQuantitySource` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateQuantitySourceData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateQuantitySourceData { + quantitySource_insert: QuantitySource_Key; +} +``` +### Using `CreateQuantitySource`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createQuantitySource, CreateQuantitySourceVariables } from '@generated/data-connector-web'; + +// The `CreateQuantitySource` mutation requires an argument of type `CreateQuantitySourceVariables`: +const createQuantitySourceVars: CreateQuantitySourceVariables = { + id: ..., + measurementSource: ..., + measurementPlasterType: ..., // optional +}; + +// Call the `createQuantitySource()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createQuantitySource(createQuantitySourceVars); +// Variables can be defined inline as well. +const { data } = await createQuantitySource({ id: ..., measurementSource: ..., measurementPlasterType: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createQuantitySource(dataConnect, createQuantitySourceVars); + +console.log(data.quantitySource_insert); + +// Or, you can use the `Promise` API. +createQuantitySource(createQuantitySourceVars).then((response) => { + const data = response.data; + console.log(data.quantitySource_insert); +}); +``` + +### Using `CreateQuantitySource`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createQuantitySourceRef, CreateQuantitySourceVariables } from '@generated/data-connector-web'; + +// The `CreateQuantitySource` mutation requires an argument of type `CreateQuantitySourceVariables`: +const createQuantitySourceVars: CreateQuantitySourceVariables = { + id: ..., + measurementSource: ..., + measurementPlasterType: ..., // optional +}; + +// Call the `createQuantitySourceRef()` function to get a reference to the mutation. +const ref = createQuantitySourceRef(createQuantitySourceVars); +// Variables can be defined inline as well. +const ref = createQuantitySourceRef({ id: ..., measurementSource: ..., measurementPlasterType: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createQuantitySourceRef(dataConnect, createQuantitySourceVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quantitySource_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quantitySource_insert); +}); +``` + +## CreateQuoteItemTemplate +You can execute the `CreateQuoteItemTemplate` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createQuoteItemTemplate(vars: CreateQuoteItemTemplateVariables): MutationPromise; + +interface CreateQuoteItemTemplateRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuoteItemTemplateVariables): MutationRef; +} +export const createQuoteItemTemplateRef: CreateQuoteItemTemplateRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createQuoteItemTemplate(dc: DataConnect, vars: CreateQuoteItemTemplateVariables): MutationPromise; + +interface CreateQuoteItemTemplateRef { + ... + (dc: DataConnect, vars: CreateQuoteItemTemplateVariables): MutationRef; +} +export const createQuoteItemTemplateRef: CreateQuoteItemTemplateRef; +``` + +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 createQuoteItemTemplateRef: +```typescript +const name = createQuoteItemTemplateRef.operationName; +console.log(name); +``` + +### Variables +The `CreateQuoteItemTemplate` mutation requires an argument of type `CreateQuoteItemTemplateVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateQuoteItemTemplateVariables { + id: UUIDString; + ownerId?: string | null; + scope: string; + systemKey?: string | null; + name: string; + hasKeywords: boolean; + keywords: string[]; + quantitySourceId?: UUIDString | null; + sortOrder: number; +} +``` +### Return Type +Recall that executing the `CreateQuoteItemTemplate` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateQuoteItemTemplateData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateQuoteItemTemplateData { + quoteItemTemplate_insert: QuoteItemTemplate_Key; +} +``` +### Using `CreateQuoteItemTemplate`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createQuoteItemTemplate, CreateQuoteItemTemplateVariables } from '@generated/data-connector-web'; + +// The `CreateQuoteItemTemplate` mutation requires an argument of type `CreateQuoteItemTemplateVariables`: +const createQuoteItemTemplateVars: CreateQuoteItemTemplateVariables = { + id: ..., + ownerId: ..., // optional + scope: ..., + systemKey: ..., // optional + name: ..., + hasKeywords: ..., + keywords: ..., + quantitySourceId: ..., // optional + sortOrder: ..., +}; + +// Call the `createQuoteItemTemplate()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createQuoteItemTemplate(createQuoteItemTemplateVars); +// Variables can be defined inline as well. +const { data } = await createQuoteItemTemplate({ id: ..., ownerId: ..., scope: ..., systemKey: ..., name: ..., hasKeywords: ..., keywords: ..., quantitySourceId: ..., sortOrder: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createQuoteItemTemplate(dataConnect, createQuoteItemTemplateVars); + +console.log(data.quoteItemTemplate_insert); + +// Or, you can use the `Promise` API. +createQuoteItemTemplate(createQuoteItemTemplateVars).then((response) => { + const data = response.data; + console.log(data.quoteItemTemplate_insert); +}); +``` + +### Using `CreateQuoteItemTemplate`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createQuoteItemTemplateRef, CreateQuoteItemTemplateVariables } from '@generated/data-connector-web'; + +// The `CreateQuoteItemTemplate` mutation requires an argument of type `CreateQuoteItemTemplateVariables`: +const createQuoteItemTemplateVars: CreateQuoteItemTemplateVariables = { + id: ..., + ownerId: ..., // optional + scope: ..., + systemKey: ..., // optional + name: ..., + hasKeywords: ..., + keywords: ..., + quantitySourceId: ..., // optional + sortOrder: ..., +}; + +// Call the `createQuoteItemTemplateRef()` function to get a reference to the mutation. +const ref = createQuoteItemTemplateRef(createQuoteItemTemplateVars); +// Variables can be defined inline as well. +const ref = createQuoteItemTemplateRef({ id: ..., ownerId: ..., scope: ..., systemKey: ..., name: ..., hasKeywords: ..., keywords: ..., quantitySourceId: ..., sortOrder: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createQuoteItemTemplateRef(dataConnect, createQuoteItemTemplateVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quoteItemTemplate_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quoteItemTemplate_insert); +}); +``` + +## UpdateQuoteItemTemplate +You can execute the `UpdateQuoteItemTemplate` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateQuoteItemTemplate(vars: UpdateQuoteItemTemplateVariables): MutationPromise; + +interface UpdateQuoteItemTemplateRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuoteItemTemplateVariables): MutationRef; +} +export const updateQuoteItemTemplateRef: UpdateQuoteItemTemplateRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateQuoteItemTemplate(dc: DataConnect, vars: UpdateQuoteItemTemplateVariables): MutationPromise; + +interface UpdateQuoteItemTemplateRef { + ... + (dc: DataConnect, vars: UpdateQuoteItemTemplateVariables): MutationRef; +} +export const updateQuoteItemTemplateRef: UpdateQuoteItemTemplateRef; +``` + +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 updateQuoteItemTemplateRef: +```typescript +const name = updateQuoteItemTemplateRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateQuoteItemTemplate` mutation requires an argument of type `UpdateQuoteItemTemplateVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateQuoteItemTemplateVariables { + id: UUIDString; + name?: string | null; + hasKeywords?: boolean | null; + keywords?: string[] | null; + quantitySourceId?: UUIDString | null; + sortOrder?: number | null; +} +``` +### Return Type +Recall that executing the `UpdateQuoteItemTemplate` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateQuoteItemTemplateData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateQuoteItemTemplateData { + quoteItemTemplate_update?: QuoteItemTemplate_Key | null; +} +``` +### Using `UpdateQuoteItemTemplate`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateQuoteItemTemplate, UpdateQuoteItemTemplateVariables } from '@generated/data-connector-web'; + +// The `UpdateQuoteItemTemplate` mutation requires an argument of type `UpdateQuoteItemTemplateVariables`: +const updateQuoteItemTemplateVars: UpdateQuoteItemTemplateVariables = { + id: ..., + name: ..., // optional + hasKeywords: ..., // optional + keywords: ..., // optional + quantitySourceId: ..., // optional + sortOrder: ..., // optional +}; + +// Call the `updateQuoteItemTemplate()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateQuoteItemTemplate(updateQuoteItemTemplateVars); +// Variables can be defined inline as well. +const { data } = await updateQuoteItemTemplate({ id: ..., name: ..., hasKeywords: ..., keywords: ..., quantitySourceId: ..., sortOrder: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateQuoteItemTemplate(dataConnect, updateQuoteItemTemplateVars); + +console.log(data.quoteItemTemplate_update); + +// Or, you can use the `Promise` API. +updateQuoteItemTemplate(updateQuoteItemTemplateVars).then((response) => { + const data = response.data; + console.log(data.quoteItemTemplate_update); +}); +``` + +### Using `UpdateQuoteItemTemplate`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateQuoteItemTemplateRef, UpdateQuoteItemTemplateVariables } from '@generated/data-connector-web'; + +// The `UpdateQuoteItemTemplate` mutation requires an argument of type `UpdateQuoteItemTemplateVariables`: +const updateQuoteItemTemplateVars: UpdateQuoteItemTemplateVariables = { + id: ..., + name: ..., // optional + hasKeywords: ..., // optional + keywords: ..., // optional + quantitySourceId: ..., // optional + sortOrder: ..., // optional +}; + +// Call the `updateQuoteItemTemplateRef()` function to get a reference to the mutation. +const ref = updateQuoteItemTemplateRef(updateQuoteItemTemplateVars); +// Variables can be defined inline as well. +const ref = updateQuoteItemTemplateRef({ id: ..., name: ..., hasKeywords: ..., keywords: ..., quantitySourceId: ..., sortOrder: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateQuoteItemTemplateRef(dataConnect, updateQuoteItemTemplateVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quoteItemTemplate_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quoteItemTemplate_update); +}); +``` + +## DeleteQuoteItemTemplate +You can execute the `DeleteQuoteItemTemplate` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteQuoteItemTemplate(vars: DeleteQuoteItemTemplateVariables): MutationPromise; + +interface DeleteQuoteItemTemplateRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteQuoteItemTemplateVariables): MutationRef; +} +export const deleteQuoteItemTemplateRef: DeleteQuoteItemTemplateRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteQuoteItemTemplate(dc: DataConnect, vars: DeleteQuoteItemTemplateVariables): MutationPromise; + +interface DeleteQuoteItemTemplateRef { + ... + (dc: DataConnect, vars: DeleteQuoteItemTemplateVariables): MutationRef; +} +export const deleteQuoteItemTemplateRef: DeleteQuoteItemTemplateRef; +``` + +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 deleteQuoteItemTemplateRef: +```typescript +const name = deleteQuoteItemTemplateRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteQuoteItemTemplate` mutation requires an argument of type `DeleteQuoteItemTemplateVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteQuoteItemTemplateVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteQuoteItemTemplate` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteQuoteItemTemplateData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteQuoteItemTemplateData { + quoteItemTemplate_delete?: QuoteItemTemplate_Key | null; +} +``` +### Using `DeleteQuoteItemTemplate`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteQuoteItemTemplate, DeleteQuoteItemTemplateVariables } from '@generated/data-connector-web'; + +// The `DeleteQuoteItemTemplate` mutation requires an argument of type `DeleteQuoteItemTemplateVariables`: +const deleteQuoteItemTemplateVars: DeleteQuoteItemTemplateVariables = { + id: ..., +}; + +// Call the `deleteQuoteItemTemplate()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteQuoteItemTemplate(deleteQuoteItemTemplateVars); +// Variables can be defined inline as well. +const { data } = await deleteQuoteItemTemplate({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteQuoteItemTemplate(dataConnect, deleteQuoteItemTemplateVars); + +console.log(data.quoteItemTemplate_delete); + +// Or, you can use the `Promise` API. +deleteQuoteItemTemplate(deleteQuoteItemTemplateVars).then((response) => { + const data = response.data; + console.log(data.quoteItemTemplate_delete); +}); +``` + +### Using `DeleteQuoteItemTemplate`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteQuoteItemTemplateRef, DeleteQuoteItemTemplateVariables } from '@generated/data-connector-web'; + +// The `DeleteQuoteItemTemplate` mutation requires an argument of type `DeleteQuoteItemTemplateVariables`: +const deleteQuoteItemTemplateVars: DeleteQuoteItemTemplateVariables = { + id: ..., +}; + +// Call the `deleteQuoteItemTemplateRef()` function to get a reference to the mutation. +const ref = deleteQuoteItemTemplateRef(deleteQuoteItemTemplateVars); +// Variables can be defined inline as well. +const ref = deleteQuoteItemTemplateRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteQuoteItemTemplateRef(dataConnect, deleteQuoteItemTemplateVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quoteItemTemplate_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quoteItemTemplate_delete); +}); +``` + +## UpsertQuoteItemTemplateConfig +You can execute the `UpsertQuoteItemTemplateConfig` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +upsertQuoteItemTemplateConfig(vars: UpsertQuoteItemTemplateConfigVariables): MutationPromise; + +interface UpsertQuoteItemTemplateConfigRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpsertQuoteItemTemplateConfigVariables): MutationRef; +} +export const upsertQuoteItemTemplateConfigRef: UpsertQuoteItemTemplateConfigRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +upsertQuoteItemTemplateConfig(dc: DataConnect, vars: UpsertQuoteItemTemplateConfigVariables): MutationPromise; + +interface UpsertQuoteItemTemplateConfigRef { + ... + (dc: DataConnect, vars: UpsertQuoteItemTemplateConfigVariables): MutationRef; +} +export const upsertQuoteItemTemplateConfigRef: UpsertQuoteItemTemplateConfigRef; +``` + +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 upsertQuoteItemTemplateConfigRef: +```typescript +const name = upsertQuoteItemTemplateConfigRef.operationName; +console.log(name); +``` + +### Variables +The `UpsertQuoteItemTemplateConfig` mutation requires an argument of type `UpsertQuoteItemTemplateConfigVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpsertQuoteItemTemplateConfigVariables { + ownerId: string; + templateId: UUIDString; + enabled: boolean; + unitPriceCents: number; + materialUnitPriceCents: number; + labourUnitPriceCents: number; +} +``` +### Return Type +Recall that executing the `UpsertQuoteItemTemplateConfig` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpsertQuoteItemTemplateConfigData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpsertQuoteItemTemplateConfigData { + quoteItemTemplateConfig_upsert: QuoteItemTemplateConfig_Key; +} +``` +### Using `UpsertQuoteItemTemplateConfig`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, upsertQuoteItemTemplateConfig, UpsertQuoteItemTemplateConfigVariables } from '@generated/data-connector-web'; + +// The `UpsertQuoteItemTemplateConfig` mutation requires an argument of type `UpsertQuoteItemTemplateConfigVariables`: +const upsertQuoteItemTemplateConfigVars: UpsertQuoteItemTemplateConfigVariables = { + ownerId: ..., + templateId: ..., + enabled: ..., + unitPriceCents: ..., + materialUnitPriceCents: ..., + labourUnitPriceCents: ..., +}; + +// Call the `upsertQuoteItemTemplateConfig()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await upsertQuoteItemTemplateConfig(upsertQuoteItemTemplateConfigVars); +// Variables can be defined inline as well. +const { data } = await upsertQuoteItemTemplateConfig({ ownerId: ..., templateId: ..., enabled: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await upsertQuoteItemTemplateConfig(dataConnect, upsertQuoteItemTemplateConfigVars); + +console.log(data.quoteItemTemplateConfig_upsert); + +// Or, you can use the `Promise` API. +upsertQuoteItemTemplateConfig(upsertQuoteItemTemplateConfigVars).then((response) => { + const data = response.data; + console.log(data.quoteItemTemplateConfig_upsert); +}); +``` + +### Using `UpsertQuoteItemTemplateConfig`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, upsertQuoteItemTemplateConfigRef, UpsertQuoteItemTemplateConfigVariables } from '@generated/data-connector-web'; + +// The `UpsertQuoteItemTemplateConfig` mutation requires an argument of type `UpsertQuoteItemTemplateConfigVariables`: +const upsertQuoteItemTemplateConfigVars: UpsertQuoteItemTemplateConfigVariables = { + ownerId: ..., + templateId: ..., + enabled: ..., + unitPriceCents: ..., + materialUnitPriceCents: ..., + labourUnitPriceCents: ..., +}; + +// Call the `upsertQuoteItemTemplateConfigRef()` function to get a reference to the mutation. +const ref = upsertQuoteItemTemplateConfigRef(upsertQuoteItemTemplateConfigVars); +// Variables can be defined inline as well. +const ref = upsertQuoteItemTemplateConfigRef({ ownerId: ..., templateId: ..., enabled: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = upsertQuoteItemTemplateConfigRef(dataConnect, upsertQuoteItemTemplateConfigVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quoteItemTemplateConfig_upsert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quoteItemTemplateConfig_upsert); +}); +``` + +## CreateSupplier +You can execute the `CreateSupplier` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createSupplier(vars: CreateSupplierVariables): MutationPromise; + +interface CreateSupplierRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateSupplierVariables): MutationRef; +} +export const createSupplierRef: CreateSupplierRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createSupplier(dc: DataConnect, vars: CreateSupplierVariables): MutationPromise; + +interface CreateSupplierRef { + ... + (dc: DataConnect, vars: CreateSupplierVariables): MutationRef; +} +export const createSupplierRef: CreateSupplierRef; +``` + +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 createSupplierRef: +```typescript +const name = createSupplierRef.operationName; +console.log(name); +``` + +### Variables +The `CreateSupplier` mutation requires an argument of type `CreateSupplierVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateSupplierVariables { + id: UUIDString; + ownerId: string; + name: string; +} +``` +### Return Type +Recall that executing the `CreateSupplier` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateSupplierData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateSupplierData { + supplier_insert: Supplier_Key; +} +``` +### Using `CreateSupplier`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createSupplier, CreateSupplierVariables } from '@generated/data-connector-web'; + +// The `CreateSupplier` mutation requires an argument of type `CreateSupplierVariables`: +const createSupplierVars: CreateSupplierVariables = { + id: ..., + ownerId: ..., + name: ..., +}; + +// Call the `createSupplier()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createSupplier(createSupplierVars); +// Variables can be defined inline as well. +const { data } = await createSupplier({ id: ..., ownerId: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createSupplier(dataConnect, createSupplierVars); + +console.log(data.supplier_insert); + +// Or, you can use the `Promise` API. +createSupplier(createSupplierVars).then((response) => { + const data = response.data; + console.log(data.supplier_insert); +}); +``` + +### Using `CreateSupplier`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createSupplierRef, CreateSupplierVariables } from '@generated/data-connector-web'; + +// The `CreateSupplier` mutation requires an argument of type `CreateSupplierVariables`: +const createSupplierVars: CreateSupplierVariables = { + id: ..., + ownerId: ..., + name: ..., +}; + +// Call the `createSupplierRef()` function to get a reference to the mutation. +const ref = createSupplierRef(createSupplierVars); +// Variables can be defined inline as well. +const ref = createSupplierRef({ id: ..., ownerId: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createSupplierRef(dataConnect, createSupplierVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.supplier_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.supplier_insert); +}); +``` + +## UpdateSupplier +You can execute the `UpdateSupplier` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateSupplier(vars: UpdateSupplierVariables): MutationPromise; + +interface UpdateSupplierRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateSupplierVariables): MutationRef; +} +export const updateSupplierRef: UpdateSupplierRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateSupplier(dc: DataConnect, vars: UpdateSupplierVariables): MutationPromise; + +interface UpdateSupplierRef { + ... + (dc: DataConnect, vars: UpdateSupplierVariables): MutationRef; +} +export const updateSupplierRef: UpdateSupplierRef; +``` + +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 updateSupplierRef: +```typescript +const name = updateSupplierRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateSupplier` mutation requires an argument of type `UpdateSupplierVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateSupplierVariables { + id: UUIDString; + name?: string | null; +} +``` +### Return Type +Recall that executing the `UpdateSupplier` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateSupplierData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateSupplierData { + supplier_update?: Supplier_Key | null; +} +``` +### Using `UpdateSupplier`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateSupplier, UpdateSupplierVariables } from '@generated/data-connector-web'; + +// The `UpdateSupplier` mutation requires an argument of type `UpdateSupplierVariables`: +const updateSupplierVars: UpdateSupplierVariables = { + id: ..., + name: ..., // optional +}; + +// Call the `updateSupplier()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateSupplier(updateSupplierVars); +// Variables can be defined inline as well. +const { data } = await updateSupplier({ id: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateSupplier(dataConnect, updateSupplierVars); + +console.log(data.supplier_update); + +// Or, you can use the `Promise` API. +updateSupplier(updateSupplierVars).then((response) => { + const data = response.data; + console.log(data.supplier_update); +}); +``` + +### Using `UpdateSupplier`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateSupplierRef, UpdateSupplierVariables } from '@generated/data-connector-web'; + +// The `UpdateSupplier` mutation requires an argument of type `UpdateSupplierVariables`: +const updateSupplierVars: UpdateSupplierVariables = { + id: ..., + name: ..., // optional +}; + +// Call the `updateSupplierRef()` function to get a reference to the mutation. +const ref = updateSupplierRef(updateSupplierVars); +// Variables can be defined inline as well. +const ref = updateSupplierRef({ id: ..., name: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateSupplierRef(dataConnect, updateSupplierVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.supplier_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.supplier_update); +}); +``` + +## DeleteSupplier +You can execute the `DeleteSupplier` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteSupplier(vars: DeleteSupplierVariables): MutationPromise; + +interface DeleteSupplierRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteSupplierVariables): MutationRef; +} +export const deleteSupplierRef: DeleteSupplierRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteSupplier(dc: DataConnect, vars: DeleteSupplierVariables): MutationPromise; + +interface DeleteSupplierRef { + ... + (dc: DataConnect, vars: DeleteSupplierVariables): MutationRef; +} +export const deleteSupplierRef: DeleteSupplierRef; +``` + +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 deleteSupplierRef: +```typescript +const name = deleteSupplierRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteSupplier` mutation requires an argument of type `DeleteSupplierVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteSupplierVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteSupplier` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteSupplierData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteSupplierData { + supplier_delete?: Supplier_Key | null; +} +``` +### Using `DeleteSupplier`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteSupplier, DeleteSupplierVariables } from '@generated/data-connector-web'; + +// The `DeleteSupplier` mutation requires an argument of type `DeleteSupplierVariables`: +const deleteSupplierVars: DeleteSupplierVariables = { + id: ..., +}; + +// Call the `deleteSupplier()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteSupplier(deleteSupplierVars); +// Variables can be defined inline as well. +const { data } = await deleteSupplier({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteSupplier(dataConnect, deleteSupplierVars); + +console.log(data.supplier_delete); + +// Or, you can use the `Promise` API. +deleteSupplier(deleteSupplierVars).then((response) => { + const data = response.data; + console.log(data.supplier_delete); +}); +``` + +### Using `DeleteSupplier`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteSupplierRef, DeleteSupplierVariables } from '@generated/data-connector-web'; + +// The `DeleteSupplier` mutation requires an argument of type `DeleteSupplierVariables`: +const deleteSupplierVars: DeleteSupplierVariables = { + id: ..., +}; + +// Call the `deleteSupplierRef()` function to get a reference to the mutation. +const ref = deleteSupplierRef(deleteSupplierVars); +// Variables can be defined inline as well. +const ref = deleteSupplierRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteSupplierRef(dataConnect, deleteSupplierVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.supplier_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.supplier_delete); +}); +``` + +## UpsertSupplierQuoteItemPrice +You can execute the `UpsertSupplierQuoteItemPrice` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +upsertSupplierQuoteItemPrice(vars: UpsertSupplierQuoteItemPriceVariables): MutationPromise; + +interface UpsertSupplierQuoteItemPriceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpsertSupplierQuoteItemPriceVariables): MutationRef; +} +export const upsertSupplierQuoteItemPriceRef: UpsertSupplierQuoteItemPriceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +upsertSupplierQuoteItemPrice(dc: DataConnect, vars: UpsertSupplierQuoteItemPriceVariables): MutationPromise; + +interface UpsertSupplierQuoteItemPriceRef { + ... + (dc: DataConnect, vars: UpsertSupplierQuoteItemPriceVariables): MutationRef; +} +export const upsertSupplierQuoteItemPriceRef: UpsertSupplierQuoteItemPriceRef; +``` + +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 upsertSupplierQuoteItemPriceRef: +```typescript +const name = upsertSupplierQuoteItemPriceRef.operationName; +console.log(name); +``` + +### Variables +The `UpsertSupplierQuoteItemPrice` mutation requires an argument of type `UpsertSupplierQuoteItemPriceVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpsertSupplierQuoteItemPriceVariables { + ownerId: string; + supplierId: UUIDString; + templateId: UUIDString; + materialUnitPriceCents: number; +} +``` +### Return Type +Recall that executing the `UpsertSupplierQuoteItemPrice` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpsertSupplierQuoteItemPriceData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpsertSupplierQuoteItemPriceData { + supplierQuoteItemPrice_upsert: SupplierQuoteItemPrice_Key; +} +``` +### Using `UpsertSupplierQuoteItemPrice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, upsertSupplierQuoteItemPrice, UpsertSupplierQuoteItemPriceVariables } from '@generated/data-connector-web'; + +// The `UpsertSupplierQuoteItemPrice` mutation requires an argument of type `UpsertSupplierQuoteItemPriceVariables`: +const upsertSupplierQuoteItemPriceVars: UpsertSupplierQuoteItemPriceVariables = { + ownerId: ..., + supplierId: ..., + templateId: ..., + materialUnitPriceCents: ..., +}; + +// Call the `upsertSupplierQuoteItemPrice()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await upsertSupplierQuoteItemPrice(upsertSupplierQuoteItemPriceVars); +// Variables can be defined inline as well. +const { data } = await upsertSupplierQuoteItemPrice({ ownerId: ..., supplierId: ..., templateId: ..., materialUnitPriceCents: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await upsertSupplierQuoteItemPrice(dataConnect, upsertSupplierQuoteItemPriceVars); + +console.log(data.supplierQuoteItemPrice_upsert); + +// Or, you can use the `Promise` API. +upsertSupplierQuoteItemPrice(upsertSupplierQuoteItemPriceVars).then((response) => { + const data = response.data; + console.log(data.supplierQuoteItemPrice_upsert); +}); +``` + +### Using `UpsertSupplierQuoteItemPrice`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, upsertSupplierQuoteItemPriceRef, UpsertSupplierQuoteItemPriceVariables } from '@generated/data-connector-web'; + +// The `UpsertSupplierQuoteItemPrice` mutation requires an argument of type `UpsertSupplierQuoteItemPriceVariables`: +const upsertSupplierQuoteItemPriceVars: UpsertSupplierQuoteItemPriceVariables = { + ownerId: ..., + supplierId: ..., + templateId: ..., + materialUnitPriceCents: ..., +}; + +// Call the `upsertSupplierQuoteItemPriceRef()` function to get a reference to the mutation. +const ref = upsertSupplierQuoteItemPriceRef(upsertSupplierQuoteItemPriceVars); +// Variables can be defined inline as well. +const ref = upsertSupplierQuoteItemPriceRef({ ownerId: ..., supplierId: ..., templateId: ..., materialUnitPriceCents: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = upsertSupplierQuoteItemPriceRef(dataConnect, upsertSupplierQuoteItemPriceVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.supplierQuoteItemPrice_upsert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.supplierQuoteItemPrice_upsert); +}); +``` + +## DeleteSupplierQuoteItemPrice +You can execute the `DeleteSupplierQuoteItemPrice` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteSupplierQuoteItemPrice(vars: DeleteSupplierQuoteItemPriceVariables): MutationPromise; + +interface DeleteSupplierQuoteItemPriceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteSupplierQuoteItemPriceVariables): MutationRef; +} +export const deleteSupplierQuoteItemPriceRef: DeleteSupplierQuoteItemPriceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteSupplierQuoteItemPrice(dc: DataConnect, vars: DeleteSupplierQuoteItemPriceVariables): MutationPromise; + +interface DeleteSupplierQuoteItemPriceRef { + ... + (dc: DataConnect, vars: DeleteSupplierQuoteItemPriceVariables): MutationRef; +} +export const deleteSupplierQuoteItemPriceRef: DeleteSupplierQuoteItemPriceRef; +``` + +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 deleteSupplierQuoteItemPriceRef: +```typescript +const name = deleteSupplierQuoteItemPriceRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteSupplierQuoteItemPrice` mutation requires an argument of type `DeleteSupplierQuoteItemPriceVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteSupplierQuoteItemPriceVariables { + supplierId: UUIDString; + templateId: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteSupplierQuoteItemPrice` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteSupplierQuoteItemPriceData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteSupplierQuoteItemPriceData { + supplierQuoteItemPrice_delete?: SupplierQuoteItemPrice_Key | null; +} +``` +### Using `DeleteSupplierQuoteItemPrice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteSupplierQuoteItemPrice, DeleteSupplierQuoteItemPriceVariables } from '@generated/data-connector-web'; + +// The `DeleteSupplierQuoteItemPrice` mutation requires an argument of type `DeleteSupplierQuoteItemPriceVariables`: +const deleteSupplierQuoteItemPriceVars: DeleteSupplierQuoteItemPriceVariables = { + supplierId: ..., + templateId: ..., +}; + +// Call the `deleteSupplierQuoteItemPrice()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteSupplierQuoteItemPrice(deleteSupplierQuoteItemPriceVars); +// Variables can be defined inline as well. +const { data } = await deleteSupplierQuoteItemPrice({ supplierId: ..., templateId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteSupplierQuoteItemPrice(dataConnect, deleteSupplierQuoteItemPriceVars); + +console.log(data.supplierQuoteItemPrice_delete); + +// Or, you can use the `Promise` API. +deleteSupplierQuoteItemPrice(deleteSupplierQuoteItemPriceVars).then((response) => { + const data = response.data; + console.log(data.supplierQuoteItemPrice_delete); +}); +``` + +### Using `DeleteSupplierQuoteItemPrice`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteSupplierQuoteItemPriceRef, DeleteSupplierQuoteItemPriceVariables } from '@generated/data-connector-web'; + +// The `DeleteSupplierQuoteItemPrice` mutation requires an argument of type `DeleteSupplierQuoteItemPriceVariables`: +const deleteSupplierQuoteItemPriceVars: DeleteSupplierQuoteItemPriceVariables = { + supplierId: ..., + templateId: ..., +}; + +// Call the `deleteSupplierQuoteItemPriceRef()` function to get a reference to the mutation. +const ref = deleteSupplierQuoteItemPriceRef(deleteSupplierQuoteItemPriceVars); +// Variables can be defined inline as well. +const ref = deleteSupplierQuoteItemPriceRef({ supplierId: ..., templateId: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteSupplierQuoteItemPriceRef(dataConnect, deleteSupplierQuoteItemPriceVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.supplierQuoteItemPrice_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.supplierQuoteItemPrice_delete); +}); +``` + +## CreateQuote +You can execute the `CreateQuote` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createQuote(vars: CreateQuoteVariables): MutationPromise; + +interface CreateQuoteRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuoteVariables): MutationRef; +} +export const createQuoteRef: CreateQuoteRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createQuote(dc: DataConnect, vars: CreateQuoteVariables): MutationPromise; + +interface CreateQuoteRef { + ... + (dc: DataConnect, vars: CreateQuoteVariables): MutationRef; +} +export const createQuoteRef: CreateQuoteRef; +``` + +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 createQuoteRef: +```typescript +const name = createQuoteRef.operationName; +console.log(name); +``` + +### Variables +The `CreateQuote` mutation requires an argument of type `CreateQuoteVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateQuoteVariables { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + supplierId?: UUIDString | null; + status: string; +} +``` +### Return Type +Recall that executing the `CreateQuote` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateQuoteData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateQuoteData { + quote_insert: Quote_Key; +} +``` +### Using `CreateQuote`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createQuote, CreateQuoteVariables } from '@generated/data-connector-web'; + +// The `CreateQuote` mutation requires an argument of type `CreateQuoteVariables`: +const createQuoteVars: CreateQuoteVariables = { + id: ..., + ownerId: ..., + projectId: ..., + supplierId: ..., // optional + status: ..., +}; + +// Call the `createQuote()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createQuote(createQuoteVars); +// Variables can be defined inline as well. +const { data } = await createQuote({ id: ..., ownerId: ..., projectId: ..., supplierId: ..., status: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createQuote(dataConnect, createQuoteVars); + +console.log(data.quote_insert); + +// Or, you can use the `Promise` API. +createQuote(createQuoteVars).then((response) => { + const data = response.data; + console.log(data.quote_insert); +}); +``` + +### Using `CreateQuote`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createQuoteRef, CreateQuoteVariables } from '@generated/data-connector-web'; + +// The `CreateQuote` mutation requires an argument of type `CreateQuoteVariables`: +const createQuoteVars: CreateQuoteVariables = { + id: ..., + ownerId: ..., + projectId: ..., + supplierId: ..., // optional + status: ..., +}; + +// Call the `createQuoteRef()` function to get a reference to the mutation. +const ref = createQuoteRef(createQuoteVars); +// Variables can be defined inline as well. +const ref = createQuoteRef({ id: ..., ownerId: ..., projectId: ..., supplierId: ..., status: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createQuoteRef(dataConnect, createQuoteVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quote_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quote_insert); +}); +``` + +## UpdateQuote +You can execute the `UpdateQuote` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateQuote(vars: UpdateQuoteVariables): MutationPromise; + +interface UpdateQuoteRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuoteVariables): MutationRef; +} +export const updateQuoteRef: UpdateQuoteRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateQuote(dc: DataConnect, vars: UpdateQuoteVariables): MutationPromise; + +interface UpdateQuoteRef { + ... + (dc: DataConnect, vars: UpdateQuoteVariables): MutationRef; +} +export const updateQuoteRef: UpdateQuoteRef; +``` + +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 updateQuoteRef: +```typescript +const name = updateQuoteRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateQuote` mutation requires an argument of type `UpdateQuoteVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateQuoteVariables { + id: UUIDString; + supplierId?: UUIDString | null; + status?: string | null; +} +``` +### Return Type +Recall that executing the `UpdateQuote` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateQuoteData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateQuoteData { + quote_update?: Quote_Key | null; +} +``` +### Using `UpdateQuote`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateQuote, UpdateQuoteVariables } from '@generated/data-connector-web'; + +// The `UpdateQuote` mutation requires an argument of type `UpdateQuoteVariables`: +const updateQuoteVars: UpdateQuoteVariables = { + id: ..., + supplierId: ..., // optional + status: ..., // optional +}; + +// Call the `updateQuote()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateQuote(updateQuoteVars); +// Variables can be defined inline as well. +const { data } = await updateQuote({ id: ..., supplierId: ..., status: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateQuote(dataConnect, updateQuoteVars); + +console.log(data.quote_update); + +// Or, you can use the `Promise` API. +updateQuote(updateQuoteVars).then((response) => { + const data = response.data; + console.log(data.quote_update); +}); +``` + +### Using `UpdateQuote`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateQuoteRef, UpdateQuoteVariables } from '@generated/data-connector-web'; + +// The `UpdateQuote` mutation requires an argument of type `UpdateQuoteVariables`: +const updateQuoteVars: UpdateQuoteVariables = { + id: ..., + supplierId: ..., // optional + status: ..., // optional +}; + +// Call the `updateQuoteRef()` function to get a reference to the mutation. +const ref = updateQuoteRef(updateQuoteVars); +// Variables can be defined inline as well. +const ref = updateQuoteRef({ id: ..., supplierId: ..., status: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateQuoteRef(dataConnect, updateQuoteVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quote_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quote_update); +}); +``` + +## DeleteQuoteItems +You can execute the `DeleteQuoteItems` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +deleteQuoteItems(vars: DeleteQuoteItemsVariables): MutationPromise; + +interface DeleteQuoteItemsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteQuoteItemsVariables): MutationRef; +} +export const deleteQuoteItemsRef: DeleteQuoteItemsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteQuoteItems(dc: DataConnect, vars: DeleteQuoteItemsVariables): MutationPromise; + +interface DeleteQuoteItemsRef { + ... + (dc: DataConnect, vars: DeleteQuoteItemsVariables): MutationRef; +} +export const deleteQuoteItemsRef: DeleteQuoteItemsRef; +``` + +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 deleteQuoteItemsRef: +```typescript +const name = deleteQuoteItemsRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteQuoteItems` mutation requires an argument of type `DeleteQuoteItemsVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteQuoteItemsVariables { + quoteId: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteQuoteItems` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteQuoteItemsData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteQuoteItemsData { + quoteItem_deleteMany: number; +} +``` +### Using `DeleteQuoteItems`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteQuoteItems, DeleteQuoteItemsVariables } from '@generated/data-connector-web'; + +// The `DeleteQuoteItems` mutation requires an argument of type `DeleteQuoteItemsVariables`: +const deleteQuoteItemsVars: DeleteQuoteItemsVariables = { + quoteId: ..., +}; + +// Call the `deleteQuoteItems()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteQuoteItems(deleteQuoteItemsVars); +// Variables can be defined inline as well. +const { data } = await deleteQuoteItems({ quoteId: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteQuoteItems(dataConnect, deleteQuoteItemsVars); + +console.log(data.quoteItem_deleteMany); + +// Or, you can use the `Promise` API. +deleteQuoteItems(deleteQuoteItemsVars).then((response) => { + const data = response.data; + console.log(data.quoteItem_deleteMany); +}); +``` + +### Using `DeleteQuoteItems`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteQuoteItemsRef, DeleteQuoteItemsVariables } from '@generated/data-connector-web'; + +// The `DeleteQuoteItems` mutation requires an argument of type `DeleteQuoteItemsVariables`: +const deleteQuoteItemsVars: DeleteQuoteItemsVariables = { + quoteId: ..., +}; + +// Call the `deleteQuoteItemsRef()` function to get a reference to the mutation. +const ref = deleteQuoteItemsRef(deleteQuoteItemsVars); +// Variables can be defined inline as well. +const ref = deleteQuoteItemsRef({ quoteId: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteQuoteItemsRef(dataConnect, deleteQuoteItemsVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quoteItem_deleteMany); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quoteItem_deleteMany); +}); +``` + +## CreateQuoteItem +You can execute the `CreateQuoteItem` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createQuoteItem(vars: CreateQuoteItemVariables): MutationPromise; + +interface CreateQuoteItemRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuoteItemVariables): MutationRef; +} +export const createQuoteItemRef: CreateQuoteItemRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createQuoteItem(dc: DataConnect, vars: CreateQuoteItemVariables): MutationPromise; + +interface CreateQuoteItemRef { + ... + (dc: DataConnect, vars: CreateQuoteItemVariables): MutationRef; +} +export const createQuoteItemRef: CreateQuoteItemRef; +``` + +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 createQuoteItemRef: +```typescript +const name = createQuoteItemRef.operationName; +console.log(name); +``` + +### Variables +The `CreateQuoteItem` mutation requires an argument of type `CreateQuoteItemVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateQuoteItemVariables { + id: UUIDString; + ownerId: string; + quoteId: UUIDString; + sourceTemplateId?: UUIDString | null; + displayOrder: number; + name: string; + quantity: number; + quantitySourceId?: UUIDString | null; + unitPriceCents: number; + materialUnitPriceCents: number; + labourUnitPriceCents: number; + matchedKeywords: string[]; +} +``` +### Return Type +Recall that executing the `CreateQuoteItem` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateQuoteItemData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateQuoteItemData { + quoteItem_insert: QuoteItem_Key; +} +``` +### Using `CreateQuoteItem`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createQuoteItem, CreateQuoteItemVariables } from '@generated/data-connector-web'; + +// The `CreateQuoteItem` mutation requires an argument of type `CreateQuoteItemVariables`: +const createQuoteItemVars: CreateQuoteItemVariables = { + id: ..., + ownerId: ..., + quoteId: ..., + sourceTemplateId: ..., // optional + displayOrder: ..., + name: ..., + quantity: ..., + quantitySourceId: ..., // optional + unitPriceCents: ..., + materialUnitPriceCents: ..., + labourUnitPriceCents: ..., + matchedKeywords: ..., +}; + +// Call the `createQuoteItem()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createQuoteItem(createQuoteItemVars); +// Variables can be defined inline as well. +const { data } = await createQuoteItem({ id: ..., ownerId: ..., quoteId: ..., sourceTemplateId: ..., displayOrder: ..., name: ..., quantity: ..., quantitySourceId: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., matchedKeywords: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createQuoteItem(dataConnect, createQuoteItemVars); + +console.log(data.quoteItem_insert); + +// Or, you can use the `Promise` API. +createQuoteItem(createQuoteItemVars).then((response) => { + const data = response.data; + console.log(data.quoteItem_insert); +}); +``` + +### Using `CreateQuoteItem`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createQuoteItemRef, CreateQuoteItemVariables } from '@generated/data-connector-web'; + +// The `CreateQuoteItem` mutation requires an argument of type `CreateQuoteItemVariables`: +const createQuoteItemVars: CreateQuoteItemVariables = { + id: ..., + ownerId: ..., + quoteId: ..., + sourceTemplateId: ..., // optional + displayOrder: ..., + name: ..., + quantity: ..., + quantitySourceId: ..., // optional + unitPriceCents: ..., + materialUnitPriceCents: ..., + labourUnitPriceCents: ..., + matchedKeywords: ..., +}; + +// Call the `createQuoteItemRef()` function to get a reference to the mutation. +const ref = createQuoteItemRef(createQuoteItemVars); +// Variables can be defined inline as well. +const ref = createQuoteItemRef({ id: ..., ownerId: ..., quoteId: ..., sourceTemplateId: ..., displayOrder: ..., name: ..., quantity: ..., quantitySourceId: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., matchedKeywords: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createQuoteItemRef(dataConnect, createQuoteItemVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quoteItem_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quoteItem_insert); +}); +``` + +## UpdateQuoteItem +You can execute the `UpdateQuoteItem` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateQuoteItem(vars: UpdateQuoteItemVariables): MutationPromise; + +interface UpdateQuoteItemRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuoteItemVariables): MutationRef; +} +export const updateQuoteItemRef: UpdateQuoteItemRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateQuoteItem(dc: DataConnect, vars: UpdateQuoteItemVariables): MutationPromise; + +interface UpdateQuoteItemRef { + ... + (dc: DataConnect, vars: UpdateQuoteItemVariables): MutationRef; +} +export const updateQuoteItemRef: UpdateQuoteItemRef; +``` + +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 updateQuoteItemRef: +```typescript +const name = updateQuoteItemRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateQuoteItem` mutation requires an argument of type `UpdateQuoteItemVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateQuoteItemVariables { + id: UUIDString; + displayOrder?: number | null; + name?: string | null; + quantity?: number | null; + quantitySourceId?: UUIDString | null; + unitPriceCents?: number | null; + materialUnitPriceCents?: number | null; + labourUnitPriceCents?: number | null; + matchedKeywords?: string[] | null; +} +``` +### Return Type +Recall that executing the `UpdateQuoteItem` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateQuoteItemData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateQuoteItemData { + quoteItem_update?: QuoteItem_Key | null; +} +``` +### Using `UpdateQuoteItem`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateQuoteItem, UpdateQuoteItemVariables } from '@generated/data-connector-web'; + +// The `UpdateQuoteItem` mutation requires an argument of type `UpdateQuoteItemVariables`: +const updateQuoteItemVars: UpdateQuoteItemVariables = { + id: ..., + displayOrder: ..., // optional + name: ..., // optional + quantity: ..., // optional + quantitySourceId: ..., // optional + unitPriceCents: ..., // optional + materialUnitPriceCents: ..., // optional + labourUnitPriceCents: ..., // optional + matchedKeywords: ..., // optional +}; + +// Call the `updateQuoteItem()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateQuoteItem(updateQuoteItemVars); +// Variables can be defined inline as well. +const { data } = await updateQuoteItem({ id: ..., displayOrder: ..., name: ..., quantity: ..., quantitySourceId: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., matchedKeywords: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateQuoteItem(dataConnect, updateQuoteItemVars); + +console.log(data.quoteItem_update); + +// Or, you can use the `Promise` API. +updateQuoteItem(updateQuoteItemVars).then((response) => { + const data = response.data; + console.log(data.quoteItem_update); +}); +``` + +### Using `UpdateQuoteItem`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateQuoteItemRef, UpdateQuoteItemVariables } from '@generated/data-connector-web'; + +// The `UpdateQuoteItem` mutation requires an argument of type `UpdateQuoteItemVariables`: +const updateQuoteItemVars: UpdateQuoteItemVariables = { + id: ..., + displayOrder: ..., // optional + name: ..., // optional + quantity: ..., // optional + quantitySourceId: ..., // optional + unitPriceCents: ..., // optional + materialUnitPriceCents: ..., // optional + labourUnitPriceCents: ..., // optional + matchedKeywords: ..., // optional +}; + +// Call the `updateQuoteItemRef()` function to get a reference to the mutation. +const ref = updateQuoteItemRef(updateQuoteItemVars); +// Variables can be defined inline as well. +const ref = updateQuoteItemRef({ id: ..., displayOrder: ..., name: ..., quantity: ..., quantitySourceId: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., matchedKeywords: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateQuoteItemRef(dataConnect, updateQuoteItemVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.quoteItem_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.quoteItem_update); +}); +``` + +## CreateReminder +You can execute the `CreateReminder` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +createReminder(vars: CreateReminderVariables): MutationPromise; + +interface CreateReminderRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateReminderVariables): MutationRef; +} +export const createReminderRef: CreateReminderRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createReminder(dc: DataConnect, vars: CreateReminderVariables): MutationPromise; + +interface CreateReminderRef { + ... + (dc: DataConnect, vars: CreateReminderVariables): MutationRef; +} +export const createReminderRef: CreateReminderRef; +``` + +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 createReminderRef: +```typescript +const name = createReminderRef.operationName; +console.log(name); +``` + +### Variables +The `CreateReminder` mutation requires an argument of type `CreateReminderVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateReminderVariables { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; +} +``` +### Return Type +Recall that executing the `CreateReminder` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateReminderData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateReminderData { + reminder_insert: Reminder_Key; +} +``` +### Using `CreateReminder`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createReminder, CreateReminderVariables } from '@generated/data-connector-web'; + +// The `CreateReminder` mutation requires an argument of type `CreateReminderVariables`: +const createReminderVars: CreateReminderVariables = { + id: ..., + ownerId: ..., + projectId: ..., + accountId: ..., // optional + name: ..., + status: ..., + dueAt: ..., +}; + +// Call the `createReminder()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createReminder(createReminderVars); +// Variables can be defined inline as well. +const { data } = await createReminder({ id: ..., ownerId: ..., projectId: ..., accountId: ..., name: ..., status: ..., dueAt: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createReminder(dataConnect, createReminderVars); + +console.log(data.reminder_insert); + +// Or, you can use the `Promise` API. +createReminder(createReminderVars).then((response) => { + const data = response.data; + console.log(data.reminder_insert); +}); +``` + +### Using `CreateReminder`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createReminderRef, CreateReminderVariables } from '@generated/data-connector-web'; + +// The `CreateReminder` mutation requires an argument of type `CreateReminderVariables`: +const createReminderVars: CreateReminderVariables = { + id: ..., + ownerId: ..., + projectId: ..., + accountId: ..., // optional + name: ..., + status: ..., + dueAt: ..., +}; + +// Call the `createReminderRef()` function to get a reference to the mutation. +const ref = createReminderRef(createReminderVars); +// Variables can be defined inline as well. +const ref = createReminderRef({ id: ..., ownerId: ..., projectId: ..., accountId: ..., name: ..., status: ..., dueAt: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createReminderRef(dataConnect, createReminderVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.reminder_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.reminder_insert); +}); +``` + +## UpdateReminder +You can execute the `UpdateReminder` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +updateReminder(vars: UpdateReminderVariables): MutationPromise; + +interface UpdateReminderRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateReminderVariables): MutationRef; +} +export const updateReminderRef: UpdateReminderRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateReminder(dc: DataConnect, vars: UpdateReminderVariables): MutationPromise; + +interface UpdateReminderRef { + ... + (dc: DataConnect, vars: UpdateReminderVariables): MutationRef; +} +export const updateReminderRef: UpdateReminderRef; +``` + +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 updateReminderRef: +```typescript +const name = updateReminderRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateReminder` mutation requires an argument of type `UpdateReminderVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateReminderVariables { + id: UUIDString; + accountId?: UUIDString | null; + name?: string | null; + status?: string | null; + dueAt?: TimestampString | null; + completedAt?: TimestampString | null; +} +``` +### Return Type +Recall that executing the `UpdateReminder` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateReminderData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateReminderData { + reminder_update?: Reminder_Key | null; +} +``` +### Using `UpdateReminder`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateReminder, UpdateReminderVariables } from '@generated/data-connector-web'; + +// The `UpdateReminder` mutation requires an argument of type `UpdateReminderVariables`: +const updateReminderVars: UpdateReminderVariables = { + id: ..., + accountId: ..., // optional + name: ..., // optional + status: ..., // optional + dueAt: ..., // optional + completedAt: ..., // optional +}; + +// Call the `updateReminder()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateReminder(updateReminderVars); +// Variables can be defined inline as well. +const { data } = await updateReminder({ id: ..., accountId: ..., name: ..., status: ..., dueAt: ..., completedAt: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateReminder(dataConnect, updateReminderVars); + +console.log(data.reminder_update); + +// Or, you can use the `Promise` API. +updateReminder(updateReminderVars).then((response) => { + const data = response.data; + console.log(data.reminder_update); +}); +``` + +### Using `UpdateReminder`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateReminderRef, UpdateReminderVariables } from '@generated/data-connector-web'; + +// The `UpdateReminder` mutation requires an argument of type `UpdateReminderVariables`: +const updateReminderVars: UpdateReminderVariables = { + id: ..., + accountId: ..., // optional + name: ..., // optional + status: ..., // optional + dueAt: ..., // optional + completedAt: ..., // optional +}; + +// Call the `updateReminderRef()` function to get a reference to the mutation. +const ref = updateReminderRef(updateReminderVars); +// Variables can be defined inline as well. +const ref = updateReminderRef({ id: ..., accountId: ..., name: ..., status: ..., dueAt: ..., completedAt: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateReminderRef(dataConnect, updateReminderVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.reminder_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.reminder_update); +}); +``` + +## UpsertUserSettings +You can execute the `UpsertUserSettings` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [data-connector-web/index.d.ts](./index.d.ts): +```typescript +upsertUserSettings(vars: UpsertUserSettingsVariables): MutationPromise; + +interface UpsertUserSettingsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpsertUserSettingsVariables): MutationRef; +} +export const upsertUserSettingsRef: UpsertUserSettingsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +upsertUserSettings(dc: DataConnect, vars: UpsertUserSettingsVariables): MutationPromise; + +interface UpsertUserSettingsRef { + ... + (dc: DataConnect, vars: UpsertUserSettingsVariables): MutationRef; +} +export const upsertUserSettingsRef: UpsertUserSettingsRef; +``` + +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 upsertUserSettingsRef: +```typescript +const name = upsertUserSettingsRef.operationName; +console.log(name); +``` + +### Variables +The `UpsertUserSettings` mutation requires an argument of type `UpsertUserSettingsVariables`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpsertUserSettingsVariables { + ownerId: string; + quoteFollowUpEnabled: boolean; + quoteFollowUpDays: number; +} +``` +### Return Type +Recall that executing the `UpsertUserSettings` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpsertUserSettingsData`, which is defined in [data-connector-web/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpsertUserSettingsData { + userSettings_upsert: UserSettings_Key; +} +``` +### Using `UpsertUserSettings`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, upsertUserSettings, UpsertUserSettingsVariables } from '@generated/data-connector-web'; + +// The `UpsertUserSettings` mutation requires an argument of type `UpsertUserSettingsVariables`: +const upsertUserSettingsVars: UpsertUserSettingsVariables = { + ownerId: ..., + quoteFollowUpEnabled: ..., + quoteFollowUpDays: ..., +}; + +// Call the `upsertUserSettings()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await upsertUserSettings(upsertUserSettingsVars); +// Variables can be defined inline as well. +const { data } = await upsertUserSettings({ ownerId: ..., quoteFollowUpEnabled: ..., quoteFollowUpDays: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await upsertUserSettings(dataConnect, upsertUserSettingsVars); + +console.log(data.userSettings_upsert); + +// Or, you can use the `Promise` API. +upsertUserSettings(upsertUserSettingsVars).then((response) => { + const data = response.data; + console.log(data.userSettings_upsert); +}); +``` + +### Using `UpsertUserSettings`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, upsertUserSettingsRef, UpsertUserSettingsVariables } from '@generated/data-connector-web'; + +// The `UpsertUserSettings` mutation requires an argument of type `UpsertUserSettingsVariables`: +const upsertUserSettingsVars: UpsertUserSettingsVariables = { + ownerId: ..., + quoteFollowUpEnabled: ..., + quoteFollowUpDays: ..., +}; + +// Call the `upsertUserSettingsRef()` function to get a reference to the mutation. +const ref = upsertUserSettingsRef(upsertUserSettingsVars); +// Variables can be defined inline as well. +const ref = upsertUserSettingsRef({ ownerId: ..., quoteFollowUpEnabled: ..., quoteFollowUpDays: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = upsertUserSettingsRef(dataConnect, upsertUserSettingsVars); + +// Call `executeMutation()` on the reference to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeMutation(ref); + +console.log(data.userSettings_upsert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.userSettings_upsert); +}); +``` + diff --git a/generated/data-connector-web/esm/index.esm.js b/generated/data-connector-web/esm/index.esm.js new file mode 100644 index 0000000..742f822 --- /dev/null +++ b/generated/data-connector-web/esm/index.esm.js @@ -0,0 +1,718 @@ +import { queryRef, executeQuery, validateArgsWithOptions, mutationRef, executeMutation, validateArgs } from 'firebase/data-connect'; + +export const connectorConfig = { + connector: 'data-connector', + service: 'plaster-calculator', + location: 'us-west1' +}; +export const createAccountRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateAccount', inputVars); +} +createAccountRef.operationName = 'CreateAccount'; + +export function createAccount(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createAccountRef(dcInstance, inputVars)); +} + +export const updateAccountRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateAccount', inputVars); +} +updateAccountRef.operationName = 'UpdateAccount'; + +export function updateAccount(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateAccountRef(dcInstance, inputVars)); +} + +export const deleteAccountContactsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteAccountContacts', inputVars); +} +deleteAccountContactsRef.operationName = 'DeleteAccountContacts'; + +export function deleteAccountContacts(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteAccountContactsRef(dcInstance, inputVars)); +} + +export const deleteAccountRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteAccount', inputVars); +} +deleteAccountRef.operationName = 'DeleteAccount'; + +export function deleteAccount(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteAccountRef(dcInstance, inputVars)); +} + +export const createAccountContactRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateAccountContact', inputVars); +} +createAccountContactRef.operationName = 'CreateAccountContact'; + +export function createAccountContact(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createAccountContactRef(dcInstance, inputVars)); +} + +export const updateAccountContactRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateAccountContact', inputVars); +} +updateAccountContactRef.operationName = 'UpdateAccountContact'; + +export function updateAccountContact(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateAccountContactRef(dcInstance, inputVars)); +} + +export const deleteAccountContactRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteAccountContact', inputVars); +} +deleteAccountContactRef.operationName = 'DeleteAccountContact'; + +export function deleteAccountContact(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteAccountContactRef(dcInstance, inputVars)); +} + +export const listAccountsByOwnerRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListAccountsByOwner', inputVars); +} +listAccountsByOwnerRef.operationName = 'ListAccountsByOwner'; + +export function listAccountsByOwner(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listAccountsByOwnerRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const getAccountByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetAccountById', inputVars); +} +getAccountByIdRef.operationName = 'GetAccountById'; + +export function getAccountById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getAccountByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const listAccountContactsByAccountIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListAccountContactsByAccountId', inputVars); +} +listAccountContactsByAccountIdRef.operationName = 'ListAccountContactsByAccountId'; + +export function listAccountContactsByAccountId(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listAccountContactsByAccountIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const getAccountContactByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetAccountContactById', inputVars); +} +getAccountContactByIdRef.operationName = 'GetAccountContactById'; + +export function getAccountContactById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getAccountContactByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const createProjectFromUploadRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateProjectFromUpload', inputVars); +} +createProjectFromUploadRef.operationName = 'CreateProjectFromUpload'; + +export function createProjectFromUpload(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createProjectFromUploadRef(dcInstance, inputVars)); +} + +export const updateProjectRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateProject', inputVars); +} +updateProjectRef.operationName = 'UpdateProject'; + +export function updateProject(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateProjectRef(dcInstance, inputVars)); +} + +export const renameProjectRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'RenameProject', inputVars); +} +renameProjectRef.operationName = 'RenameProject'; + +export function renameProject(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(renameProjectRef(dcInstance, inputVars)); +} + +export const touchProjectRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'TouchProject', inputVars); +} +touchProjectRef.operationName = 'TouchProject'; + +export function touchProject(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(touchProjectRef(dcInstance, inputVars)); +} + +export const deleteFloorplanPagesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteFloorplanPages', inputVars); +} +deleteFloorplanPagesRef.operationName = 'DeleteFloorplanPages'; + +export function deleteFloorplanPages(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteFloorplanPagesRef(dcInstance, inputVars)); +} + +export const deleteProjectRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteProject', inputVars); +} +deleteProjectRef.operationName = 'DeleteProject'; + +export function deleteProject(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteProjectRef(dcInstance, inputVars)); +} + +export const createFloorplanPageRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateFloorplanPage', inputVars); +} +createFloorplanPageRef.operationName = 'CreateFloorplanPage'; + +export function createFloorplanPage(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createFloorplanPageRef(dcInstance, inputVars)); +} + +export const updateFloorplanPageAnalysisRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateFloorplanPageAnalysis', inputVars); +} +updateFloorplanPageAnalysisRef.operationName = 'UpdateFloorplanPageAnalysis'; + +export function updateFloorplanPageAnalysis(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateFloorplanPageAnalysisRef(dcInstance, inputVars)); +} + +export const updateFloorplanPageRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateFloorplanPage', inputVars); +} +updateFloorplanPageRef.operationName = 'UpdateFloorplanPage'; + +export function updateFloorplanPage(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateFloorplanPageRef(dcInstance, inputVars)); +} + +export const updateFloorplanPagesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateFloorplanPages', inputVars); +} +updateFloorplanPagesRef.operationName = 'UpdateFloorplanPages'; + +export function updateFloorplanPages(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateFloorplanPagesRef(dcInstance, inputVars)); +} + +export const listProjectsByOwnerAndSalesStatusRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListProjectsByOwnerAndSalesStatus', inputVars); +} +listProjectsByOwnerAndSalesStatusRef.operationName = 'ListProjectsByOwnerAndSalesStatus'; + +export function listProjectsByOwnerAndSalesStatus(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listProjectsByOwnerAndSalesStatusRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const listProjectsByAccountRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListProjectsByAccount', inputVars); +} +listProjectsByAccountRef.operationName = 'ListProjectsByAccount'; + +export function listProjectsByAccount(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listProjectsByAccountRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const getProjectDetailsByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetProjectDetailsById', inputVars); +} +getProjectDetailsByIdRef.operationName = 'GetProjectDetailsById'; + +export function getProjectDetailsById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getProjectDetailsByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const getProjectByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetProjectById', inputVars); +} +getProjectByIdRef.operationName = 'GetProjectById'; + +export function getProjectById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getProjectByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const getFloorplanPageByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetFloorplanPageById', inputVars); +} +getFloorplanPageByIdRef.operationName = 'GetFloorplanPageById'; + +export function getFloorplanPageById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getFloorplanPageByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const createQuestionnaireTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuestionnaireTemplate', inputVars); +} +createQuestionnaireTemplateRef.operationName = 'CreateQuestionnaireTemplate'; + +export function createQuestionnaireTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuestionnaireTemplateRef(dcInstance, inputVars)); +} + +export const createQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuestionnaireTemplateQuestion', inputVars); +} +createQuestionnaireTemplateQuestionRef.operationName = 'CreateQuestionnaireTemplateQuestion'; + +export function createQuestionnaireTemplateQuestion(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); +} + +export const updateQuestionnaireTemplateNameRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuestionnaireTemplateName', inputVars); +} +updateQuestionnaireTemplateNameRef.operationName = 'UpdateQuestionnaireTemplateName'; + +export function updateQuestionnaireTemplateName(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuestionnaireTemplateNameRef(dcInstance, inputVars)); +} + +export const updateQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuestionnaireTemplateQuestion', inputVars); +} +updateQuestionnaireTemplateQuestionRef.operationName = 'UpdateQuestionnaireTemplateQuestion'; + +export function updateQuestionnaireTemplateQuestion(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); +} + +export const deleteQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteQuestionnaireTemplateQuestion', inputVars); +} +deleteQuestionnaireTemplateQuestionRef.operationName = 'DeleteQuestionnaireTemplateQuestion'; + +export function deleteQuestionnaireTemplateQuestion(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); +} + +export const deleteQuestionnaireTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteQuestionnaireTemplate', inputVars); +} +deleteQuestionnaireTemplateRef.operationName = 'DeleteQuestionnaireTemplate'; + +export function deleteQuestionnaireTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteQuestionnaireTemplateRef(dcInstance, inputVars)); +} + +export const createProjectQuestionnaireRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateProjectQuestionnaire', inputVars); +} +createProjectQuestionnaireRef.operationName = 'CreateProjectQuestionnaire'; + +export function createProjectQuestionnaire(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createProjectQuestionnaireRef(dcInstance, inputVars)); +} + +export const createProjectQuestionnaireAnswerRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateProjectQuestionnaireAnswer', inputVars); +} +createProjectQuestionnaireAnswerRef.operationName = 'CreateProjectQuestionnaireAnswer'; + +export function createProjectQuestionnaireAnswer(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createProjectQuestionnaireAnswerRef(dcInstance, inputVars)); +} + +export const listQuestionnaireTemplatesRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListQuestionnaireTemplates'); +} +listQuestionnaireTemplatesRef.operationName = 'ListQuestionnaireTemplates'; + +export function listQuestionnaireTemplates(dcOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrOptions, options, undefined,false, false); + return executeQuery(listQuestionnaireTemplatesRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const getQuestionnaireTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetQuestionnaireTemplate', inputVars); +} +getQuestionnaireTemplateRef.operationName = 'GetQuestionnaireTemplate'; + +export function getQuestionnaireTemplate(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getQuestionnaireTemplateRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const createQuantitySourceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuantitySource', inputVars); +} +createQuantitySourceRef.operationName = 'CreateQuantitySource'; + +export function createQuantitySource(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuantitySourceRef(dcInstance, inputVars)); +} + +export const createQuoteItemTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuoteItemTemplate', inputVars); +} +createQuoteItemTemplateRef.operationName = 'CreateQuoteItemTemplate'; + +export function createQuoteItemTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuoteItemTemplateRef(dcInstance, inputVars)); +} + +export const updateQuoteItemTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuoteItemTemplate', inputVars); +} +updateQuoteItemTemplateRef.operationName = 'UpdateQuoteItemTemplate'; + +export function updateQuoteItemTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuoteItemTemplateRef(dcInstance, inputVars)); +} + +export const deleteQuoteItemTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteQuoteItemTemplate', inputVars); +} +deleteQuoteItemTemplateRef.operationName = 'DeleteQuoteItemTemplate'; + +export function deleteQuoteItemTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteQuoteItemTemplateRef(dcInstance, inputVars)); +} + +export const upsertQuoteItemTemplateConfigRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpsertQuoteItemTemplateConfig', inputVars); +} +upsertQuoteItemTemplateConfigRef.operationName = 'UpsertQuoteItemTemplateConfig'; + +export function upsertQuoteItemTemplateConfig(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(upsertQuoteItemTemplateConfigRef(dcInstance, inputVars)); +} + +export const createSupplierRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateSupplier', inputVars); +} +createSupplierRef.operationName = 'CreateSupplier'; + +export function createSupplier(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createSupplierRef(dcInstance, inputVars)); +} + +export const updateSupplierRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateSupplier', inputVars); +} +updateSupplierRef.operationName = 'UpdateSupplier'; + +export function updateSupplier(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateSupplierRef(dcInstance, inputVars)); +} + +export const deleteSupplierRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteSupplier', inputVars); +} +deleteSupplierRef.operationName = 'DeleteSupplier'; + +export function deleteSupplier(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteSupplierRef(dcInstance, inputVars)); +} + +export const upsertSupplierQuoteItemPriceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpsertSupplierQuoteItemPrice', inputVars); +} +upsertSupplierQuoteItemPriceRef.operationName = 'UpsertSupplierQuoteItemPrice'; + +export function upsertSupplierQuoteItemPrice(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(upsertSupplierQuoteItemPriceRef(dcInstance, inputVars)); +} + +export const deleteSupplierQuoteItemPriceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteSupplierQuoteItemPrice', inputVars); +} +deleteSupplierQuoteItemPriceRef.operationName = 'DeleteSupplierQuoteItemPrice'; + +export function deleteSupplierQuoteItemPrice(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteSupplierQuoteItemPriceRef(dcInstance, inputVars)); +} + +export const createQuoteRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuote', inputVars); +} +createQuoteRef.operationName = 'CreateQuote'; + +export function createQuote(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuoteRef(dcInstance, inputVars)); +} + +export const updateQuoteRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuote', inputVars); +} +updateQuoteRef.operationName = 'UpdateQuote'; + +export function updateQuote(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuoteRef(dcInstance, inputVars)); +} + +export const deleteQuoteItemsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteQuoteItems', inputVars); +} +deleteQuoteItemsRef.operationName = 'DeleteQuoteItems'; + +export function deleteQuoteItems(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteQuoteItemsRef(dcInstance, inputVars)); +} + +export const createQuoteItemRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuoteItem', inputVars); +} +createQuoteItemRef.operationName = 'CreateQuoteItem'; + +export function createQuoteItem(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuoteItemRef(dcInstance, inputVars)); +} + +export const updateQuoteItemRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuoteItem', inputVars); +} +updateQuoteItemRef.operationName = 'UpdateQuoteItem'; + +export function updateQuoteItem(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuoteItemRef(dcInstance, inputVars)); +} + +export const createReminderRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateReminder', inputVars); +} +createReminderRef.operationName = 'CreateReminder'; + +export function createReminder(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createReminderRef(dcInstance, inputVars)); +} + +export const updateReminderRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateReminder', inputVars); +} +updateReminderRef.operationName = 'UpdateReminder'; + +export function updateReminder(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateReminderRef(dcInstance, inputVars)); +} + +export const listDueRemindersRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListDueReminders', inputVars); +} +listDueRemindersRef.operationName = 'ListDueReminders'; + +export function listDueReminders(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listDueRemindersRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const listProjectRemindersRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListProjectReminders', inputVars); +} +listProjectRemindersRef.operationName = 'ListProjectReminders'; + +export function listProjectReminders(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listProjectRemindersRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const getReminderByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetReminderById', inputVars); +} +getReminderByIdRef.operationName = 'GetReminderById'; + +export function getReminderById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getReminderByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + +export const upsertUserSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpsertUserSettings', inputVars); +} +upsertUserSettingsRef.operationName = 'UpsertUserSettings'; + +export function upsertUserSettings(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(upsertUserSettingsRef(dcInstance, inputVars)); +} + +export const getUserSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetUserSettings', inputVars); +} +getUserSettingsRef.operationName = 'GetUserSettings'; + +export function getUserSettings(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getUserSettingsRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} + diff --git a/generated/example-data-connector/esm/package.json b/generated/data-connector-web/esm/package.json similarity index 100% rename from generated/example-data-connector/esm/package.json rename to generated/data-connector-web/esm/package.json diff --git a/generated/data-connector-web/index.cjs.js b/generated/data-connector-web/index.cjs.js new file mode 100644 index 0000000..acc27c5 --- /dev/null +++ b/generated/data-connector-web/index.cjs.js @@ -0,0 +1,835 @@ +const { queryRef, executeQuery, validateArgsWithOptions, mutationRef, executeMutation, validateArgs } = require('firebase/data-connect'); + +const connectorConfig = { + connector: 'data-connector', + service: 'plaster-calculator', + location: 'us-west1' +}; +exports.connectorConfig = connectorConfig; + +const createAccountRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateAccount', inputVars); +} +createAccountRef.operationName = 'CreateAccount'; +exports.createAccountRef = createAccountRef; + +exports.createAccount = function createAccount(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createAccountRef(dcInstance, inputVars)); +} +; + +const updateAccountRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateAccount', inputVars); +} +updateAccountRef.operationName = 'UpdateAccount'; +exports.updateAccountRef = updateAccountRef; + +exports.updateAccount = function updateAccount(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateAccountRef(dcInstance, inputVars)); +} +; + +const deleteAccountContactsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteAccountContacts', inputVars); +} +deleteAccountContactsRef.operationName = 'DeleteAccountContacts'; +exports.deleteAccountContactsRef = deleteAccountContactsRef; + +exports.deleteAccountContacts = function deleteAccountContacts(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteAccountContactsRef(dcInstance, inputVars)); +} +; + +const deleteAccountRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteAccount', inputVars); +} +deleteAccountRef.operationName = 'DeleteAccount'; +exports.deleteAccountRef = deleteAccountRef; + +exports.deleteAccount = function deleteAccount(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteAccountRef(dcInstance, inputVars)); +} +; + +const createAccountContactRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateAccountContact', inputVars); +} +createAccountContactRef.operationName = 'CreateAccountContact'; +exports.createAccountContactRef = createAccountContactRef; + +exports.createAccountContact = function createAccountContact(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createAccountContactRef(dcInstance, inputVars)); +} +; + +const updateAccountContactRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateAccountContact', inputVars); +} +updateAccountContactRef.operationName = 'UpdateAccountContact'; +exports.updateAccountContactRef = updateAccountContactRef; + +exports.updateAccountContact = function updateAccountContact(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateAccountContactRef(dcInstance, inputVars)); +} +; + +const deleteAccountContactRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteAccountContact', inputVars); +} +deleteAccountContactRef.operationName = 'DeleteAccountContact'; +exports.deleteAccountContactRef = deleteAccountContactRef; + +exports.deleteAccountContact = function deleteAccountContact(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteAccountContactRef(dcInstance, inputVars)); +} +; + +const listAccountsByOwnerRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListAccountsByOwner', inputVars); +} +listAccountsByOwnerRef.operationName = 'ListAccountsByOwner'; +exports.listAccountsByOwnerRef = listAccountsByOwnerRef; + +exports.listAccountsByOwner = function listAccountsByOwner(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listAccountsByOwnerRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const getAccountByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetAccountById', inputVars); +} +getAccountByIdRef.operationName = 'GetAccountById'; +exports.getAccountByIdRef = getAccountByIdRef; + +exports.getAccountById = function getAccountById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getAccountByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const listAccountContactsByAccountIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListAccountContactsByAccountId', inputVars); +} +listAccountContactsByAccountIdRef.operationName = 'ListAccountContactsByAccountId'; +exports.listAccountContactsByAccountIdRef = listAccountContactsByAccountIdRef; + +exports.listAccountContactsByAccountId = function listAccountContactsByAccountId(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listAccountContactsByAccountIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const getAccountContactByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetAccountContactById', inputVars); +} +getAccountContactByIdRef.operationName = 'GetAccountContactById'; +exports.getAccountContactByIdRef = getAccountContactByIdRef; + +exports.getAccountContactById = function getAccountContactById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getAccountContactByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const createProjectFromUploadRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateProjectFromUpload', inputVars); +} +createProjectFromUploadRef.operationName = 'CreateProjectFromUpload'; +exports.createProjectFromUploadRef = createProjectFromUploadRef; + +exports.createProjectFromUpload = function createProjectFromUpload(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createProjectFromUploadRef(dcInstance, inputVars)); +} +; + +const updateProjectRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateProject', inputVars); +} +updateProjectRef.operationName = 'UpdateProject'; +exports.updateProjectRef = updateProjectRef; + +exports.updateProject = function updateProject(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateProjectRef(dcInstance, inputVars)); +} +; + +const renameProjectRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'RenameProject', inputVars); +} +renameProjectRef.operationName = 'RenameProject'; +exports.renameProjectRef = renameProjectRef; + +exports.renameProject = function renameProject(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(renameProjectRef(dcInstance, inputVars)); +} +; + +const touchProjectRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'TouchProject', inputVars); +} +touchProjectRef.operationName = 'TouchProject'; +exports.touchProjectRef = touchProjectRef; + +exports.touchProject = function touchProject(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(touchProjectRef(dcInstance, inputVars)); +} +; + +const deleteFloorplanPagesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteFloorplanPages', inputVars); +} +deleteFloorplanPagesRef.operationName = 'DeleteFloorplanPages'; +exports.deleteFloorplanPagesRef = deleteFloorplanPagesRef; + +exports.deleteFloorplanPages = function deleteFloorplanPages(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteFloorplanPagesRef(dcInstance, inputVars)); +} +; + +const deleteProjectRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteProject', inputVars); +} +deleteProjectRef.operationName = 'DeleteProject'; +exports.deleteProjectRef = deleteProjectRef; + +exports.deleteProject = function deleteProject(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteProjectRef(dcInstance, inputVars)); +} +; + +const createFloorplanPageRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateFloorplanPage', inputVars); +} +createFloorplanPageRef.operationName = 'CreateFloorplanPage'; +exports.createFloorplanPageRef = createFloorplanPageRef; + +exports.createFloorplanPage = function createFloorplanPage(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createFloorplanPageRef(dcInstance, inputVars)); +} +; + +const updateFloorplanPageAnalysisRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateFloorplanPageAnalysis', inputVars); +} +updateFloorplanPageAnalysisRef.operationName = 'UpdateFloorplanPageAnalysis'; +exports.updateFloorplanPageAnalysisRef = updateFloorplanPageAnalysisRef; + +exports.updateFloorplanPageAnalysis = function updateFloorplanPageAnalysis(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateFloorplanPageAnalysisRef(dcInstance, inputVars)); +} +; + +const updateFloorplanPageRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateFloorplanPage', inputVars); +} +updateFloorplanPageRef.operationName = 'UpdateFloorplanPage'; +exports.updateFloorplanPageRef = updateFloorplanPageRef; + +exports.updateFloorplanPage = function updateFloorplanPage(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateFloorplanPageRef(dcInstance, inputVars)); +} +; + +const updateFloorplanPagesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateFloorplanPages', inputVars); +} +updateFloorplanPagesRef.operationName = 'UpdateFloorplanPages'; +exports.updateFloorplanPagesRef = updateFloorplanPagesRef; + +exports.updateFloorplanPages = function updateFloorplanPages(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateFloorplanPagesRef(dcInstance, inputVars)); +} +; + +const listProjectsByOwnerAndSalesStatusRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListProjectsByOwnerAndSalesStatus', inputVars); +} +listProjectsByOwnerAndSalesStatusRef.operationName = 'ListProjectsByOwnerAndSalesStatus'; +exports.listProjectsByOwnerAndSalesStatusRef = listProjectsByOwnerAndSalesStatusRef; + +exports.listProjectsByOwnerAndSalesStatus = function listProjectsByOwnerAndSalesStatus(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listProjectsByOwnerAndSalesStatusRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const listProjectsByAccountRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListProjectsByAccount', inputVars); +} +listProjectsByAccountRef.operationName = 'ListProjectsByAccount'; +exports.listProjectsByAccountRef = listProjectsByAccountRef; + +exports.listProjectsByAccount = function listProjectsByAccount(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listProjectsByAccountRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const getProjectDetailsByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetProjectDetailsById', inputVars); +} +getProjectDetailsByIdRef.operationName = 'GetProjectDetailsById'; +exports.getProjectDetailsByIdRef = getProjectDetailsByIdRef; + +exports.getProjectDetailsById = function getProjectDetailsById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getProjectDetailsByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const getProjectByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetProjectById', inputVars); +} +getProjectByIdRef.operationName = 'GetProjectById'; +exports.getProjectByIdRef = getProjectByIdRef; + +exports.getProjectById = function getProjectById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getProjectByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const getFloorplanPageByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetFloorplanPageById', inputVars); +} +getFloorplanPageByIdRef.operationName = 'GetFloorplanPageById'; +exports.getFloorplanPageByIdRef = getFloorplanPageByIdRef; + +exports.getFloorplanPageById = function getFloorplanPageById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getFloorplanPageByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const createQuestionnaireTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuestionnaireTemplate', inputVars); +} +createQuestionnaireTemplateRef.operationName = 'CreateQuestionnaireTemplate'; +exports.createQuestionnaireTemplateRef = createQuestionnaireTemplateRef; + +exports.createQuestionnaireTemplate = function createQuestionnaireTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuestionnaireTemplateRef(dcInstance, inputVars)); +} +; + +const createQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuestionnaireTemplateQuestion', inputVars); +} +createQuestionnaireTemplateQuestionRef.operationName = 'CreateQuestionnaireTemplateQuestion'; +exports.createQuestionnaireTemplateQuestionRef = createQuestionnaireTemplateQuestionRef; + +exports.createQuestionnaireTemplateQuestion = function createQuestionnaireTemplateQuestion(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); +} +; + +const updateQuestionnaireTemplateNameRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuestionnaireTemplateName', inputVars); +} +updateQuestionnaireTemplateNameRef.operationName = 'UpdateQuestionnaireTemplateName'; +exports.updateQuestionnaireTemplateNameRef = updateQuestionnaireTemplateNameRef; + +exports.updateQuestionnaireTemplateName = function updateQuestionnaireTemplateName(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuestionnaireTemplateNameRef(dcInstance, inputVars)); +} +; + +const updateQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuestionnaireTemplateQuestion', inputVars); +} +updateQuestionnaireTemplateQuestionRef.operationName = 'UpdateQuestionnaireTemplateQuestion'; +exports.updateQuestionnaireTemplateQuestionRef = updateQuestionnaireTemplateQuestionRef; + +exports.updateQuestionnaireTemplateQuestion = function updateQuestionnaireTemplateQuestion(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); +} +; + +const deleteQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteQuestionnaireTemplateQuestion', inputVars); +} +deleteQuestionnaireTemplateQuestionRef.operationName = 'DeleteQuestionnaireTemplateQuestion'; +exports.deleteQuestionnaireTemplateQuestionRef = deleteQuestionnaireTemplateQuestionRef; + +exports.deleteQuestionnaireTemplateQuestion = function deleteQuestionnaireTemplateQuestion(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); +} +; + +const deleteQuestionnaireTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteQuestionnaireTemplate', inputVars); +} +deleteQuestionnaireTemplateRef.operationName = 'DeleteQuestionnaireTemplate'; +exports.deleteQuestionnaireTemplateRef = deleteQuestionnaireTemplateRef; + +exports.deleteQuestionnaireTemplate = function deleteQuestionnaireTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteQuestionnaireTemplateRef(dcInstance, inputVars)); +} +; + +const createProjectQuestionnaireRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateProjectQuestionnaire', inputVars); +} +createProjectQuestionnaireRef.operationName = 'CreateProjectQuestionnaire'; +exports.createProjectQuestionnaireRef = createProjectQuestionnaireRef; + +exports.createProjectQuestionnaire = function createProjectQuestionnaire(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createProjectQuestionnaireRef(dcInstance, inputVars)); +} +; + +const createProjectQuestionnaireAnswerRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateProjectQuestionnaireAnswer', inputVars); +} +createProjectQuestionnaireAnswerRef.operationName = 'CreateProjectQuestionnaireAnswer'; +exports.createProjectQuestionnaireAnswerRef = createProjectQuestionnaireAnswerRef; + +exports.createProjectQuestionnaireAnswer = function createProjectQuestionnaireAnswer(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createProjectQuestionnaireAnswerRef(dcInstance, inputVars)); +} +; + +const listQuestionnaireTemplatesRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListQuestionnaireTemplates'); +} +listQuestionnaireTemplatesRef.operationName = 'ListQuestionnaireTemplates'; +exports.listQuestionnaireTemplatesRef = listQuestionnaireTemplatesRef; + +exports.listQuestionnaireTemplates = function listQuestionnaireTemplates(dcOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrOptions, options, undefined,false, false); + return executeQuery(listQuestionnaireTemplatesRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const getQuestionnaireTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetQuestionnaireTemplate', inputVars); +} +getQuestionnaireTemplateRef.operationName = 'GetQuestionnaireTemplate'; +exports.getQuestionnaireTemplateRef = getQuestionnaireTemplateRef; + +exports.getQuestionnaireTemplate = function getQuestionnaireTemplate(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getQuestionnaireTemplateRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const createQuantitySourceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuantitySource', inputVars); +} +createQuantitySourceRef.operationName = 'CreateQuantitySource'; +exports.createQuantitySourceRef = createQuantitySourceRef; + +exports.createQuantitySource = function createQuantitySource(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuantitySourceRef(dcInstance, inputVars)); +} +; + +const createQuoteItemTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuoteItemTemplate', inputVars); +} +createQuoteItemTemplateRef.operationName = 'CreateQuoteItemTemplate'; +exports.createQuoteItemTemplateRef = createQuoteItemTemplateRef; + +exports.createQuoteItemTemplate = function createQuoteItemTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuoteItemTemplateRef(dcInstance, inputVars)); +} +; + +const updateQuoteItemTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuoteItemTemplate', inputVars); +} +updateQuoteItemTemplateRef.operationName = 'UpdateQuoteItemTemplate'; +exports.updateQuoteItemTemplateRef = updateQuoteItemTemplateRef; + +exports.updateQuoteItemTemplate = function updateQuoteItemTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuoteItemTemplateRef(dcInstance, inputVars)); +} +; + +const deleteQuoteItemTemplateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteQuoteItemTemplate', inputVars); +} +deleteQuoteItemTemplateRef.operationName = 'DeleteQuoteItemTemplate'; +exports.deleteQuoteItemTemplateRef = deleteQuoteItemTemplateRef; + +exports.deleteQuoteItemTemplate = function deleteQuoteItemTemplate(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteQuoteItemTemplateRef(dcInstance, inputVars)); +} +; + +const upsertQuoteItemTemplateConfigRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpsertQuoteItemTemplateConfig', inputVars); +} +upsertQuoteItemTemplateConfigRef.operationName = 'UpsertQuoteItemTemplateConfig'; +exports.upsertQuoteItemTemplateConfigRef = upsertQuoteItemTemplateConfigRef; + +exports.upsertQuoteItemTemplateConfig = function upsertQuoteItemTemplateConfig(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(upsertQuoteItemTemplateConfigRef(dcInstance, inputVars)); +} +; + +const createSupplierRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateSupplier', inputVars); +} +createSupplierRef.operationName = 'CreateSupplier'; +exports.createSupplierRef = createSupplierRef; + +exports.createSupplier = function createSupplier(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createSupplierRef(dcInstance, inputVars)); +} +; + +const updateSupplierRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateSupplier', inputVars); +} +updateSupplierRef.operationName = 'UpdateSupplier'; +exports.updateSupplierRef = updateSupplierRef; + +exports.updateSupplier = function updateSupplier(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateSupplierRef(dcInstance, inputVars)); +} +; + +const deleteSupplierRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteSupplier', inputVars); +} +deleteSupplierRef.operationName = 'DeleteSupplier'; +exports.deleteSupplierRef = deleteSupplierRef; + +exports.deleteSupplier = function deleteSupplier(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteSupplierRef(dcInstance, inputVars)); +} +; + +const upsertSupplierQuoteItemPriceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpsertSupplierQuoteItemPrice', inputVars); +} +upsertSupplierQuoteItemPriceRef.operationName = 'UpsertSupplierQuoteItemPrice'; +exports.upsertSupplierQuoteItemPriceRef = upsertSupplierQuoteItemPriceRef; + +exports.upsertSupplierQuoteItemPrice = function upsertSupplierQuoteItemPrice(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(upsertSupplierQuoteItemPriceRef(dcInstance, inputVars)); +} +; + +const deleteSupplierQuoteItemPriceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteSupplierQuoteItemPrice', inputVars); +} +deleteSupplierQuoteItemPriceRef.operationName = 'DeleteSupplierQuoteItemPrice'; +exports.deleteSupplierQuoteItemPriceRef = deleteSupplierQuoteItemPriceRef; + +exports.deleteSupplierQuoteItemPrice = function deleteSupplierQuoteItemPrice(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteSupplierQuoteItemPriceRef(dcInstance, inputVars)); +} +; + +const createQuoteRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuote', inputVars); +} +createQuoteRef.operationName = 'CreateQuote'; +exports.createQuoteRef = createQuoteRef; + +exports.createQuote = function createQuote(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuoteRef(dcInstance, inputVars)); +} +; + +const updateQuoteRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuote', inputVars); +} +updateQuoteRef.operationName = 'UpdateQuote'; +exports.updateQuoteRef = updateQuoteRef; + +exports.updateQuote = function updateQuote(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuoteRef(dcInstance, inputVars)); +} +; + +const deleteQuoteItemsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteQuoteItems', inputVars); +} +deleteQuoteItemsRef.operationName = 'DeleteQuoteItems'; +exports.deleteQuoteItemsRef = deleteQuoteItemsRef; + +exports.deleteQuoteItems = function deleteQuoteItems(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(deleteQuoteItemsRef(dcInstance, inputVars)); +} +; + +const createQuoteItemRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateQuoteItem', inputVars); +} +createQuoteItemRef.operationName = 'CreateQuoteItem'; +exports.createQuoteItemRef = createQuoteItemRef; + +exports.createQuoteItem = function createQuoteItem(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createQuoteItemRef(dcInstance, inputVars)); +} +; + +const updateQuoteItemRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateQuoteItem', inputVars); +} +updateQuoteItemRef.operationName = 'UpdateQuoteItem'; +exports.updateQuoteItemRef = updateQuoteItemRef; + +exports.updateQuoteItem = function updateQuoteItem(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateQuoteItemRef(dcInstance, inputVars)); +} +; + +const createReminderRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateReminder', inputVars); +} +createReminderRef.operationName = 'CreateReminder'; +exports.createReminderRef = createReminderRef; + +exports.createReminder = function createReminder(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(createReminderRef(dcInstance, inputVars)); +} +; + +const updateReminderRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateReminder', inputVars); +} +updateReminderRef.operationName = 'UpdateReminder'; +exports.updateReminderRef = updateReminderRef; + +exports.updateReminder = function updateReminder(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(updateReminderRef(dcInstance, inputVars)); +} +; + +const listDueRemindersRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListDueReminders', inputVars); +} +listDueRemindersRef.operationName = 'ListDueReminders'; +exports.listDueRemindersRef = listDueRemindersRef; + +exports.listDueReminders = function listDueReminders(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listDueRemindersRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const listProjectRemindersRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'ListProjectReminders', inputVars); +} +listProjectRemindersRef.operationName = 'ListProjectReminders'; +exports.listProjectRemindersRef = listProjectRemindersRef; + +exports.listProjectReminders = function listProjectReminders(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(listProjectRemindersRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const getReminderByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetReminderById', inputVars); +} +getReminderByIdRef.operationName = 'GetReminderById'; +exports.getReminderByIdRef = getReminderByIdRef; + +exports.getReminderById = function getReminderById(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getReminderByIdRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; + +const upsertUserSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpsertUserSettings', inputVars); +} +upsertUserSettingsRef.operationName = 'UpsertUserSettings'; +exports.upsertUserSettingsRef = upsertUserSettingsRef; + +exports.upsertUserSettings = function upsertUserSettings(dcOrVars, vars) { + const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); + return executeMutation(upsertUserSettingsRef(dcInstance, inputVars)); +} +; + +const getUserSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'GetUserSettings', inputVars); +} +getUserSettingsRef.operationName = 'GetUserSettings'; +exports.getUserSettingsRef = getUserSettingsRef; + +exports.getUserSettings = function getUserSettings(dcOrVars, varsOrOptions, options) { + + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + return executeQuery(getUserSettingsRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); +} +; diff --git a/generated/data-connector-web/index.d.ts b/generated/data-connector-web/index.d.ts new file mode 100644 index 0000000..9be17bf --- /dev/null +++ b/generated/data-connector-web/index.d.ts @@ -0,0 +1,1610 @@ +import { ConnectorConfig, DataConnect, QueryRef, QueryPromise, ExecuteQueryOptions, MutationRef, MutationPromise } from 'firebase/data-connect'; + +export const connectorConfig: ConnectorConfig; + +export type TimestampString = string; +export type UUIDString = string; +export type Int64String = string; +export type DateString = string; + + + + +export interface AccountContact_Key { + id: UUIDString; + __typename?: 'AccountContact_Key'; +} + +export interface Account_Key { + id: UUIDString; + __typename?: 'Account_Key'; +} + +export interface CreateAccountContactData { + accountContact_insert: AccountContact_Key; +} + +export interface CreateAccountContactVariables { + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; +} + +export interface CreateAccountData { + account_insert: Account_Key; +} + +export interface CreateAccountVariables { + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; +} + +export interface CreateFloorplanPageData { + floorplanPage_insert: FloorplanPage_Key; +} + +export interface CreateFloorplanPageVariables { + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; +} + +export interface CreateProjectFromUploadData { + project_insert: Project_Key; +} + +export interface CreateProjectFromUploadVariables { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus?: string | null; + pageCount: number; +} + +export interface CreateProjectQuestionnaireAnswerData { + projectQuestionnaireAnswer_insert: ProjectQuestionnaireAnswer_Key; +} + +export interface CreateProjectQuestionnaireAnswerVariables { + id: UUIDString; + projectQuestionnaireId: UUIDString; + questionId: UUIDString; + position: number; + answer?: string | null; +} + +export interface CreateProjectQuestionnaireData { + projectQuestionnaire_insert: ProjectQuestionnaire_Key; +} + +export interface CreateProjectQuestionnaireVariables { + id: UUIDString; + projectId: UUIDString; + sourceTemplateId?: UUIDString | null; +} + +export interface CreateQuantitySourceData { + quantitySource_insert: QuantitySource_Key; +} + +export interface CreateQuantitySourceVariables { + id: UUIDString; + measurementSource: string; + measurementPlasterType?: string | null; +} + +export interface CreateQuestionnaireTemplateData { + questionnaireTemplate_insert: QuestionnaireTemplate_Key; +} + +export interface CreateQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_insert: QuestionnaireTemplateQuestion_Key; +} + +export interface CreateQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; + label: string; + position: number; + description?: string | null; +} + +export interface CreateQuestionnaireTemplateVariables { + id: UUIDString; + name: string; +} + +export interface CreateQuoteData { + quote_insert: Quote_Key; +} + +export interface CreateQuoteItemData { + quoteItem_insert: QuoteItem_Key; +} + +export interface CreateQuoteItemTemplateData { + quoteItemTemplate_insert: QuoteItemTemplate_Key; +} + +export interface CreateQuoteItemTemplateVariables { + id: UUIDString; + ownerId?: string | null; + scope: string; + systemKey?: string | null; + name: string; + hasKeywords: boolean; + keywords: string[]; + quantitySourceId?: UUIDString | null; + sortOrder: number; +} + +export interface CreateQuoteItemVariables { + id: UUIDString; + ownerId: string; + quoteId: UUIDString; + sourceTemplateId?: UUIDString | null; + displayOrder: number; + name: string; + quantity: number; + quantitySourceId?: UUIDString | null; + unitPriceCents: number; + materialUnitPriceCents: number; + labourUnitPriceCents: number; + matchedKeywords: string[]; +} + +export interface CreateQuoteVariables { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + supplierId?: UUIDString | null; + status: string; +} + +export interface CreateReminderData { + reminder_insert: Reminder_Key; +} + +export interface CreateReminderVariables { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; +} + +export interface CreateSupplierData { + supplier_insert: Supplier_Key; +} + +export interface CreateSupplierVariables { + id: UUIDString; + ownerId: string; + name: string; +} + +export interface DeleteAccountContactData { + accountContact_delete?: AccountContact_Key | null; +} + +export interface DeleteAccountContactVariables { + id: UUIDString; +} + +export interface DeleteAccountContactsData { + accountContact_deleteMany: number; +} + +export interface DeleteAccountContactsVariables { + accountId: UUIDString; +} + +export interface DeleteAccountData { + account_delete?: Account_Key | null; +} + +export interface DeleteAccountVariables { + id: UUIDString; +} + +export interface DeleteFloorplanPagesData { + floorplanPage_deleteMany: number; +} + +export interface DeleteFloorplanPagesVariables { + projectId: UUIDString; +} + +export interface DeleteProjectData { + project_delete?: Project_Key | null; +} + +export interface DeleteProjectVariables { + id: UUIDString; +} + +export interface DeleteQuestionnaireTemplateData { + questionnaireTemplateQuestion_deleteMany: number; + questionnaireTemplate_delete?: QuestionnaireTemplate_Key | null; +} + +export interface DeleteQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_delete?: QuestionnaireTemplateQuestion_Key | null; +} + +export interface DeleteQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; +} + +export interface DeleteQuestionnaireTemplateVariables { + id: UUIDString; +} + +export interface DeleteQuoteItemTemplateData { + quoteItemTemplate_delete?: QuoteItemTemplate_Key | null; +} + +export interface DeleteQuoteItemTemplateVariables { + id: UUIDString; +} + +export interface DeleteQuoteItemsData { + quoteItem_deleteMany: number; +} + +export interface DeleteQuoteItemsVariables { + quoteId: UUIDString; +} + +export interface DeleteSupplierData { + supplier_delete?: Supplier_Key | null; +} + +export interface DeleteSupplierQuoteItemPriceData { + supplierQuoteItemPrice_delete?: SupplierQuoteItemPrice_Key | null; +} + +export interface DeleteSupplierQuoteItemPriceVariables { + supplierId: UUIDString; + templateId: UUIDString; +} + +export interface DeleteSupplierVariables { + id: UUIDString; +} + +export interface FloorplanPage_Key { + id: UUIDString; + __typename?: 'FloorplanPage_Key'; +} + +export interface GetAccountByIdData { + account?: { + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + contacts: ({ + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key)[]; + } & Account_Key; +} + +export interface GetAccountByIdVariables { + id: UUIDString; +} + +export interface GetAccountContactByIdData { + accountContact?: { + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key; +} + +export interface GetAccountContactByIdVariables { + accountId: UUIDString; + contactId: UUIDString; +} + +export interface GetFloorplanPageByIdData { + floorplanPage?: { + id: UUIDString; + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & FloorplanPage_Key; +} + +export interface GetFloorplanPageByIdVariables { + projectId: UUIDString; + pageId: UUIDString; +} + +export interface GetProjectByIdData { + project?: { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key; +} + +export interface GetProjectByIdVariables { + id: UUIDString; +} + +export interface GetProjectDetailsByIdData { + project?: { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + pages: ({ + id: UUIDString; + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & FloorplanPage_Key)[]; + } & Project_Key; +} + +export interface GetProjectDetailsByIdVariables { + id: UUIDString; +} + +export interface GetQuestionnaireTemplateData { + questionnaireTemplate?: { + id: UUIDString; + ownerId: string; + name: string; + createdAt: TimestampString; + updatedAt: TimestampString; + questions: ({ + id: UUIDString; + label: string; + description?: string | null; + position: number; + } & QuestionnaireTemplateQuestion_Key)[]; + } & QuestionnaireTemplate_Key; +} + +export interface GetQuestionnaireTemplateVariables { + id: UUIDString; +} + +export interface GetReminderByIdData { + reminder?: { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key; +} + +export interface GetReminderByIdVariables { + id: UUIDString; +} + +export interface GetUserSettingsData { + userSettings?: { + ownerId: string; + quoteFollowUpEnabled: boolean; + quoteFollowUpDays: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & UserSettings_Key; +} + +export interface GetUserSettingsVariables { + ownerId: string; +} + +export interface ListAccountContactsByAccountIdData { + accountContacts: ({ + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key)[]; +} + +export interface ListAccountContactsByAccountIdVariables { + accountId: UUIDString; +} + +export interface ListAccountsByOwnerData { + accounts: ({ + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Account_Key)[]; +} + +export interface ListAccountsByOwnerVariables { + ownerId: string; +} + +export interface ListDueRemindersData { + reminders: ({ + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key)[]; +} + +export interface ListDueRemindersVariables { + ownerId: string; +} + +export interface ListProjectRemindersData { + reminders: ({ + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key)[]; +} + +export interface ListProjectRemindersVariables { + projectId: UUIDString; +} + +export interface ListProjectsByAccountData { + projects: ({ + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key)[]; +} + +export interface ListProjectsByAccountVariables { + accountId: UUIDString; +} + +export interface ListProjectsByOwnerAndSalesStatusData { + projects: ({ + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key)[]; +} + +export interface ListProjectsByOwnerAndSalesStatusVariables { + ownerId: string; + salesStatus: string; +} + +export interface ListQuestionnaireTemplatesData { + questionnaireTemplates: ({ + id: UUIDString; + name: string; + createdAt: TimestampString; + updatedAt: TimestampString; + } & QuestionnaireTemplate_Key)[]; +} + +export interface ProjectQuestionnaireAnswer_Key { + id: UUIDString; + __typename?: 'ProjectQuestionnaireAnswer_Key'; +} + +export interface ProjectQuestionnaire_Key { + id: UUIDString; + __typename?: 'ProjectQuestionnaire_Key'; +} + +export interface Project_Key { + id: UUIDString; + __typename?: 'Project_Key'; +} + +export interface QuantitySource_Key { + id: UUIDString; + __typename?: 'QuantitySource_Key'; +} + +export interface QuestionnaireTemplateQuestion_Key { + id: UUIDString; + __typename?: 'QuestionnaireTemplateQuestion_Key'; +} + +export interface QuestionnaireTemplate_Key { + id: UUIDString; + __typename?: 'QuestionnaireTemplate_Key'; +} + +export interface QuoteItemTemplateConfig_Key { + ownerId: string; + templateId: UUIDString; + __typename?: 'QuoteItemTemplateConfig_Key'; +} + +export interface QuoteItemTemplate_Key { + id: UUIDString; + __typename?: 'QuoteItemTemplate_Key'; +} + +export interface QuoteItem_Key { + id: UUIDString; + __typename?: 'QuoteItem_Key'; +} + +export interface Quote_Key { + id: UUIDString; + __typename?: 'Quote_Key'; +} + +export interface Reminder_Key { + id: UUIDString; + __typename?: 'Reminder_Key'; +} + +export interface RenameProjectData { + project_update?: Project_Key | null; +} + +export interface RenameProjectVariables { + id: UUIDString; + name: string; +} + +export interface SupplierQuoteItemPrice_Key { + supplierId: UUIDString; + templateId: UUIDString; + __typename?: 'SupplierQuoteItemPrice_Key'; +} + +export interface Supplier_Key { + id: UUIDString; + __typename?: 'Supplier_Key'; +} + +export interface TouchProjectData { + project_update?: Project_Key | null; +} + +export interface TouchProjectVariables { + id: UUIDString; + status?: string | null; + processingError?: string | null; +} + +export interface UpdateAccountContactData { + accountContact_update?: AccountContact_Key | null; +} + +export interface UpdateAccountContactVariables { + id: UUIDString; + name?: string | null; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; +} + +export interface UpdateAccountData { + account_update?: Account_Key | null; +} + +export interface UpdateAccountVariables { + id: UUIDString; + companyName?: string | null; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; +} + +export interface UpdateFloorplanPageAnalysisData { + floorplanPage_update?: FloorplanPage_Key | null; +} + +export interface UpdateFloorplanPageAnalysisVariables { + id: UUIDString; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; +} + +export interface UpdateFloorplanPageData { + floorplanPage_update?: FloorplanPage_Key | null; +} + +export interface UpdateFloorplanPageVariables { + id: UUIDString; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; +} + +export interface UpdateFloorplanPagesData { + floorplanPage_updateMany: number; +} + +export interface UpdateFloorplanPagesVariables { + projectId: UUIDString; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; +} + +export interface UpdateProjectData { + project_update?: Project_Key | null; +} + +export interface UpdateProjectVariables { + id: UUIDString; + name?: string | null; + accountId?: UUIDString | null; + address?: string | null; + salesStatus?: string | null; +} + +export interface UpdateQuestionnaireTemplateNameData { + questionnaireTemplate_update?: QuestionnaireTemplate_Key | null; +} + +export interface UpdateQuestionnaireTemplateNameVariables { + id: UUIDString; + name: string; +} + +export interface UpdateQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_update?: QuestionnaireTemplateQuestion_Key | null; +} + +export interface UpdateQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; + label: string; + position: number; + description?: string | null; +} + +export interface UpdateQuoteData { + quote_update?: Quote_Key | null; +} + +export interface UpdateQuoteItemData { + quoteItem_update?: QuoteItem_Key | null; +} + +export interface UpdateQuoteItemTemplateData { + quoteItemTemplate_update?: QuoteItemTemplate_Key | null; +} + +export interface UpdateQuoteItemTemplateVariables { + id: UUIDString; + name?: string | null; + hasKeywords?: boolean | null; + keywords?: string[] | null; + quantitySourceId?: UUIDString | null; + sortOrder?: number | null; +} + +export interface UpdateQuoteItemVariables { + id: UUIDString; + displayOrder?: number | null; + name?: string | null; + quantity?: number | null; + quantitySourceId?: UUIDString | null; + unitPriceCents?: number | null; + materialUnitPriceCents?: number | null; + labourUnitPriceCents?: number | null; + matchedKeywords?: string[] | null; +} + +export interface UpdateQuoteVariables { + id: UUIDString; + supplierId?: UUIDString | null; + status?: string | null; +} + +export interface UpdateReminderData { + reminder_update?: Reminder_Key | null; +} + +export interface UpdateReminderVariables { + id: UUIDString; + accountId?: UUIDString | null; + name?: string | null; + status?: string | null; + dueAt?: TimestampString | null; + completedAt?: TimestampString | null; +} + +export interface UpdateSupplierData { + supplier_update?: Supplier_Key | null; +} + +export interface UpdateSupplierVariables { + id: UUIDString; + name?: string | null; +} + +export interface UpsertQuoteItemTemplateConfigData { + quoteItemTemplateConfig_upsert: QuoteItemTemplateConfig_Key; +} + +export interface UpsertQuoteItemTemplateConfigVariables { + ownerId: string; + templateId: UUIDString; + enabled: boolean; + unitPriceCents: number; + materialUnitPriceCents: number; + labourUnitPriceCents: number; +} + +export interface UpsertSupplierQuoteItemPriceData { + supplierQuoteItemPrice_upsert: SupplierQuoteItemPrice_Key; +} + +export interface UpsertSupplierQuoteItemPriceVariables { + ownerId: string; + supplierId: UUIDString; + templateId: UUIDString; + materialUnitPriceCents: number; +} + +export interface UpsertUserSettingsData { + userSettings_upsert: UserSettings_Key; +} + +export interface UpsertUserSettingsVariables { + ownerId: string; + quoteFollowUpEnabled: boolean; + quoteFollowUpDays: number; +} + +export interface UserSettings_Key { + ownerId: string; + __typename?: 'UserSettings_Key'; +} + +interface CreateAccountRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateAccountVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateAccountVariables): MutationRef; + operationName: string; +} +export const createAccountRef: CreateAccountRef; + +export function createAccount(vars: CreateAccountVariables): MutationPromise; +export function createAccount(dc: DataConnect, vars: CreateAccountVariables): MutationPromise; + +interface UpdateAccountRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateAccountVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateAccountVariables): MutationRef; + operationName: string; +} +export const updateAccountRef: UpdateAccountRef; + +export function updateAccount(vars: UpdateAccountVariables): MutationPromise; +export function updateAccount(dc: DataConnect, vars: UpdateAccountVariables): MutationPromise; + +interface DeleteAccountContactsRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteAccountContactsVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteAccountContactsVariables): MutationRef; + operationName: string; +} +export const deleteAccountContactsRef: DeleteAccountContactsRef; + +export function deleteAccountContacts(vars: DeleteAccountContactsVariables): MutationPromise; +export function deleteAccountContacts(dc: DataConnect, vars: DeleteAccountContactsVariables): MutationPromise; + +interface DeleteAccountRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteAccountVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteAccountVariables): MutationRef; + operationName: string; +} +export const deleteAccountRef: DeleteAccountRef; + +export function deleteAccount(vars: DeleteAccountVariables): MutationPromise; +export function deleteAccount(dc: DataConnect, vars: DeleteAccountVariables): MutationPromise; + +interface CreateAccountContactRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateAccountContactVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateAccountContactVariables): MutationRef; + operationName: string; +} +export const createAccountContactRef: CreateAccountContactRef; + +export function createAccountContact(vars: CreateAccountContactVariables): MutationPromise; +export function createAccountContact(dc: DataConnect, vars: CreateAccountContactVariables): MutationPromise; + +interface UpdateAccountContactRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateAccountContactVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateAccountContactVariables): MutationRef; + operationName: string; +} +export const updateAccountContactRef: UpdateAccountContactRef; + +export function updateAccountContact(vars: UpdateAccountContactVariables): MutationPromise; +export function updateAccountContact(dc: DataConnect, vars: UpdateAccountContactVariables): MutationPromise; + +interface DeleteAccountContactRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteAccountContactVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteAccountContactVariables): MutationRef; + operationName: string; +} +export const deleteAccountContactRef: DeleteAccountContactRef; + +export function deleteAccountContact(vars: DeleteAccountContactVariables): MutationPromise; +export function deleteAccountContact(dc: DataConnect, vars: DeleteAccountContactVariables): MutationPromise; + +interface ListAccountsByOwnerRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: ListAccountsByOwnerVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: ListAccountsByOwnerVariables): QueryRef; + operationName: string; +} +export const listAccountsByOwnerRef: ListAccountsByOwnerRef; + +export function listAccountsByOwner(vars: ListAccountsByOwnerVariables, options?: ExecuteQueryOptions): QueryPromise; +export function listAccountsByOwner(dc: DataConnect, vars: ListAccountsByOwnerVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetAccountByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetAccountByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetAccountByIdVariables): QueryRef; + operationName: string; +} +export const getAccountByIdRef: GetAccountByIdRef; + +export function getAccountById(vars: GetAccountByIdVariables, options?: ExecuteQueryOptions): QueryPromise; +export function getAccountById(dc: DataConnect, vars: GetAccountByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListAccountContactsByAccountIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: ListAccountContactsByAccountIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: ListAccountContactsByAccountIdVariables): QueryRef; + operationName: string; +} +export const listAccountContactsByAccountIdRef: ListAccountContactsByAccountIdRef; + +export function listAccountContactsByAccountId(vars: ListAccountContactsByAccountIdVariables, options?: ExecuteQueryOptions): QueryPromise; +export function listAccountContactsByAccountId(dc: DataConnect, vars: ListAccountContactsByAccountIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetAccountContactByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetAccountContactByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetAccountContactByIdVariables): QueryRef; + operationName: string; +} +export const getAccountContactByIdRef: GetAccountContactByIdRef; + +export function getAccountContactById(vars: GetAccountContactByIdVariables, options?: ExecuteQueryOptions): QueryPromise; +export function getAccountContactById(dc: DataConnect, vars: GetAccountContactByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface CreateProjectFromUploadRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateProjectFromUploadVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateProjectFromUploadVariables): MutationRef; + operationName: string; +} +export const createProjectFromUploadRef: CreateProjectFromUploadRef; + +export function createProjectFromUpload(vars: CreateProjectFromUploadVariables): MutationPromise; +export function createProjectFromUpload(dc: DataConnect, vars: CreateProjectFromUploadVariables): MutationPromise; + +interface UpdateProjectRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateProjectVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateProjectVariables): MutationRef; + operationName: string; +} +export const updateProjectRef: UpdateProjectRef; + +export function updateProject(vars: UpdateProjectVariables): MutationPromise; +export function updateProject(dc: DataConnect, vars: UpdateProjectVariables): MutationPromise; + +interface RenameProjectRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: RenameProjectVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: RenameProjectVariables): MutationRef; + operationName: string; +} +export const renameProjectRef: RenameProjectRef; + +export function renameProject(vars: RenameProjectVariables): MutationPromise; +export function renameProject(dc: DataConnect, vars: RenameProjectVariables): MutationPromise; + +interface TouchProjectRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: TouchProjectVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: TouchProjectVariables): MutationRef; + operationName: string; +} +export const touchProjectRef: TouchProjectRef; + +export function touchProject(vars: TouchProjectVariables): MutationPromise; +export function touchProject(dc: DataConnect, vars: TouchProjectVariables): MutationPromise; + +interface DeleteFloorplanPagesRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteFloorplanPagesVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteFloorplanPagesVariables): MutationRef; + operationName: string; +} +export const deleteFloorplanPagesRef: DeleteFloorplanPagesRef; + +export function deleteFloorplanPages(vars: DeleteFloorplanPagesVariables): MutationPromise; +export function deleteFloorplanPages(dc: DataConnect, vars: DeleteFloorplanPagesVariables): MutationPromise; + +interface DeleteProjectRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteProjectVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteProjectVariables): MutationRef; + operationName: string; +} +export const deleteProjectRef: DeleteProjectRef; + +export function deleteProject(vars: DeleteProjectVariables): MutationPromise; +export function deleteProject(dc: DataConnect, vars: DeleteProjectVariables): MutationPromise; + +interface CreateFloorplanPageRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateFloorplanPageVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateFloorplanPageVariables): MutationRef; + operationName: string; +} +export const createFloorplanPageRef: CreateFloorplanPageRef; + +export function createFloorplanPage(vars: CreateFloorplanPageVariables): MutationPromise; +export function createFloorplanPage(dc: DataConnect, vars: CreateFloorplanPageVariables): MutationPromise; + +interface UpdateFloorplanPageAnalysisRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateFloorplanPageAnalysisVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateFloorplanPageAnalysisVariables): MutationRef; + operationName: string; +} +export const updateFloorplanPageAnalysisRef: UpdateFloorplanPageAnalysisRef; + +export function updateFloorplanPageAnalysis(vars: UpdateFloorplanPageAnalysisVariables): MutationPromise; +export function updateFloorplanPageAnalysis(dc: DataConnect, vars: UpdateFloorplanPageAnalysisVariables): MutationPromise; + +interface UpdateFloorplanPageRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateFloorplanPageVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateFloorplanPageVariables): MutationRef; + operationName: string; +} +export const updateFloorplanPageRef: UpdateFloorplanPageRef; + +export function updateFloorplanPage(vars: UpdateFloorplanPageVariables): MutationPromise; +export function updateFloorplanPage(dc: DataConnect, vars: UpdateFloorplanPageVariables): MutationPromise; + +interface UpdateFloorplanPagesRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateFloorplanPagesVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateFloorplanPagesVariables): MutationRef; + operationName: string; +} +export const updateFloorplanPagesRef: UpdateFloorplanPagesRef; + +export function updateFloorplanPages(vars: UpdateFloorplanPagesVariables): MutationPromise; +export function updateFloorplanPages(dc: DataConnect, vars: UpdateFloorplanPagesVariables): MutationPromise; + +interface ListProjectsByOwnerAndSalesStatusRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: ListProjectsByOwnerAndSalesStatusVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: ListProjectsByOwnerAndSalesStatusVariables): QueryRef; + operationName: string; +} +export const listProjectsByOwnerAndSalesStatusRef: ListProjectsByOwnerAndSalesStatusRef; + +export function listProjectsByOwnerAndSalesStatus(vars: ListProjectsByOwnerAndSalesStatusVariables, options?: ExecuteQueryOptions): QueryPromise; +export function listProjectsByOwnerAndSalesStatus(dc: DataConnect, vars: ListProjectsByOwnerAndSalesStatusVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListProjectsByAccountRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: ListProjectsByAccountVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: ListProjectsByAccountVariables): QueryRef; + operationName: string; +} +export const listProjectsByAccountRef: ListProjectsByAccountRef; + +export function listProjectsByAccount(vars: ListProjectsByAccountVariables, options?: ExecuteQueryOptions): QueryPromise; +export function listProjectsByAccount(dc: DataConnect, vars: ListProjectsByAccountVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetProjectDetailsByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetProjectDetailsByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetProjectDetailsByIdVariables): QueryRef; + operationName: string; +} +export const getProjectDetailsByIdRef: GetProjectDetailsByIdRef; + +export function getProjectDetailsById(vars: GetProjectDetailsByIdVariables, options?: ExecuteQueryOptions): QueryPromise; +export function getProjectDetailsById(dc: DataConnect, vars: GetProjectDetailsByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetProjectByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetProjectByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetProjectByIdVariables): QueryRef; + operationName: string; +} +export const getProjectByIdRef: GetProjectByIdRef; + +export function getProjectById(vars: GetProjectByIdVariables, options?: ExecuteQueryOptions): QueryPromise; +export function getProjectById(dc: DataConnect, vars: GetProjectByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetFloorplanPageByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetFloorplanPageByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetFloorplanPageByIdVariables): QueryRef; + operationName: string; +} +export const getFloorplanPageByIdRef: GetFloorplanPageByIdRef; + +export function getFloorplanPageById(vars: GetFloorplanPageByIdVariables, options?: ExecuteQueryOptions): QueryPromise; +export function getFloorplanPageById(dc: DataConnect, vars: GetFloorplanPageByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface CreateQuestionnaireTemplateRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuestionnaireTemplateVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateQuestionnaireTemplateVariables): MutationRef; + operationName: string; +} +export const createQuestionnaireTemplateRef: CreateQuestionnaireTemplateRef; + +export function createQuestionnaireTemplate(vars: CreateQuestionnaireTemplateVariables): MutationPromise; +export function createQuestionnaireTemplate(dc: DataConnect, vars: CreateQuestionnaireTemplateVariables): MutationPromise; + +interface CreateQuestionnaireTemplateQuestionRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuestionnaireTemplateQuestionVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables): MutationRef; + operationName: string; +} +export const createQuestionnaireTemplateQuestionRef: CreateQuestionnaireTemplateQuestionRef; + +export function createQuestionnaireTemplateQuestion(vars: CreateQuestionnaireTemplateQuestionVariables): MutationPromise; +export function createQuestionnaireTemplateQuestion(dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface UpdateQuestionnaireTemplateNameRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuestionnaireTemplateNameVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables): MutationRef; + operationName: string; +} +export const updateQuestionnaireTemplateNameRef: UpdateQuestionnaireTemplateNameRef; + +export function updateQuestionnaireTemplateName(vars: UpdateQuestionnaireTemplateNameVariables): MutationPromise; +export function updateQuestionnaireTemplateName(dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables): MutationPromise; + +interface UpdateQuestionnaireTemplateQuestionRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuestionnaireTemplateQuestionVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables): MutationRef; + operationName: string; +} +export const updateQuestionnaireTemplateQuestionRef: UpdateQuestionnaireTemplateQuestionRef; + +export function updateQuestionnaireTemplateQuestion(vars: UpdateQuestionnaireTemplateQuestionVariables): MutationPromise; +export function updateQuestionnaireTemplateQuestion(dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface DeleteQuestionnaireTemplateQuestionRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteQuestionnaireTemplateQuestionVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables): MutationRef; + operationName: string; +} +export const deleteQuestionnaireTemplateQuestionRef: DeleteQuestionnaireTemplateQuestionRef; + +export function deleteQuestionnaireTemplateQuestion(vars: DeleteQuestionnaireTemplateQuestionVariables): MutationPromise; +export function deleteQuestionnaireTemplateQuestion(dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables): MutationPromise; + +interface DeleteQuestionnaireTemplateRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteQuestionnaireTemplateVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables): MutationRef; + operationName: string; +} +export const deleteQuestionnaireTemplateRef: DeleteQuestionnaireTemplateRef; + +export function deleteQuestionnaireTemplate(vars: DeleteQuestionnaireTemplateVariables): MutationPromise; +export function deleteQuestionnaireTemplate(dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables): MutationPromise; + +interface CreateProjectQuestionnaireRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateProjectQuestionnaireVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateProjectQuestionnaireVariables): MutationRef; + operationName: string; +} +export const createProjectQuestionnaireRef: CreateProjectQuestionnaireRef; + +export function createProjectQuestionnaire(vars: CreateProjectQuestionnaireVariables): MutationPromise; +export function createProjectQuestionnaire(dc: DataConnect, vars: CreateProjectQuestionnaireVariables): MutationPromise; + +interface CreateProjectQuestionnaireAnswerRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateProjectQuestionnaireAnswerVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables): MutationRef; + operationName: string; +} +export const createProjectQuestionnaireAnswerRef: CreateProjectQuestionnaireAnswerRef; + +export function createProjectQuestionnaireAnswer(vars: CreateProjectQuestionnaireAnswerVariables): MutationPromise; +export function createProjectQuestionnaireAnswer(dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables): MutationPromise; + +interface ListQuestionnaireTemplatesRef { + /* Allow users to create refs without passing in DataConnect */ + (): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect): QueryRef; + operationName: string; +} +export const listQuestionnaireTemplatesRef: ListQuestionnaireTemplatesRef; + +export function listQuestionnaireTemplates(options?: ExecuteQueryOptions): QueryPromise; +export function listQuestionnaireTemplates(dc: DataConnect, options?: ExecuteQueryOptions): QueryPromise; + +interface GetQuestionnaireTemplateRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetQuestionnaireTemplateVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetQuestionnaireTemplateVariables): QueryRef; + operationName: string; +} +export const getQuestionnaireTemplateRef: GetQuestionnaireTemplateRef; + +export function getQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: ExecuteQueryOptions): QueryPromise; +export function getQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface CreateQuantitySourceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuantitySourceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateQuantitySourceVariables): MutationRef; + operationName: string; +} +export const createQuantitySourceRef: CreateQuantitySourceRef; + +export function createQuantitySource(vars: CreateQuantitySourceVariables): MutationPromise; +export function createQuantitySource(dc: DataConnect, vars: CreateQuantitySourceVariables): MutationPromise; + +interface CreateQuoteItemTemplateRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuoteItemTemplateVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateQuoteItemTemplateVariables): MutationRef; + operationName: string; +} +export const createQuoteItemTemplateRef: CreateQuoteItemTemplateRef; + +export function createQuoteItemTemplate(vars: CreateQuoteItemTemplateVariables): MutationPromise; +export function createQuoteItemTemplate(dc: DataConnect, vars: CreateQuoteItemTemplateVariables): MutationPromise; + +interface UpdateQuoteItemTemplateRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuoteItemTemplateVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateQuoteItemTemplateVariables): MutationRef; + operationName: string; +} +export const updateQuoteItemTemplateRef: UpdateQuoteItemTemplateRef; + +export function updateQuoteItemTemplate(vars: UpdateQuoteItemTemplateVariables): MutationPromise; +export function updateQuoteItemTemplate(dc: DataConnect, vars: UpdateQuoteItemTemplateVariables): MutationPromise; + +interface DeleteQuoteItemTemplateRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteQuoteItemTemplateVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteQuoteItemTemplateVariables): MutationRef; + operationName: string; +} +export const deleteQuoteItemTemplateRef: DeleteQuoteItemTemplateRef; + +export function deleteQuoteItemTemplate(vars: DeleteQuoteItemTemplateVariables): MutationPromise; +export function deleteQuoteItemTemplate(dc: DataConnect, vars: DeleteQuoteItemTemplateVariables): MutationPromise; + +interface UpsertQuoteItemTemplateConfigRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpsertQuoteItemTemplateConfigVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpsertQuoteItemTemplateConfigVariables): MutationRef; + operationName: string; +} +export const upsertQuoteItemTemplateConfigRef: UpsertQuoteItemTemplateConfigRef; + +export function upsertQuoteItemTemplateConfig(vars: UpsertQuoteItemTemplateConfigVariables): MutationPromise; +export function upsertQuoteItemTemplateConfig(dc: DataConnect, vars: UpsertQuoteItemTemplateConfigVariables): MutationPromise; + +interface CreateSupplierRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateSupplierVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateSupplierVariables): MutationRef; + operationName: string; +} +export const createSupplierRef: CreateSupplierRef; + +export function createSupplier(vars: CreateSupplierVariables): MutationPromise; +export function createSupplier(dc: DataConnect, vars: CreateSupplierVariables): MutationPromise; + +interface UpdateSupplierRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateSupplierVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateSupplierVariables): MutationRef; + operationName: string; +} +export const updateSupplierRef: UpdateSupplierRef; + +export function updateSupplier(vars: UpdateSupplierVariables): MutationPromise; +export function updateSupplier(dc: DataConnect, vars: UpdateSupplierVariables): MutationPromise; + +interface DeleteSupplierRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteSupplierVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteSupplierVariables): MutationRef; + operationName: string; +} +export const deleteSupplierRef: DeleteSupplierRef; + +export function deleteSupplier(vars: DeleteSupplierVariables): MutationPromise; +export function deleteSupplier(dc: DataConnect, vars: DeleteSupplierVariables): MutationPromise; + +interface UpsertSupplierQuoteItemPriceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpsertSupplierQuoteItemPriceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpsertSupplierQuoteItemPriceVariables): MutationRef; + operationName: string; +} +export const upsertSupplierQuoteItemPriceRef: UpsertSupplierQuoteItemPriceRef; + +export function upsertSupplierQuoteItemPrice(vars: UpsertSupplierQuoteItemPriceVariables): MutationPromise; +export function upsertSupplierQuoteItemPrice(dc: DataConnect, vars: UpsertSupplierQuoteItemPriceVariables): MutationPromise; + +interface DeleteSupplierQuoteItemPriceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteSupplierQuoteItemPriceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteSupplierQuoteItemPriceVariables): MutationRef; + operationName: string; +} +export const deleteSupplierQuoteItemPriceRef: DeleteSupplierQuoteItemPriceRef; + +export function deleteSupplierQuoteItemPrice(vars: DeleteSupplierQuoteItemPriceVariables): MutationPromise; +export function deleteSupplierQuoteItemPrice(dc: DataConnect, vars: DeleteSupplierQuoteItemPriceVariables): MutationPromise; + +interface CreateQuoteRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuoteVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateQuoteVariables): MutationRef; + operationName: string; +} +export const createQuoteRef: CreateQuoteRef; + +export function createQuote(vars: CreateQuoteVariables): MutationPromise; +export function createQuote(dc: DataConnect, vars: CreateQuoteVariables): MutationPromise; + +interface UpdateQuoteRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuoteVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateQuoteVariables): MutationRef; + operationName: string; +} +export const updateQuoteRef: UpdateQuoteRef; + +export function updateQuote(vars: UpdateQuoteVariables): MutationPromise; +export function updateQuote(dc: DataConnect, vars: UpdateQuoteVariables): MutationPromise; + +interface DeleteQuoteItemsRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteQuoteItemsVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteQuoteItemsVariables): MutationRef; + operationName: string; +} +export const deleteQuoteItemsRef: DeleteQuoteItemsRef; + +export function deleteQuoteItems(vars: DeleteQuoteItemsVariables): MutationPromise; +export function deleteQuoteItems(dc: DataConnect, vars: DeleteQuoteItemsVariables): MutationPromise; + +interface CreateQuoteItemRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateQuoteItemVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateQuoteItemVariables): MutationRef; + operationName: string; +} +export const createQuoteItemRef: CreateQuoteItemRef; + +export function createQuoteItem(vars: CreateQuoteItemVariables): MutationPromise; +export function createQuoteItem(dc: DataConnect, vars: CreateQuoteItemVariables): MutationPromise; + +interface UpdateQuoteItemRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateQuoteItemVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateQuoteItemVariables): MutationRef; + operationName: string; +} +export const updateQuoteItemRef: UpdateQuoteItemRef; + +export function updateQuoteItem(vars: UpdateQuoteItemVariables): MutationPromise; +export function updateQuoteItem(dc: DataConnect, vars: UpdateQuoteItemVariables): MutationPromise; + +interface CreateReminderRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateReminderVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateReminderVariables): MutationRef; + operationName: string; +} +export const createReminderRef: CreateReminderRef; + +export function createReminder(vars: CreateReminderVariables): MutationPromise; +export function createReminder(dc: DataConnect, vars: CreateReminderVariables): MutationPromise; + +interface UpdateReminderRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateReminderVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateReminderVariables): MutationRef; + operationName: string; +} +export const updateReminderRef: UpdateReminderRef; + +export function updateReminder(vars: UpdateReminderVariables): MutationPromise; +export function updateReminder(dc: DataConnect, vars: UpdateReminderVariables): MutationPromise; + +interface ListDueRemindersRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: ListDueRemindersVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: ListDueRemindersVariables): QueryRef; + operationName: string; +} +export const listDueRemindersRef: ListDueRemindersRef; + +export function listDueReminders(vars: ListDueRemindersVariables, options?: ExecuteQueryOptions): QueryPromise; +export function listDueReminders(dc: DataConnect, vars: ListDueRemindersVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface ListProjectRemindersRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: ListProjectRemindersVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: ListProjectRemindersVariables): QueryRef; + operationName: string; +} +export const listProjectRemindersRef: ListProjectRemindersRef; + +export function listProjectReminders(vars: ListProjectRemindersVariables, options?: ExecuteQueryOptions): QueryPromise; +export function listProjectReminders(dc: DataConnect, vars: ListProjectRemindersVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface GetReminderByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetReminderByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetReminderByIdVariables): QueryRef; + operationName: string; +} +export const getReminderByIdRef: GetReminderByIdRef; + +export function getReminderById(vars: GetReminderByIdVariables, options?: ExecuteQueryOptions): QueryPromise; +export function getReminderById(dc: DataConnect, vars: GetReminderByIdVariables, options?: ExecuteQueryOptions): QueryPromise; + +interface UpsertUserSettingsRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpsertUserSettingsVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpsertUserSettingsVariables): MutationRef; + operationName: string; +} +export const upsertUserSettingsRef: UpsertUserSettingsRef; + +export function upsertUserSettings(vars: UpsertUserSettingsVariables): MutationPromise; +export function upsertUserSettings(dc: DataConnect, vars: UpsertUserSettingsVariables): MutationPromise; + +interface GetUserSettingsRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetUserSettingsVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetUserSettingsVariables): QueryRef; + operationName: string; +} +export const getUserSettingsRef: GetUserSettingsRef; + +export function getUserSettings(vars: GetUserSettingsVariables, options?: ExecuteQueryOptions): QueryPromise; +export function getUserSettings(dc: DataConnect, vars: GetUserSettingsVariables, options?: ExecuteQueryOptions): QueryPromise; + diff --git a/generated/questionnaires-data-connector-web/package.json b/generated/data-connector-web/package.json similarity index 87% rename from generated/questionnaires-data-connector-web/package.json rename to generated/data-connector-web/package.json index cc0373e..5512a07 100644 --- a/generated/questionnaires-data-connector-web/package.json +++ b/generated/data-connector-web/package.json @@ -1,8 +1,8 @@ { - "name": "@generated/questionnaires-data-connector-web", + "name": "@generated/data-connector-web", "version": "1.0.0", "author": "Firebase (https://firebase.google.com/)", - "description": "Generated SDK For questionnaires", + "description": "Generated SDK For data-connector", "license": "Apache-2.0", "engines": { "node": " >=18.0" diff --git a/generated/data-connector-web/react/README.md b/generated/data-connector-web/react/README.md new file mode 100644 index 0000000..2a8f2e2 --- /dev/null +++ b/generated/data-connector-web/react/README.md @@ -0,0 +1,5962 @@ +# Generated React README +This README will guide you through the process of using the generated React SDK package for the connector `data-connector`. It will also provide examples on how to use your generated SDK to call your Data Connect queries and mutations. + +**If you're looking for the `JavaScript README`, you can find it at [`data-connector-web/README.md`](../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.* + +You can use this generated SDK by importing from the package `@generated/data-connector-web/react` 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#react). + +# Table of Contents +- [**Overview**](#generated-react-readme) +- [**TanStack Query Firebase & TanStack React Query**](#tanstack-query-firebase-tanstack-react-query) + - [*Package Installation*](#installing-tanstack-query-firebase-and-tanstack-react-query-packages) + - [*Configuring TanStack Query*](#configuring-tanstack-query) +- [**Accessing the connector**](#accessing-the-connector) + - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) +- [**Queries**](#queries) + - [*ListAccountsByOwner*](#listaccountsbyowner) + - [*GetAccountById*](#getaccountbyid) + - [*ListAccountContactsByAccountId*](#listaccountcontactsbyaccountid) + - [*GetAccountContactById*](#getaccountcontactbyid) + - [*ListProjectsByOwnerAndSalesStatus*](#listprojectsbyownerandsalesstatus) + - [*ListProjectsByAccount*](#listprojectsbyaccount) + - [*GetProjectDetailsById*](#getprojectdetailsbyid) + - [*GetProjectById*](#getprojectbyid) + - [*GetFloorplanPageById*](#getfloorplanpagebyid) + - [*ListQuestionnaireTemplates*](#listquestionnairetemplates) + - [*GetQuestionnaireTemplate*](#getquestionnairetemplate) + - [*ListDueReminders*](#listduereminders) + - [*ListProjectReminders*](#listprojectreminders) + - [*GetReminderById*](#getreminderbyid) + - [*GetUserSettings*](#getusersettings) +- [**Mutations**](#mutations) + - [*CreateAccount*](#createaccount) + - [*UpdateAccount*](#updateaccount) + - [*DeleteAccountContacts*](#deleteaccountcontacts) + - [*DeleteAccount*](#deleteaccount) + - [*CreateAccountContact*](#createaccountcontact) + - [*UpdateAccountContact*](#updateaccountcontact) + - [*DeleteAccountContact*](#deleteaccountcontact) + - [*CreateProjectFromUpload*](#createprojectfromupload) + - [*UpdateProject*](#updateproject) + - [*RenameProject*](#renameproject) + - [*TouchProject*](#touchproject) + - [*DeleteFloorplanPages*](#deletefloorplanpages) + - [*DeleteProject*](#deleteproject) + - [*CreateFloorplanPage*](#createfloorplanpage) + - [*UpdateFloorplanPageAnalysis*](#updatefloorplanpageanalysis) + - [*UpdateFloorplanPage*](#updatefloorplanpage) + - [*UpdateFloorplanPages*](#updatefloorplanpages) + - [*CreateQuestionnaireTemplate*](#createquestionnairetemplate) + - [*CreateQuestionnaireTemplateQuestion*](#createquestionnairetemplatequestion) + - [*UpdateQuestionnaireTemplateName*](#updatequestionnairetemplatename) + - [*UpdateQuestionnaireTemplateQuestion*](#updatequestionnairetemplatequestion) + - [*DeleteQuestionnaireTemplateQuestion*](#deletequestionnairetemplatequestion) + - [*DeleteQuestionnaireTemplate*](#deletequestionnairetemplate) + - [*CreateProjectQuestionnaire*](#createprojectquestionnaire) + - [*CreateProjectQuestionnaireAnswer*](#createprojectquestionnaireanswer) + - [*CreateQuantitySource*](#createquantitysource) + - [*CreateQuoteItemTemplate*](#createquoteitemtemplate) + - [*UpdateQuoteItemTemplate*](#updatequoteitemtemplate) + - [*DeleteQuoteItemTemplate*](#deletequoteitemtemplate) + - [*UpsertQuoteItemTemplateConfig*](#upsertquoteitemtemplateconfig) + - [*CreateSupplier*](#createsupplier) + - [*UpdateSupplier*](#updatesupplier) + - [*DeleteSupplier*](#deletesupplier) + - [*UpsertSupplierQuoteItemPrice*](#upsertsupplierquoteitemprice) + - [*DeleteSupplierQuoteItemPrice*](#deletesupplierquoteitemprice) + - [*CreateQuote*](#createquote) + - [*UpdateQuote*](#updatequote) + - [*DeleteQuoteItems*](#deletequoteitems) + - [*CreateQuoteItem*](#createquoteitem) + - [*UpdateQuoteItem*](#updatequoteitem) + - [*CreateReminder*](#createreminder) + - [*UpdateReminder*](#updatereminder) + - [*UpsertUserSettings*](#upsertusersettings) + +# TanStack Query Firebase & TanStack React Query +This SDK provides [React](https://react.dev/) hooks generated specific to your application, for the operations found in the connector `data-connector`. These hooks are generated using [TanStack Query Firebase](https://react-query-firebase.invertase.dev/) by our partners at Invertase, a library built on top of [TanStack React Query v5](https://tanstack.com/query/v5/docs/framework/react/overview). + +***You do not need to be familiar with Tanstack Query or Tanstack Query Firebase to use this SDK.*** However, you may find it useful to learn more about them, as they will empower you as a user of this Generated React SDK. + +## Installing TanStack Query Firebase and TanStack React Query Packages +In order to use the React generated SDK, you must install the `TanStack React Query` and `TanStack Query Firebase` packages. +```bash +npm i --save @tanstack/react-query @tanstack-query-firebase/react +``` +```bash +npm i --save firebase@latest # Note: React has a peer dependency on ^11.3.0 +``` + +You can also follow the installation instructions from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#tanstack-install), or the [TanStack Query Firebase documentation](https://react-query-firebase.invertase.dev/react) and [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/installation). + +## Configuring TanStack Query +In order to use the React generated SDK in your application, you must wrap your application's component tree in a `QueryClientProvider` component from TanStack React Query. None of your generated React SDK hooks will work without this provider. + +```javascript +import { QueryClientProvider } from '@tanstack/react-query'; + +// Create a TanStack Query client instance +const queryClient = new QueryClient() + +function App() { + return ( + // Provide the client to your App + + + + ) +} +``` + +To learn more about `QueryClientProvider`, see the [TanStack React Query documentation](https://tanstack.com/query/latest/docs/framework/react/quick-start) and the [TanStack Query Firebase documentation](https://invertase.docs.page/tanstack-query-firebase/react#usage). + +# 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 `data-connector`. + +You can find more information about connectors in the [Data Connect documentation](https://firebase.google.com/docs/data-connect#how-does). + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@generated/data-connector-web'; + +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#emulator-react-angular). + +```javascript +import { connectDataConnectEmulator, getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@generated/data-connector-web'; + +const dataConnect = getDataConnect(connectorConfig); +connectDataConnectEmulator(dataConnect, 'localhost', 9399); +``` + +After it's initialized, you can call your Data Connect [queries](#queries) and [mutations](#mutations) using the hooks provided from your generated React SDK. + +# Queries + +The React generated SDK provides Query hook functions that call and return [`useDataConnectQuery`](https://react-query-firebase.invertase.dev/react/data-connect/querying) hooks from TanStack Query Firebase. + +Calling these hook functions will return a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and the most recent data returned by the Query, among other things. To learn more about these hooks and how to use them, see the [TanStack Query Firebase documentation](https://react-query-firebase.invertase.dev/react/data-connect/querying). + +TanStack React Query caches the results of your Queries, so using the same Query hook function in multiple places in your application allows the entire application to automatically see updates to that Query's data. + +Query hooks execute their Queries automatically when called, and periodically refresh, unless you change the `queryOptions` for the Query. To learn how to stop a Query from automatically executing, including how to make a query "lazy", see the [TanStack React Query documentation](https://tanstack.com/query/latest/docs/framework/react/guides/disabling-queries). + +To learn more about TanStack React Query's Queries, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/guides/queries). + +## Using Query Hooks +Here's a general overview of how to use the generated Query hooks in your code: + +- If the Query has no variables, the Query hook function does not require arguments. +- If the Query has any required variables, the Query hook function will require at least one argument: an object that contains all the required variables for the Query. +- If the Query has some required and some optional variables, only required variables are necessary in the variables argument object, and optional variables may be provided as well. +- If all of the Query's variables are optional, the Query hook function does not require any arguments. +- Query hook 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. +- Query hooks functions can be called with or without passing in an `options` argument of type `useDataConnectQueryOptions`. To learn more about the `options` argument, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/guides/query-options). + - ***Special case:*** If the Query has all optional variables and you would like to provide an `options` argument to the Query hook function without providing any variables, you must pass `undefined` where you would normally pass the Query's variables, and then may provide the `options` argument. + +Below are examples of how to use the `data-connector` connector's generated Query hook 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#operations-react-angular). + +## ListAccountsByOwner +You can execute the `ListAccountsByOwner` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useListAccountsByOwner(dc: DataConnect, vars: ListAccountsByOwnerVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListAccountsByOwner(vars: ListAccountsByOwnerVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `ListAccountsByOwner` Query requires an argument of type `ListAccountsByOwnerVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface ListAccountsByOwnerVariables { + ownerId: string; +} +``` +### Return Type +Recall that calling the `ListAccountsByOwner` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `ListAccountsByOwner` Query is of type `ListAccountsByOwnerData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListAccountsByOwnerData { + accounts: ({ + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Account_Key)[]; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `ListAccountsByOwner`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, ListAccountsByOwnerVariables } from '@generated/data-connector-web'; +import { useListAccountsByOwner } from '@generated/data-connector-web/react' + +export default function ListAccountsByOwnerComponent() { + // The `useListAccountsByOwner` Query hook requires an argument of type `ListAccountsByOwnerVariables`: + const listAccountsByOwnerVars: ListAccountsByOwnerVariables = { + ownerId: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useListAccountsByOwner(listAccountsByOwnerVars); + // Variables can be defined inline as well. + const query = useListAccountsByOwner({ ownerId: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListAccountsByOwner(dataConnect, listAccountsByOwnerVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListAccountsByOwner(listAccountsByOwnerVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListAccountsByOwner(dataConnect, listAccountsByOwnerVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.accounts); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## GetAccountById +You can execute the `GetAccountById` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useGetAccountById(dc: DataConnect, vars: GetAccountByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetAccountById(vars: GetAccountByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `GetAccountById` Query requires an argument of type `GetAccountByIdVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetAccountByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `GetAccountById` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetAccountById` Query is of type `GetAccountByIdData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetAccountByIdData { + account?: { + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + contacts: ({ + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key)[]; + } & Account_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `GetAccountById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetAccountByIdVariables } from '@generated/data-connector-web'; +import { useGetAccountById } from '@generated/data-connector-web/react' + +export default function GetAccountByIdComponent() { + // The `useGetAccountById` Query hook requires an argument of type `GetAccountByIdVariables`: + const getAccountByIdVars: GetAccountByIdVariables = { + id: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useGetAccountById(getAccountByIdVars); + // Variables can be defined inline as well. + const query = useGetAccountById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetAccountById(dataConnect, getAccountByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetAccountById(getAccountByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetAccountById(dataConnect, getAccountByIdVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.account); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## ListAccountContactsByAccountId +You can execute the `ListAccountContactsByAccountId` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useListAccountContactsByAccountId(dc: DataConnect, vars: ListAccountContactsByAccountIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListAccountContactsByAccountId(vars: ListAccountContactsByAccountIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `ListAccountContactsByAccountId` Query requires an argument of type `ListAccountContactsByAccountIdVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface ListAccountContactsByAccountIdVariables { + accountId: UUIDString; +} +``` +### Return Type +Recall that calling the `ListAccountContactsByAccountId` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `ListAccountContactsByAccountId` Query is of type `ListAccountContactsByAccountIdData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListAccountContactsByAccountIdData { + accountContacts: ({ + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key)[]; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `ListAccountContactsByAccountId`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, ListAccountContactsByAccountIdVariables } from '@generated/data-connector-web'; +import { useListAccountContactsByAccountId } from '@generated/data-connector-web/react' + +export default function ListAccountContactsByAccountIdComponent() { + // The `useListAccountContactsByAccountId` Query hook requires an argument of type `ListAccountContactsByAccountIdVariables`: + const listAccountContactsByAccountIdVars: ListAccountContactsByAccountIdVariables = { + accountId: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useListAccountContactsByAccountId(listAccountContactsByAccountIdVars); + // Variables can be defined inline as well. + const query = useListAccountContactsByAccountId({ accountId: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListAccountContactsByAccountId(dataConnect, listAccountContactsByAccountIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListAccountContactsByAccountId(listAccountContactsByAccountIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListAccountContactsByAccountId(dataConnect, listAccountContactsByAccountIdVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.accountContacts); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## GetAccountContactById +You can execute the `GetAccountContactById` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useGetAccountContactById(dc: DataConnect, vars: GetAccountContactByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetAccountContactById(vars: GetAccountContactByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `GetAccountContactById` Query requires an argument of type `GetAccountContactByIdVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetAccountContactByIdVariables { + accountId: UUIDString; + contactId: UUIDString; +} +``` +### Return Type +Recall that calling the `GetAccountContactById` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetAccountContactById` Query is of type `GetAccountContactByIdData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetAccountContactByIdData { + accountContact?: { + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & AccountContact_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `GetAccountContactById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetAccountContactByIdVariables } from '@generated/data-connector-web'; +import { useGetAccountContactById } from '@generated/data-connector-web/react' + +export default function GetAccountContactByIdComponent() { + // The `useGetAccountContactById` Query hook requires an argument of type `GetAccountContactByIdVariables`: + const getAccountContactByIdVars: GetAccountContactByIdVariables = { + accountId: ..., + contactId: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useGetAccountContactById(getAccountContactByIdVars); + // Variables can be defined inline as well. + const query = useGetAccountContactById({ accountId: ..., contactId: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetAccountContactById(dataConnect, getAccountContactByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetAccountContactById(getAccountContactByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetAccountContactById(dataConnect, getAccountContactByIdVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.accountContact); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## ListProjectsByOwnerAndSalesStatus +You can execute the `ListProjectsByOwnerAndSalesStatus` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useListProjectsByOwnerAndSalesStatus(dc: DataConnect, vars: ListProjectsByOwnerAndSalesStatusVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListProjectsByOwnerAndSalesStatus(vars: ListProjectsByOwnerAndSalesStatusVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `ListProjectsByOwnerAndSalesStatus` Query requires an argument of type `ListProjectsByOwnerAndSalesStatusVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface ListProjectsByOwnerAndSalesStatusVariables { + ownerId: string; + salesStatus: string; +} +``` +### Return Type +Recall that calling the `ListProjectsByOwnerAndSalesStatus` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `ListProjectsByOwnerAndSalesStatus` Query is of type `ListProjectsByOwnerAndSalesStatusData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListProjectsByOwnerAndSalesStatusData { + projects: ({ + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key)[]; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `ListProjectsByOwnerAndSalesStatus`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, ListProjectsByOwnerAndSalesStatusVariables } from '@generated/data-connector-web'; +import { useListProjectsByOwnerAndSalesStatus } from '@generated/data-connector-web/react' + +export default function ListProjectsByOwnerAndSalesStatusComponent() { + // The `useListProjectsByOwnerAndSalesStatus` Query hook requires an argument of type `ListProjectsByOwnerAndSalesStatusVariables`: + const listProjectsByOwnerAndSalesStatusVars: ListProjectsByOwnerAndSalesStatusVariables = { + ownerId: ..., + salesStatus: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useListProjectsByOwnerAndSalesStatus(listProjectsByOwnerAndSalesStatusVars); + // Variables can be defined inline as well. + const query = useListProjectsByOwnerAndSalesStatus({ ownerId: ..., salesStatus: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListProjectsByOwnerAndSalesStatus(dataConnect, listProjectsByOwnerAndSalesStatusVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListProjectsByOwnerAndSalesStatus(listProjectsByOwnerAndSalesStatusVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListProjectsByOwnerAndSalesStatus(dataConnect, listProjectsByOwnerAndSalesStatusVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.projects); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## ListProjectsByAccount +You can execute the `ListProjectsByAccount` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useListProjectsByAccount(dc: DataConnect, vars: ListProjectsByAccountVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListProjectsByAccount(vars: ListProjectsByAccountVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `ListProjectsByAccount` Query requires an argument of type `ListProjectsByAccountVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface ListProjectsByAccountVariables { + accountId: UUIDString; +} +``` +### Return Type +Recall that calling the `ListProjectsByAccount` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `ListProjectsByAccount` Query is of type `ListProjectsByAccountData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListProjectsByAccountData { + projects: ({ + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key)[]; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `ListProjectsByAccount`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, ListProjectsByAccountVariables } from '@generated/data-connector-web'; +import { useListProjectsByAccount } from '@generated/data-connector-web/react' + +export default function ListProjectsByAccountComponent() { + // The `useListProjectsByAccount` Query hook requires an argument of type `ListProjectsByAccountVariables`: + const listProjectsByAccountVars: ListProjectsByAccountVariables = { + accountId: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useListProjectsByAccount(listProjectsByAccountVars); + // Variables can be defined inline as well. + const query = useListProjectsByAccount({ accountId: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListProjectsByAccount(dataConnect, listProjectsByAccountVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListProjectsByAccount(listProjectsByAccountVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListProjectsByAccount(dataConnect, listProjectsByAccountVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.projects); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## GetProjectDetailsById +You can execute the `GetProjectDetailsById` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useGetProjectDetailsById(dc: DataConnect, vars: GetProjectDetailsByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetProjectDetailsById(vars: GetProjectDetailsByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `GetProjectDetailsById` Query requires an argument of type `GetProjectDetailsByIdVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetProjectDetailsByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `GetProjectDetailsById` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetProjectDetailsById` Query is of type `GetProjectDetailsByIdData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetProjectDetailsByIdData { + project?: { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + pages: ({ + id: UUIDString; + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & FloorplanPage_Key)[]; + } & Project_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `GetProjectDetailsById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetProjectDetailsByIdVariables } from '@generated/data-connector-web'; +import { useGetProjectDetailsById } from '@generated/data-connector-web/react' + +export default function GetProjectDetailsByIdComponent() { + // The `useGetProjectDetailsById` Query hook requires an argument of type `GetProjectDetailsByIdVariables`: + const getProjectDetailsByIdVars: GetProjectDetailsByIdVariables = { + id: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useGetProjectDetailsById(getProjectDetailsByIdVars); + // Variables can be defined inline as well. + const query = useGetProjectDetailsById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetProjectDetailsById(dataConnect, getProjectDetailsByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetProjectDetailsById(getProjectDetailsByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetProjectDetailsById(dataConnect, getProjectDetailsByIdVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.project); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## GetProjectById +You can execute the `GetProjectById` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useGetProjectById(dc: DataConnect, vars: GetProjectByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetProjectById(vars: GetProjectByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `GetProjectById` Query requires an argument of type `GetProjectByIdVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetProjectByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `GetProjectById` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetProjectById` Query is of type `GetProjectByIdData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetProjectByIdData { + project?: { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus: string; + processingError?: string | null; + pageCount: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Project_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `GetProjectById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetProjectByIdVariables } from '@generated/data-connector-web'; +import { useGetProjectById } from '@generated/data-connector-web/react' + +export default function GetProjectByIdComponent() { + // The `useGetProjectById` Query hook requires an argument of type `GetProjectByIdVariables`: + const getProjectByIdVars: GetProjectByIdVariables = { + id: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useGetProjectById(getProjectByIdVars); + // Variables can be defined inline as well. + const query = useGetProjectById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetProjectById(dataConnect, getProjectByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetProjectById(getProjectByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetProjectById(dataConnect, getProjectByIdVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.project); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## GetFloorplanPageById +You can execute the `GetFloorplanPageById` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useGetFloorplanPageById(dc: DataConnect, vars: GetFloorplanPageByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetFloorplanPageById(vars: GetFloorplanPageByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `GetFloorplanPageById` Query requires an argument of type `GetFloorplanPageByIdVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetFloorplanPageByIdVariables { + projectId: UUIDString; + pageId: UUIDString; +} +``` +### Return Type +Recall that calling the `GetFloorplanPageById` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetFloorplanPageById` Query is of type `GetFloorplanPageByIdData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetFloorplanPageByIdData { + floorplanPage?: { + id: UUIDString; + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & FloorplanPage_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `GetFloorplanPageById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetFloorplanPageByIdVariables } from '@generated/data-connector-web'; +import { useGetFloorplanPageById } from '@generated/data-connector-web/react' + +export default function GetFloorplanPageByIdComponent() { + // The `useGetFloorplanPageById` Query hook requires an argument of type `GetFloorplanPageByIdVariables`: + const getFloorplanPageByIdVars: GetFloorplanPageByIdVariables = { + projectId: ..., + pageId: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useGetFloorplanPageById(getFloorplanPageByIdVars); + // Variables can be defined inline as well. + const query = useGetFloorplanPageById({ projectId: ..., pageId: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetFloorplanPageById(dataConnect, getFloorplanPageByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetFloorplanPageById(getFloorplanPageByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetFloorplanPageById(dataConnect, getFloorplanPageByIdVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.floorplanPage); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## ListQuestionnaireTemplates +You can execute the `ListQuestionnaireTemplates` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useListQuestionnaireTemplates(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListQuestionnaireTemplates(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `ListQuestionnaireTemplates` Query has no variables. +### Return Type +Recall that calling the `ListQuestionnaireTemplates` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `ListQuestionnaireTemplates` Query is of type `ListQuestionnaireTemplatesData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListQuestionnaireTemplatesData { + questionnaireTemplates: ({ + id: UUIDString; + name: string; + createdAt: TimestampString; + updatedAt: TimestampString; + } & QuestionnaireTemplate_Key)[]; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `ListQuestionnaireTemplates`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@generated/data-connector-web'; +import { useListQuestionnaireTemplates } from '@generated/data-connector-web/react' + +export default function ListQuestionnaireTemplatesComponent() { + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useListQuestionnaireTemplates(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListQuestionnaireTemplates(dataConnect); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListQuestionnaireTemplates(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListQuestionnaireTemplates(dataConnect, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.questionnaireTemplates); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## GetQuestionnaireTemplate +You can execute the `GetQuestionnaireTemplate` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useGetQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `GetQuestionnaireTemplate` Query requires an argument of type `GetQuestionnaireTemplateVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetQuestionnaireTemplateVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `GetQuestionnaireTemplate` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetQuestionnaireTemplate` Query is of type `GetQuestionnaireTemplateData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetQuestionnaireTemplateData { + questionnaireTemplate?: { + id: UUIDString; + ownerId: string; + name: string; + createdAt: TimestampString; + updatedAt: TimestampString; + questions: ({ + id: UUIDString; + label: string; + description?: string | null; + position: number; + } & QuestionnaireTemplateQuestion_Key)[]; + } & QuestionnaireTemplate_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `GetQuestionnaireTemplate`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetQuestionnaireTemplateVariables } from '@generated/data-connector-web'; +import { useGetQuestionnaireTemplate } from '@generated/data-connector-web/react' + +export default function GetQuestionnaireTemplateComponent() { + // The `useGetQuestionnaireTemplate` Query hook requires an argument of type `GetQuestionnaireTemplateVariables`: + const getQuestionnaireTemplateVars: GetQuestionnaireTemplateVariables = { + id: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useGetQuestionnaireTemplate(getQuestionnaireTemplateVars); + // Variables can be defined inline as well. + const query = useGetQuestionnaireTemplate({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetQuestionnaireTemplate(dataConnect, getQuestionnaireTemplateVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetQuestionnaireTemplate(getQuestionnaireTemplateVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetQuestionnaireTemplate(dataConnect, getQuestionnaireTemplateVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.questionnaireTemplate); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## ListDueReminders +You can execute the `ListDueReminders` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useListDueReminders(dc: DataConnect, vars: ListDueRemindersVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListDueReminders(vars: ListDueRemindersVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `ListDueReminders` Query requires an argument of type `ListDueRemindersVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface ListDueRemindersVariables { + ownerId: string; +} +``` +### Return Type +Recall that calling the `ListDueReminders` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `ListDueReminders` Query is of type `ListDueRemindersData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListDueRemindersData { + reminders: ({ + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key)[]; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `ListDueReminders`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, ListDueRemindersVariables } from '@generated/data-connector-web'; +import { useListDueReminders } from '@generated/data-connector-web/react' + +export default function ListDueRemindersComponent() { + // The `useListDueReminders` Query hook requires an argument of type `ListDueRemindersVariables`: + const listDueRemindersVars: ListDueRemindersVariables = { + ownerId: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useListDueReminders(listDueRemindersVars); + // Variables can be defined inline as well. + const query = useListDueReminders({ ownerId: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListDueReminders(dataConnect, listDueRemindersVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListDueReminders(listDueRemindersVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListDueReminders(dataConnect, listDueRemindersVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.reminders); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## ListProjectReminders +You can execute the `ListProjectReminders` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useListProjectReminders(dc: DataConnect, vars: ListProjectRemindersVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListProjectReminders(vars: ListProjectRemindersVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `ListProjectReminders` Query requires an argument of type `ListProjectRemindersVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface ListProjectRemindersVariables { + projectId: UUIDString; +} +``` +### Return Type +Recall that calling the `ListProjectReminders` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `ListProjectReminders` Query is of type `ListProjectRemindersData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListProjectRemindersData { + reminders: ({ + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key)[]; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `ListProjectReminders`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, ListProjectRemindersVariables } from '@generated/data-connector-web'; +import { useListProjectReminders } from '@generated/data-connector-web/react' + +export default function ListProjectRemindersComponent() { + // The `useListProjectReminders` Query hook requires an argument of type `ListProjectRemindersVariables`: + const listProjectRemindersVars: ListProjectRemindersVariables = { + projectId: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useListProjectReminders(listProjectRemindersVars); + // Variables can be defined inline as well. + const query = useListProjectReminders({ projectId: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListProjectReminders(dataConnect, listProjectRemindersVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListProjectReminders(listProjectRemindersVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListProjectReminders(dataConnect, listProjectRemindersVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.reminders); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## GetReminderById +You can execute the `GetReminderById` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useGetReminderById(dc: DataConnect, vars: GetReminderByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetReminderById(vars: GetReminderByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `GetReminderById` Query requires an argument of type `GetReminderByIdVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetReminderByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `GetReminderById` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetReminderById` Query is of type `GetReminderByIdData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetReminderByIdData { + reminder?: { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; + completedAt?: TimestampString | null; + createdAt: TimestampString; + updatedAt: TimestampString; + } & Reminder_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `GetReminderById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetReminderByIdVariables } from '@generated/data-connector-web'; +import { useGetReminderById } from '@generated/data-connector-web/react' + +export default function GetReminderByIdComponent() { + // The `useGetReminderById` Query hook requires an argument of type `GetReminderByIdVariables`: + const getReminderByIdVars: GetReminderByIdVariables = { + id: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useGetReminderById(getReminderByIdVars); + // Variables can be defined inline as well. + const query = useGetReminderById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetReminderById(dataConnect, getReminderByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetReminderById(getReminderByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetReminderById(dataConnect, getReminderByIdVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.reminder); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## GetUserSettings +You can execute the `GetUserSettings` Query using the following Query hook function, which is defined in [data-connector-web/react/index.d.ts](./index.d.ts): + +```javascript +useGetUserSettings(dc: DataConnect, vars: GetUserSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetUserSettings(vars: GetUserSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `GetUserSettings` Query requires an argument of type `GetUserSettingsVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetUserSettingsVariables { + ownerId: string; +} +``` +### Return Type +Recall that calling the `GetUserSettings` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. + +To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. + +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetUserSettings` Query is of type `GetUserSettingsData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetUserSettingsData { + userSettings?: { + ownerId: string; + quoteFollowUpEnabled: boolean; + quoteFollowUpDays: number; + createdAt: TimestampString; + updatedAt: TimestampString; + } & UserSettings_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `GetUserSettings`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetUserSettingsVariables } from '@generated/data-connector-web'; +import { useGetUserSettings } from '@generated/data-connector-web/react' + +export default function GetUserSettingsComponent() { + // The `useGetUserSettings` Query hook requires an argument of type `GetUserSettingsVariables`: + const getUserSettingsVars: GetUserSettingsVariables = { + ownerId: ..., + }; + + // You don't have to do anything to "execute" the Query. + // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. + const query = useGetUserSettings(getUserSettingsVars); + // Variables can be defined inline as well. + const query = useGetUserSettings({ ownerId: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetUserSettings(dataConnect, getUserSettingsVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetUserSettings(getUserSettingsVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetUserSettings(dataConnect, getUserSettingsVars, options); + + // Then, you can render your component dynamically based on the status of the Query. + if (query.isPending) { + return
Loading...
; + } + + if (query.isError) { + return
Error: {query.error.message}
; + } + + // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. + if (query.isSuccess) { + console.log(query.data.userSettings); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +# Mutations + +The React generated SDK provides Mutations hook functions that call and return [`useDataConnectMutation`](https://react-query-firebase.invertase.dev/react/data-connect/mutations) hooks from TanStack Query Firebase. + +Calling these hook functions will return a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, and the most recent data returned by the Mutation, among other things. To learn more about these hooks and how to use them, see the [TanStack Query Firebase documentation](https://react-query-firebase.invertase.dev/react/data-connect/mutations). + +Mutation hooks do not execute their Mutations automatically when called. Rather, after calling the Mutation hook function and getting a `UseMutationResult` object, you must call the `UseMutationResult.mutate()` function to execute the Mutation. + +To learn more about TanStack React Query's Mutations, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/guides/mutations). + +## Using Mutation Hooks +Here's a general overview of how to use the generated Mutation hooks in your code: + +- Mutation hook functions are not called with the arguments to the Mutation. Instead, arguments are passed to `UseMutationResult.mutate()`. +- If the Mutation has no variables, the `mutate()` function does not require arguments. +- If the Mutation has any required variables, the `mutate()` function will require at least one argument: an object that contains all the required variables for the Mutation. +- If the Mutation has some required and some optional variables, only required variables are necessary in the variables argument object, and optional variables may be provided as well. +- If all of the Mutation's variables are optional, the Mutation hook function does not require any arguments. +- Mutation hook 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. +- Mutation hooks also accept an `options` argument of type `useDataConnectMutationOptions`. To learn more about the `options` argument, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/guides/mutations#mutation-side-effects). + - `UseMutationResult.mutate()` also accepts an `options` argument of type `useDataConnectMutationOptions`. + - ***Special case:*** If the Mutation has no arguments (or all optional arguments and you wish to provide none), and you want to pass `options` to `UseMutationResult.mutate()`, you must pass `undefined` where you would normally pass the Mutation's arguments, and then may provide the options argument. + +Below are examples of how to use the `data-connector` connector's generated Mutation hook functions to execute each Mutation. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#operations-react-angular). + +## CreateAccount +You can execute the `CreateAccount` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateAccount(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateAccount(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateAccount` Mutation requires an argument of type `CreateAccountVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateAccountVariables { + id: UUIDString; + ownerId: string; + companyName: string; + businessNumber?: string | null; + phoneNumber?: string | null; +} +``` +### Return Type +Recall that calling the `CreateAccount` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateAccount` Mutation is of type `CreateAccountData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateAccountData { + account_insert: Account_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateAccount`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateAccountVariables } from '@generated/data-connector-web'; +import { useCreateAccount } from '@generated/data-connector-web/react' + +export default function CreateAccountComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateAccount(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateAccount(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateAccount(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateAccount(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateAccount` Mutation requires an argument of type `CreateAccountVariables`: + const createAccountVars: CreateAccountVariables = { + id: ..., + ownerId: ..., + companyName: ..., + businessNumber: ..., // optional + phoneNumber: ..., // optional + }; + mutation.mutate(createAccountVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., ownerId: ..., companyName: ..., businessNumber: ..., phoneNumber: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createAccountVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.account_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateAccount +You can execute the `UpdateAccount` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateAccount(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateAccount(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateAccount` Mutation requires an argument of type `UpdateAccountVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateAccountVariables { + id: UUIDString; + companyName?: string | null; + businessNumber?: string | null; + phoneNumber?: string | null; + primaryContactId?: UUIDString | null; +} +``` +### Return Type +Recall that calling the `UpdateAccount` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateAccount` Mutation is of type `UpdateAccountData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateAccountData { + account_update?: Account_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateAccount`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateAccountVariables } from '@generated/data-connector-web'; +import { useUpdateAccount } from '@generated/data-connector-web/react' + +export default function UpdateAccountComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateAccount(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateAccount(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateAccount(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateAccount(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateAccount` Mutation requires an argument of type `UpdateAccountVariables`: + const updateAccountVars: UpdateAccountVariables = { + id: ..., + companyName: ..., // optional + businessNumber: ..., // optional + phoneNumber: ..., // optional + primaryContactId: ..., // optional + }; + mutation.mutate(updateAccountVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., companyName: ..., businessNumber: ..., phoneNumber: ..., primaryContactId: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateAccountVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.account_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteAccountContacts +You can execute the `DeleteAccountContacts` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteAccountContacts(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteAccountContacts(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteAccountContacts` Mutation requires an argument of type `DeleteAccountContactsVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteAccountContactsVariables { + accountId: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteAccountContacts` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteAccountContacts` Mutation is of type `DeleteAccountContactsData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteAccountContactsData { + accountContact_deleteMany: number; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteAccountContacts`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteAccountContactsVariables } from '@generated/data-connector-web'; +import { useDeleteAccountContacts } from '@generated/data-connector-web/react' + +export default function DeleteAccountContactsComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteAccountContacts(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteAccountContacts(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteAccountContacts(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteAccountContacts(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteAccountContacts` Mutation requires an argument of type `DeleteAccountContactsVariables`: + const deleteAccountContactsVars: DeleteAccountContactsVariables = { + accountId: ..., + }; + mutation.mutate(deleteAccountContactsVars); + // Variables can be defined inline as well. + mutation.mutate({ accountId: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteAccountContactsVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.accountContact_deleteMany); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteAccount +You can execute the `DeleteAccount` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteAccount(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteAccount(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteAccount` Mutation requires an argument of type `DeleteAccountVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteAccountVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteAccount` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteAccount` Mutation is of type `DeleteAccountData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteAccountData { + account_delete?: Account_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteAccount`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteAccountVariables } from '@generated/data-connector-web'; +import { useDeleteAccount } from '@generated/data-connector-web/react' + +export default function DeleteAccountComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteAccount(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteAccount(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteAccount(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteAccount(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteAccount` Mutation requires an argument of type `DeleteAccountVariables`: + const deleteAccountVars: DeleteAccountVariables = { + id: ..., + }; + mutation.mutate(deleteAccountVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteAccountVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.account_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateAccountContact +You can execute the `CreateAccountContact` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateAccountContact(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateAccountContact(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateAccountContact` Mutation requires an argument of type `CreateAccountContactVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateAccountContactVariables { + id: UUIDString; + accountId: UUIDString; + name: string; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; +} +``` +### Return Type +Recall that calling the `CreateAccountContact` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateAccountContact` Mutation is of type `CreateAccountContactData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateAccountContactData { + accountContact_insert: AccountContact_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateAccountContact`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateAccountContactVariables } from '@generated/data-connector-web'; +import { useCreateAccountContact } from '@generated/data-connector-web/react' + +export default function CreateAccountContactComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateAccountContact(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateAccountContact(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateAccountContact(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateAccountContact(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateAccountContact` Mutation requires an argument of type `CreateAccountContactVariables`: + const createAccountContactVars: CreateAccountContactVariables = { + id: ..., + accountId: ..., + name: ..., + email: ..., // optional + phoneNumber: ..., // optional + role: ..., // optional + }; + mutation.mutate(createAccountContactVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., accountId: ..., name: ..., email: ..., phoneNumber: ..., role: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createAccountContactVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.accountContact_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateAccountContact +You can execute the `UpdateAccountContact` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateAccountContact(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateAccountContact(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateAccountContact` Mutation requires an argument of type `UpdateAccountContactVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateAccountContactVariables { + id: UUIDString; + name?: string | null; + email?: string | null; + phoneNumber?: string | null; + role?: string | null; +} +``` +### Return Type +Recall that calling the `UpdateAccountContact` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateAccountContact` Mutation is of type `UpdateAccountContactData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateAccountContactData { + accountContact_update?: AccountContact_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateAccountContact`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateAccountContactVariables } from '@generated/data-connector-web'; +import { useUpdateAccountContact } from '@generated/data-connector-web/react' + +export default function UpdateAccountContactComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateAccountContact(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateAccountContact(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateAccountContact(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateAccountContact(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateAccountContact` Mutation requires an argument of type `UpdateAccountContactVariables`: + const updateAccountContactVars: UpdateAccountContactVariables = { + id: ..., + name: ..., // optional + email: ..., // optional + phoneNumber: ..., // optional + role: ..., // optional + }; + mutation.mutate(updateAccountContactVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., name: ..., email: ..., phoneNumber: ..., role: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateAccountContactVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.accountContact_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteAccountContact +You can execute the `DeleteAccountContact` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteAccountContact(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteAccountContact(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteAccountContact` Mutation requires an argument of type `DeleteAccountContactVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteAccountContactVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteAccountContact` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteAccountContact` Mutation is of type `DeleteAccountContactData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteAccountContactData { + accountContact_delete?: AccountContact_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteAccountContact`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteAccountContactVariables } from '@generated/data-connector-web'; +import { useDeleteAccountContact } from '@generated/data-connector-web/react' + +export default function DeleteAccountContactComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteAccountContact(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteAccountContact(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteAccountContact(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteAccountContact(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteAccountContact` Mutation requires an argument of type `DeleteAccountContactVariables`: + const deleteAccountContactVars: DeleteAccountContactVariables = { + id: ..., + }; + mutation.mutate(deleteAccountContactVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteAccountContactVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.accountContact_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateProjectFromUpload +You can execute the `CreateProjectFromUpload` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateProjectFromUpload(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateProjectFromUpload(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateProjectFromUpload` Mutation requires an argument of type `CreateProjectFromUploadVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateProjectFromUploadVariables { + id: UUIDString; + ownerId: string; + accountId?: UUIDString | null; + name: string; + address?: string | null; + originalFileName: string; + uploadType: string; + originalPath: string; + status: string; + salesStatus?: string | null; + pageCount: number; +} +``` +### Return Type +Recall that calling the `CreateProjectFromUpload` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateProjectFromUpload` Mutation is of type `CreateProjectFromUploadData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateProjectFromUploadData { + project_insert: Project_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateProjectFromUpload`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateProjectFromUploadVariables } from '@generated/data-connector-web'; +import { useCreateProjectFromUpload } from '@generated/data-connector-web/react' + +export default function CreateProjectFromUploadComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateProjectFromUpload(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateProjectFromUpload(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateProjectFromUpload(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateProjectFromUpload(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateProjectFromUpload` Mutation requires an argument of type `CreateProjectFromUploadVariables`: + const createProjectFromUploadVars: CreateProjectFromUploadVariables = { + id: ..., + ownerId: ..., + accountId: ..., // optional + name: ..., + address: ..., // optional + originalFileName: ..., + uploadType: ..., + originalPath: ..., + status: ..., + salesStatus: ..., // optional + pageCount: ..., + }; + mutation.mutate(createProjectFromUploadVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., ownerId: ..., accountId: ..., name: ..., address: ..., originalFileName: ..., uploadType: ..., originalPath: ..., status: ..., salesStatus: ..., pageCount: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createProjectFromUploadVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.project_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateProject +You can execute the `UpdateProject` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateProject(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateProject(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateProject` Mutation requires an argument of type `UpdateProjectVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateProjectVariables { + id: UUIDString; + name?: string | null; + accountId?: UUIDString | null; + address?: string | null; + salesStatus?: string | null; +} +``` +### Return Type +Recall that calling the `UpdateProject` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateProject` Mutation is of type `UpdateProjectData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateProjectData { + project_update?: Project_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateProject`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateProjectVariables } from '@generated/data-connector-web'; +import { useUpdateProject } from '@generated/data-connector-web/react' + +export default function UpdateProjectComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateProject(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateProject(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateProject(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateProject(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateProject` Mutation requires an argument of type `UpdateProjectVariables`: + const updateProjectVars: UpdateProjectVariables = { + id: ..., + name: ..., // optional + accountId: ..., // optional + address: ..., // optional + salesStatus: ..., // optional + }; + mutation.mutate(updateProjectVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., name: ..., accountId: ..., address: ..., salesStatus: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateProjectVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.project_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## RenameProject +You can execute the `RenameProject` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useRenameProject(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useRenameProject(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `RenameProject` Mutation requires an argument of type `RenameProjectVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface RenameProjectVariables { + id: UUIDString; + name: string; +} +``` +### Return Type +Recall that calling the `RenameProject` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `RenameProject` Mutation is of type `RenameProjectData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface RenameProjectData { + project_update?: Project_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `RenameProject`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, RenameProjectVariables } from '@generated/data-connector-web'; +import { useRenameProject } from '@generated/data-connector-web/react' + +export default function RenameProjectComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useRenameProject(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useRenameProject(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useRenameProject(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useRenameProject(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useRenameProject` Mutation requires an argument of type `RenameProjectVariables`: + const renameProjectVars: RenameProjectVariables = { + id: ..., + name: ..., + }; + mutation.mutate(renameProjectVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., name: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(renameProjectVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.project_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## TouchProject +You can execute the `TouchProject` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useTouchProject(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useTouchProject(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `TouchProject` Mutation requires an argument of type `TouchProjectVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface TouchProjectVariables { + id: UUIDString; + status?: string | null; + processingError?: string | null; +} +``` +### Return Type +Recall that calling the `TouchProject` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `TouchProject` Mutation is of type `TouchProjectData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface TouchProjectData { + project_update?: Project_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `TouchProject`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, TouchProjectVariables } from '@generated/data-connector-web'; +import { useTouchProject } from '@generated/data-connector-web/react' + +export default function TouchProjectComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useTouchProject(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useTouchProject(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useTouchProject(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useTouchProject(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useTouchProject` Mutation requires an argument of type `TouchProjectVariables`: + const touchProjectVars: TouchProjectVariables = { + id: ..., + status: ..., // optional + processingError: ..., // optional + }; + mutation.mutate(touchProjectVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., status: ..., processingError: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(touchProjectVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.project_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteFloorplanPages +You can execute the `DeleteFloorplanPages` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteFloorplanPages(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteFloorplanPages(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteFloorplanPages` Mutation requires an argument of type `DeleteFloorplanPagesVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteFloorplanPagesVariables { + projectId: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteFloorplanPages` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteFloorplanPages` Mutation is of type `DeleteFloorplanPagesData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteFloorplanPagesData { + floorplanPage_deleteMany: number; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteFloorplanPages`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteFloorplanPagesVariables } from '@generated/data-connector-web'; +import { useDeleteFloorplanPages } from '@generated/data-connector-web/react' + +export default function DeleteFloorplanPagesComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteFloorplanPages(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteFloorplanPages(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteFloorplanPages(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteFloorplanPages(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteFloorplanPages` Mutation requires an argument of type `DeleteFloorplanPagesVariables`: + const deleteFloorplanPagesVars: DeleteFloorplanPagesVariables = { + projectId: ..., + }; + mutation.mutate(deleteFloorplanPagesVars); + // Variables can be defined inline as well. + mutation.mutate({ projectId: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteFloorplanPagesVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.floorplanPage_deleteMany); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteProject +You can execute the `DeleteProject` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteProject(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteProject(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteProject` Mutation requires an argument of type `DeleteProjectVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteProjectVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteProject` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteProject` Mutation is of type `DeleteProjectData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteProjectData { + project_delete?: Project_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteProject`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteProjectVariables } from '@generated/data-connector-web'; +import { useDeleteProject } from '@generated/data-connector-web/react' + +export default function DeleteProjectComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteProject(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteProject(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteProject(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteProject(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteProject` Mutation requires an argument of type `DeleteProjectVariables`: + const deleteProjectVars: DeleteProjectVariables = { + id: ..., + }; + mutation.mutate(deleteProjectVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteProjectVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.project_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateFloorplanPage +You can execute the `CreateFloorplanPage` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateFloorplanPage(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateFloorplanPage(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateFloorplanPage` Mutation requires an argument of type `CreateFloorplanPageVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateFloorplanPageVariables { + projectId: UUIDString; + pageNumber: number; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; +} +``` +### Return Type +Recall that calling the `CreateFloorplanPage` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateFloorplanPage` Mutation is of type `CreateFloorplanPageData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateFloorplanPageData { + floorplanPage_insert: FloorplanPage_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateFloorplanPage`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateFloorplanPageVariables } from '@generated/data-connector-web'; +import { useCreateFloorplanPage } from '@generated/data-connector-web/react' + +export default function CreateFloorplanPageComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateFloorplanPage(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateFloorplanPage(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateFloorplanPage(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateFloorplanPage(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateFloorplanPage` Mutation requires an argument of type `CreateFloorplanPageVariables`: + const createFloorplanPageVars: CreateFloorplanPageVariables = { + projectId: ..., + pageNumber: ..., + status: ..., + processingError: ..., // optional + sourceImagePath: ..., // optional + previewImagePath: ..., // optional + rawJsonPath: ..., // optional + rawFloorplanPath: ..., // optional + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional + processingStrategy: ..., // optional + processingMetadataJson: ..., // optional + }; + mutation.mutate(createFloorplanPageVars); + // Variables can be defined inline as well. + mutation.mutate({ projectId: ..., pageNumber: ..., status: ..., processingError: ..., sourceImagePath: ..., previewImagePath: ..., rawJsonPath: ..., rawFloorplanPath: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., processingStrategy: ..., processingMetadataJson: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createFloorplanPageVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.floorplanPage_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateFloorplanPageAnalysis +You can execute the `UpdateFloorplanPageAnalysis` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateFloorplanPageAnalysis(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateFloorplanPageAnalysis(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateFloorplanPageAnalysis` Mutation requires an argument of type `UpdateFloorplanPageAnalysisVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateFloorplanPageAnalysisVariables { + id: UUIDString; + status: string; + processingError?: string | null; + sourceImagePath?: string | null; + previewImagePath?: string | null; + rawJsonPath?: string | null; + rawFloorplanPath?: string | null; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; + processingStrategy?: string | null; + processingMetadataJson?: string | null; +} +``` +### Return Type +Recall that calling the `UpdateFloorplanPageAnalysis` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateFloorplanPageAnalysis` Mutation is of type `UpdateFloorplanPageAnalysisData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateFloorplanPageAnalysisData { + floorplanPage_update?: FloorplanPage_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateFloorplanPageAnalysis`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateFloorplanPageAnalysisVariables } from '@generated/data-connector-web'; +import { useUpdateFloorplanPageAnalysis } from '@generated/data-connector-web/react' + +export default function UpdateFloorplanPageAnalysisComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateFloorplanPageAnalysis(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateFloorplanPageAnalysis(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateFloorplanPageAnalysis(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateFloorplanPageAnalysis(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateFloorplanPageAnalysis` Mutation requires an argument of type `UpdateFloorplanPageAnalysisVariables`: + const updateFloorplanPageAnalysisVars: UpdateFloorplanPageAnalysisVariables = { + id: ..., + status: ..., + processingError: ..., // optional + sourceImagePath: ..., // optional + previewImagePath: ..., // optional + rawJsonPath: ..., // optional + rawFloorplanPath: ..., // optional + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional + processingStrategy: ..., // optional + processingMetadataJson: ..., // optional + }; + mutation.mutate(updateFloorplanPageAnalysisVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., status: ..., processingError: ..., sourceImagePath: ..., previewImagePath: ..., rawJsonPath: ..., rawFloorplanPath: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., processingStrategy: ..., processingMetadataJson: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateFloorplanPageAnalysisVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.floorplanPage_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateFloorplanPage +You can execute the `UpdateFloorplanPage` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateFloorplanPage(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateFloorplanPage(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateFloorplanPage` Mutation requires an argument of type `UpdateFloorplanPageVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateFloorplanPageVariables { + id: UUIDString; + overlayJson?: string | null; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; + referencePointsJson?: string | null; + referenceLengthMm?: number | null; +} +``` +### Return Type +Recall that calling the `UpdateFloorplanPage` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateFloorplanPage` Mutation is of type `UpdateFloorplanPageData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateFloorplanPageData { + floorplanPage_update?: FloorplanPage_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateFloorplanPage`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateFloorplanPageVariables } from '@generated/data-connector-web'; +import { useUpdateFloorplanPage } from '@generated/data-connector-web/react' + +export default function UpdateFloorplanPageComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateFloorplanPage(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateFloorplanPage(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateFloorplanPage(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateFloorplanPage(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateFloorplanPage` Mutation requires an argument of type `UpdateFloorplanPageVariables`: + const updateFloorplanPageVars: UpdateFloorplanPageVariables = { + id: ..., + overlayJson: ..., // optional + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + referencePointsJson: ..., // optional + referenceLengthMm: ..., // optional + }; + mutation.mutate(updateFloorplanPageVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., overlayJson: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., referencePointsJson: ..., referenceLengthMm: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateFloorplanPageVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.floorplanPage_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateFloorplanPages +You can execute the `UpdateFloorplanPages` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateFloorplanPages(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateFloorplanPages(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateFloorplanPages` Mutation requires an argument of type `UpdateFloorplanPagesVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateFloorplanPagesVariables { + projectId: UUIDString; + scaleMmPerPx?: number | null; + ceilingHeightMm?: number | null; +} +``` +### Return Type +Recall that calling the `UpdateFloorplanPages` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateFloorplanPages` Mutation is of type `UpdateFloorplanPagesData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateFloorplanPagesData { + floorplanPage_updateMany: number; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateFloorplanPages`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateFloorplanPagesVariables } from '@generated/data-connector-web'; +import { useUpdateFloorplanPages } from '@generated/data-connector-web/react' + +export default function UpdateFloorplanPagesComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateFloorplanPages(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateFloorplanPages(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateFloorplanPages(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateFloorplanPages(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateFloorplanPages` Mutation requires an argument of type `UpdateFloorplanPagesVariables`: + const updateFloorplanPagesVars: UpdateFloorplanPagesVariables = { + projectId: ..., + scaleMmPerPx: ..., // optional + ceilingHeightMm: ..., // optional + }; + mutation.mutate(updateFloorplanPagesVars); + // Variables can be defined inline as well. + mutation.mutate({ projectId: ..., scaleMmPerPx: ..., ceilingHeightMm: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateFloorplanPagesVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.floorplanPage_updateMany); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateQuestionnaireTemplate +You can execute the `CreateQuestionnaireTemplate` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateQuestionnaireTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateQuestionnaireTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateQuestionnaireTemplate` Mutation requires an argument of type `CreateQuestionnaireTemplateVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateQuestionnaireTemplateVariables { + id: UUIDString; + name: string; +} +``` +### Return Type +Recall that calling the `CreateQuestionnaireTemplate` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateQuestionnaireTemplate` Mutation is of type `CreateQuestionnaireTemplateData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateQuestionnaireTemplateData { + questionnaireTemplate_insert: QuestionnaireTemplate_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateQuestionnaireTemplate`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateQuestionnaireTemplateVariables } from '@generated/data-connector-web'; +import { useCreateQuestionnaireTemplate } from '@generated/data-connector-web/react' + +export default function CreateQuestionnaireTemplateComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateQuestionnaireTemplate(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateQuestionnaireTemplate(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuestionnaireTemplate(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuestionnaireTemplate(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateQuestionnaireTemplate` Mutation requires an argument of type `CreateQuestionnaireTemplateVariables`: + const createQuestionnaireTemplateVars: CreateQuestionnaireTemplateVariables = { + id: ..., + name: ..., + }; + mutation.mutate(createQuestionnaireTemplateVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., name: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createQuestionnaireTemplateVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.questionnaireTemplate_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateQuestionnaireTemplateQuestion +You can execute the `CreateQuestionnaireTemplateQuestion` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateQuestionnaireTemplateQuestion` Mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; + label: string; + position: number; + description?: string | null; +} +``` +### Return Type +Recall that calling the `CreateQuestionnaireTemplateQuestion` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateQuestionnaireTemplateQuestion` Mutation is of type `CreateQuestionnaireTemplateQuestionData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_insert: QuestionnaireTemplateQuestion_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateQuestionnaireTemplateQuestion`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; +import { useCreateQuestionnaireTemplateQuestion } from '@generated/data-connector-web/react' + +export default function CreateQuestionnaireTemplateQuestionComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateQuestionnaireTemplateQuestion(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateQuestionnaireTemplateQuestion(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuestionnaireTemplateQuestion(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuestionnaireTemplateQuestion(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateQuestionnaireTemplateQuestion` Mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`: + const createQuestionnaireTemplateQuestionVars: CreateQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., + label: ..., + position: ..., + description: ..., // optional + }; + mutation.mutate(createQuestionnaireTemplateQuestionVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createQuestionnaireTemplateQuestionVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.questionnaireTemplateQuestion_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateQuestionnaireTemplateName +You can execute the `UpdateQuestionnaireTemplateName` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateQuestionnaireTemplateName(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateQuestionnaireTemplateName(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateQuestionnaireTemplateName` Mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateQuestionnaireTemplateNameVariables { + id: UUIDString; + name: string; +} +``` +### Return Type +Recall that calling the `UpdateQuestionnaireTemplateName` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateQuestionnaireTemplateName` Mutation is of type `UpdateQuestionnaireTemplateNameData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateQuestionnaireTemplateNameData { + questionnaireTemplate_update?: QuestionnaireTemplate_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateQuestionnaireTemplateName`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateQuestionnaireTemplateNameVariables } from '@generated/data-connector-web'; +import { useUpdateQuestionnaireTemplateName } from '@generated/data-connector-web/react' + +export default function UpdateQuestionnaireTemplateNameComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateQuestionnaireTemplateName(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateQuestionnaireTemplateName(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuestionnaireTemplateName(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuestionnaireTemplateName(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateQuestionnaireTemplateName` Mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`: + const updateQuestionnaireTemplateNameVars: UpdateQuestionnaireTemplateNameVariables = { + id: ..., + name: ..., + }; + mutation.mutate(updateQuestionnaireTemplateNameVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., name: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateQuestionnaireTemplateNameVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.questionnaireTemplate_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateQuestionnaireTemplateQuestion +You can execute the `UpdateQuestionnaireTemplateQuestion` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateQuestionnaireTemplateQuestion` Mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; + label: string; + position: number; + description?: string | null; +} +``` +### Return Type +Recall that calling the `UpdateQuestionnaireTemplateQuestion` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateQuestionnaireTemplateQuestion` Mutation is of type `UpdateQuestionnaireTemplateQuestionData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_update?: QuestionnaireTemplateQuestion_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateQuestionnaireTemplateQuestion`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; +import { useUpdateQuestionnaireTemplateQuestion } from '@generated/data-connector-web/react' + +export default function UpdateQuestionnaireTemplateQuestionComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateQuestionnaireTemplateQuestion(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateQuestionnaireTemplateQuestion(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuestionnaireTemplateQuestion(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuestionnaireTemplateQuestion(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateQuestionnaireTemplateQuestion` Mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`: + const updateQuestionnaireTemplateQuestionVars: UpdateQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., + label: ..., + position: ..., + description: ..., // optional + }; + mutation.mutate(updateQuestionnaireTemplateQuestionVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateQuestionnaireTemplateQuestionVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.questionnaireTemplateQuestion_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteQuestionnaireTemplateQuestion +You can execute the `DeleteQuestionnaireTemplateQuestion` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteQuestionnaireTemplateQuestion` Mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteQuestionnaireTemplateQuestionVariables { + id: UUIDString; + templateId: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteQuestionnaireTemplateQuestion` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteQuestionnaireTemplateQuestion` Mutation is of type `DeleteQuestionnaireTemplateQuestionData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteQuestionnaireTemplateQuestionData { + questionnaireTemplateQuestion_delete?: QuestionnaireTemplateQuestion_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteQuestionnaireTemplateQuestion`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteQuestionnaireTemplateQuestionVariables } from '@generated/data-connector-web'; +import { useDeleteQuestionnaireTemplateQuestion } from '@generated/data-connector-web/react' + +export default function DeleteQuestionnaireTemplateQuestionComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteQuestionnaireTemplateQuestion(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteQuestionnaireTemplateQuestion(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteQuestionnaireTemplateQuestion(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteQuestionnaireTemplateQuestion(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteQuestionnaireTemplateQuestion` Mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`: + const deleteQuestionnaireTemplateQuestionVars: DeleteQuestionnaireTemplateQuestionVariables = { + id: ..., + templateId: ..., + }; + mutation.mutate(deleteQuestionnaireTemplateQuestionVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., templateId: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteQuestionnaireTemplateQuestionVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.questionnaireTemplateQuestion_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteQuestionnaireTemplate +You can execute the `DeleteQuestionnaireTemplate` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteQuestionnaireTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteQuestionnaireTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteQuestionnaireTemplate` Mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteQuestionnaireTemplateVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteQuestionnaireTemplate` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteQuestionnaireTemplate` Mutation is of type `DeleteQuestionnaireTemplateData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteQuestionnaireTemplateData { + questionnaireTemplateQuestion_deleteMany: number; + questionnaireTemplate_delete?: QuestionnaireTemplate_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteQuestionnaireTemplate`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteQuestionnaireTemplateVariables } from '@generated/data-connector-web'; +import { useDeleteQuestionnaireTemplate } from '@generated/data-connector-web/react' + +export default function DeleteQuestionnaireTemplateComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteQuestionnaireTemplate(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteQuestionnaireTemplate(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteQuestionnaireTemplate(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteQuestionnaireTemplate(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteQuestionnaireTemplate` Mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`: + const deleteQuestionnaireTemplateVars: DeleteQuestionnaireTemplateVariables = { + id: ..., + }; + mutation.mutate(deleteQuestionnaireTemplateVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteQuestionnaireTemplateVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.questionnaireTemplateQuestion_deleteMany); + console.log(mutation.data.questionnaireTemplate_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateProjectQuestionnaire +You can execute the `CreateProjectQuestionnaire` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateProjectQuestionnaire(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateProjectQuestionnaire(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateProjectQuestionnaire` Mutation requires an argument of type `CreateProjectQuestionnaireVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateProjectQuestionnaireVariables { + id: UUIDString; + projectId: UUIDString; + sourceTemplateId?: UUIDString | null; +} +``` +### Return Type +Recall that calling the `CreateProjectQuestionnaire` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateProjectQuestionnaire` Mutation is of type `CreateProjectQuestionnaireData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateProjectQuestionnaireData { + projectQuestionnaire_insert: ProjectQuestionnaire_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateProjectQuestionnaire`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateProjectQuestionnaireVariables } from '@generated/data-connector-web'; +import { useCreateProjectQuestionnaire } from '@generated/data-connector-web/react' + +export default function CreateProjectQuestionnaireComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateProjectQuestionnaire(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateProjectQuestionnaire(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateProjectQuestionnaire(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateProjectQuestionnaire(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateProjectQuestionnaire` Mutation requires an argument of type `CreateProjectQuestionnaireVariables`: + const createProjectQuestionnaireVars: CreateProjectQuestionnaireVariables = { + id: ..., + projectId: ..., + sourceTemplateId: ..., // optional + }; + mutation.mutate(createProjectQuestionnaireVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., projectId: ..., sourceTemplateId: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createProjectQuestionnaireVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.projectQuestionnaire_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateProjectQuestionnaireAnswer +You can execute the `CreateProjectQuestionnaireAnswer` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateProjectQuestionnaireAnswer(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateProjectQuestionnaireAnswer(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateProjectQuestionnaireAnswer` Mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateProjectQuestionnaireAnswerVariables { + id: UUIDString; + projectQuestionnaireId: UUIDString; + questionId: UUIDString; + position: number; + answer?: string | null; +} +``` +### Return Type +Recall that calling the `CreateProjectQuestionnaireAnswer` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateProjectQuestionnaireAnswer` Mutation is of type `CreateProjectQuestionnaireAnswerData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateProjectQuestionnaireAnswerData { + projectQuestionnaireAnswer_insert: ProjectQuestionnaireAnswer_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateProjectQuestionnaireAnswer`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateProjectQuestionnaireAnswerVariables } from '@generated/data-connector-web'; +import { useCreateProjectQuestionnaireAnswer } from '@generated/data-connector-web/react' + +export default function CreateProjectQuestionnaireAnswerComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateProjectQuestionnaireAnswer(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateProjectQuestionnaireAnswer(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateProjectQuestionnaireAnswer(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateProjectQuestionnaireAnswer(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateProjectQuestionnaireAnswer` Mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`: + const createProjectQuestionnaireAnswerVars: CreateProjectQuestionnaireAnswerVariables = { + id: ..., + projectQuestionnaireId: ..., + questionId: ..., + position: ..., + answer: ..., // optional + }; + mutation.mutate(createProjectQuestionnaireAnswerVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., projectQuestionnaireId: ..., questionId: ..., position: ..., answer: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createProjectQuestionnaireAnswerVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.projectQuestionnaireAnswer_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateQuantitySource +You can execute the `CreateQuantitySource` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateQuantitySource(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateQuantitySource(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateQuantitySource` Mutation requires an argument of type `CreateQuantitySourceVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateQuantitySourceVariables { + id: UUIDString; + measurementSource: string; + measurementPlasterType?: string | null; +} +``` +### Return Type +Recall that calling the `CreateQuantitySource` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateQuantitySource` Mutation is of type `CreateQuantitySourceData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateQuantitySourceData { + quantitySource_insert: QuantitySource_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateQuantitySource`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateQuantitySourceVariables } from '@generated/data-connector-web'; +import { useCreateQuantitySource } from '@generated/data-connector-web/react' + +export default function CreateQuantitySourceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateQuantitySource(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateQuantitySource(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuantitySource(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuantitySource(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateQuantitySource` Mutation requires an argument of type `CreateQuantitySourceVariables`: + const createQuantitySourceVars: CreateQuantitySourceVariables = { + id: ..., + measurementSource: ..., + measurementPlasterType: ..., // optional + }; + mutation.mutate(createQuantitySourceVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., measurementSource: ..., measurementPlasterType: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createQuantitySourceVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quantitySource_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateQuoteItemTemplate +You can execute the `CreateQuoteItemTemplate` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateQuoteItemTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateQuoteItemTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateQuoteItemTemplate` Mutation requires an argument of type `CreateQuoteItemTemplateVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateQuoteItemTemplateVariables { + id: UUIDString; + ownerId?: string | null; + scope: string; + systemKey?: string | null; + name: string; + hasKeywords: boolean; + keywords: string[]; + quantitySourceId?: UUIDString | null; + sortOrder: number; +} +``` +### Return Type +Recall that calling the `CreateQuoteItemTemplate` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateQuoteItemTemplate` Mutation is of type `CreateQuoteItemTemplateData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateQuoteItemTemplateData { + quoteItemTemplate_insert: QuoteItemTemplate_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateQuoteItemTemplate`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateQuoteItemTemplateVariables } from '@generated/data-connector-web'; +import { useCreateQuoteItemTemplate } from '@generated/data-connector-web/react' + +export default function CreateQuoteItemTemplateComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateQuoteItemTemplate(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateQuoteItemTemplate(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuoteItemTemplate(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuoteItemTemplate(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateQuoteItemTemplate` Mutation requires an argument of type `CreateQuoteItemTemplateVariables`: + const createQuoteItemTemplateVars: CreateQuoteItemTemplateVariables = { + id: ..., + ownerId: ..., // optional + scope: ..., + systemKey: ..., // optional + name: ..., + hasKeywords: ..., + keywords: ..., + quantitySourceId: ..., // optional + sortOrder: ..., + }; + mutation.mutate(createQuoteItemTemplateVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., ownerId: ..., scope: ..., systemKey: ..., name: ..., hasKeywords: ..., keywords: ..., quantitySourceId: ..., sortOrder: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createQuoteItemTemplateVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quoteItemTemplate_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateQuoteItemTemplate +You can execute the `UpdateQuoteItemTemplate` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateQuoteItemTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateQuoteItemTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateQuoteItemTemplate` Mutation requires an argument of type `UpdateQuoteItemTemplateVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateQuoteItemTemplateVariables { + id: UUIDString; + name?: string | null; + hasKeywords?: boolean | null; + keywords?: string[] | null; + quantitySourceId?: UUIDString | null; + sortOrder?: number | null; +} +``` +### Return Type +Recall that calling the `UpdateQuoteItemTemplate` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateQuoteItemTemplate` Mutation is of type `UpdateQuoteItemTemplateData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateQuoteItemTemplateData { + quoteItemTemplate_update?: QuoteItemTemplate_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateQuoteItemTemplate`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateQuoteItemTemplateVariables } from '@generated/data-connector-web'; +import { useUpdateQuoteItemTemplate } from '@generated/data-connector-web/react' + +export default function UpdateQuoteItemTemplateComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateQuoteItemTemplate(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateQuoteItemTemplate(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuoteItemTemplate(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuoteItemTemplate(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateQuoteItemTemplate` Mutation requires an argument of type `UpdateQuoteItemTemplateVariables`: + const updateQuoteItemTemplateVars: UpdateQuoteItemTemplateVariables = { + id: ..., + name: ..., // optional + hasKeywords: ..., // optional + keywords: ..., // optional + quantitySourceId: ..., // optional + sortOrder: ..., // optional + }; + mutation.mutate(updateQuoteItemTemplateVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., name: ..., hasKeywords: ..., keywords: ..., quantitySourceId: ..., sortOrder: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateQuoteItemTemplateVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quoteItemTemplate_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteQuoteItemTemplate +You can execute the `DeleteQuoteItemTemplate` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteQuoteItemTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteQuoteItemTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteQuoteItemTemplate` Mutation requires an argument of type `DeleteQuoteItemTemplateVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteQuoteItemTemplateVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteQuoteItemTemplate` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteQuoteItemTemplate` Mutation is of type `DeleteQuoteItemTemplateData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteQuoteItemTemplateData { + quoteItemTemplate_delete?: QuoteItemTemplate_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteQuoteItemTemplate`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteQuoteItemTemplateVariables } from '@generated/data-connector-web'; +import { useDeleteQuoteItemTemplate } from '@generated/data-connector-web/react' + +export default function DeleteQuoteItemTemplateComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteQuoteItemTemplate(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteQuoteItemTemplate(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteQuoteItemTemplate(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteQuoteItemTemplate(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteQuoteItemTemplate` Mutation requires an argument of type `DeleteQuoteItemTemplateVariables`: + const deleteQuoteItemTemplateVars: DeleteQuoteItemTemplateVariables = { + id: ..., + }; + mutation.mutate(deleteQuoteItemTemplateVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteQuoteItemTemplateVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quoteItemTemplate_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpsertQuoteItemTemplateConfig +You can execute the `UpsertQuoteItemTemplateConfig` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpsertQuoteItemTemplateConfig(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpsertQuoteItemTemplateConfig(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpsertQuoteItemTemplateConfig` Mutation requires an argument of type `UpsertQuoteItemTemplateConfigVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpsertQuoteItemTemplateConfigVariables { + ownerId: string; + templateId: UUIDString; + enabled: boolean; + unitPriceCents: number; + materialUnitPriceCents: number; + labourUnitPriceCents: number; +} +``` +### Return Type +Recall that calling the `UpsertQuoteItemTemplateConfig` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpsertQuoteItemTemplateConfig` Mutation is of type `UpsertQuoteItemTemplateConfigData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpsertQuoteItemTemplateConfigData { + quoteItemTemplateConfig_upsert: QuoteItemTemplateConfig_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpsertQuoteItemTemplateConfig`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpsertQuoteItemTemplateConfigVariables } from '@generated/data-connector-web'; +import { useUpsertQuoteItemTemplateConfig } from '@generated/data-connector-web/react' + +export default function UpsertQuoteItemTemplateConfigComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpsertQuoteItemTemplateConfig(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpsertQuoteItemTemplateConfig(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpsertQuoteItemTemplateConfig(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpsertQuoteItemTemplateConfig(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpsertQuoteItemTemplateConfig` Mutation requires an argument of type `UpsertQuoteItemTemplateConfigVariables`: + const upsertQuoteItemTemplateConfigVars: UpsertQuoteItemTemplateConfigVariables = { + ownerId: ..., + templateId: ..., + enabled: ..., + unitPriceCents: ..., + materialUnitPriceCents: ..., + labourUnitPriceCents: ..., + }; + mutation.mutate(upsertQuoteItemTemplateConfigVars); + // Variables can be defined inline as well. + mutation.mutate({ ownerId: ..., templateId: ..., enabled: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(upsertQuoteItemTemplateConfigVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quoteItemTemplateConfig_upsert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateSupplier +You can execute the `CreateSupplier` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateSupplier(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateSupplier(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateSupplier` Mutation requires an argument of type `CreateSupplierVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateSupplierVariables { + id: UUIDString; + ownerId: string; + name: string; +} +``` +### Return Type +Recall that calling the `CreateSupplier` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateSupplier` Mutation is of type `CreateSupplierData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateSupplierData { + supplier_insert: Supplier_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateSupplier`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateSupplierVariables } from '@generated/data-connector-web'; +import { useCreateSupplier } from '@generated/data-connector-web/react' + +export default function CreateSupplierComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateSupplier(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateSupplier(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateSupplier(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateSupplier(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateSupplier` Mutation requires an argument of type `CreateSupplierVariables`: + const createSupplierVars: CreateSupplierVariables = { + id: ..., + ownerId: ..., + name: ..., + }; + mutation.mutate(createSupplierVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., ownerId: ..., name: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createSupplierVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.supplier_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateSupplier +You can execute the `UpdateSupplier` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateSupplier(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateSupplier(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateSupplier` Mutation requires an argument of type `UpdateSupplierVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateSupplierVariables { + id: UUIDString; + name?: string | null; +} +``` +### Return Type +Recall that calling the `UpdateSupplier` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateSupplier` Mutation is of type `UpdateSupplierData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateSupplierData { + supplier_update?: Supplier_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateSupplier`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateSupplierVariables } from '@generated/data-connector-web'; +import { useUpdateSupplier } from '@generated/data-connector-web/react' + +export default function UpdateSupplierComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateSupplier(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateSupplier(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateSupplier(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateSupplier(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateSupplier` Mutation requires an argument of type `UpdateSupplierVariables`: + const updateSupplierVars: UpdateSupplierVariables = { + id: ..., + name: ..., // optional + }; + mutation.mutate(updateSupplierVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., name: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateSupplierVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.supplier_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteSupplier +You can execute the `DeleteSupplier` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteSupplier(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteSupplier(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteSupplier` Mutation requires an argument of type `DeleteSupplierVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteSupplierVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteSupplier` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteSupplier` Mutation is of type `DeleteSupplierData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteSupplierData { + supplier_delete?: Supplier_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteSupplier`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteSupplierVariables } from '@generated/data-connector-web'; +import { useDeleteSupplier } from '@generated/data-connector-web/react' + +export default function DeleteSupplierComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteSupplier(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteSupplier(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteSupplier(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteSupplier(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteSupplier` Mutation requires an argument of type `DeleteSupplierVariables`: + const deleteSupplierVars: DeleteSupplierVariables = { + id: ..., + }; + mutation.mutate(deleteSupplierVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteSupplierVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.supplier_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpsertSupplierQuoteItemPrice +You can execute the `UpsertSupplierQuoteItemPrice` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpsertSupplierQuoteItemPrice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpsertSupplierQuoteItemPrice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpsertSupplierQuoteItemPrice` Mutation requires an argument of type `UpsertSupplierQuoteItemPriceVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpsertSupplierQuoteItemPriceVariables { + ownerId: string; + supplierId: UUIDString; + templateId: UUIDString; + materialUnitPriceCents: number; +} +``` +### Return Type +Recall that calling the `UpsertSupplierQuoteItemPrice` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpsertSupplierQuoteItemPrice` Mutation is of type `UpsertSupplierQuoteItemPriceData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpsertSupplierQuoteItemPriceData { + supplierQuoteItemPrice_upsert: SupplierQuoteItemPrice_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpsertSupplierQuoteItemPrice`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpsertSupplierQuoteItemPriceVariables } from '@generated/data-connector-web'; +import { useUpsertSupplierQuoteItemPrice } from '@generated/data-connector-web/react' + +export default function UpsertSupplierQuoteItemPriceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpsertSupplierQuoteItemPrice(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpsertSupplierQuoteItemPrice(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpsertSupplierQuoteItemPrice(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpsertSupplierQuoteItemPrice(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpsertSupplierQuoteItemPrice` Mutation requires an argument of type `UpsertSupplierQuoteItemPriceVariables`: + const upsertSupplierQuoteItemPriceVars: UpsertSupplierQuoteItemPriceVariables = { + ownerId: ..., + supplierId: ..., + templateId: ..., + materialUnitPriceCents: ..., + }; + mutation.mutate(upsertSupplierQuoteItemPriceVars); + // Variables can be defined inline as well. + mutation.mutate({ ownerId: ..., supplierId: ..., templateId: ..., materialUnitPriceCents: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(upsertSupplierQuoteItemPriceVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.supplierQuoteItemPrice_upsert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteSupplierQuoteItemPrice +You can execute the `DeleteSupplierQuoteItemPrice` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteSupplierQuoteItemPrice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteSupplierQuoteItemPrice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteSupplierQuoteItemPrice` Mutation requires an argument of type `DeleteSupplierQuoteItemPriceVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteSupplierQuoteItemPriceVariables { + supplierId: UUIDString; + templateId: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteSupplierQuoteItemPrice` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteSupplierQuoteItemPrice` Mutation is of type `DeleteSupplierQuoteItemPriceData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteSupplierQuoteItemPriceData { + supplierQuoteItemPrice_delete?: SupplierQuoteItemPrice_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteSupplierQuoteItemPrice`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteSupplierQuoteItemPriceVariables } from '@generated/data-connector-web'; +import { useDeleteSupplierQuoteItemPrice } from '@generated/data-connector-web/react' + +export default function DeleteSupplierQuoteItemPriceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteSupplierQuoteItemPrice(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteSupplierQuoteItemPrice(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteSupplierQuoteItemPrice(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteSupplierQuoteItemPrice(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteSupplierQuoteItemPrice` Mutation requires an argument of type `DeleteSupplierQuoteItemPriceVariables`: + const deleteSupplierQuoteItemPriceVars: DeleteSupplierQuoteItemPriceVariables = { + supplierId: ..., + templateId: ..., + }; + mutation.mutate(deleteSupplierQuoteItemPriceVars); + // Variables can be defined inline as well. + mutation.mutate({ supplierId: ..., templateId: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteSupplierQuoteItemPriceVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.supplierQuoteItemPrice_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateQuote +You can execute the `CreateQuote` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateQuote(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateQuote(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateQuote` Mutation requires an argument of type `CreateQuoteVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateQuoteVariables { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + supplierId?: UUIDString | null; + status: string; +} +``` +### Return Type +Recall that calling the `CreateQuote` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateQuote` Mutation is of type `CreateQuoteData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateQuoteData { + quote_insert: Quote_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateQuote`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateQuoteVariables } from '@generated/data-connector-web'; +import { useCreateQuote } from '@generated/data-connector-web/react' + +export default function CreateQuoteComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateQuote(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateQuote(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuote(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuote(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateQuote` Mutation requires an argument of type `CreateQuoteVariables`: + const createQuoteVars: CreateQuoteVariables = { + id: ..., + ownerId: ..., + projectId: ..., + supplierId: ..., // optional + status: ..., + }; + mutation.mutate(createQuoteVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., ownerId: ..., projectId: ..., supplierId: ..., status: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createQuoteVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quote_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateQuote +You can execute the `UpdateQuote` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateQuote(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateQuote(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateQuote` Mutation requires an argument of type `UpdateQuoteVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateQuoteVariables { + id: UUIDString; + supplierId?: UUIDString | null; + status?: string | null; +} +``` +### Return Type +Recall that calling the `UpdateQuote` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateQuote` Mutation is of type `UpdateQuoteData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateQuoteData { + quote_update?: Quote_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateQuote`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateQuoteVariables } from '@generated/data-connector-web'; +import { useUpdateQuote } from '@generated/data-connector-web/react' + +export default function UpdateQuoteComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateQuote(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateQuote(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuote(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuote(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateQuote` Mutation requires an argument of type `UpdateQuoteVariables`: + const updateQuoteVars: UpdateQuoteVariables = { + id: ..., + supplierId: ..., // optional + status: ..., // optional + }; + mutation.mutate(updateQuoteVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., supplierId: ..., status: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateQuoteVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quote_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteQuoteItems +You can execute the `DeleteQuoteItems` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteQuoteItems(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteQuoteItems(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteQuoteItems` Mutation requires an argument of type `DeleteQuoteItemsVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteQuoteItemsVariables { + quoteId: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteQuoteItems` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteQuoteItems` Mutation is of type `DeleteQuoteItemsData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteQuoteItemsData { + quoteItem_deleteMany: number; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `DeleteQuoteItems`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteQuoteItemsVariables } from '@generated/data-connector-web'; +import { useDeleteQuoteItems } from '@generated/data-connector-web/react' + +export default function DeleteQuoteItemsComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteQuoteItems(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteQuoteItems(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteQuoteItems(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteQuoteItems(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteQuoteItems` Mutation requires an argument of type `DeleteQuoteItemsVariables`: + const deleteQuoteItemsVars: DeleteQuoteItemsVariables = { + quoteId: ..., + }; + mutation.mutate(deleteQuoteItemsVars); + // Variables can be defined inline as well. + mutation.mutate({ quoteId: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(deleteQuoteItemsVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quoteItem_deleteMany); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateQuoteItem +You can execute the `CreateQuoteItem` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateQuoteItem(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateQuoteItem(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateQuoteItem` Mutation requires an argument of type `CreateQuoteItemVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateQuoteItemVariables { + id: UUIDString; + ownerId: string; + quoteId: UUIDString; + sourceTemplateId?: UUIDString | null; + displayOrder: number; + name: string; + quantity: number; + quantitySourceId?: UUIDString | null; + unitPriceCents: number; + materialUnitPriceCents: number; + labourUnitPriceCents: number; + matchedKeywords: string[]; +} +``` +### Return Type +Recall that calling the `CreateQuoteItem` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateQuoteItem` Mutation is of type `CreateQuoteItemData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateQuoteItemData { + quoteItem_insert: QuoteItem_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateQuoteItem`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateQuoteItemVariables } from '@generated/data-connector-web'; +import { useCreateQuoteItem } from '@generated/data-connector-web/react' + +export default function CreateQuoteItemComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateQuoteItem(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateQuoteItem(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuoteItem(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateQuoteItem(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateQuoteItem` Mutation requires an argument of type `CreateQuoteItemVariables`: + const createQuoteItemVars: CreateQuoteItemVariables = { + id: ..., + ownerId: ..., + quoteId: ..., + sourceTemplateId: ..., // optional + displayOrder: ..., + name: ..., + quantity: ..., + quantitySourceId: ..., // optional + unitPriceCents: ..., + materialUnitPriceCents: ..., + labourUnitPriceCents: ..., + matchedKeywords: ..., + }; + mutation.mutate(createQuoteItemVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., ownerId: ..., quoteId: ..., sourceTemplateId: ..., displayOrder: ..., name: ..., quantity: ..., quantitySourceId: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., matchedKeywords: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createQuoteItemVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quoteItem_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateQuoteItem +You can execute the `UpdateQuoteItem` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateQuoteItem(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateQuoteItem(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateQuoteItem` Mutation requires an argument of type `UpdateQuoteItemVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateQuoteItemVariables { + id: UUIDString; + displayOrder?: number | null; + name?: string | null; + quantity?: number | null; + quantitySourceId?: UUIDString | null; + unitPriceCents?: number | null; + materialUnitPriceCents?: number | null; + labourUnitPriceCents?: number | null; + matchedKeywords?: string[] | null; +} +``` +### Return Type +Recall that calling the `UpdateQuoteItem` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateQuoteItem` Mutation is of type `UpdateQuoteItemData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateQuoteItemData { + quoteItem_update?: QuoteItem_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateQuoteItem`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateQuoteItemVariables } from '@generated/data-connector-web'; +import { useUpdateQuoteItem } from '@generated/data-connector-web/react' + +export default function UpdateQuoteItemComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateQuoteItem(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateQuoteItem(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuoteItem(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateQuoteItem(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateQuoteItem` Mutation requires an argument of type `UpdateQuoteItemVariables`: + const updateQuoteItemVars: UpdateQuoteItemVariables = { + id: ..., + displayOrder: ..., // optional + name: ..., // optional + quantity: ..., // optional + quantitySourceId: ..., // optional + unitPriceCents: ..., // optional + materialUnitPriceCents: ..., // optional + labourUnitPriceCents: ..., // optional + matchedKeywords: ..., // optional + }; + mutation.mutate(updateQuoteItemVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., displayOrder: ..., name: ..., quantity: ..., quantitySourceId: ..., unitPriceCents: ..., materialUnitPriceCents: ..., labourUnitPriceCents: ..., matchedKeywords: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateQuoteItemVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.quoteItem_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateReminder +You can execute the `CreateReminder` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useCreateReminder(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateReminder(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateReminder` Mutation requires an argument of type `CreateReminderVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateReminderVariables { + id: UUIDString; + ownerId: string; + projectId: UUIDString; + accountId?: UUIDString | null; + name: string; + status: string; + dueAt: TimestampString; +} +``` +### Return Type +Recall that calling the `CreateReminder` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateReminder` Mutation is of type `CreateReminderData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateReminderData { + reminder_insert: Reminder_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `CreateReminder`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateReminderVariables } from '@generated/data-connector-web'; +import { useCreateReminder } from '@generated/data-connector-web/react' + +export default function CreateReminderComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateReminder(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateReminder(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateReminder(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateReminder(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateReminder` Mutation requires an argument of type `CreateReminderVariables`: + const createReminderVars: CreateReminderVariables = { + id: ..., + ownerId: ..., + projectId: ..., + accountId: ..., // optional + name: ..., + status: ..., + dueAt: ..., + }; + mutation.mutate(createReminderVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., ownerId: ..., projectId: ..., accountId: ..., name: ..., status: ..., dueAt: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createReminderVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.reminder_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateReminder +You can execute the `UpdateReminder` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateReminder(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateReminder(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateReminder` Mutation requires an argument of type `UpdateReminderVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateReminderVariables { + id: UUIDString; + accountId?: UUIDString | null; + name?: string | null; + status?: string | null; + dueAt?: TimestampString | null; + completedAt?: TimestampString | null; +} +``` +### Return Type +Recall that calling the `UpdateReminder` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateReminder` Mutation is of type `UpdateReminderData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateReminderData { + reminder_update?: Reminder_Key | null; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpdateReminder`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateReminderVariables } from '@generated/data-connector-web'; +import { useUpdateReminder } from '@generated/data-connector-web/react' + +export default function UpdateReminderComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateReminder(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateReminder(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateReminder(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateReminder(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateReminder` Mutation requires an argument of type `UpdateReminderVariables`: + const updateReminderVars: UpdateReminderVariables = { + id: ..., + accountId: ..., // optional + name: ..., // optional + status: ..., // optional + dueAt: ..., // optional + completedAt: ..., // optional + }; + mutation.mutate(updateReminderVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., accountId: ..., name: ..., status: ..., dueAt: ..., completedAt: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateReminderVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.reminder_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpsertUserSettings +You can execute the `UpsertUserSettings` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [data-connector-web/react/index.d.ts](./index.d.ts)): +```javascript +useUpsertUserSettings(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpsertUserSettings(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpsertUserSettings` Mutation requires an argument of type `UpsertUserSettingsVariables`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpsertUserSettingsVariables { + ownerId: string; + quoteFollowUpEnabled: boolean; + quoteFollowUpDays: number; +} +``` +### Return Type +Recall that calling the `UpsertUserSettings` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. + +To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. + +To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. + +To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpsertUserSettings` Mutation is of type `UpsertUserSettingsData`, which is defined in [data-connector-web/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpsertUserSettingsData { + userSettings_upsert: UserSettings_Key; +} +``` + +To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). + +### Using `UpsertUserSettings`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpsertUserSettingsVariables } from '@generated/data-connector-web'; +import { useUpsertUserSettings } from '@generated/data-connector-web/react' + +export default function UpsertUserSettingsComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpsertUserSettings(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpsertUserSettings(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpsertUserSettings(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpsertUserSettings(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpsertUserSettings` Mutation requires an argument of type `UpsertUserSettingsVariables`: + const upsertUserSettingsVars: UpsertUserSettingsVariables = { + ownerId: ..., + quoteFollowUpEnabled: ..., + quoteFollowUpDays: ..., + }; + mutation.mutate(upsertUserSettingsVars); + // Variables can be defined inline as well. + mutation.mutate({ ownerId: ..., quoteFollowUpEnabled: ..., quoteFollowUpDays: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(upsertUserSettingsVars, options); + + // Then, you can render your component dynamically based on the status of the Mutation. + if (mutation.isPending) { + return
Loading...
; + } + + if (mutation.isError) { + return
Error: {mutation.error.message}
; + } + + // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. + if (mutation.isSuccess) { + console.log(mutation.data.userSettings_upsert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + diff --git a/generated/data-connector-web/react/esm/index.esm.js b/generated/data-connector-web/react/esm/index.esm.js new file mode 100644 index 0000000..b5d4bd1 --- /dev/null +++ b/generated/data-connector-web/react/esm/index.esm.js @@ -0,0 +1,438 @@ +import { createAccountRef, updateAccountRef, deleteAccountContactsRef, deleteAccountRef, createAccountContactRef, updateAccountContactRef, deleteAccountContactRef, listAccountsByOwnerRef, getAccountByIdRef, listAccountContactsByAccountIdRef, getAccountContactByIdRef, createProjectFromUploadRef, updateProjectRef, renameProjectRef, touchProjectRef, deleteFloorplanPagesRef, deleteProjectRef, createFloorplanPageRef, updateFloorplanPageAnalysisRef, updateFloorplanPageRef, updateFloorplanPagesRef, listProjectsByOwnerAndSalesStatusRef, listProjectsByAccountRef, getProjectDetailsByIdRef, getProjectByIdRef, getFloorplanPageByIdRef, createQuestionnaireTemplateRef, createQuestionnaireTemplateQuestionRef, updateQuestionnaireTemplateNameRef, updateQuestionnaireTemplateQuestionRef, deleteQuestionnaireTemplateQuestionRef, deleteQuestionnaireTemplateRef, createProjectQuestionnaireRef, createProjectQuestionnaireAnswerRef, listQuestionnaireTemplatesRef, getQuestionnaireTemplateRef, createQuantitySourceRef, createQuoteItemTemplateRef, updateQuoteItemTemplateRef, deleteQuoteItemTemplateRef, upsertQuoteItemTemplateConfigRef, createSupplierRef, updateSupplierRef, deleteSupplierRef, upsertSupplierQuoteItemPriceRef, deleteSupplierQuoteItemPriceRef, createQuoteRef, updateQuoteRef, deleteQuoteItemsRef, createQuoteItemRef, updateQuoteItemRef, createReminderRef, updateReminderRef, listDueRemindersRef, listProjectRemindersRef, getReminderByIdRef, upsertUserSettingsRef, getUserSettingsRef, connectorConfig } from '../../esm/index.esm.js'; +import { validateArgs, CallerSdkTypeEnum } from 'firebase/data-connect'; +import { useDataConnectQuery, useDataConnectMutation, validateReactArgs } from '@tanstack-query-firebase/react/data-connect'; + +export function useCreateAccount(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createAccountRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateAccount(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateAccountRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteAccountContacts(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteAccountContactsRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteAccount(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteAccountRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateAccountContact(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createAccountContactRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateAccountContact(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateAccountContactRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteAccountContact(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteAccountContactRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useListAccountsByOwner(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listAccountsByOwnerRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetAccountById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getAccountByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useListAccountContactsByAccountId(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listAccountContactsByAccountIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetAccountContactById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getAccountContactByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +export function useCreateProjectFromUpload(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createProjectFromUploadRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateProject(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateProjectRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useRenameProject(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return renameProjectRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useTouchProject(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return touchProjectRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteFloorplanPages(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteFloorplanPagesRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteProject(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteProjectRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateFloorplanPage(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createFloorplanPageRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateFloorplanPageAnalysis(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateFloorplanPageAnalysisRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateFloorplanPage(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateFloorplanPageRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateFloorplanPages(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateFloorplanPagesRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useListProjectsByOwnerAndSalesStatus(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listProjectsByOwnerAndSalesStatusRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useListProjectsByAccount(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listProjectsByAccountRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetProjectDetailsById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getProjectDetailsByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetProjectById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getProjectByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetFloorplanPageById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getFloorplanPageByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +export function useCreateQuestionnaireTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuestionnaireTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateQuestionnaireTemplateQuestion(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuestionnaireTemplateQuestionRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateQuestionnaireTemplateName(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuestionnaireTemplateNameRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateQuestionnaireTemplateQuestion(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuestionnaireTemplateQuestionRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteQuestionnaireTemplateQuestion(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteQuestionnaireTemplateQuestionRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteQuestionnaireTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteQuestionnaireTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateProjectQuestionnaire(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createProjectQuestionnaireRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateProjectQuestionnaireAnswer(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createProjectQuestionnaireAnswerRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useListQuestionnaireTemplates(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listQuestionnaireTemplatesRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetQuestionnaireTemplate(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getQuestionnaireTemplateRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +export function useCreateQuantitySource(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuantitySourceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateQuoteItemTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuoteItemTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateQuoteItemTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuoteItemTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteQuoteItemTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteQuoteItemTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpsertQuoteItemTemplateConfig(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return upsertQuoteItemTemplateConfigRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateSupplier(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createSupplierRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateSupplier(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateSupplierRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteSupplier(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteSupplierRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpsertSupplierQuoteItemPrice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return upsertSupplierQuoteItemPriceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteSupplierQuoteItemPrice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteSupplierQuoteItemPriceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateQuote(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuoteRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateQuote(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuoteRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteQuoteItems(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteQuoteItemsRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateQuoteItem(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuoteItemRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateQuoteItem(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuoteItemRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useCreateReminder(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createReminderRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateReminder(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateReminderRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useListDueReminders(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listDueRemindersRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useListProjectReminders(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listProjectRemindersRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetReminderById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getReminderByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +export function useUpsertUserSettings(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return upsertUserSettingsRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useGetUserSettings(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getUserSettingsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} \ No newline at end of file diff --git a/generated/questionnaires-data-connector-admin/esm/package.json b/generated/data-connector-web/react/esm/package.json similarity index 100% rename from generated/questionnaires-data-connector-admin/esm/package.json rename to generated/data-connector-web/react/esm/package.json diff --git a/generated/data-connector-web/react/index.cjs.js b/generated/data-connector-web/react/index.cjs.js new file mode 100644 index 0000000..3b3baaf --- /dev/null +++ b/generated/data-connector-web/react/index.cjs.js @@ -0,0 +1,438 @@ +const { createAccountRef, updateAccountRef, deleteAccountContactsRef, deleteAccountRef, createAccountContactRef, updateAccountContactRef, deleteAccountContactRef, listAccountsByOwnerRef, getAccountByIdRef, listAccountContactsByAccountIdRef, getAccountContactByIdRef, createProjectFromUploadRef, updateProjectRef, renameProjectRef, touchProjectRef, deleteFloorplanPagesRef, deleteProjectRef, createFloorplanPageRef, updateFloorplanPageAnalysisRef, updateFloorplanPageRef, updateFloorplanPagesRef, listProjectsByOwnerAndSalesStatusRef, listProjectsByAccountRef, getProjectDetailsByIdRef, getProjectByIdRef, getFloorplanPageByIdRef, createQuestionnaireTemplateRef, createQuestionnaireTemplateQuestionRef, updateQuestionnaireTemplateNameRef, updateQuestionnaireTemplateQuestionRef, deleteQuestionnaireTemplateQuestionRef, deleteQuestionnaireTemplateRef, createProjectQuestionnaireRef, createProjectQuestionnaireAnswerRef, listQuestionnaireTemplatesRef, getQuestionnaireTemplateRef, createQuantitySourceRef, createQuoteItemTemplateRef, updateQuoteItemTemplateRef, deleteQuoteItemTemplateRef, upsertQuoteItemTemplateConfigRef, createSupplierRef, updateSupplierRef, deleteSupplierRef, upsertSupplierQuoteItemPriceRef, deleteSupplierQuoteItemPriceRef, createQuoteRef, updateQuoteRef, deleteQuoteItemsRef, createQuoteItemRef, updateQuoteItemRef, createReminderRef, updateReminderRef, listDueRemindersRef, listProjectRemindersRef, getReminderByIdRef, upsertUserSettingsRef, getUserSettingsRef, connectorConfig } = require('../index.cjs.js'); +const { validateArgs, CallerSdkTypeEnum } = require('firebase/data-connect'); +const { useDataConnectQuery, useDataConnectMutation, validateReactArgs } = require('@tanstack-query-firebase/react/data-connect'); + +exports.useCreateAccount = function useCreateAccount(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createAccountRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateAccount = function useUpdateAccount(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateAccountRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteAccountContacts = function useDeleteAccountContacts(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteAccountContactsRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteAccount = function useDeleteAccount(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteAccountRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateAccountContact = function useCreateAccountContact(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createAccountContactRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateAccountContact = function useUpdateAccountContact(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateAccountContactRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteAccountContact = function useDeleteAccountContact(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteAccountContactRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useListAccountsByOwner = function useListAccountsByOwner(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listAccountsByOwnerRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetAccountById = function useGetAccountById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getAccountByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useListAccountContactsByAccountId = function useListAccountContactsByAccountId(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listAccountContactsByAccountIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetAccountContactById = function useGetAccountContactById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getAccountContactByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +exports.useCreateProjectFromUpload = function useCreateProjectFromUpload(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createProjectFromUploadRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateProject = function useUpdateProject(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateProjectRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useRenameProject = function useRenameProject(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return renameProjectRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useTouchProject = function useTouchProject(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return touchProjectRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteFloorplanPages = function useDeleteFloorplanPages(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteFloorplanPagesRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteProject = function useDeleteProject(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteProjectRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateFloorplanPage = function useCreateFloorplanPage(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createFloorplanPageRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateFloorplanPageAnalysis = function useUpdateFloorplanPageAnalysis(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateFloorplanPageAnalysisRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateFloorplanPage = function useUpdateFloorplanPage(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateFloorplanPageRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateFloorplanPages = function useUpdateFloorplanPages(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateFloorplanPagesRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useListProjectsByOwnerAndSalesStatus = function useListProjectsByOwnerAndSalesStatus(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listProjectsByOwnerAndSalesStatusRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useListProjectsByAccount = function useListProjectsByAccount(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listProjectsByAccountRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetProjectDetailsById = function useGetProjectDetailsById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getProjectDetailsByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetProjectById = function useGetProjectById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getProjectByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetFloorplanPageById = function useGetFloorplanPageById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getFloorplanPageByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +exports.useCreateQuestionnaireTemplate = function useCreateQuestionnaireTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuestionnaireTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateQuestionnaireTemplateQuestion = function useCreateQuestionnaireTemplateQuestion(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuestionnaireTemplateQuestionRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateQuestionnaireTemplateName = function useUpdateQuestionnaireTemplateName(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuestionnaireTemplateNameRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateQuestionnaireTemplateQuestion = function useUpdateQuestionnaireTemplateQuestion(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuestionnaireTemplateQuestionRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteQuestionnaireTemplateQuestion = function useDeleteQuestionnaireTemplateQuestion(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteQuestionnaireTemplateQuestionRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteQuestionnaireTemplate = function useDeleteQuestionnaireTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteQuestionnaireTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateProjectQuestionnaire = function useCreateProjectQuestionnaire(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createProjectQuestionnaireRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateProjectQuestionnaireAnswer = function useCreateProjectQuestionnaireAnswer(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createProjectQuestionnaireAnswerRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useListQuestionnaireTemplates = function useListQuestionnaireTemplates(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listQuestionnaireTemplatesRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetQuestionnaireTemplate = function useGetQuestionnaireTemplate(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getQuestionnaireTemplateRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +exports.useCreateQuantitySource = function useCreateQuantitySource(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuantitySourceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateQuoteItemTemplate = function useCreateQuoteItemTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuoteItemTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateQuoteItemTemplate = function useUpdateQuoteItemTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuoteItemTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteQuoteItemTemplate = function useDeleteQuoteItemTemplate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteQuoteItemTemplateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpsertQuoteItemTemplateConfig = function useUpsertQuoteItemTemplateConfig(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return upsertQuoteItemTemplateConfigRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateSupplier = function useCreateSupplier(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createSupplierRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateSupplier = function useUpdateSupplier(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateSupplierRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteSupplier = function useDeleteSupplier(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteSupplierRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpsertSupplierQuoteItemPrice = function useUpsertSupplierQuoteItemPrice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return upsertSupplierQuoteItemPriceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteSupplierQuoteItemPrice = function useDeleteSupplierQuoteItemPrice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteSupplierQuoteItemPriceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateQuote = function useCreateQuote(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuoteRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateQuote = function useUpdateQuote(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuoteRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteQuoteItems = function useDeleteQuoteItems(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteQuoteItemsRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateQuoteItem = function useCreateQuoteItem(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createQuoteItemRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateQuoteItem = function useUpdateQuoteItem(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateQuoteItemRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useCreateReminder = function useCreateReminder(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createReminderRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateReminder = function useUpdateReminder(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateReminderRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useListDueReminders = function useListDueReminders(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listDueRemindersRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useListProjectReminders = function useListProjectReminders(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = listProjectRemindersRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetReminderById = function useGetReminderById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getReminderByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +exports.useUpsertUserSettings = function useUpsertUserSettings(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return upsertUserSettingsRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useGetUserSettings = function useGetUserSettings(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getUserSettingsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} \ No newline at end of file diff --git a/generated/data-connector-web/react/index.d.ts b/generated/data-connector-web/react/index.d.ts new file mode 100644 index 0000000..226c545 --- /dev/null +++ b/generated/data-connector-web/react/index.d.ts @@ -0,0 +1,180 @@ +import { CreateAccountData, CreateAccountVariables, UpdateAccountData, UpdateAccountVariables, DeleteAccountContactsData, DeleteAccountContactsVariables, DeleteAccountData, DeleteAccountVariables, CreateAccountContactData, CreateAccountContactVariables, UpdateAccountContactData, UpdateAccountContactVariables, DeleteAccountContactData, DeleteAccountContactVariables, ListAccountsByOwnerData, ListAccountsByOwnerVariables, GetAccountByIdData, GetAccountByIdVariables, ListAccountContactsByAccountIdData, ListAccountContactsByAccountIdVariables, GetAccountContactByIdData, GetAccountContactByIdVariables, CreateProjectFromUploadData, CreateProjectFromUploadVariables, UpdateProjectData, UpdateProjectVariables, RenameProjectData, RenameProjectVariables, TouchProjectData, TouchProjectVariables, DeleteFloorplanPagesData, DeleteFloorplanPagesVariables, DeleteProjectData, DeleteProjectVariables, CreateFloorplanPageData, CreateFloorplanPageVariables, UpdateFloorplanPageAnalysisData, UpdateFloorplanPageAnalysisVariables, UpdateFloorplanPageData, UpdateFloorplanPageVariables, UpdateFloorplanPagesData, UpdateFloorplanPagesVariables, ListProjectsByOwnerAndSalesStatusData, ListProjectsByOwnerAndSalesStatusVariables, ListProjectsByAccountData, ListProjectsByAccountVariables, GetProjectDetailsByIdData, GetProjectDetailsByIdVariables, GetProjectByIdData, GetProjectByIdVariables, GetFloorplanPageByIdData, GetFloorplanPageByIdVariables, CreateQuestionnaireTemplateData, CreateQuestionnaireTemplateVariables, CreateQuestionnaireTemplateQuestionData, CreateQuestionnaireTemplateQuestionVariables, UpdateQuestionnaireTemplateNameData, UpdateQuestionnaireTemplateNameVariables, UpdateQuestionnaireTemplateQuestionData, UpdateQuestionnaireTemplateQuestionVariables, DeleteQuestionnaireTemplateQuestionData, DeleteQuestionnaireTemplateQuestionVariables, DeleteQuestionnaireTemplateData, DeleteQuestionnaireTemplateVariables, CreateProjectQuestionnaireData, CreateProjectQuestionnaireVariables, CreateProjectQuestionnaireAnswerData, CreateProjectQuestionnaireAnswerVariables, ListQuestionnaireTemplatesData, GetQuestionnaireTemplateData, GetQuestionnaireTemplateVariables, CreateQuantitySourceData, CreateQuantitySourceVariables, CreateQuoteItemTemplateData, CreateQuoteItemTemplateVariables, UpdateQuoteItemTemplateData, UpdateQuoteItemTemplateVariables, DeleteQuoteItemTemplateData, DeleteQuoteItemTemplateVariables, UpsertQuoteItemTemplateConfigData, UpsertQuoteItemTemplateConfigVariables, CreateSupplierData, CreateSupplierVariables, UpdateSupplierData, UpdateSupplierVariables, DeleteSupplierData, DeleteSupplierVariables, UpsertSupplierQuoteItemPriceData, UpsertSupplierQuoteItemPriceVariables, DeleteSupplierQuoteItemPriceData, DeleteSupplierQuoteItemPriceVariables, CreateQuoteData, CreateQuoteVariables, UpdateQuoteData, UpdateQuoteVariables, DeleteQuoteItemsData, DeleteQuoteItemsVariables, CreateQuoteItemData, CreateQuoteItemVariables, UpdateQuoteItemData, UpdateQuoteItemVariables, CreateReminderData, CreateReminderVariables, UpdateReminderData, UpdateReminderVariables, ListDueRemindersData, ListDueRemindersVariables, ListProjectRemindersData, ListProjectRemindersVariables, GetReminderByIdData, GetReminderByIdVariables, UpsertUserSettingsData, UpsertUserSettingsVariables, GetUserSettingsData, GetUserSettingsVariables } from '../'; +import { UseDataConnectQueryResult, useDataConnectQueryOptions, UseDataConnectMutationResult, useDataConnectMutationOptions} from '@tanstack-query-firebase/react/data-connect'; +import { UseQueryResult, UseMutationResult} from '@tanstack/react-query'; +import { DataConnect } from 'firebase/data-connect'; +import { FirebaseError } from 'firebase/app'; + + +export function useCreateAccount(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateAccount(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateAccount(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateAccount(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteAccountContacts(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteAccountContacts(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteAccount(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteAccount(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateAccountContact(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateAccountContact(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateAccountContact(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateAccountContact(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteAccountContact(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteAccountContact(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useListAccountsByOwner(vars: ListAccountsByOwnerVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListAccountsByOwner(dc: DataConnect, vars: ListAccountsByOwnerVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetAccountById(vars: GetAccountByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetAccountById(dc: DataConnect, vars: GetAccountByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useListAccountContactsByAccountId(vars: ListAccountContactsByAccountIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListAccountContactsByAccountId(dc: DataConnect, vars: ListAccountContactsByAccountIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetAccountContactById(vars: GetAccountContactByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetAccountContactById(dc: DataConnect, vars: GetAccountContactByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useCreateProjectFromUpload(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateProjectFromUpload(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateProject(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateProject(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useRenameProject(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useRenameProject(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useTouchProject(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useTouchProject(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteFloorplanPages(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteFloorplanPages(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteProject(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteProject(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateFloorplanPage(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateFloorplanPage(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateFloorplanPageAnalysis(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateFloorplanPageAnalysis(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateFloorplanPage(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateFloorplanPage(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateFloorplanPages(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateFloorplanPages(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useListProjectsByOwnerAndSalesStatus(vars: ListProjectsByOwnerAndSalesStatusVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListProjectsByOwnerAndSalesStatus(dc: DataConnect, vars: ListProjectsByOwnerAndSalesStatusVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useListProjectsByAccount(vars: ListProjectsByAccountVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListProjectsByAccount(dc: DataConnect, vars: ListProjectsByAccountVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetProjectDetailsById(vars: GetProjectDetailsByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetProjectDetailsById(dc: DataConnect, vars: GetProjectDetailsByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetProjectById(vars: GetProjectByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetProjectById(dc: DataConnect, vars: GetProjectByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetFloorplanPageById(vars: GetFloorplanPageByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetFloorplanPageById(dc: DataConnect, vars: GetFloorplanPageByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useCreateQuestionnaireTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateQuestionnaireTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateQuestionnaireTemplateName(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateQuestionnaireTemplateName(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteQuestionnaireTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteQuestionnaireTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateProjectQuestionnaire(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateProjectQuestionnaire(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateProjectQuestionnaireAnswer(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateProjectQuestionnaireAnswer(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useListQuestionnaireTemplates(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListQuestionnaireTemplates(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useCreateQuantitySource(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateQuantitySource(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateQuoteItemTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateQuoteItemTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateQuoteItemTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateQuoteItemTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteQuoteItemTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteQuoteItemTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpsertQuoteItemTemplateConfig(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpsertQuoteItemTemplateConfig(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateSupplier(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateSupplier(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateSupplier(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateSupplier(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteSupplier(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteSupplier(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpsertSupplierQuoteItemPrice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpsertSupplierQuoteItemPrice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteSupplierQuoteItemPrice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteSupplierQuoteItemPrice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateQuote(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateQuote(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateQuote(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateQuote(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteQuoteItems(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteQuoteItems(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateQuoteItem(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateQuoteItem(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateQuoteItem(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateQuoteItem(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useCreateReminder(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateReminder(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateReminder(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateReminder(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useListDueReminders(vars: ListDueRemindersVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListDueReminders(dc: DataConnect, vars: ListDueRemindersVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useListProjectReminders(vars: ListProjectRemindersVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListProjectReminders(dc: DataConnect, vars: ListProjectRemindersVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetReminderById(vars: GetReminderByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetReminderById(dc: DataConnect, vars: GetReminderByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useUpsertUserSettings(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpsertUserSettings(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useGetUserSettings(vars: GetUserSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetUserSettings(dc: DataConnect, vars: GetUserSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; diff --git a/generated/questionnaires-data-connector-web/react/package.json b/generated/data-connector-web/react/package.json similarity index 76% rename from generated/questionnaires-data-connector-web/react/package.json rename to generated/data-connector-web/react/package.json index e162d2f..e616870 100644 --- a/generated/questionnaires-data-connector-web/react/package.json +++ b/generated/data-connector-web/react/package.json @@ -1,8 +1,8 @@ { - "name": "@generated/questionnaires-data-connector-web-react", + "name": "@generated/data-connector-web-react", "version": "1.0.0", "author": "Firebase (https://firebase.google.com/)", - "description": "Generated SDK For questionnaires", + "description": "Generated SDK For data-connector", "license": "Apache-2.0", "engines": { "node": " >=18.0" diff --git a/generated/questionnaires-data-connector-admin/esm/index.esm.js b/generated/questionnaires-data-connector-admin/esm/index.esm.js deleted file mode 100644 index c590d5c..0000000 --- a/generated/questionnaires-data-connector-admin/esm/index.esm.js +++ /dev/null @@ -1,68 +0,0 @@ -import { validateAdminArgs } from 'firebase-admin/data-connect'; - -export const connectorConfig = { - connector: 'questionnaires', - serviceId: 'plaster-calculator', - location: 'us-west1' -}; - -export function createQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateQuestionnaireTemplate', inputVars, inputOpts); -} - -export function createQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateQuestionnaireTemplateQuestion', inputVars, inputOpts); -} - -export function updateQuestionnaireTemplateName(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateQuestionnaireTemplateName', inputVars, inputOpts); -} - -export function updateQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateQuestionnaireTemplateQuestion', inputVars, inputOpts); -} - -export function deleteQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteQuestionnaireTemplateQuestion', inputVars, inputOpts); -} - -export function deleteQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteQuestionnaireTemplate', inputVars, inputOpts); -} - -export function createProjectQuestionnaire(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateProjectQuestionnaire', inputVars, inputOpts); -} - -export function createProjectQuestionnaireAnswer(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateProjectQuestionnaireAnswer', inputVars, inputOpts); -} - -export function listQuestionnaireTemplates(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrOptions, options, undefined); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListQuestionnaireTemplates', undefined, inputOpts); -} - -export function getQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('GetQuestionnaireTemplate', inputVars, inputOpts); -} - diff --git a/generated/questionnaires-data-connector-admin/index.cjs.js b/generated/questionnaires-data-connector-admin/index.cjs.js deleted file mode 100644 index a635278..0000000 --- a/generated/questionnaires-data-connector-admin/index.cjs.js +++ /dev/null @@ -1,79 +0,0 @@ -const { validateAdminArgs } = require('firebase-admin/data-connect'); - -const connectorConfig = { - connector: 'questionnaires', - serviceId: 'plaster-calculator', - location: 'us-west1' -}; -exports.connectorConfig = connectorConfig; - -function createQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateQuestionnaireTemplate', inputVars, inputOpts); -} -exports.createQuestionnaireTemplate = createQuestionnaireTemplate; - -function createQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateQuestionnaireTemplateQuestion', inputVars, inputOpts); -} -exports.createQuestionnaireTemplateQuestion = createQuestionnaireTemplateQuestion; - -function updateQuestionnaireTemplateName(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateQuestionnaireTemplateName', inputVars, inputOpts); -} -exports.updateQuestionnaireTemplateName = updateQuestionnaireTemplateName; - -function updateQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('UpdateQuestionnaireTemplateQuestion', inputVars, inputOpts); -} -exports.updateQuestionnaireTemplateQuestion = updateQuestionnaireTemplateQuestion; - -function deleteQuestionnaireTemplateQuestion(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteQuestionnaireTemplateQuestion', inputVars, inputOpts); -} -exports.deleteQuestionnaireTemplateQuestion = deleteQuestionnaireTemplateQuestion; - -function deleteQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('DeleteQuestionnaireTemplate', inputVars, inputOpts); -} -exports.deleteQuestionnaireTemplate = deleteQuestionnaireTemplate; - -function createProjectQuestionnaire(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateProjectQuestionnaire', inputVars, inputOpts); -} -exports.createProjectQuestionnaire = createProjectQuestionnaire; - -function createProjectQuestionnaireAnswer(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeMutation('CreateProjectQuestionnaireAnswer', inputVars, inputOpts); -} -exports.createProjectQuestionnaireAnswer = createProjectQuestionnaireAnswer; - -function listQuestionnaireTemplates(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrOptions, options, undefined); - dcInstance.useGen(true); - return dcInstance.executeQuery('ListQuestionnaireTemplates', undefined, inputOpts); -} -exports.listQuestionnaireTemplates = listQuestionnaireTemplates; - -function getQuestionnaireTemplate(dcOrVarsOrOptions, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts} = validateAdminArgs(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, true, true); - dcInstance.useGen(true); - return dcInstance.executeQuery('GetQuestionnaireTemplate', inputVars, inputOpts); -} -exports.getQuestionnaireTemplate = getQuestionnaireTemplate; - diff --git a/generated/questionnaires-data-connector-admin/index.d.ts b/generated/questionnaires-data-connector-admin/index.d.ts deleted file mode 100644 index 4d45183..0000000 --- a/generated/questionnaires-data-connector-admin/index.d.ts +++ /dev/null @@ -1,258 +0,0 @@ -import { ConnectorConfig, DataConnect, OperationOptions, ExecuteOperationResponse } from 'firebase-admin/data-connect'; - -export const connectorConfig: ConnectorConfig; - -export type TimestampString = string; -export type UUIDString = string; -export type Int64String = string; -export type DateString = string; - - -export interface AccountContact_Key { - id: UUIDString; - __typename?: 'AccountContact_Key'; -} - -export interface Account_Key { - id: UUIDString; - __typename?: 'Account_Key'; -} - -export interface CreateProjectQuestionnaireAnswerData { - projectQuestionnaireAnswer_insert: ProjectQuestionnaireAnswer_Key; -} - -export interface CreateProjectQuestionnaireAnswerVariables { - id: UUIDString; - projectQuestionnaireId: UUIDString; - questionId: UUIDString; - position: number; - answer?: string | null; -} - -export interface CreateProjectQuestionnaireData { - projectQuestionnaire_insert: ProjectQuestionnaire_Key; -} - -export interface CreateProjectQuestionnaireVariables { - id: UUIDString; - projectId: UUIDString; - sourceTemplateId?: UUIDString | null; -} - -export interface CreateQuestionnaireTemplateData { - questionnaireTemplate_insert: QuestionnaireTemplate_Key; -} - -export interface CreateQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_insert: QuestionnaireTemplateQuestion_Key; -} - -export interface CreateQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; - label: string; - position: number; - description?: string | null; -} - -export interface CreateQuestionnaireTemplateVariables { - id: UUIDString; - name: string; -} - -export interface DeleteQuestionnaireTemplateData { - questionnaireTemplateQuestion_deleteMany: number; - questionnaireTemplate_delete?: QuestionnaireTemplate_Key | null; -} - -export interface DeleteQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_delete?: QuestionnaireTemplateQuestion_Key | null; -} - -export interface DeleteQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; -} - -export interface DeleteQuestionnaireTemplateVariables { - id: UUIDString; -} - -export interface FloorplanPage_Key { - id: UUIDString; - __typename?: 'FloorplanPage_Key'; -} - -export interface GetQuestionnaireTemplateData { - questionnaireTemplate?: { - id: UUIDString; - ownerId: string; - name: string; - createdAt: TimestampString; - updatedAt: TimestampString; - questions: ({ - id: UUIDString; - label: string; - description?: string | null; - position: number; - } & QuestionnaireTemplateQuestion_Key)[]; - } & QuestionnaireTemplate_Key; -} - -export interface GetQuestionnaireTemplateVariables { - id: UUIDString; -} - -export interface ListQuestionnaireTemplatesData { - questionnaireTemplates: ({ - id: UUIDString; - name: string; - createdAt: TimestampString; - updatedAt: TimestampString; - } & QuestionnaireTemplate_Key)[]; -} - -export interface ProjectQuestionnaireAnswer_Key { - id: UUIDString; - __typename?: 'ProjectQuestionnaireAnswer_Key'; -} - -export interface ProjectQuestionnaire_Key { - id: UUIDString; - __typename?: 'ProjectQuestionnaire_Key'; -} - -export interface Project_Key { - id: UUIDString; - __typename?: 'Project_Key'; -} - -export interface QuantitySource_Key { - id: UUIDString; - __typename?: 'QuantitySource_Key'; -} - -export interface QuestionnaireTemplateQuestion_Key { - id: UUIDString; - __typename?: 'QuestionnaireTemplateQuestion_Key'; -} - -export interface QuestionnaireTemplate_Key { - id: UUIDString; - __typename?: 'QuestionnaireTemplate_Key'; -} - -export interface QuoteItemTemplateConfig_Key { - ownerId: string; - templateId: UUIDString; - __typename?: 'QuoteItemTemplateConfig_Key'; -} - -export interface QuoteItemTemplate_Key { - id: UUIDString; - __typename?: 'QuoteItemTemplate_Key'; -} - -export interface QuoteItem_Key { - id: UUIDString; - __typename?: 'QuoteItem_Key'; -} - -export interface Quote_Key { - id: UUIDString; - __typename?: 'Quote_Key'; -} - -export interface Reminder_Key { - id: UUIDString; - __typename?: 'Reminder_Key'; -} - -export interface SupplierQuoteItemPrice_Key { - supplierId: UUIDString; - templateId: UUIDString; - __typename?: 'SupplierQuoteItemPrice_Key'; -} - -export interface Supplier_Key { - id: UUIDString; - __typename?: 'Supplier_Key'; -} - -export interface UpdateQuestionnaireTemplateNameData { - questionnaireTemplate_update?: QuestionnaireTemplate_Key | null; -} - -export interface UpdateQuestionnaireTemplateNameVariables { - id: UUIDString; - name: string; -} - -export interface UpdateQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_update?: QuestionnaireTemplateQuestion_Key | null; -} - -export interface UpdateQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; - label: string; - position: number; - description?: string | null; -} - -export interface UserSettings_Key { - ownerId: string; - __typename?: 'UserSettings_Key'; -} - -/** Generated Node Admin SDK operation action function for the 'CreateQuestionnaireTemplate' Mutation. Allow users to execute without passing in DataConnect. */ -export function createQuestionnaireTemplate(dc: DataConnect, vars: CreateQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'CreateQuestionnaireTemplate' Mutation. Allow users to pass in custom DataConnect instances. */ -export function createQuestionnaireTemplate(vars: CreateQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'CreateQuestionnaireTemplateQuestion' Mutation. Allow users to execute without passing in DataConnect. */ -export function createQuestionnaireTemplateQuestion(dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'CreateQuestionnaireTemplateQuestion' Mutation. Allow users to pass in custom DataConnect instances. */ -export function createQuestionnaireTemplateQuestion(vars: CreateQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'UpdateQuestionnaireTemplateName' Mutation. Allow users to execute without passing in DataConnect. */ -export function updateQuestionnaireTemplateName(dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'UpdateQuestionnaireTemplateName' Mutation. Allow users to pass in custom DataConnect instances. */ -export function updateQuestionnaireTemplateName(vars: UpdateQuestionnaireTemplateNameVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'UpdateQuestionnaireTemplateQuestion' Mutation. Allow users to execute without passing in DataConnect. */ -export function updateQuestionnaireTemplateQuestion(dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'UpdateQuestionnaireTemplateQuestion' Mutation. Allow users to pass in custom DataConnect instances. */ -export function updateQuestionnaireTemplateQuestion(vars: UpdateQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'DeleteQuestionnaireTemplateQuestion' Mutation. Allow users to execute without passing in DataConnect. */ -export function deleteQuestionnaireTemplateQuestion(dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'DeleteQuestionnaireTemplateQuestion' Mutation. Allow users to pass in custom DataConnect instances. */ -export function deleteQuestionnaireTemplateQuestion(vars: DeleteQuestionnaireTemplateQuestionVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'DeleteQuestionnaireTemplate' Mutation. Allow users to execute without passing in DataConnect. */ -export function deleteQuestionnaireTemplate(dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'DeleteQuestionnaireTemplate' Mutation. Allow users to pass in custom DataConnect instances. */ -export function deleteQuestionnaireTemplate(vars: DeleteQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'CreateProjectQuestionnaire' Mutation. Allow users to execute without passing in DataConnect. */ -export function createProjectQuestionnaire(dc: DataConnect, vars: CreateProjectQuestionnaireVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'CreateProjectQuestionnaire' Mutation. Allow users to pass in custom DataConnect instances. */ -export function createProjectQuestionnaire(vars: CreateProjectQuestionnaireVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'CreateProjectQuestionnaireAnswer' Mutation. Allow users to execute without passing in DataConnect. */ -export function createProjectQuestionnaireAnswer(dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'CreateProjectQuestionnaireAnswer' Mutation. Allow users to pass in custom DataConnect instances. */ -export function createProjectQuestionnaireAnswer(vars: CreateProjectQuestionnaireAnswerVariables, options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'ListQuestionnaireTemplates' Query. Allow users to execute without passing in DataConnect. */ -export function listQuestionnaireTemplates(dc: DataConnect, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'ListQuestionnaireTemplates' Query. Allow users to pass in custom DataConnect instances. */ -export function listQuestionnaireTemplates(options?: OperationOptions): Promise>; - -/** Generated Node Admin SDK operation action function for the 'GetQuestionnaireTemplate' Query. Allow users to execute without passing in DataConnect. */ -export function getQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; -/** Generated Node Admin SDK operation action function for the 'GetQuestionnaireTemplate' Query. Allow users to pass in custom DataConnect instances. */ -export function getQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: OperationOptions): Promise>; - diff --git a/generated/questionnaires-data-connector-admin/package.json b/generated/questionnaires-data-connector-admin/package.json deleted file mode 100644 index 6e82d6d..0000000 --- a/generated/questionnaires-data-connector-admin/package.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "name": "@generated/questionnaires-data-connector-admin", - "version": "0.0.1", - "author": "Firebase (https://firebase.google.com/)", - "description": "Generated Admin SDK For questionnaires", - "license": "Apache-2.0", - "engines": { - "node": " >=18.0" - }, - "typings": "index.d.ts", - "module": "esm/index.esm.js", - "main": "index.cjs.js", - "browser": "esm/index.esm.js", - "exports": { - ".": { - "types": "./index.d.ts", - "require": "./index.cjs.js", - "default": "./esm/index.esm.js" - }, - "./package.json": "./package.json" - }, - "peerDependencies": { - "firebase-admin": "^13.4.0" - } -} \ No newline at end of file diff --git a/generated/questionnaires-data-connector-web/.guides/usage.md b/generated/questionnaires-data-connector-web/.guides/usage.md deleted file mode 100644 index 660a180..0000000 --- a/generated/questionnaires-data-connector-web/.guides/usage.md +++ /dev/null @@ -1,109 +0,0 @@ -# Basic Usage - -Always prioritize using a supported framework over using the generated SDK -directly. Supported frameworks simplify the developer experience and help ensure -best practices are followed. - - - - -### React -For each operation, there is a wrapper hook that can be used to call the operation. - -Here are all of the hooks that get generated: -```ts -import { useCreateQuestionnaireTemplate, useCreateQuestionnaireTemplateQuestion, useUpdateQuestionnaireTemplateName, useUpdateQuestionnaireTemplateQuestion, useDeleteQuestionnaireTemplateQuestion, useDeleteQuestionnaireTemplate, useCreateProjectQuestionnaire, useCreateProjectQuestionnaireAnswer, useListQuestionnaireTemplates, useGetQuestionnaireTemplate } from '@generated/questionnaires-data-connector-web/react'; -// The types of these hooks are available in react/index.d.ts - -const { data, isPending, isSuccess, isError, error } = useCreateQuestionnaireTemplate(createQuestionnaireTemplateVars); - -const { data, isPending, isSuccess, isError, error } = useCreateQuestionnaireTemplateQuestion(createQuestionnaireTemplateQuestionVars); - -const { data, isPending, isSuccess, isError, error } = useUpdateQuestionnaireTemplateName(updateQuestionnaireTemplateNameVars); - -const { data, isPending, isSuccess, isError, error } = useUpdateQuestionnaireTemplateQuestion(updateQuestionnaireTemplateQuestionVars); - -const { data, isPending, isSuccess, isError, error } = useDeleteQuestionnaireTemplateQuestion(deleteQuestionnaireTemplateQuestionVars); - -const { data, isPending, isSuccess, isError, error } = useDeleteQuestionnaireTemplate(deleteQuestionnaireTemplateVars); - -const { data, isPending, isSuccess, isError, error } = useCreateProjectQuestionnaire(createProjectQuestionnaireVars); - -const { data, isPending, isSuccess, isError, error } = useCreateProjectQuestionnaireAnswer(createProjectQuestionnaireAnswerVars); - -const { data, isPending, isSuccess, isError, error } = useListQuestionnaireTemplates(); - -const { data, isPending, isSuccess, isError, error } = useGetQuestionnaireTemplate(getQuestionnaireTemplateVars); - -``` - -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 { createQuestionnaireTemplate, createQuestionnaireTemplateQuestion, updateQuestionnaireTemplateName, updateQuestionnaireTemplateQuestion, deleteQuestionnaireTemplateQuestion, deleteQuestionnaireTemplate, createProjectQuestionnaire, createProjectQuestionnaireAnswer, listQuestionnaireTemplates, getQuestionnaireTemplate } from '@generated/questionnaires-data-connector-web'; - - -// Operation CreateQuestionnaireTemplate: For variables, look at type CreateQuestionnaireTemplateVars in ../index.d.ts -const { data } = await CreateQuestionnaireTemplate(dataConnect, createQuestionnaireTemplateVars); - -// Operation CreateQuestionnaireTemplateQuestion: For variables, look at type CreateQuestionnaireTemplateQuestionVars in ../index.d.ts -const { data } = await CreateQuestionnaireTemplateQuestion(dataConnect, createQuestionnaireTemplateQuestionVars); - -// Operation UpdateQuestionnaireTemplateName: For variables, look at type UpdateQuestionnaireTemplateNameVars in ../index.d.ts -const { data } = await UpdateQuestionnaireTemplateName(dataConnect, updateQuestionnaireTemplateNameVars); - -// Operation UpdateQuestionnaireTemplateQuestion: For variables, look at type UpdateQuestionnaireTemplateQuestionVars in ../index.d.ts -const { data } = await UpdateQuestionnaireTemplateQuestion(dataConnect, updateQuestionnaireTemplateQuestionVars); - -// Operation DeleteQuestionnaireTemplateQuestion: For variables, look at type DeleteQuestionnaireTemplateQuestionVars in ../index.d.ts -const { data } = await DeleteQuestionnaireTemplateQuestion(dataConnect, deleteQuestionnaireTemplateQuestionVars); - -// Operation DeleteQuestionnaireTemplate: For variables, look at type DeleteQuestionnaireTemplateVars in ../index.d.ts -const { data } = await DeleteQuestionnaireTemplate(dataConnect, deleteQuestionnaireTemplateVars); - -// Operation CreateProjectQuestionnaire: For variables, look at type CreateProjectQuestionnaireVars in ../index.d.ts -const { data } = await CreateProjectQuestionnaire(dataConnect, createProjectQuestionnaireVars); - -// Operation CreateProjectQuestionnaireAnswer: For variables, look at type CreateProjectQuestionnaireAnswerVars in ../index.d.ts -const { data } = await CreateProjectQuestionnaireAnswer(dataConnect, createProjectQuestionnaireAnswerVars); - -// Operation ListQuestionnaireTemplates: -const { data } = await ListQuestionnaireTemplates(dataConnect); - -// Operation GetQuestionnaireTemplate: For variables, look at type GetQuestionnaireTemplateVars in ../index.d.ts -const { data } = await GetQuestionnaireTemplate(dataConnect, getQuestionnaireTemplateVars); - - -``` \ No newline at end of file diff --git a/generated/questionnaires-data-connector-web/README.md b/generated/questionnaires-data-connector-web/README.md deleted file mode 100644 index 7af676d..0000000 --- a/generated/questionnaires-data-connector-web/README.md +++ /dev/null @@ -1,1229 +0,0 @@ -# Generated TypeScript README -This README will guide you through the process of using the generated JavaScript SDK package for the connector `questionnaires`. 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 [`questionnaires-data-connector-web/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) - - [*ListQuestionnaireTemplates*](#listquestionnairetemplates) - - [*GetQuestionnaireTemplate*](#getquestionnairetemplate) -- [**Mutations**](#mutations) - - [*CreateQuestionnaireTemplate*](#createquestionnairetemplate) - - [*CreateQuestionnaireTemplateQuestion*](#createquestionnairetemplatequestion) - - [*UpdateQuestionnaireTemplateName*](#updatequestionnairetemplatename) - - [*UpdateQuestionnaireTemplateQuestion*](#updatequestionnairetemplatequestion) - - [*DeleteQuestionnaireTemplateQuestion*](#deletequestionnairetemplatequestion) - - [*DeleteQuestionnaireTemplate*](#deletequestionnairetemplate) - - [*CreateProjectQuestionnaire*](#createprojectquestionnaire) - - [*CreateProjectQuestionnaireAnswer*](#createprojectquestionnaireanswer) - -# 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 `questionnaires`. 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 `@generated/questionnaires-data-connector-web` 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 '@generated/questionnaires-data-connector-web'; - -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 '@generated/questionnaires-data-connector-web'; - -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 `questionnaires` 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). - -## ListQuestionnaireTemplates -You can execute the `ListQuestionnaireTemplates` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -listQuestionnaireTemplates(options?: ExecuteQueryOptions): QueryPromise; - -interface ListQuestionnaireTemplatesRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; -} -export const listQuestionnaireTemplatesRef: ListQuestionnaireTemplatesRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -listQuestionnaireTemplates(dc: DataConnect, options?: ExecuteQueryOptions): QueryPromise; - -interface ListQuestionnaireTemplatesRef { - ... - (dc: DataConnect): QueryRef; -} -export const listQuestionnaireTemplatesRef: ListQuestionnaireTemplatesRef; -``` - -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 listQuestionnaireTemplatesRef: -```typescript -const name = listQuestionnaireTemplatesRef.operationName; -console.log(name); -``` - -### Variables -The `ListQuestionnaireTemplates` query has no variables. -### Return Type -Recall that executing the `ListQuestionnaireTemplates` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `ListQuestionnaireTemplatesData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface ListQuestionnaireTemplatesData { - questionnaireTemplates: ({ - id: UUIDString; - name: string; - createdAt: TimestampString; - updatedAt: TimestampString; - } & QuestionnaireTemplate_Key)[]; -} -``` -### Using `ListQuestionnaireTemplates`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, listQuestionnaireTemplates } from '@generated/questionnaires-data-connector-web'; - - -// Call the `listQuestionnaireTemplates()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await listQuestionnaireTemplates(); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await listQuestionnaireTemplates(dataConnect); - -console.log(data.questionnaireTemplates); - -// Or, you can use the `Promise` API. -listQuestionnaireTemplates().then((response) => { - const data = response.data; - console.log(data.questionnaireTemplates); -}); -``` - -### Using `ListQuestionnaireTemplates`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, listQuestionnaireTemplatesRef } from '@generated/questionnaires-data-connector-web'; - - -// Call the `listQuestionnaireTemplatesRef()` function to get a reference to the query. -const ref = listQuestionnaireTemplatesRef(); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = listQuestionnaireTemplatesRef(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.questionnaireTemplates); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplates); -}); -``` - -## GetQuestionnaireTemplate -You can execute the `GetQuestionnaireTemplate` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -getQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: ExecuteQueryOptions): QueryPromise; - -interface GetQuestionnaireTemplateRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: GetQuestionnaireTemplateVariables): QueryRef; -} -export const getQuestionnaireTemplateRef: GetQuestionnaireTemplateRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -getQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: ExecuteQueryOptions): QueryPromise; - -interface GetQuestionnaireTemplateRef { - ... - (dc: DataConnect, vars: GetQuestionnaireTemplateVariables): QueryRef; -} -export const getQuestionnaireTemplateRef: GetQuestionnaireTemplateRef; -``` - -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 getQuestionnaireTemplateRef: -```typescript -const name = getQuestionnaireTemplateRef.operationName; -console.log(name); -``` - -### Variables -The `GetQuestionnaireTemplate` query requires an argument of type `GetQuestionnaireTemplateVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface GetQuestionnaireTemplateVariables { - id: UUIDString; -} -``` -### Return Type -Recall that executing the `GetQuestionnaireTemplate` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `GetQuestionnaireTemplateData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface GetQuestionnaireTemplateData { - questionnaireTemplate?: { - id: UUIDString; - ownerId: string; - name: string; - createdAt: TimestampString; - updatedAt: TimestampString; - questions: ({ - id: UUIDString; - label: string; - description?: string | null; - position: number; - } & QuestionnaireTemplateQuestion_Key)[]; - } & QuestionnaireTemplate_Key; -} -``` -### Using `GetQuestionnaireTemplate`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, getQuestionnaireTemplate, GetQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; - -// The `GetQuestionnaireTemplate` query requires an argument of type `GetQuestionnaireTemplateVariables`: -const getQuestionnaireTemplateVars: GetQuestionnaireTemplateVariables = { - id: ..., -}; - -// Call the `getQuestionnaireTemplate()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await getQuestionnaireTemplate(getQuestionnaireTemplateVars); -// Variables can be defined inline as well. -const { data } = await getQuestionnaireTemplate({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await getQuestionnaireTemplate(dataConnect, getQuestionnaireTemplateVars); - -console.log(data.questionnaireTemplate); - -// Or, you can use the `Promise` API. -getQuestionnaireTemplate(getQuestionnaireTemplateVars).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplate); -}); -``` - -### Using `GetQuestionnaireTemplate`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, getQuestionnaireTemplateRef, GetQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; - -// The `GetQuestionnaireTemplate` query requires an argument of type `GetQuestionnaireTemplateVariables`: -const getQuestionnaireTemplateVars: GetQuestionnaireTemplateVariables = { - id: ..., -}; - -// Call the `getQuestionnaireTemplateRef()` function to get a reference to the query. -const ref = getQuestionnaireTemplateRef(getQuestionnaireTemplateVars); -// Variables can be defined inline as well. -const ref = getQuestionnaireTemplateRef({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = getQuestionnaireTemplateRef(dataConnect, getQuestionnaireTemplateVars); - -// 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.questionnaireTemplate); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplate); -}); -``` - -# Mutations - -There are two ways to execute a Data Connect Mutation using the generated Web SDK: -- Using a Mutation Reference function, which returns a `MutationRef` - - The `MutationRef` can be used as an argument to `executeMutation()`, which will execute the Mutation and return a `MutationPromise` -- Using an action shortcut function, which returns a `MutationPromise` - - Calling the action shortcut function will execute the Mutation and return a `MutationPromise` - -The following is true for both the action shortcut function and the `MutationRef` function: -- The `MutationPromise` returned will resolve to the result of the Mutation once it has finished executing -- If the Mutation accepts arguments, both the action shortcut function and the `MutationRef` function accept a single argument: an object that contains all the required variables (and the optional variables) for the Mutation -- 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 `questionnaires` connector's generated functions to execute each mutation. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#using-mutations). - -## CreateQuestionnaireTemplate -You can execute the `CreateQuestionnaireTemplate` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -createQuestionnaireTemplate(vars: CreateQuestionnaireTemplateVariables): MutationPromise; - -interface CreateQuestionnaireTemplateRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateQuestionnaireTemplateVariables): MutationRef; -} -export const createQuestionnaireTemplateRef: CreateQuestionnaireTemplateRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -createQuestionnaireTemplate(dc: DataConnect, vars: CreateQuestionnaireTemplateVariables): MutationPromise; - -interface CreateQuestionnaireTemplateRef { - ... - (dc: DataConnect, vars: CreateQuestionnaireTemplateVariables): MutationRef; -} -export const createQuestionnaireTemplateRef: CreateQuestionnaireTemplateRef; -``` - -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 createQuestionnaireTemplateRef: -```typescript -const name = createQuestionnaireTemplateRef.operationName; -console.log(name); -``` - -### Variables -The `CreateQuestionnaireTemplate` mutation requires an argument of type `CreateQuestionnaireTemplateVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface CreateQuestionnaireTemplateVariables { - id: UUIDString; - name: string; -} -``` -### Return Type -Recall that executing the `CreateQuestionnaireTemplate` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `CreateQuestionnaireTemplateData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface CreateQuestionnaireTemplateData { - questionnaireTemplate_insert: QuestionnaireTemplate_Key; -} -``` -### Using `CreateQuestionnaireTemplate`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, createQuestionnaireTemplate, CreateQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; - -// The `CreateQuestionnaireTemplate` mutation requires an argument of type `CreateQuestionnaireTemplateVariables`: -const createQuestionnaireTemplateVars: CreateQuestionnaireTemplateVariables = { - id: ..., - name: ..., -}; - -// Call the `createQuestionnaireTemplate()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await createQuestionnaireTemplate(createQuestionnaireTemplateVars); -// Variables can be defined inline as well. -const { data } = await createQuestionnaireTemplate({ id: ..., name: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await createQuestionnaireTemplate(dataConnect, createQuestionnaireTemplateVars); - -console.log(data.questionnaireTemplate_insert); - -// Or, you can use the `Promise` API. -createQuestionnaireTemplate(createQuestionnaireTemplateVars).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplate_insert); -}); -``` - -### Using `CreateQuestionnaireTemplate`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, createQuestionnaireTemplateRef, CreateQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; - -// The `CreateQuestionnaireTemplate` mutation requires an argument of type `CreateQuestionnaireTemplateVariables`: -const createQuestionnaireTemplateVars: CreateQuestionnaireTemplateVariables = { - id: ..., - name: ..., -}; - -// Call the `createQuestionnaireTemplateRef()` function to get a reference to the mutation. -const ref = createQuestionnaireTemplateRef(createQuestionnaireTemplateVars); -// Variables can be defined inline as well. -const ref = createQuestionnaireTemplateRef({ id: ..., name: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = createQuestionnaireTemplateRef(dataConnect, createQuestionnaireTemplateVars); - -// Call `executeMutation()` on the reference to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeMutation(ref); - -console.log(data.questionnaireTemplate_insert); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplate_insert); -}); -``` - -## CreateQuestionnaireTemplateQuestion -You can execute the `CreateQuestionnaireTemplateQuestion` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -createQuestionnaireTemplateQuestion(vars: CreateQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface CreateQuestionnaireTemplateQuestionRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateQuestionnaireTemplateQuestionVariables): MutationRef; -} -export const createQuestionnaireTemplateQuestionRef: CreateQuestionnaireTemplateQuestionRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -createQuestionnaireTemplateQuestion(dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface CreateQuestionnaireTemplateQuestionRef { - ... - (dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables): MutationRef; -} -export const createQuestionnaireTemplateQuestionRef: CreateQuestionnaireTemplateQuestionRef; -``` - -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 createQuestionnaireTemplateQuestionRef: -```typescript -const name = createQuestionnaireTemplateQuestionRef.operationName; -console.log(name); -``` - -### Variables -The `CreateQuestionnaireTemplateQuestion` mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface CreateQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; - label: string; - position: number; - description?: string | null; -} -``` -### Return Type -Recall that executing the `CreateQuestionnaireTemplateQuestion` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `CreateQuestionnaireTemplateQuestionData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface CreateQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_insert: QuestionnaireTemplateQuestion_Key; -} -``` -### Using `CreateQuestionnaireTemplateQuestion`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, createQuestionnaireTemplateQuestion, CreateQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; - -// The `CreateQuestionnaireTemplateQuestion` mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`: -const createQuestionnaireTemplateQuestionVars: CreateQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., - label: ..., - position: ..., - description: ..., // optional -}; - -// Call the `createQuestionnaireTemplateQuestion()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await createQuestionnaireTemplateQuestion(createQuestionnaireTemplateQuestionVars); -// Variables can be defined inline as well. -const { data } = await createQuestionnaireTemplateQuestion({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await createQuestionnaireTemplateQuestion(dataConnect, createQuestionnaireTemplateQuestionVars); - -console.log(data.questionnaireTemplateQuestion_insert); - -// Or, you can use the `Promise` API. -createQuestionnaireTemplateQuestion(createQuestionnaireTemplateQuestionVars).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplateQuestion_insert); -}); -``` - -### Using `CreateQuestionnaireTemplateQuestion`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, createQuestionnaireTemplateQuestionRef, CreateQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; - -// The `CreateQuestionnaireTemplateQuestion` mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`: -const createQuestionnaireTemplateQuestionVars: CreateQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., - label: ..., - position: ..., - description: ..., // optional -}; - -// Call the `createQuestionnaireTemplateQuestionRef()` function to get a reference to the mutation. -const ref = createQuestionnaireTemplateQuestionRef(createQuestionnaireTemplateQuestionVars); -// Variables can be defined inline as well. -const ref = createQuestionnaireTemplateQuestionRef({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = createQuestionnaireTemplateQuestionRef(dataConnect, createQuestionnaireTemplateQuestionVars); - -// Call `executeMutation()` on the reference to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeMutation(ref); - -console.log(data.questionnaireTemplateQuestion_insert); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplateQuestion_insert); -}); -``` - -## UpdateQuestionnaireTemplateName -You can execute the `UpdateQuestionnaireTemplateName` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -updateQuestionnaireTemplateName(vars: UpdateQuestionnaireTemplateNameVariables): MutationPromise; - -interface UpdateQuestionnaireTemplateNameRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: UpdateQuestionnaireTemplateNameVariables): MutationRef; -} -export const updateQuestionnaireTemplateNameRef: UpdateQuestionnaireTemplateNameRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -updateQuestionnaireTemplateName(dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables): MutationPromise; - -interface UpdateQuestionnaireTemplateNameRef { - ... - (dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables): MutationRef; -} -export const updateQuestionnaireTemplateNameRef: UpdateQuestionnaireTemplateNameRef; -``` - -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 updateQuestionnaireTemplateNameRef: -```typescript -const name = updateQuestionnaireTemplateNameRef.operationName; -console.log(name); -``` - -### Variables -The `UpdateQuestionnaireTemplateName` mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface UpdateQuestionnaireTemplateNameVariables { - id: UUIDString; - name: string; -} -``` -### Return Type -Recall that executing the `UpdateQuestionnaireTemplateName` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `UpdateQuestionnaireTemplateNameData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface UpdateQuestionnaireTemplateNameData { - questionnaireTemplate_update?: QuestionnaireTemplate_Key | null; -} -``` -### Using `UpdateQuestionnaireTemplateName`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, updateQuestionnaireTemplateName, UpdateQuestionnaireTemplateNameVariables } from '@generated/questionnaires-data-connector-web'; - -// The `UpdateQuestionnaireTemplateName` mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`: -const updateQuestionnaireTemplateNameVars: UpdateQuestionnaireTemplateNameVariables = { - id: ..., - name: ..., -}; - -// Call the `updateQuestionnaireTemplateName()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await updateQuestionnaireTemplateName(updateQuestionnaireTemplateNameVars); -// Variables can be defined inline as well. -const { data } = await updateQuestionnaireTemplateName({ id: ..., name: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await updateQuestionnaireTemplateName(dataConnect, updateQuestionnaireTemplateNameVars); - -console.log(data.questionnaireTemplate_update); - -// Or, you can use the `Promise` API. -updateQuestionnaireTemplateName(updateQuestionnaireTemplateNameVars).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplate_update); -}); -``` - -### Using `UpdateQuestionnaireTemplateName`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, updateQuestionnaireTemplateNameRef, UpdateQuestionnaireTemplateNameVariables } from '@generated/questionnaires-data-connector-web'; - -// The `UpdateQuestionnaireTemplateName` mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`: -const updateQuestionnaireTemplateNameVars: UpdateQuestionnaireTemplateNameVariables = { - id: ..., - name: ..., -}; - -// Call the `updateQuestionnaireTemplateNameRef()` function to get a reference to the mutation. -const ref = updateQuestionnaireTemplateNameRef(updateQuestionnaireTemplateNameVars); -// Variables can be defined inline as well. -const ref = updateQuestionnaireTemplateNameRef({ id: ..., name: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = updateQuestionnaireTemplateNameRef(dataConnect, updateQuestionnaireTemplateNameVars); - -// Call `executeMutation()` on the reference to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeMutation(ref); - -console.log(data.questionnaireTemplate_update); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplate_update); -}); -``` - -## UpdateQuestionnaireTemplateQuestion -You can execute the `UpdateQuestionnaireTemplateQuestion` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -updateQuestionnaireTemplateQuestion(vars: UpdateQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface UpdateQuestionnaireTemplateQuestionRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: UpdateQuestionnaireTemplateQuestionVariables): MutationRef; -} -export const updateQuestionnaireTemplateQuestionRef: UpdateQuestionnaireTemplateQuestionRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -updateQuestionnaireTemplateQuestion(dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface UpdateQuestionnaireTemplateQuestionRef { - ... - (dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables): MutationRef; -} -export const updateQuestionnaireTemplateQuestionRef: UpdateQuestionnaireTemplateQuestionRef; -``` - -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 updateQuestionnaireTemplateQuestionRef: -```typescript -const name = updateQuestionnaireTemplateQuestionRef.operationName; -console.log(name); -``` - -### Variables -The `UpdateQuestionnaireTemplateQuestion` mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface UpdateQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; - label: string; - position: number; - description?: string | null; -} -``` -### Return Type -Recall that executing the `UpdateQuestionnaireTemplateQuestion` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `UpdateQuestionnaireTemplateQuestionData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface UpdateQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_update?: QuestionnaireTemplateQuestion_Key | null; -} -``` -### Using `UpdateQuestionnaireTemplateQuestion`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, updateQuestionnaireTemplateQuestion, UpdateQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; - -// The `UpdateQuestionnaireTemplateQuestion` mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`: -const updateQuestionnaireTemplateQuestionVars: UpdateQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., - label: ..., - position: ..., - description: ..., // optional -}; - -// Call the `updateQuestionnaireTemplateQuestion()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await updateQuestionnaireTemplateQuestion(updateQuestionnaireTemplateQuestionVars); -// Variables can be defined inline as well. -const { data } = await updateQuestionnaireTemplateQuestion({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await updateQuestionnaireTemplateQuestion(dataConnect, updateQuestionnaireTemplateQuestionVars); - -console.log(data.questionnaireTemplateQuestion_update); - -// Or, you can use the `Promise` API. -updateQuestionnaireTemplateQuestion(updateQuestionnaireTemplateQuestionVars).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplateQuestion_update); -}); -``` - -### Using `UpdateQuestionnaireTemplateQuestion`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, updateQuestionnaireTemplateQuestionRef, UpdateQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; - -// The `UpdateQuestionnaireTemplateQuestion` mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`: -const updateQuestionnaireTemplateQuestionVars: UpdateQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., - label: ..., - position: ..., - description: ..., // optional -}; - -// Call the `updateQuestionnaireTemplateQuestionRef()` function to get a reference to the mutation. -const ref = updateQuestionnaireTemplateQuestionRef(updateQuestionnaireTemplateQuestionVars); -// Variables can be defined inline as well. -const ref = updateQuestionnaireTemplateQuestionRef({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = updateQuestionnaireTemplateQuestionRef(dataConnect, updateQuestionnaireTemplateQuestionVars); - -// Call `executeMutation()` on the reference to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeMutation(ref); - -console.log(data.questionnaireTemplateQuestion_update); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplateQuestion_update); -}); -``` - -## DeleteQuestionnaireTemplateQuestion -You can execute the `DeleteQuestionnaireTemplateQuestion` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -deleteQuestionnaireTemplateQuestion(vars: DeleteQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface DeleteQuestionnaireTemplateQuestionRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: DeleteQuestionnaireTemplateQuestionVariables): MutationRef; -} -export const deleteQuestionnaireTemplateQuestionRef: DeleteQuestionnaireTemplateQuestionRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -deleteQuestionnaireTemplateQuestion(dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface DeleteQuestionnaireTemplateQuestionRef { - ... - (dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables): MutationRef; -} -export const deleteQuestionnaireTemplateQuestionRef: DeleteQuestionnaireTemplateQuestionRef; -``` - -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 deleteQuestionnaireTemplateQuestionRef: -```typescript -const name = deleteQuestionnaireTemplateQuestionRef.operationName; -console.log(name); -``` - -### Variables -The `DeleteQuestionnaireTemplateQuestion` mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface DeleteQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; -} -``` -### Return Type -Recall that executing the `DeleteQuestionnaireTemplateQuestion` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `DeleteQuestionnaireTemplateQuestionData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface DeleteQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_delete?: QuestionnaireTemplateQuestion_Key | null; -} -``` -### Using `DeleteQuestionnaireTemplateQuestion`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, deleteQuestionnaireTemplateQuestion, DeleteQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; - -// The `DeleteQuestionnaireTemplateQuestion` mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`: -const deleteQuestionnaireTemplateQuestionVars: DeleteQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., -}; - -// Call the `deleteQuestionnaireTemplateQuestion()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await deleteQuestionnaireTemplateQuestion(deleteQuestionnaireTemplateQuestionVars); -// Variables can be defined inline as well. -const { data } = await deleteQuestionnaireTemplateQuestion({ id: ..., templateId: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await deleteQuestionnaireTemplateQuestion(dataConnect, deleteQuestionnaireTemplateQuestionVars); - -console.log(data.questionnaireTemplateQuestion_delete); - -// Or, you can use the `Promise` API. -deleteQuestionnaireTemplateQuestion(deleteQuestionnaireTemplateQuestionVars).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplateQuestion_delete); -}); -``` - -### Using `DeleteQuestionnaireTemplateQuestion`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, deleteQuestionnaireTemplateQuestionRef, DeleteQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; - -// The `DeleteQuestionnaireTemplateQuestion` mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`: -const deleteQuestionnaireTemplateQuestionVars: DeleteQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., -}; - -// Call the `deleteQuestionnaireTemplateQuestionRef()` function to get a reference to the mutation. -const ref = deleteQuestionnaireTemplateQuestionRef(deleteQuestionnaireTemplateQuestionVars); -// Variables can be defined inline as well. -const ref = deleteQuestionnaireTemplateQuestionRef({ id: ..., templateId: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = deleteQuestionnaireTemplateQuestionRef(dataConnect, deleteQuestionnaireTemplateQuestionVars); - -// Call `executeMutation()` on the reference to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeMutation(ref); - -console.log(data.questionnaireTemplateQuestion_delete); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplateQuestion_delete); -}); -``` - -## DeleteQuestionnaireTemplate -You can execute the `DeleteQuestionnaireTemplate` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -deleteQuestionnaireTemplate(vars: DeleteQuestionnaireTemplateVariables): MutationPromise; - -interface DeleteQuestionnaireTemplateRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: DeleteQuestionnaireTemplateVariables): MutationRef; -} -export const deleteQuestionnaireTemplateRef: DeleteQuestionnaireTemplateRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -deleteQuestionnaireTemplate(dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables): MutationPromise; - -interface DeleteQuestionnaireTemplateRef { - ... - (dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables): MutationRef; -} -export const deleteQuestionnaireTemplateRef: DeleteQuestionnaireTemplateRef; -``` - -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 deleteQuestionnaireTemplateRef: -```typescript -const name = deleteQuestionnaireTemplateRef.operationName; -console.log(name); -``` - -### Variables -The `DeleteQuestionnaireTemplate` mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface DeleteQuestionnaireTemplateVariables { - id: UUIDString; -} -``` -### Return Type -Recall that executing the `DeleteQuestionnaireTemplate` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `DeleteQuestionnaireTemplateData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface DeleteQuestionnaireTemplateData { - questionnaireTemplateQuestion_deleteMany: number; - questionnaireTemplate_delete?: QuestionnaireTemplate_Key | null; -} -``` -### Using `DeleteQuestionnaireTemplate`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, deleteQuestionnaireTemplate, DeleteQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; - -// The `DeleteQuestionnaireTemplate` mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`: -const deleteQuestionnaireTemplateVars: DeleteQuestionnaireTemplateVariables = { - id: ..., -}; - -// Call the `deleteQuestionnaireTemplate()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await deleteQuestionnaireTemplate(deleteQuestionnaireTemplateVars); -// Variables can be defined inline as well. -const { data } = await deleteQuestionnaireTemplate({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await deleteQuestionnaireTemplate(dataConnect, deleteQuestionnaireTemplateVars); - -console.log(data.questionnaireTemplateQuestion_deleteMany); -console.log(data.questionnaireTemplate_delete); - -// Or, you can use the `Promise` API. -deleteQuestionnaireTemplate(deleteQuestionnaireTemplateVars).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplateQuestion_deleteMany); - console.log(data.questionnaireTemplate_delete); -}); -``` - -### Using `DeleteQuestionnaireTemplate`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, deleteQuestionnaireTemplateRef, DeleteQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; - -// The `DeleteQuestionnaireTemplate` mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`: -const deleteQuestionnaireTemplateVars: DeleteQuestionnaireTemplateVariables = { - id: ..., -}; - -// Call the `deleteQuestionnaireTemplateRef()` function to get a reference to the mutation. -const ref = deleteQuestionnaireTemplateRef(deleteQuestionnaireTemplateVars); -// Variables can be defined inline as well. -const ref = deleteQuestionnaireTemplateRef({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = deleteQuestionnaireTemplateRef(dataConnect, deleteQuestionnaireTemplateVars); - -// Call `executeMutation()` on the reference to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeMutation(ref); - -console.log(data.questionnaireTemplateQuestion_deleteMany); -console.log(data.questionnaireTemplate_delete); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.questionnaireTemplateQuestion_deleteMany); - console.log(data.questionnaireTemplate_delete); -}); -``` - -## CreateProjectQuestionnaire -You can execute the `CreateProjectQuestionnaire` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -createProjectQuestionnaire(vars: CreateProjectQuestionnaireVariables): MutationPromise; - -interface CreateProjectQuestionnaireRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateProjectQuestionnaireVariables): MutationRef; -} -export const createProjectQuestionnaireRef: CreateProjectQuestionnaireRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -createProjectQuestionnaire(dc: DataConnect, vars: CreateProjectQuestionnaireVariables): MutationPromise; - -interface CreateProjectQuestionnaireRef { - ... - (dc: DataConnect, vars: CreateProjectQuestionnaireVariables): MutationRef; -} -export const createProjectQuestionnaireRef: CreateProjectQuestionnaireRef; -``` - -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 createProjectQuestionnaireRef: -```typescript -const name = createProjectQuestionnaireRef.operationName; -console.log(name); -``` - -### Variables -The `CreateProjectQuestionnaire` mutation requires an argument of type `CreateProjectQuestionnaireVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface CreateProjectQuestionnaireVariables { - id: UUIDString; - projectId: UUIDString; - sourceTemplateId?: UUIDString | null; -} -``` -### Return Type -Recall that executing the `CreateProjectQuestionnaire` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `CreateProjectQuestionnaireData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface CreateProjectQuestionnaireData { - projectQuestionnaire_insert: ProjectQuestionnaire_Key; -} -``` -### Using `CreateProjectQuestionnaire`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, createProjectQuestionnaire, CreateProjectQuestionnaireVariables } from '@generated/questionnaires-data-connector-web'; - -// The `CreateProjectQuestionnaire` mutation requires an argument of type `CreateProjectQuestionnaireVariables`: -const createProjectQuestionnaireVars: CreateProjectQuestionnaireVariables = { - id: ..., - projectId: ..., - sourceTemplateId: ..., // optional -}; - -// Call the `createProjectQuestionnaire()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await createProjectQuestionnaire(createProjectQuestionnaireVars); -// Variables can be defined inline as well. -const { data } = await createProjectQuestionnaire({ id: ..., projectId: ..., sourceTemplateId: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await createProjectQuestionnaire(dataConnect, createProjectQuestionnaireVars); - -console.log(data.projectQuestionnaire_insert); - -// Or, you can use the `Promise` API. -createProjectQuestionnaire(createProjectQuestionnaireVars).then((response) => { - const data = response.data; - console.log(data.projectQuestionnaire_insert); -}); -``` - -### Using `CreateProjectQuestionnaire`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, createProjectQuestionnaireRef, CreateProjectQuestionnaireVariables } from '@generated/questionnaires-data-connector-web'; - -// The `CreateProjectQuestionnaire` mutation requires an argument of type `CreateProjectQuestionnaireVariables`: -const createProjectQuestionnaireVars: CreateProjectQuestionnaireVariables = { - id: ..., - projectId: ..., - sourceTemplateId: ..., // optional -}; - -// Call the `createProjectQuestionnaireRef()` function to get a reference to the mutation. -const ref = createProjectQuestionnaireRef(createProjectQuestionnaireVars); -// Variables can be defined inline as well. -const ref = createProjectQuestionnaireRef({ id: ..., projectId: ..., sourceTemplateId: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = createProjectQuestionnaireRef(dataConnect, createProjectQuestionnaireVars); - -// Call `executeMutation()` on the reference to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeMutation(ref); - -console.log(data.projectQuestionnaire_insert); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.projectQuestionnaire_insert); -}); -``` - -## CreateProjectQuestionnaireAnswer -You can execute the `CreateProjectQuestionnaireAnswer` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts): -```typescript -createProjectQuestionnaireAnswer(vars: CreateProjectQuestionnaireAnswerVariables): MutationPromise; - -interface CreateProjectQuestionnaireAnswerRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateProjectQuestionnaireAnswerVariables): MutationRef; -} -export const createProjectQuestionnaireAnswerRef: CreateProjectQuestionnaireAnswerRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -createProjectQuestionnaireAnswer(dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables): MutationPromise; - -interface CreateProjectQuestionnaireAnswerRef { - ... - (dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables): MutationRef; -} -export const createProjectQuestionnaireAnswerRef: CreateProjectQuestionnaireAnswerRef; -``` - -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 createProjectQuestionnaireAnswerRef: -```typescript -const name = createProjectQuestionnaireAnswerRef.operationName; -console.log(name); -``` - -### Variables -The `CreateProjectQuestionnaireAnswer` mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface CreateProjectQuestionnaireAnswerVariables { - id: UUIDString; - projectQuestionnaireId: UUIDString; - questionId: UUIDString; - position: number; - answer?: string | null; -} -``` -### Return Type -Recall that executing the `CreateProjectQuestionnaireAnswer` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `CreateProjectQuestionnaireAnswerData`, which is defined in [questionnaires-data-connector-web/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface CreateProjectQuestionnaireAnswerData { - projectQuestionnaireAnswer_insert: ProjectQuestionnaireAnswer_Key; -} -``` -### Using `CreateProjectQuestionnaireAnswer`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, createProjectQuestionnaireAnswer, CreateProjectQuestionnaireAnswerVariables } from '@generated/questionnaires-data-connector-web'; - -// The `CreateProjectQuestionnaireAnswer` mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`: -const createProjectQuestionnaireAnswerVars: CreateProjectQuestionnaireAnswerVariables = { - id: ..., - projectQuestionnaireId: ..., - questionId: ..., - position: ..., - answer: ..., // optional -}; - -// Call the `createProjectQuestionnaireAnswer()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await createProjectQuestionnaireAnswer(createProjectQuestionnaireAnswerVars); -// Variables can be defined inline as well. -const { data } = await createProjectQuestionnaireAnswer({ id: ..., projectQuestionnaireId: ..., questionId: ..., position: ..., answer: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await createProjectQuestionnaireAnswer(dataConnect, createProjectQuestionnaireAnswerVars); - -console.log(data.projectQuestionnaireAnswer_insert); - -// Or, you can use the `Promise` API. -createProjectQuestionnaireAnswer(createProjectQuestionnaireAnswerVars).then((response) => { - const data = response.data; - console.log(data.projectQuestionnaireAnswer_insert); -}); -``` - -### Using `CreateProjectQuestionnaireAnswer`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, createProjectQuestionnaireAnswerRef, CreateProjectQuestionnaireAnswerVariables } from '@generated/questionnaires-data-connector-web'; - -// The `CreateProjectQuestionnaireAnswer` mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`: -const createProjectQuestionnaireAnswerVars: CreateProjectQuestionnaireAnswerVariables = { - id: ..., - projectQuestionnaireId: ..., - questionId: ..., - position: ..., - answer: ..., // optional -}; - -// Call the `createProjectQuestionnaireAnswerRef()` function to get a reference to the mutation. -const ref = createProjectQuestionnaireAnswerRef(createProjectQuestionnaireAnswerVars); -// Variables can be defined inline as well. -const ref = createProjectQuestionnaireAnswerRef({ id: ..., projectQuestionnaireId: ..., questionId: ..., position: ..., answer: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = createProjectQuestionnaireAnswerRef(dataConnect, createProjectQuestionnaireAnswerVars); - -// Call `executeMutation()` on the reference to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeMutation(ref); - -console.log(data.projectQuestionnaireAnswer_insert); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.projectQuestionnaireAnswer_insert); -}); -``` - diff --git a/generated/questionnaires-data-connector-web/esm/index.esm.js b/generated/questionnaires-data-connector-web/esm/index.esm.js deleted file mode 100644 index eb9915b..0000000 --- a/generated/questionnaires-data-connector-web/esm/index.esm.js +++ /dev/null @@ -1,129 +0,0 @@ -import { queryRef, executeQuery, validateArgsWithOptions, mutationRef, executeMutation, validateArgs } from 'firebase/data-connect'; - -export const connectorConfig = { - connector: 'questionnaires', - service: 'plaster-calculator', - location: 'us-west1' -}; -export const createQuestionnaireTemplateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateQuestionnaireTemplate', inputVars); -} -createQuestionnaireTemplateRef.operationName = 'CreateQuestionnaireTemplate'; - -export function createQuestionnaireTemplate(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(createQuestionnaireTemplateRef(dcInstance, inputVars)); -} - -export const createQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateQuestionnaireTemplateQuestion', inputVars); -} -createQuestionnaireTemplateQuestionRef.operationName = 'CreateQuestionnaireTemplateQuestion'; - -export function createQuestionnaireTemplateQuestion(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(createQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); -} - -export const updateQuestionnaireTemplateNameRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateQuestionnaireTemplateName', inputVars); -} -updateQuestionnaireTemplateNameRef.operationName = 'UpdateQuestionnaireTemplateName'; - -export function updateQuestionnaireTemplateName(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(updateQuestionnaireTemplateNameRef(dcInstance, inputVars)); -} - -export const updateQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateQuestionnaireTemplateQuestion', inputVars); -} -updateQuestionnaireTemplateQuestionRef.operationName = 'UpdateQuestionnaireTemplateQuestion'; - -export function updateQuestionnaireTemplateQuestion(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(updateQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); -} - -export const deleteQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteQuestionnaireTemplateQuestion', inputVars); -} -deleteQuestionnaireTemplateQuestionRef.operationName = 'DeleteQuestionnaireTemplateQuestion'; - -export function deleteQuestionnaireTemplateQuestion(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(deleteQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); -} - -export const deleteQuestionnaireTemplateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteQuestionnaireTemplate', inputVars); -} -deleteQuestionnaireTemplateRef.operationName = 'DeleteQuestionnaireTemplate'; - -export function deleteQuestionnaireTemplate(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(deleteQuestionnaireTemplateRef(dcInstance, inputVars)); -} - -export const createProjectQuestionnaireRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateProjectQuestionnaire', inputVars); -} -createProjectQuestionnaireRef.operationName = 'CreateProjectQuestionnaire'; - -export function createProjectQuestionnaire(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(createProjectQuestionnaireRef(dcInstance, inputVars)); -} - -export const createProjectQuestionnaireAnswerRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateProjectQuestionnaireAnswer', inputVars); -} -createProjectQuestionnaireAnswerRef.operationName = 'CreateProjectQuestionnaireAnswer'; - -export function createProjectQuestionnaireAnswer(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(createProjectQuestionnaireAnswerRef(dcInstance, inputVars)); -} - -export const listQuestionnaireTemplatesRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'ListQuestionnaireTemplates'); -} -listQuestionnaireTemplatesRef.operationName = 'ListQuestionnaireTemplates'; - -export function listQuestionnaireTemplates(dcOrOptions, options) { - - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrOptions, options, undefined,false, false); - return executeQuery(listQuestionnaireTemplatesRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); -} - -export const getQuestionnaireTemplateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'GetQuestionnaireTemplate', inputVars); -} -getQuestionnaireTemplateRef.operationName = 'GetQuestionnaireTemplate'; - -export function getQuestionnaireTemplate(dcOrVars, varsOrOptions, options) { - - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - return executeQuery(getQuestionnaireTemplateRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); -} - diff --git a/generated/questionnaires-data-connector-web/esm/package.json b/generated/questionnaires-data-connector-web/esm/package.json deleted file mode 100644 index 7c34deb..0000000 --- a/generated/questionnaires-data-connector-web/esm/package.json +++ /dev/null @@ -1 +0,0 @@ -{"type":"module"} \ No newline at end of file diff --git a/generated/questionnaires-data-connector-web/index.cjs.js b/generated/questionnaires-data-connector-web/index.cjs.js deleted file mode 100644 index 294abed..0000000 --- a/generated/questionnaires-data-connector-web/index.cjs.js +++ /dev/null @@ -1,150 +0,0 @@ -const { queryRef, executeQuery, validateArgsWithOptions, mutationRef, executeMutation, validateArgs } = require('firebase/data-connect'); - -const connectorConfig = { - connector: 'questionnaires', - service: 'plaster-calculator', - location: 'us-west1' -}; -exports.connectorConfig = connectorConfig; - -const createQuestionnaireTemplateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateQuestionnaireTemplate', inputVars); -} -createQuestionnaireTemplateRef.operationName = 'CreateQuestionnaireTemplate'; -exports.createQuestionnaireTemplateRef = createQuestionnaireTemplateRef; - -exports.createQuestionnaireTemplate = function createQuestionnaireTemplate(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(createQuestionnaireTemplateRef(dcInstance, inputVars)); -} -; - -const createQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateQuestionnaireTemplateQuestion', inputVars); -} -createQuestionnaireTemplateQuestionRef.operationName = 'CreateQuestionnaireTemplateQuestion'; -exports.createQuestionnaireTemplateQuestionRef = createQuestionnaireTemplateQuestionRef; - -exports.createQuestionnaireTemplateQuestion = function createQuestionnaireTemplateQuestion(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(createQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); -} -; - -const updateQuestionnaireTemplateNameRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateQuestionnaireTemplateName', inputVars); -} -updateQuestionnaireTemplateNameRef.operationName = 'UpdateQuestionnaireTemplateName'; -exports.updateQuestionnaireTemplateNameRef = updateQuestionnaireTemplateNameRef; - -exports.updateQuestionnaireTemplateName = function updateQuestionnaireTemplateName(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(updateQuestionnaireTemplateNameRef(dcInstance, inputVars)); -} -; - -const updateQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateQuestionnaireTemplateQuestion', inputVars); -} -updateQuestionnaireTemplateQuestionRef.operationName = 'UpdateQuestionnaireTemplateQuestion'; -exports.updateQuestionnaireTemplateQuestionRef = updateQuestionnaireTemplateQuestionRef; - -exports.updateQuestionnaireTemplateQuestion = function updateQuestionnaireTemplateQuestion(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(updateQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); -} -; - -const deleteQuestionnaireTemplateQuestionRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteQuestionnaireTemplateQuestion', inputVars); -} -deleteQuestionnaireTemplateQuestionRef.operationName = 'DeleteQuestionnaireTemplateQuestion'; -exports.deleteQuestionnaireTemplateQuestionRef = deleteQuestionnaireTemplateQuestionRef; - -exports.deleteQuestionnaireTemplateQuestion = function deleteQuestionnaireTemplateQuestion(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(deleteQuestionnaireTemplateQuestionRef(dcInstance, inputVars)); -} -; - -const deleteQuestionnaireTemplateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteQuestionnaireTemplate', inputVars); -} -deleteQuestionnaireTemplateRef.operationName = 'DeleteQuestionnaireTemplate'; -exports.deleteQuestionnaireTemplateRef = deleteQuestionnaireTemplateRef; - -exports.deleteQuestionnaireTemplate = function deleteQuestionnaireTemplate(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(deleteQuestionnaireTemplateRef(dcInstance, inputVars)); -} -; - -const createProjectQuestionnaireRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateProjectQuestionnaire', inputVars); -} -createProjectQuestionnaireRef.operationName = 'CreateProjectQuestionnaire'; -exports.createProjectQuestionnaireRef = createProjectQuestionnaireRef; - -exports.createProjectQuestionnaire = function createProjectQuestionnaire(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(createProjectQuestionnaireRef(dcInstance, inputVars)); -} -; - -const createProjectQuestionnaireAnswerRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateProjectQuestionnaireAnswer', inputVars); -} -createProjectQuestionnaireAnswerRef.operationName = 'CreateProjectQuestionnaireAnswer'; -exports.createProjectQuestionnaireAnswerRef = createProjectQuestionnaireAnswerRef; - -exports.createProjectQuestionnaireAnswer = function createProjectQuestionnaireAnswer(dcOrVars, vars) { - const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true); - return executeMutation(createProjectQuestionnaireAnswerRef(dcInstance, inputVars)); -} -; - -const listQuestionnaireTemplatesRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'ListQuestionnaireTemplates'); -} -listQuestionnaireTemplatesRef.operationName = 'ListQuestionnaireTemplates'; -exports.listQuestionnaireTemplatesRef = listQuestionnaireTemplatesRef; - -exports.listQuestionnaireTemplates = function listQuestionnaireTemplates(dcOrOptions, options) { - - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrOptions, options, undefined,false, false); - return executeQuery(listQuestionnaireTemplatesRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); -} -; - -const getQuestionnaireTemplateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'GetQuestionnaireTemplate', inputVars); -} -getQuestionnaireTemplateRef.operationName = 'GetQuestionnaireTemplate'; -exports.getQuestionnaireTemplateRef = getQuestionnaireTemplateRef; - -exports.getQuestionnaireTemplate = function getQuestionnaireTemplate(dcOrVars, varsOrOptions, options) { - - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateArgsWithOptions(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - return executeQuery(getQuestionnaireTemplateRef(dcInstance, inputVars), inputOpts && { fetchPolicy: inputOpts.fetchPolicy }); -} -; diff --git a/generated/questionnaires-data-connector-web/index.d.ts b/generated/questionnaires-data-connector-web/index.d.ts deleted file mode 100644 index 5ad06ee..0000000 --- a/generated/questionnaires-data-connector-web/index.d.ts +++ /dev/null @@ -1,330 +0,0 @@ -import { ConnectorConfig, DataConnect, QueryRef, QueryPromise, ExecuteQueryOptions, MutationRef, MutationPromise } from 'firebase/data-connect'; - -export const connectorConfig: ConnectorConfig; - -export type TimestampString = string; -export type UUIDString = string; -export type Int64String = string; -export type DateString = string; - - - - -export interface AccountContact_Key { - id: UUIDString; - __typename?: 'AccountContact_Key'; -} - -export interface Account_Key { - id: UUIDString; - __typename?: 'Account_Key'; -} - -export interface CreateProjectQuestionnaireAnswerData { - projectQuestionnaireAnswer_insert: ProjectQuestionnaireAnswer_Key; -} - -export interface CreateProjectQuestionnaireAnswerVariables { - id: UUIDString; - projectQuestionnaireId: UUIDString; - questionId: UUIDString; - position: number; - answer?: string | null; -} - -export interface CreateProjectQuestionnaireData { - projectQuestionnaire_insert: ProjectQuestionnaire_Key; -} - -export interface CreateProjectQuestionnaireVariables { - id: UUIDString; - projectId: UUIDString; - sourceTemplateId?: UUIDString | null; -} - -export interface CreateQuestionnaireTemplateData { - questionnaireTemplate_insert: QuestionnaireTemplate_Key; -} - -export interface CreateQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_insert: QuestionnaireTemplateQuestion_Key; -} - -export interface CreateQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; - label: string; - position: number; - description?: string | null; -} - -export interface CreateQuestionnaireTemplateVariables { - id: UUIDString; - name: string; -} - -export interface DeleteQuestionnaireTemplateData { - questionnaireTemplateQuestion_deleteMany: number; - questionnaireTemplate_delete?: QuestionnaireTemplate_Key | null; -} - -export interface DeleteQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_delete?: QuestionnaireTemplateQuestion_Key | null; -} - -export interface DeleteQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; -} - -export interface DeleteQuestionnaireTemplateVariables { - id: UUIDString; -} - -export interface FloorplanPage_Key { - id: UUIDString; - __typename?: 'FloorplanPage_Key'; -} - -export interface GetQuestionnaireTemplateData { - questionnaireTemplate?: { - id: UUIDString; - ownerId: string; - name: string; - createdAt: TimestampString; - updatedAt: TimestampString; - questions: ({ - id: UUIDString; - label: string; - description?: string | null; - position: number; - } & QuestionnaireTemplateQuestion_Key)[]; - } & QuestionnaireTemplate_Key; -} - -export interface GetQuestionnaireTemplateVariables { - id: UUIDString; -} - -export interface ListQuestionnaireTemplatesData { - questionnaireTemplates: ({ - id: UUIDString; - name: string; - createdAt: TimestampString; - updatedAt: TimestampString; - } & QuestionnaireTemplate_Key)[]; -} - -export interface ProjectQuestionnaireAnswer_Key { - id: UUIDString; - __typename?: 'ProjectQuestionnaireAnswer_Key'; -} - -export interface ProjectQuestionnaire_Key { - id: UUIDString; - __typename?: 'ProjectQuestionnaire_Key'; -} - -export interface Project_Key { - id: UUIDString; - __typename?: 'Project_Key'; -} - -export interface QuantitySource_Key { - id: UUIDString; - __typename?: 'QuantitySource_Key'; -} - -export interface QuestionnaireTemplateQuestion_Key { - id: UUIDString; - __typename?: 'QuestionnaireTemplateQuestion_Key'; -} - -export interface QuestionnaireTemplate_Key { - id: UUIDString; - __typename?: 'QuestionnaireTemplate_Key'; -} - -export interface QuoteItemTemplateConfig_Key { - ownerId: string; - templateId: UUIDString; - __typename?: 'QuoteItemTemplateConfig_Key'; -} - -export interface QuoteItemTemplate_Key { - id: UUIDString; - __typename?: 'QuoteItemTemplate_Key'; -} - -export interface QuoteItem_Key { - id: UUIDString; - __typename?: 'QuoteItem_Key'; -} - -export interface Quote_Key { - id: UUIDString; - __typename?: 'Quote_Key'; -} - -export interface Reminder_Key { - id: UUIDString; - __typename?: 'Reminder_Key'; -} - -export interface SupplierQuoteItemPrice_Key { - supplierId: UUIDString; - templateId: UUIDString; - __typename?: 'SupplierQuoteItemPrice_Key'; -} - -export interface Supplier_Key { - id: UUIDString; - __typename?: 'Supplier_Key'; -} - -export interface UpdateQuestionnaireTemplateNameData { - questionnaireTemplate_update?: QuestionnaireTemplate_Key | null; -} - -export interface UpdateQuestionnaireTemplateNameVariables { - id: UUIDString; - name: string; -} - -export interface UpdateQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_update?: QuestionnaireTemplateQuestion_Key | null; -} - -export interface UpdateQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; - label: string; - position: number; - description?: string | null; -} - -export interface UserSettings_Key { - ownerId: string; - __typename?: 'UserSettings_Key'; -} - -interface CreateQuestionnaireTemplateRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateQuestionnaireTemplateVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: CreateQuestionnaireTemplateVariables): MutationRef; - operationName: string; -} -export const createQuestionnaireTemplateRef: CreateQuestionnaireTemplateRef; - -export function createQuestionnaireTemplate(vars: CreateQuestionnaireTemplateVariables): MutationPromise; -export function createQuestionnaireTemplate(dc: DataConnect, vars: CreateQuestionnaireTemplateVariables): MutationPromise; - -interface CreateQuestionnaireTemplateQuestionRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateQuestionnaireTemplateQuestionVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables): MutationRef; - operationName: string; -} -export const createQuestionnaireTemplateQuestionRef: CreateQuestionnaireTemplateQuestionRef; - -export function createQuestionnaireTemplateQuestion(vars: CreateQuestionnaireTemplateQuestionVariables): MutationPromise; -export function createQuestionnaireTemplateQuestion(dc: DataConnect, vars: CreateQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface UpdateQuestionnaireTemplateNameRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: UpdateQuestionnaireTemplateNameVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables): MutationRef; - operationName: string; -} -export const updateQuestionnaireTemplateNameRef: UpdateQuestionnaireTemplateNameRef; - -export function updateQuestionnaireTemplateName(vars: UpdateQuestionnaireTemplateNameVariables): MutationPromise; -export function updateQuestionnaireTemplateName(dc: DataConnect, vars: UpdateQuestionnaireTemplateNameVariables): MutationPromise; - -interface UpdateQuestionnaireTemplateQuestionRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: UpdateQuestionnaireTemplateQuestionVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables): MutationRef; - operationName: string; -} -export const updateQuestionnaireTemplateQuestionRef: UpdateQuestionnaireTemplateQuestionRef; - -export function updateQuestionnaireTemplateQuestion(vars: UpdateQuestionnaireTemplateQuestionVariables): MutationPromise; -export function updateQuestionnaireTemplateQuestion(dc: DataConnect, vars: UpdateQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface DeleteQuestionnaireTemplateQuestionRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: DeleteQuestionnaireTemplateQuestionVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables): MutationRef; - operationName: string; -} -export const deleteQuestionnaireTemplateQuestionRef: DeleteQuestionnaireTemplateQuestionRef; - -export function deleteQuestionnaireTemplateQuestion(vars: DeleteQuestionnaireTemplateQuestionVariables): MutationPromise; -export function deleteQuestionnaireTemplateQuestion(dc: DataConnect, vars: DeleteQuestionnaireTemplateQuestionVariables): MutationPromise; - -interface DeleteQuestionnaireTemplateRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: DeleteQuestionnaireTemplateVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables): MutationRef; - operationName: string; -} -export const deleteQuestionnaireTemplateRef: DeleteQuestionnaireTemplateRef; - -export function deleteQuestionnaireTemplate(vars: DeleteQuestionnaireTemplateVariables): MutationPromise; -export function deleteQuestionnaireTemplate(dc: DataConnect, vars: DeleteQuestionnaireTemplateVariables): MutationPromise; - -interface CreateProjectQuestionnaireRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateProjectQuestionnaireVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: CreateProjectQuestionnaireVariables): MutationRef; - operationName: string; -} -export const createProjectQuestionnaireRef: CreateProjectQuestionnaireRef; - -export function createProjectQuestionnaire(vars: CreateProjectQuestionnaireVariables): MutationPromise; -export function createProjectQuestionnaire(dc: DataConnect, vars: CreateProjectQuestionnaireVariables): MutationPromise; - -interface CreateProjectQuestionnaireAnswerRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateProjectQuestionnaireAnswerVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables): MutationRef; - operationName: string; -} -export const createProjectQuestionnaireAnswerRef: CreateProjectQuestionnaireAnswerRef; - -export function createProjectQuestionnaireAnswer(vars: CreateProjectQuestionnaireAnswerVariables): MutationPromise; -export function createProjectQuestionnaireAnswer(dc: DataConnect, vars: CreateProjectQuestionnaireAnswerVariables): MutationPromise; - -interface ListQuestionnaireTemplatesRef { - /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect): QueryRef; - operationName: string; -} -export const listQuestionnaireTemplatesRef: ListQuestionnaireTemplatesRef; - -export function listQuestionnaireTemplates(options?: ExecuteQueryOptions): QueryPromise; -export function listQuestionnaireTemplates(dc: DataConnect, options?: ExecuteQueryOptions): QueryPromise; - -interface GetQuestionnaireTemplateRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: GetQuestionnaireTemplateVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: GetQuestionnaireTemplateVariables): QueryRef; - operationName: string; -} -export const getQuestionnaireTemplateRef: GetQuestionnaireTemplateRef; - -export function getQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: ExecuteQueryOptions): QueryPromise; -export function getQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: ExecuteQueryOptions): QueryPromise; - diff --git a/generated/questionnaires-data-connector-web/react/README.md b/generated/questionnaires-data-connector-web/react/README.md deleted file mode 100644 index 583e330..0000000 --- a/generated/questionnaires-data-connector-web/react/README.md +++ /dev/null @@ -1,1102 +0,0 @@ -# Generated React README -This README will guide you through the process of using the generated React SDK package for the connector `questionnaires`. 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 `JavaScript README`, you can find it at [`questionnaires-data-connector-web/README.md`](../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.* - -You can use this generated SDK by importing from the package `@generated/questionnaires-data-connector-web/react` 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#react). - -# Table of Contents -- [**Overview**](#generated-react-readme) -- [**TanStack Query Firebase & TanStack React Query**](#tanstack-query-firebase-tanstack-react-query) - - [*Package Installation*](#installing-tanstack-query-firebase-and-tanstack-react-query-packages) - - [*Configuring TanStack Query*](#configuring-tanstack-query) -- [**Accessing the connector**](#accessing-the-connector) - - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) -- [**Queries**](#queries) - - [*ListQuestionnaireTemplates*](#listquestionnairetemplates) - - [*GetQuestionnaireTemplate*](#getquestionnairetemplate) -- [**Mutations**](#mutations) - - [*CreateQuestionnaireTemplate*](#createquestionnairetemplate) - - [*CreateQuestionnaireTemplateQuestion*](#createquestionnairetemplatequestion) - - [*UpdateQuestionnaireTemplateName*](#updatequestionnairetemplatename) - - [*UpdateQuestionnaireTemplateQuestion*](#updatequestionnairetemplatequestion) - - [*DeleteQuestionnaireTemplateQuestion*](#deletequestionnairetemplatequestion) - - [*DeleteQuestionnaireTemplate*](#deletequestionnairetemplate) - - [*CreateProjectQuestionnaire*](#createprojectquestionnaire) - - [*CreateProjectQuestionnaireAnswer*](#createprojectquestionnaireanswer) - -# TanStack Query Firebase & TanStack React Query -This SDK provides [React](https://react.dev/) hooks generated specific to your application, for the operations found in the connector `questionnaires`. These hooks are generated using [TanStack Query Firebase](https://react-query-firebase.invertase.dev/) by our partners at Invertase, a library built on top of [TanStack React Query v5](https://tanstack.com/query/v5/docs/framework/react/overview). - -***You do not need to be familiar with Tanstack Query or Tanstack Query Firebase to use this SDK.*** However, you may find it useful to learn more about them, as they will empower you as a user of this Generated React SDK. - -## Installing TanStack Query Firebase and TanStack React Query Packages -In order to use the React generated SDK, you must install the `TanStack React Query` and `TanStack Query Firebase` packages. -```bash -npm i --save @tanstack/react-query @tanstack-query-firebase/react -``` -```bash -npm i --save firebase@latest # Note: React has a peer dependency on ^11.3.0 -``` - -You can also follow the installation instructions from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#tanstack-install), or the [TanStack Query Firebase documentation](https://react-query-firebase.invertase.dev/react) and [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/installation). - -## Configuring TanStack Query -In order to use the React generated SDK in your application, you must wrap your application's component tree in a `QueryClientProvider` component from TanStack React Query. None of your generated React SDK hooks will work without this provider. - -```javascript -import { QueryClientProvider } from '@tanstack/react-query'; - -// Create a TanStack Query client instance -const queryClient = new QueryClient() - -function App() { - return ( - // Provide the client to your App - - - - ) -} -``` - -To learn more about `QueryClientProvider`, see the [TanStack React Query documentation](https://tanstack.com/query/latest/docs/framework/react/quick-start) and the [TanStack Query Firebase documentation](https://invertase.docs.page/tanstack-query-firebase/react#usage). - -# 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 `questionnaires`. - -You can find more information about connectors in the [Data Connect documentation](https://firebase.google.com/docs/data-connect#how-does). - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig } from '@generated/questionnaires-data-connector-web'; - -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#emulator-react-angular). - -```javascript -import { connectDataConnectEmulator, getDataConnect } from 'firebase/data-connect'; -import { connectorConfig } from '@generated/questionnaires-data-connector-web'; - -const dataConnect = getDataConnect(connectorConfig); -connectDataConnectEmulator(dataConnect, 'localhost', 9399); -``` - -After it's initialized, you can call your Data Connect [queries](#queries) and [mutations](#mutations) using the hooks provided from your generated React SDK. - -# Queries - -The React generated SDK provides Query hook functions that call and return [`useDataConnectQuery`](https://react-query-firebase.invertase.dev/react/data-connect/querying) hooks from TanStack Query Firebase. - -Calling these hook functions will return a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and the most recent data returned by the Query, among other things. To learn more about these hooks and how to use them, see the [TanStack Query Firebase documentation](https://react-query-firebase.invertase.dev/react/data-connect/querying). - -TanStack React Query caches the results of your Queries, so using the same Query hook function in multiple places in your application allows the entire application to automatically see updates to that Query's data. - -Query hooks execute their Queries automatically when called, and periodically refresh, unless you change the `queryOptions` for the Query. To learn how to stop a Query from automatically executing, including how to make a query "lazy", see the [TanStack React Query documentation](https://tanstack.com/query/latest/docs/framework/react/guides/disabling-queries). - -To learn more about TanStack React Query's Queries, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/guides/queries). - -## Using Query Hooks -Here's a general overview of how to use the generated Query hooks in your code: - -- If the Query has no variables, the Query hook function does not require arguments. -- If the Query has any required variables, the Query hook function will require at least one argument: an object that contains all the required variables for the Query. -- If the Query has some required and some optional variables, only required variables are necessary in the variables argument object, and optional variables may be provided as well. -- If all of the Query's variables are optional, the Query hook function does not require any arguments. -- Query hook 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. -- Query hooks functions can be called with or without passing in an `options` argument of type `useDataConnectQueryOptions`. To learn more about the `options` argument, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/guides/query-options). - - ***Special case:*** If the Query has all optional variables and you would like to provide an `options` argument to the Query hook function without providing any variables, you must pass `undefined` where you would normally pass the Query's variables, and then may provide the `options` argument. - -Below are examples of how to use the `questionnaires` connector's generated Query hook 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#operations-react-angular). - -## ListQuestionnaireTemplates -You can execute the `ListQuestionnaireTemplates` Query using the following Query hook function, which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts): - -```javascript -useListQuestionnaireTemplates(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useListQuestionnaireTemplates(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `ListQuestionnaireTemplates` Query has no variables. -### Return Type -Recall that calling the `ListQuestionnaireTemplates` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. - -To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. - -To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `ListQuestionnaireTemplates` Query is of type `ListQuestionnaireTemplatesData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface ListQuestionnaireTemplatesData { - questionnaireTemplates: ({ - id: UUIDString; - name: string; - createdAt: TimestampString; - updatedAt: TimestampString; - } & QuestionnaireTemplate_Key)[]; -} -``` - -To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). - -### Using `ListQuestionnaireTemplates`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig } from '@generated/questionnaires-data-connector-web'; -import { useListQuestionnaireTemplates } from '@generated/questionnaires-data-connector-web/react' - -export default function ListQuestionnaireTemplatesComponent() { - // You don't have to do anything to "execute" the Query. - // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. - const query = useListQuestionnaireTemplates(); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useListQuestionnaireTemplates(dataConnect); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useListQuestionnaireTemplates(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useListQuestionnaireTemplates(dataConnect, options); - - // Then, you can render your component dynamically based on the status of the Query. - if (query.isPending) { - return
Loading...
; - } - - if (query.isError) { - return
Error: {query.error.message}
; - } - - // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. - if (query.isSuccess) { - console.log(query.data.questionnaireTemplates); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## GetQuestionnaireTemplate -You can execute the `GetQuestionnaireTemplate` Query using the following Query hook function, which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts): - -```javascript -useGetQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useGetQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `GetQuestionnaireTemplate` Query requires an argument of type `GetQuestionnaireTemplateVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface GetQuestionnaireTemplateVariables { - id: UUIDString; -} -``` -### Return Type -Recall that calling the `GetQuestionnaireTemplate` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things. - -To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields. - -To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `GetQuestionnaireTemplate` Query is of type `GetQuestionnaireTemplateData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface GetQuestionnaireTemplateData { - questionnaireTemplate?: { - id: UUIDString; - ownerId: string; - name: string; - createdAt: TimestampString; - updatedAt: TimestampString; - questions: ({ - id: UUIDString; - label: string; - description?: string | null; - position: number; - } & QuestionnaireTemplateQuestion_Key)[]; - } & QuestionnaireTemplate_Key; -} -``` - -To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). - -### Using `GetQuestionnaireTemplate`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, GetQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; -import { useGetQuestionnaireTemplate } from '@generated/questionnaires-data-connector-web/react' - -export default function GetQuestionnaireTemplateComponent() { - // The `useGetQuestionnaireTemplate` Query hook requires an argument of type `GetQuestionnaireTemplateVariables`: - const getQuestionnaireTemplateVars: GetQuestionnaireTemplateVariables = { - id: ..., - }; - - // You don't have to do anything to "execute" the Query. - // Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query. - const query = useGetQuestionnaireTemplate(getQuestionnaireTemplateVars); - // Variables can be defined inline as well. - const query = useGetQuestionnaireTemplate({ id: ..., }); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useGetQuestionnaireTemplate(dataConnect, getQuestionnaireTemplateVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useGetQuestionnaireTemplate(getQuestionnaireTemplateVars, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useGetQuestionnaireTemplate(dataConnect, getQuestionnaireTemplateVars, options); - - // Then, you can render your component dynamically based on the status of the Query. - if (query.isPending) { - return
Loading...
; - } - - if (query.isError) { - return
Error: {query.error.message}
; - } - - // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. - if (query.isSuccess) { - console.log(query.data.questionnaireTemplate); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -# Mutations - -The React generated SDK provides Mutations hook functions that call and return [`useDataConnectMutation`](https://react-query-firebase.invertase.dev/react/data-connect/mutations) hooks from TanStack Query Firebase. - -Calling these hook functions will return a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, and the most recent data returned by the Mutation, among other things. To learn more about these hooks and how to use them, see the [TanStack Query Firebase documentation](https://react-query-firebase.invertase.dev/react/data-connect/mutations). - -Mutation hooks do not execute their Mutations automatically when called. Rather, after calling the Mutation hook function and getting a `UseMutationResult` object, you must call the `UseMutationResult.mutate()` function to execute the Mutation. - -To learn more about TanStack React Query's Mutations, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/guides/mutations). - -## Using Mutation Hooks -Here's a general overview of how to use the generated Mutation hooks in your code: - -- Mutation hook functions are not called with the arguments to the Mutation. Instead, arguments are passed to `UseMutationResult.mutate()`. -- If the Mutation has no variables, the `mutate()` function does not require arguments. -- If the Mutation has any required variables, the `mutate()` function will require at least one argument: an object that contains all the required variables for the Mutation. -- If the Mutation has some required and some optional variables, only required variables are necessary in the variables argument object, and optional variables may be provided as well. -- If all of the Mutation's variables are optional, the Mutation hook function does not require any arguments. -- Mutation hook 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. -- Mutation hooks also accept an `options` argument of type `useDataConnectMutationOptions`. To learn more about the `options` argument, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/guides/mutations#mutation-side-effects). - - `UseMutationResult.mutate()` also accepts an `options` argument of type `useDataConnectMutationOptions`. - - ***Special case:*** If the Mutation has no arguments (or all optional arguments and you wish to provide none), and you want to pass `options` to `UseMutationResult.mutate()`, you must pass `undefined` where you would normally pass the Mutation's arguments, and then may provide the options argument. - -Below are examples of how to use the `questionnaires` connector's generated Mutation hook functions to execute each Mutation. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#operations-react-angular). - -## CreateQuestionnaireTemplate -You can execute the `CreateQuestionnaireTemplate` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts)): -```javascript -useCreateQuestionnaireTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useCreateQuestionnaireTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `CreateQuestionnaireTemplate` Mutation requires an argument of type `CreateQuestionnaireTemplateVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface CreateQuestionnaireTemplateVariables { - id: UUIDString; - name: string; -} -``` -### Return Type -Recall that calling the `CreateQuestionnaireTemplate` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. - -To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. - -To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. - -To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateQuestionnaireTemplate` Mutation is of type `CreateQuestionnaireTemplateData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface CreateQuestionnaireTemplateData { - questionnaireTemplate_insert: QuestionnaireTemplate_Key; -} -``` - -To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). - -### Using `CreateQuestionnaireTemplate`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, CreateQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; -import { useCreateQuestionnaireTemplate } from '@generated/questionnaires-data-connector-web/react' - -export default function CreateQuestionnaireTemplateComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useCreateQuestionnaireTemplate(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useCreateQuestionnaireTemplate(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateQuestionnaireTemplate(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateQuestionnaireTemplate(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useCreateQuestionnaireTemplate` Mutation requires an argument of type `CreateQuestionnaireTemplateVariables`: - const createQuestionnaireTemplateVars: CreateQuestionnaireTemplateVariables = { - id: ..., - name: ..., - }; - mutation.mutate(createQuestionnaireTemplateVars); - // Variables can be defined inline as well. - mutation.mutate({ id: ..., name: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(createQuestionnaireTemplateVars, options); - - // Then, you can render your component dynamically based on the status of the Mutation. - if (mutation.isPending) { - return
Loading...
; - } - - if (mutation.isError) { - return
Error: {mutation.error.message}
; - } - - // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. - if (mutation.isSuccess) { - console.log(mutation.data.questionnaireTemplate_insert); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## CreateQuestionnaireTemplateQuestion -You can execute the `CreateQuestionnaireTemplateQuestion` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts)): -```javascript -useCreateQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useCreateQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `CreateQuestionnaireTemplateQuestion` Mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface CreateQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; - label: string; - position: number; - description?: string | null; -} -``` -### Return Type -Recall that calling the `CreateQuestionnaireTemplateQuestion` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. - -To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. - -To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. - -To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateQuestionnaireTemplateQuestion` Mutation is of type `CreateQuestionnaireTemplateQuestionData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface CreateQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_insert: QuestionnaireTemplateQuestion_Key; -} -``` - -To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). - -### Using `CreateQuestionnaireTemplateQuestion`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, CreateQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; -import { useCreateQuestionnaireTemplateQuestion } from '@generated/questionnaires-data-connector-web/react' - -export default function CreateQuestionnaireTemplateQuestionComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useCreateQuestionnaireTemplateQuestion(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useCreateQuestionnaireTemplateQuestion(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateQuestionnaireTemplateQuestion(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateQuestionnaireTemplateQuestion(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useCreateQuestionnaireTemplateQuestion` Mutation requires an argument of type `CreateQuestionnaireTemplateQuestionVariables`: - const createQuestionnaireTemplateQuestionVars: CreateQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., - label: ..., - position: ..., - description: ..., // optional - }; - mutation.mutate(createQuestionnaireTemplateQuestionVars); - // Variables can be defined inline as well. - mutation.mutate({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(createQuestionnaireTemplateQuestionVars, options); - - // Then, you can render your component dynamically based on the status of the Mutation. - if (mutation.isPending) { - return
Loading...
; - } - - if (mutation.isError) { - return
Error: {mutation.error.message}
; - } - - // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. - if (mutation.isSuccess) { - console.log(mutation.data.questionnaireTemplateQuestion_insert); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## UpdateQuestionnaireTemplateName -You can execute the `UpdateQuestionnaireTemplateName` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts)): -```javascript -useUpdateQuestionnaireTemplateName(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useUpdateQuestionnaireTemplateName(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `UpdateQuestionnaireTemplateName` Mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface UpdateQuestionnaireTemplateNameVariables { - id: UUIDString; - name: string; -} -``` -### Return Type -Recall that calling the `UpdateQuestionnaireTemplateName` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. - -To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. - -To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. - -To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateQuestionnaireTemplateName` Mutation is of type `UpdateQuestionnaireTemplateNameData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface UpdateQuestionnaireTemplateNameData { - questionnaireTemplate_update?: QuestionnaireTemplate_Key | null; -} -``` - -To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). - -### Using `UpdateQuestionnaireTemplateName`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, UpdateQuestionnaireTemplateNameVariables } from '@generated/questionnaires-data-connector-web'; -import { useUpdateQuestionnaireTemplateName } from '@generated/questionnaires-data-connector-web/react' - -export default function UpdateQuestionnaireTemplateNameComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useUpdateQuestionnaireTemplateName(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useUpdateQuestionnaireTemplateName(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useUpdateQuestionnaireTemplateName(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useUpdateQuestionnaireTemplateName(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useUpdateQuestionnaireTemplateName` Mutation requires an argument of type `UpdateQuestionnaireTemplateNameVariables`: - const updateQuestionnaireTemplateNameVars: UpdateQuestionnaireTemplateNameVariables = { - id: ..., - name: ..., - }; - mutation.mutate(updateQuestionnaireTemplateNameVars); - // Variables can be defined inline as well. - mutation.mutate({ id: ..., name: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(updateQuestionnaireTemplateNameVars, options); - - // Then, you can render your component dynamically based on the status of the Mutation. - if (mutation.isPending) { - return
Loading...
; - } - - if (mutation.isError) { - return
Error: {mutation.error.message}
; - } - - // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. - if (mutation.isSuccess) { - console.log(mutation.data.questionnaireTemplate_update); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## UpdateQuestionnaireTemplateQuestion -You can execute the `UpdateQuestionnaireTemplateQuestion` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts)): -```javascript -useUpdateQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useUpdateQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `UpdateQuestionnaireTemplateQuestion` Mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface UpdateQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; - label: string; - position: number; - description?: string | null; -} -``` -### Return Type -Recall that calling the `UpdateQuestionnaireTemplateQuestion` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. - -To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. - -To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. - -To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateQuestionnaireTemplateQuestion` Mutation is of type `UpdateQuestionnaireTemplateQuestionData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface UpdateQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_update?: QuestionnaireTemplateQuestion_Key | null; -} -``` - -To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). - -### Using `UpdateQuestionnaireTemplateQuestion`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, UpdateQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; -import { useUpdateQuestionnaireTemplateQuestion } from '@generated/questionnaires-data-connector-web/react' - -export default function UpdateQuestionnaireTemplateQuestionComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useUpdateQuestionnaireTemplateQuestion(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useUpdateQuestionnaireTemplateQuestion(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useUpdateQuestionnaireTemplateQuestion(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useUpdateQuestionnaireTemplateQuestion(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useUpdateQuestionnaireTemplateQuestion` Mutation requires an argument of type `UpdateQuestionnaireTemplateQuestionVariables`: - const updateQuestionnaireTemplateQuestionVars: UpdateQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., - label: ..., - position: ..., - description: ..., // optional - }; - mutation.mutate(updateQuestionnaireTemplateQuestionVars); - // Variables can be defined inline as well. - mutation.mutate({ id: ..., templateId: ..., label: ..., position: ..., description: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(updateQuestionnaireTemplateQuestionVars, options); - - // Then, you can render your component dynamically based on the status of the Mutation. - if (mutation.isPending) { - return
Loading...
; - } - - if (mutation.isError) { - return
Error: {mutation.error.message}
; - } - - // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. - if (mutation.isSuccess) { - console.log(mutation.data.questionnaireTemplateQuestion_update); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## DeleteQuestionnaireTemplateQuestion -You can execute the `DeleteQuestionnaireTemplateQuestion` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts)): -```javascript -useDeleteQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useDeleteQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `DeleteQuestionnaireTemplateQuestion` Mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface DeleteQuestionnaireTemplateQuestionVariables { - id: UUIDString; - templateId: UUIDString; -} -``` -### Return Type -Recall that calling the `DeleteQuestionnaireTemplateQuestion` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. - -To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. - -To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. - -To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteQuestionnaireTemplateQuestion` Mutation is of type `DeleteQuestionnaireTemplateQuestionData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface DeleteQuestionnaireTemplateQuestionData { - questionnaireTemplateQuestion_delete?: QuestionnaireTemplateQuestion_Key | null; -} -``` - -To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). - -### Using `DeleteQuestionnaireTemplateQuestion`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, DeleteQuestionnaireTemplateQuestionVariables } from '@generated/questionnaires-data-connector-web'; -import { useDeleteQuestionnaireTemplateQuestion } from '@generated/questionnaires-data-connector-web/react' - -export default function DeleteQuestionnaireTemplateQuestionComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useDeleteQuestionnaireTemplateQuestion(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useDeleteQuestionnaireTemplateQuestion(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useDeleteQuestionnaireTemplateQuestion(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useDeleteQuestionnaireTemplateQuestion(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useDeleteQuestionnaireTemplateQuestion` Mutation requires an argument of type `DeleteQuestionnaireTemplateQuestionVariables`: - const deleteQuestionnaireTemplateQuestionVars: DeleteQuestionnaireTemplateQuestionVariables = { - id: ..., - templateId: ..., - }; - mutation.mutate(deleteQuestionnaireTemplateQuestionVars); - // Variables can be defined inline as well. - mutation.mutate({ id: ..., templateId: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(deleteQuestionnaireTemplateQuestionVars, options); - - // Then, you can render your component dynamically based on the status of the Mutation. - if (mutation.isPending) { - return
Loading...
; - } - - if (mutation.isError) { - return
Error: {mutation.error.message}
; - } - - // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. - if (mutation.isSuccess) { - console.log(mutation.data.questionnaireTemplateQuestion_delete); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## DeleteQuestionnaireTemplate -You can execute the `DeleteQuestionnaireTemplate` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts)): -```javascript -useDeleteQuestionnaireTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useDeleteQuestionnaireTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `DeleteQuestionnaireTemplate` Mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface DeleteQuestionnaireTemplateVariables { - id: UUIDString; -} -``` -### Return Type -Recall that calling the `DeleteQuestionnaireTemplate` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. - -To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. - -To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. - -To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteQuestionnaireTemplate` Mutation is of type `DeleteQuestionnaireTemplateData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface DeleteQuestionnaireTemplateData { - questionnaireTemplateQuestion_deleteMany: number; - questionnaireTemplate_delete?: QuestionnaireTemplate_Key | null; -} -``` - -To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). - -### Using `DeleteQuestionnaireTemplate`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, DeleteQuestionnaireTemplateVariables } from '@generated/questionnaires-data-connector-web'; -import { useDeleteQuestionnaireTemplate } from '@generated/questionnaires-data-connector-web/react' - -export default function DeleteQuestionnaireTemplateComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useDeleteQuestionnaireTemplate(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useDeleteQuestionnaireTemplate(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useDeleteQuestionnaireTemplate(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useDeleteQuestionnaireTemplate(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useDeleteQuestionnaireTemplate` Mutation requires an argument of type `DeleteQuestionnaireTemplateVariables`: - const deleteQuestionnaireTemplateVars: DeleteQuestionnaireTemplateVariables = { - id: ..., - }; - mutation.mutate(deleteQuestionnaireTemplateVars); - // Variables can be defined inline as well. - mutation.mutate({ id: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(deleteQuestionnaireTemplateVars, options); - - // Then, you can render your component dynamically based on the status of the Mutation. - if (mutation.isPending) { - return
Loading...
; - } - - if (mutation.isError) { - return
Error: {mutation.error.message}
; - } - - // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. - if (mutation.isSuccess) { - console.log(mutation.data.questionnaireTemplateQuestion_deleteMany); - console.log(mutation.data.questionnaireTemplate_delete); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## CreateProjectQuestionnaire -You can execute the `CreateProjectQuestionnaire` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts)): -```javascript -useCreateProjectQuestionnaire(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useCreateProjectQuestionnaire(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `CreateProjectQuestionnaire` Mutation requires an argument of type `CreateProjectQuestionnaireVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface CreateProjectQuestionnaireVariables { - id: UUIDString; - projectId: UUIDString; - sourceTemplateId?: UUIDString | null; -} -``` -### Return Type -Recall that calling the `CreateProjectQuestionnaire` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. - -To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. - -To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. - -To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateProjectQuestionnaire` Mutation is of type `CreateProjectQuestionnaireData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface CreateProjectQuestionnaireData { - projectQuestionnaire_insert: ProjectQuestionnaire_Key; -} -``` - -To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). - -### Using `CreateProjectQuestionnaire`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, CreateProjectQuestionnaireVariables } from '@generated/questionnaires-data-connector-web'; -import { useCreateProjectQuestionnaire } from '@generated/questionnaires-data-connector-web/react' - -export default function CreateProjectQuestionnaireComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useCreateProjectQuestionnaire(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useCreateProjectQuestionnaire(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateProjectQuestionnaire(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateProjectQuestionnaire(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useCreateProjectQuestionnaire` Mutation requires an argument of type `CreateProjectQuestionnaireVariables`: - const createProjectQuestionnaireVars: CreateProjectQuestionnaireVariables = { - id: ..., - projectId: ..., - sourceTemplateId: ..., // optional - }; - mutation.mutate(createProjectQuestionnaireVars); - // Variables can be defined inline as well. - mutation.mutate({ id: ..., projectId: ..., sourceTemplateId: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(createProjectQuestionnaireVars, options); - - // Then, you can render your component dynamically based on the status of the Mutation. - if (mutation.isPending) { - return
Loading...
; - } - - if (mutation.isError) { - return
Error: {mutation.error.message}
; - } - - // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. - if (mutation.isSuccess) { - console.log(mutation.data.projectQuestionnaire_insert); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## CreateProjectQuestionnaireAnswer -You can execute the `CreateProjectQuestionnaireAnswer` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [questionnaires-data-connector-web/react/index.d.ts](./index.d.ts)): -```javascript -useCreateProjectQuestionnaireAnswer(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useCreateProjectQuestionnaireAnswer(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `CreateProjectQuestionnaireAnswer` Mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface CreateProjectQuestionnaireAnswerVariables { - id: UUIDString; - projectQuestionnaireId: UUIDString; - questionId: UUIDString; - position: number; - answer?: string | null; -} -``` -### Return Type -Recall that calling the `CreateProjectQuestionnaireAnswer` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things. - -To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields. - -To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation. - -To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `CreateProjectQuestionnaireAnswer` Mutation is of type `CreateProjectQuestionnaireAnswerData`, which is defined in [questionnaires-data-connector-web/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface CreateProjectQuestionnaireAnswerData { - projectQuestionnaireAnswer_insert: ProjectQuestionnaireAnswer_Key; -} -``` - -To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation). - -### Using `CreateProjectQuestionnaireAnswer`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, CreateProjectQuestionnaireAnswerVariables } from '@generated/questionnaires-data-connector-web'; -import { useCreateProjectQuestionnaireAnswer } from '@generated/questionnaires-data-connector-web/react' - -export default function CreateProjectQuestionnaireAnswerComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useCreateProjectQuestionnaireAnswer(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useCreateProjectQuestionnaireAnswer(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateProjectQuestionnaireAnswer(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateProjectQuestionnaireAnswer(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useCreateProjectQuestionnaireAnswer` Mutation requires an argument of type `CreateProjectQuestionnaireAnswerVariables`: - const createProjectQuestionnaireAnswerVars: CreateProjectQuestionnaireAnswerVariables = { - id: ..., - projectQuestionnaireId: ..., - questionId: ..., - position: ..., - answer: ..., // optional - }; - mutation.mutate(createProjectQuestionnaireAnswerVars); - // Variables can be defined inline as well. - mutation.mutate({ id: ..., projectQuestionnaireId: ..., questionId: ..., position: ..., answer: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(createProjectQuestionnaireAnswerVars, options); - - // Then, you can render your component dynamically based on the status of the Mutation. - if (mutation.isPending) { - return
Loading...
; - } - - if (mutation.isError) { - return
Error: {mutation.error.message}
; - } - - // If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field. - if (mutation.isSuccess) { - console.log(mutation.data.projectQuestionnaireAnswer_insert); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - diff --git a/generated/questionnaires-data-connector-web/react/esm/index.esm.js b/generated/questionnaires-data-connector-web/react/esm/index.esm.js deleted file mode 100644 index 964d0db..0000000 --- a/generated/questionnaires-data-connector-web/react/esm/index.esm.js +++ /dev/null @@ -1,80 +0,0 @@ -import { createQuestionnaireTemplateRef, createQuestionnaireTemplateQuestionRef, updateQuestionnaireTemplateNameRef, updateQuestionnaireTemplateQuestionRef, deleteQuestionnaireTemplateQuestionRef, deleteQuestionnaireTemplateRef, createProjectQuestionnaireRef, createProjectQuestionnaireAnswerRef, listQuestionnaireTemplatesRef, getQuestionnaireTemplateRef, connectorConfig } from '../../esm/index.esm.js'; -import { validateArgs, CallerSdkTypeEnum } from 'firebase/data-connect'; -import { useDataConnectQuery, useDataConnectMutation, validateReactArgs } from '@tanstack-query-firebase/react/data-connect'; - -export function useCreateQuestionnaireTemplate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createQuestionnaireTemplateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useCreateQuestionnaireTemplateQuestion(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createQuestionnaireTemplateQuestionRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useUpdateQuestionnaireTemplateName(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateQuestionnaireTemplateNameRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useUpdateQuestionnaireTemplateQuestion(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateQuestionnaireTemplateQuestionRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useDeleteQuestionnaireTemplateQuestion(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteQuestionnaireTemplateQuestionRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useDeleteQuestionnaireTemplate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteQuestionnaireTemplateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useCreateProjectQuestionnaire(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createProjectQuestionnaireRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useCreateProjectQuestionnaireAnswer(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createProjectQuestionnaireAnswerRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - - -export function useListQuestionnaireTemplates(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listQuestionnaireTemplatesRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useGetQuestionnaireTemplate(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getQuestionnaireTemplateRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} \ No newline at end of file diff --git a/generated/questionnaires-data-connector-web/react/esm/package.json b/generated/questionnaires-data-connector-web/react/esm/package.json deleted file mode 100644 index 7c34deb..0000000 --- a/generated/questionnaires-data-connector-web/react/esm/package.json +++ /dev/null @@ -1 +0,0 @@ -{"type":"module"} \ No newline at end of file diff --git a/generated/questionnaires-data-connector-web/react/index.cjs.js b/generated/questionnaires-data-connector-web/react/index.cjs.js deleted file mode 100644 index e0b87fc..0000000 --- a/generated/questionnaires-data-connector-web/react/index.cjs.js +++ /dev/null @@ -1,80 +0,0 @@ -const { createQuestionnaireTemplateRef, createQuestionnaireTemplateQuestionRef, updateQuestionnaireTemplateNameRef, updateQuestionnaireTemplateQuestionRef, deleteQuestionnaireTemplateQuestionRef, deleteQuestionnaireTemplateRef, createProjectQuestionnaireRef, createProjectQuestionnaireAnswerRef, listQuestionnaireTemplatesRef, getQuestionnaireTemplateRef, connectorConfig } = require('../index.cjs.js'); -const { validateArgs, CallerSdkTypeEnum } = require('firebase/data-connect'); -const { useDataConnectQuery, useDataConnectMutation, validateReactArgs } = require('@tanstack-query-firebase/react/data-connect'); - -exports.useCreateQuestionnaireTemplate = function useCreateQuestionnaireTemplate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createQuestionnaireTemplateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useCreateQuestionnaireTemplateQuestion = function useCreateQuestionnaireTemplateQuestion(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createQuestionnaireTemplateQuestionRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useUpdateQuestionnaireTemplateName = function useUpdateQuestionnaireTemplateName(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateQuestionnaireTemplateNameRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useUpdateQuestionnaireTemplateQuestion = function useUpdateQuestionnaireTemplateQuestion(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateQuestionnaireTemplateQuestionRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useDeleteQuestionnaireTemplateQuestion = function useDeleteQuestionnaireTemplateQuestion(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteQuestionnaireTemplateQuestionRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useDeleteQuestionnaireTemplate = function useDeleteQuestionnaireTemplate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteQuestionnaireTemplateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useCreateProjectQuestionnaire = function useCreateProjectQuestionnaire(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createProjectQuestionnaireRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useCreateProjectQuestionnaireAnswer = function useCreateProjectQuestionnaireAnswer(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createProjectQuestionnaireAnswerRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - - -exports.useListQuestionnaireTemplates = function useListQuestionnaireTemplates(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listQuestionnaireTemplatesRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useGetQuestionnaireTemplate = function useGetQuestionnaireTemplate(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getQuestionnaireTemplateRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} \ No newline at end of file diff --git a/generated/questionnaires-data-connector-web/react/index.d.ts b/generated/questionnaires-data-connector-web/react/index.d.ts deleted file mode 100644 index f806b12..0000000 --- a/generated/questionnaires-data-connector-web/react/index.d.ts +++ /dev/null @@ -1,36 +0,0 @@ -import { CreateQuestionnaireTemplateData, CreateQuestionnaireTemplateVariables, CreateQuestionnaireTemplateQuestionData, CreateQuestionnaireTemplateQuestionVariables, UpdateQuestionnaireTemplateNameData, UpdateQuestionnaireTemplateNameVariables, UpdateQuestionnaireTemplateQuestionData, UpdateQuestionnaireTemplateQuestionVariables, DeleteQuestionnaireTemplateQuestionData, DeleteQuestionnaireTemplateQuestionVariables, DeleteQuestionnaireTemplateData, DeleteQuestionnaireTemplateVariables, CreateProjectQuestionnaireData, CreateProjectQuestionnaireVariables, CreateProjectQuestionnaireAnswerData, CreateProjectQuestionnaireAnswerVariables, ListQuestionnaireTemplatesData, GetQuestionnaireTemplateData, GetQuestionnaireTemplateVariables } from '../'; -import { UseDataConnectQueryResult, useDataConnectQueryOptions, UseDataConnectMutationResult, useDataConnectMutationOptions} from '@tanstack-query-firebase/react/data-connect'; -import { UseQueryResult, UseMutationResult} from '@tanstack/react-query'; -import { DataConnect } from 'firebase/data-connect'; -import { FirebaseError } from 'firebase/app'; - - -export function useCreateQuestionnaireTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateQuestionnaireTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useCreateQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useUpdateQuestionnaireTemplateName(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useUpdateQuestionnaireTemplateName(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useUpdateQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useUpdateQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useDeleteQuestionnaireTemplateQuestion(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useDeleteQuestionnaireTemplateQuestion(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useDeleteQuestionnaireTemplate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useDeleteQuestionnaireTemplate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useCreateProjectQuestionnaire(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateProjectQuestionnaire(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useCreateProjectQuestionnaireAnswer(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateProjectQuestionnaireAnswer(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useListQuestionnaireTemplates(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useListQuestionnaireTemplates(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useGetQuestionnaireTemplate(vars: GetQuestionnaireTemplateVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useGetQuestionnaireTemplate(dc: DataConnect, vars: GetQuestionnaireTemplateVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; diff --git a/libraries/plaster-calculator-ui/package.json b/libraries/plaster-calculator-ui/package.json index 7c5d63d..d712048 100644 --- a/libraries/plaster-calculator-ui/package.json +++ b/libraries/plaster-calculator-ui/package.json @@ -10,7 +10,7 @@ "build": "tsc --build tsconfig.build.json" }, "dependencies": { - "@generated/questionnaires-data-connector-web": "workspace:*", + "@generated/data-connector-web": "workspace:*", "@libraries/plaster-calculator-common": "workspace:*", "@libraries/uikit-web": "workspace:*", "@tanstack-query-firebase/react": "^2.0.0", diff --git a/libraries/plaster-calculator-ui/src/questionnaires/edit-questionnaire-template-drawer/edit-questionnaire-template-drawer.component.tsx b/libraries/plaster-calculator-ui/src/questionnaires/edit-questionnaire-template-drawer/edit-questionnaire-template-drawer.component.tsx index a1ba8f6..8d77540 100644 --- a/libraries/plaster-calculator-ui/src/questionnaires/edit-questionnaire-template-drawer/edit-questionnaire-template-drawer.component.tsx +++ b/libraries/plaster-calculator-ui/src/questionnaires/edit-questionnaire-template-drawer/edit-questionnaire-template-drawer.component.tsx @@ -4,11 +4,11 @@ import { useId, useMemo } from "react"; import { QuestionnaireTemplateForm } from "../questionnaire-template-form/index.ts"; import type { QuestionnaireTemplateFormValues } from "../questionnaire-template-form/index.ts"; -import type { GetQuestionnaireTemplateData } from "@generated/questionnaires-data-connector-web"; +import type * as DataConnector from "@generated/data-connector-web"; import type { ReactElement } from "react"; export type QuestionnaireTemplateDetails = NonNullable< - GetQuestionnaireTemplateData["questionnaireTemplate"] + DataConnector.GetQuestionnaireTemplateData["questionnaireTemplate"] >; export interface EditQuestionnaireTemplateDrawerProps { diff --git a/libraries/plaster-calculator-ui/src/questionnaires/questionnaire-template-card/questionnaire-template-card.component.tsx b/libraries/plaster-calculator-ui/src/questionnaires/questionnaire-template-card/questionnaire-template-card.component.tsx index 6f7847a..4fdfd2f 100644 --- a/libraries/plaster-calculator-ui/src/questionnaires/questionnaire-template-card/questionnaire-template-card.component.tsx +++ b/libraries/plaster-calculator-ui/src/questionnaires/questionnaire-template-card/questionnaire-template-card.component.tsx @@ -2,11 +2,11 @@ import { formatRelativeTime } from "@libraries/plaster-calculator-common"; import { Box, Button, Card, IconTile, Text } from "@libraries/uikit-web"; import { ClipboardList, Copy, Pencil, Trash2 } from "lucide-react"; -import type { ListQuestionnaireTemplatesData } from "@generated/questionnaires-data-connector-web"; +import type * as DataConnector from "@generated/data-connector-web"; import type { ReactElement } from "react"; export type QuestionnaireTemplate = - ListQuestionnaireTemplatesData["questionnaireTemplates"][number]; + DataConnector.ListQuestionnaireTemplatesData["questionnaireTemplates"][number]; export interface QuestionnaireTemplateCardProps { readonly template: QuestionnaireTemplate; diff --git a/libraries/plaster-calculator-web-core/package.json b/libraries/plaster-calculator-web-core/package.json index 8cd1d22..a240617 100644 --- a/libraries/plaster-calculator-web-core/package.json +++ b/libraries/plaster-calculator-web-core/package.json @@ -10,7 +10,7 @@ "build": "tsc --build tsconfig.build.json" }, "dependencies": { - "@generated/questionnaires-data-connector-web": "workspace:*", + "@generated/data-connector-web": "workspace:*", "@libraries/plaster-calculator-common": "workspace:*" }, "devDependencies": { diff --git a/libraries/plaster-calculator-web-core/src/firebase/firebase.service.ts b/libraries/plaster-calculator-web-core/src/firebase/firebase.service.ts index 39fb126..e7a204a 100644 --- a/libraries/plaster-calculator-web-core/src/firebase/firebase.service.ts +++ b/libraries/plaster-calculator-web-core/src/firebase/firebase.service.ts @@ -1,4 +1,4 @@ -import { connectorConfig as questionnairesConnectorConfig } from "@generated/questionnaires-data-connector-web"; +import * as DataConnector from "@generated/data-connector-web"; import { getApps, initializeApp, type FirebaseApp } from "firebase/app"; import { connectAuthEmulator, getAuth } from "firebase/auth"; import { @@ -57,7 +57,7 @@ export class FirebaseService { ); connectStorageEmulator(FirebaseService.getStorage(), "127.0.0.1", 9199); connectDataConnectEmulator( - FirebaseService.getDataConnect(questionnairesConnectorConfig), + FirebaseService.getDataConnect(DataConnector.connectorConfig), "127.0.0.1", 9399, ); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 30f5f7f..ea04b2e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -112,9 +112,9 @@ importers: apps/plaster-calculator-web: dependencies: - '@generated/questionnaires-data-connector-web': + '@generated/data-connector-web': specifier: workspace:* - version: link:../../generated/questionnaires-data-connector-web + version: link:../../generated/data-connector-web '@libraries/plaster-calculator-common': specifier: workspace:* version: link:../../libraries/plaster-calculator-common @@ -182,9 +182,9 @@ importers: apps/storybook-web: dependencies: - '@generated/questionnaires-data-connector-web': + '@generated/data-connector-web': specifier: workspace:* - version: link:../../generated/questionnaires-data-connector-web + version: link:../../generated/data-connector-web '@libraries/plaster-calculator-common': specifier: workspace:* version: link:../../libraries/plaster-calculator-common @@ -249,12 +249,9 @@ importers: functions/plaster-calculator-functions: dependencies: - '@generated/accounts-data-connector-admin': + '@generated/data-connector-admin': specifier: workspace:* - version: link:../../generated/accounts-data-connector-admin - '@generated/example-data-connector': - specifier: workspace:* - version: link:../../generated/example-data-connector + version: link:../../generated/data-connector-admin firebase-admin: specifier: ^13.10.0 version: 13.10.0 @@ -281,25 +278,13 @@ importers: specifier: ^6.0.3 version: 6.0.3 - generated/accounts-data-connector-admin: - dependencies: - firebase-admin: - specifier: ^13.4.0 - version: 13.10.0 - - generated/example-data-connector: - dependencies: - firebase-admin: - specifier: ^13.4.0 - version: 13.10.0 - - generated/questionnaires-data-connector-admin: + generated/data-connector-admin: dependencies: firebase-admin: specifier: ^13.4.0 version: 13.10.0 - generated/questionnaires-data-connector-web: + generated/data-connector-web: dependencies: '@tanstack-query-firebase/react': specifier: ^2.0.0 @@ -335,9 +320,9 @@ importers: libraries/plaster-calculator-ui: dependencies: - '@generated/questionnaires-data-connector-web': + '@generated/data-connector-web': specifier: workspace:* - version: link:../../generated/questionnaires-data-connector-web + version: link:../../generated/data-connector-web '@libraries/plaster-calculator-common': specifier: workspace:* version: link:../plaster-calculator-common @@ -372,9 +357,9 @@ importers: libraries/plaster-calculator-web-core: dependencies: - '@generated/questionnaires-data-connector-web': + '@generated/data-connector-web': specifier: workspace:* - version: link:../../generated/questionnaires-data-connector-web + version: link:../../generated/data-connector-web '@libraries/plaster-calculator-common': specifier: workspace:* version: link:../plaster-calculator-common