From 846d2edd53ae9138eef3710e6bee2d99cee3d2fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Salazar?= <73718835+joshrs23@users.noreply.github.com> Date: Tue, 25 Nov 2025 13:23:42 -0500 Subject: [PATCH 1/3] new vendorDefaultSettings entity --- .../vendorDefaultSettings/mutations.gql | 35 +++++++++++++++++ .../vendorDefaultSettings/queries.gql | 38 +++++++++++++++++++ dataconnect/schema/vendorDefaultSettings.gql | 9 +++++ 3 files changed, 82 insertions(+) create mode 100644 dataconnect/connector/vendorDefaultSettings/mutations.gql create mode 100644 dataconnect/connector/vendorDefaultSettings/queries.gql create mode 100644 dataconnect/schema/vendorDefaultSettings.gql diff --git a/dataconnect/connector/vendorDefaultSettings/mutations.gql b/dataconnect/connector/vendorDefaultSettings/mutations.gql new file mode 100644 index 00000000..92763bd4 --- /dev/null +++ b/dataconnect/connector/vendorDefaultSettings/mutations.gql @@ -0,0 +1,35 @@ +mutation CreateVendorDefaultSettings( + $vendorName: String!, + $defaultMarkupPercentage: Float!, + $defaultVendorFeePercentage: Float! +) @auth(level: USER) { + vendorDefaultSettings_insert( + data: { + vendorName: $vendorName + defaultMarkupPercentage: $defaultMarkupPercentage + defaultVendorFeePercentage: $defaultVendorFeePercentage + } + ) +} + +mutation UpdateVendorDefaultSettings( + $id: UUID!, + $vendorName: String, + $defaultMarkupPercentage: Float, + $defaultVendorFeePercentage: Float +) @auth(level: USER) { + vendorDefaultSettings_update( + id: $id, + data: { + vendorName: $vendorName + defaultMarkupPercentage: $defaultMarkupPercentage + defaultVendorFeePercentage: $defaultVendorFeePercentage + } + ) +} + +mutation DeleteVendorDefaultSettings( + $id: UUID! +) @auth(level: USER) { + vendorDefaultSettings_delete(id: $id) +} diff --git a/dataconnect/connector/vendorDefaultSettings/queries.gql b/dataconnect/connector/vendorDefaultSettings/queries.gql new file mode 100644 index 00000000..be01706a --- /dev/null +++ b/dataconnect/connector/vendorDefaultSettings/queries.gql @@ -0,0 +1,38 @@ +query listVendorDefaultSettings @auth(level: USER) { + vendorDefaultSettings { + id + vendorName + defaultMarkupPercentage + defaultVendorFeePercentage + } +} + +query getVendorDefaultSettingsById( + $id: UUID! +) @auth(level: USER) { + vendorDefaultSettings(id: $id) { + id + vendorName + defaultMarkupPercentage + defaultVendorFeePercentage + } +} + +query filterVendorDefaultSettings( + $vendorName: String, + $defaultMarkupPercentage: Float, + $defaultVendorFeePercentage: Float +) @auth(level: USER) { + vendorDefaultSettings( + where: { + vendorName: { eq: $vendorName } + defaultMarkupPercentage: { eq: $defaultMarkupPercentage } + defaultVendorFeePercentage: { eq: $defaultVendorFeePercentage } + } + ) { + id + vendorName + defaultMarkupPercentage + defaultVendorFeePercentage + } +} diff --git a/dataconnect/schema/vendorDefaultSettings.gql b/dataconnect/schema/vendorDefaultSettings.gql new file mode 100644 index 00000000..c88269fd --- /dev/null +++ b/dataconnect/schema/vendorDefaultSettings.gql @@ -0,0 +1,9 @@ +type VendorDefaultSettings @table(name: "vendor_default_settings") { + id: UUID! @default(expr: "uuidV4()") + vendorName: String! + defaultMarkupPercentage: Float! + defaultVendorFeePercentage: Float! + createdDate: Timestamp @default(expr: "request.time") + updatedDate: Timestamp @default(expr: "request.time") + createdBy: String @default(expr: "auth.uid") +} From 146a43847daaf9d7544b8a8e578ca8cffc89d1c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Salazar?= <73718835+joshrs23@users.noreply.github.com> Date: Tue, 25 Nov 2025 13:47:59 -0500 Subject: [PATCH 2/3] changing name of variable of table, dataconnect need singular but table plural --- .../connector/vendorDefaultSettings/mutations.gql | 12 ++++++------ .../connector/vendorDefaultSettings/queries.gql | 4 ++-- dataconnect/schema/vendorDefaultSettings.gql | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/dataconnect/connector/vendorDefaultSettings/mutations.gql b/dataconnect/connector/vendorDefaultSettings/mutations.gql index 92763bd4..79289ede 100644 --- a/dataconnect/connector/vendorDefaultSettings/mutations.gql +++ b/dataconnect/connector/vendorDefaultSettings/mutations.gql @@ -1,9 +1,9 @@ -mutation CreateVendorDefaultSettings( +mutation CreateVendorDefaultSetting( $vendorName: String!, $defaultMarkupPercentage: Float!, $defaultVendorFeePercentage: Float! ) @auth(level: USER) { - vendorDefaultSettings_insert( + vendorDefaultSetting_insert( data: { vendorName: $vendorName defaultMarkupPercentage: $defaultMarkupPercentage @@ -12,13 +12,13 @@ mutation CreateVendorDefaultSettings( ) } -mutation UpdateVendorDefaultSettings( +mutation UpdateVendorDefaultSetting( $id: UUID!, $vendorName: String, $defaultMarkupPercentage: Float, $defaultVendorFeePercentage: Float ) @auth(level: USER) { - vendorDefaultSettings_update( + vendorDefaultSetting_update( id: $id, data: { vendorName: $vendorName @@ -28,8 +28,8 @@ mutation UpdateVendorDefaultSettings( ) } -mutation DeleteVendorDefaultSettings( +mutation DeleteVendorDefaultSetting( $id: UUID! ) @auth(level: USER) { - vendorDefaultSettings_delete(id: $id) + vendorDefaultSetting_delete(id: $id) } diff --git a/dataconnect/connector/vendorDefaultSettings/queries.gql b/dataconnect/connector/vendorDefaultSettings/queries.gql index be01706a..7407d306 100644 --- a/dataconnect/connector/vendorDefaultSettings/queries.gql +++ b/dataconnect/connector/vendorDefaultSettings/queries.gql @@ -7,10 +7,10 @@ query listVendorDefaultSettings @auth(level: USER) { } } -query getVendorDefaultSettingsById( +query getVendorDefaultSettingById( $id: UUID! ) @auth(level: USER) { - vendorDefaultSettings(id: $id) { + vendorDefaultSetting(id: $id) { id vendorName defaultMarkupPercentage diff --git a/dataconnect/schema/vendorDefaultSettings.gql b/dataconnect/schema/vendorDefaultSettings.gql index c88269fd..3ced1140 100644 --- a/dataconnect/schema/vendorDefaultSettings.gql +++ b/dataconnect/schema/vendorDefaultSettings.gql @@ -1,4 +1,4 @@ -type VendorDefaultSettings @table(name: "vendor_default_settings") { +type VendorDefaultSetting @table(name: "vendor_default_settings") { id: UUID! @default(expr: "uuidV4()") vendorName: String! defaultMarkupPercentage: Float! From d028f1567b6c84fd723ba20fa020ecc62b17d9ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Salazar?= <73718835+joshrs23@users.noreply.github.com> Date: Tue, 25 Nov 2025 13:48:28 -0500 Subject: [PATCH 3/3] new schema crud of vendorDefaultSettings --- .../dataconnect-generated/.guides/usage.md | 40 +- .../src/dataconnect-generated/README.md | 2086 +++++++++++------ .../dataconnect-generated/esm/index.esm.js | 208 +- .../src/dataconnect-generated/index.cjs.js | 228 +- .../src/dataconnect-generated/index.d.ts | 299 ++- .../src/dataconnect-generated/react/README.md | 1628 ++++++++----- .../react/esm/index.esm.js | 120 +- .../dataconnect-generated/react/index.cjs.js | 120 +- .../dataconnect-generated/react/index.d.ts | 60 +- .../dataconnect-generated/.guides/usage.md | 40 +- .../src/dataconnect-generated/README.md | 2086 +++++++++++------ .../dataconnect-generated/esm/index.esm.js | 208 +- .../src/dataconnect-generated/index.cjs.js | 228 +- .../src/dataconnect-generated/index.d.ts | 299 ++- .../src/dataconnect-generated/react/README.md | 1628 ++++++++----- .../react/esm/index.esm.js | 120 +- .../dataconnect-generated/react/index.cjs.js | 120 +- .../dataconnect-generated/react/index.d.ts | 60 +- 18 files changed, 6410 insertions(+), 3168 deletions(-) diff --git a/frontend-web/src/dataconnect-generated/.guides/usage.md b/frontend-web/src/dataconnect-generated/.guides/usage.md index 98ae3760..d83b82a0 100644 --- a/frontend-web/src/dataconnect-generated/.guides/usage.md +++ b/frontend-web/src/dataconnect-generated/.guides/usage.md @@ -12,28 +12,28 @@ For each operation, there is a wrapper hook that can be used to call the operati Here are all of the hooks that get generated: ```ts -import { useCreateVendor, useUpdateVendor, useDeleteVendor, useListVendor, useGetVendorById, useFilterVendors, useCreateVendorRate, useUpdateVendorRate, useDeleteVendorRate, useListVendorRate } from '@dataconnect/generated/react'; +import { useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useCreateVendorRate, useUpdateVendorRate, useDeleteVendorRate, useCreateEvent, useUpdateEvent, useDeleteEvent } from '@dataconnect/generated/react'; // The types of these hooks are available in react/index.d.ts +const { data, isPending, isSuccess, isError, error } = useListStaff(); + const { data, isPending, isSuccess, isError, error } = useCreateVendor(createVendorVars); const { data, isPending, isSuccess, isError, error } = useUpdateVendor(updateVendorVars); const { data, isPending, isSuccess, isError, error } = useDeleteVendor(deleteVendorVars); -const { data, isPending, isSuccess, isError, error } = useListVendor(); - -const { data, isPending, isSuccess, isError, error } = useGetVendorById(getVendorByIdVars); - -const { data, isPending, isSuccess, isError, error } = useFilterVendors(filterVendorsVars); - const { data, isPending, isSuccess, isError, error } = useCreateVendorRate(createVendorRateVars); const { data, isPending, isSuccess, isError, error } = useUpdateVendorRate(updateVendorRateVars); const { data, isPending, isSuccess, isError, error } = useDeleteVendorRate(deleteVendorRateVars); -const { data, isPending, isSuccess, isError, error } = useListVendorRate(); +const { data, isPending, isSuccess, isError, error } = useCreateEvent(createEventVars); + +const { data, isPending, isSuccess, isError, error } = useUpdateEvent(updateEventVars); + +const { data, isPending, isSuccess, isError, error } = useDeleteEvent(deleteEventVars); ``` @@ -72,9 +72,12 @@ If a user is not using a supported framework, they can use the generated SDK dir Here's an example of how to use it with the first 5 operations: ```js -import { createVendor, updateVendor, deleteVendor, listVendor, getVendorById, filterVendors, createVendorRate, updateVendorRate, deleteVendorRate, listVendorRate } from '@dataconnect/generated'; +import { listStaff, createVendor, updateVendor, deleteVendor, createVendorRate, updateVendorRate, deleteVendorRate, createEvent, updateEvent, deleteEvent } from '@dataconnect/generated'; +// Operation listStaff: +const { data } = await ListStaff(dataConnect); + // Operation CreateVendor: For variables, look at type CreateVendorVars in ../index.d.ts const { data } = await CreateVendor(dataConnect, createVendorVars); @@ -84,15 +87,6 @@ const { data } = await UpdateVendor(dataConnect, updateVendorVars); // Operation DeleteVendor: For variables, look at type DeleteVendorVars in ../index.d.ts const { data } = await DeleteVendor(dataConnect, deleteVendorVars); -// Operation listVendor: -const { data } = await ListVendor(dataConnect); - -// Operation getVendorById: For variables, look at type GetVendorByIdVars in ../index.d.ts -const { data } = await GetVendorById(dataConnect, getVendorByIdVars); - -// Operation filterVendors: For variables, look at type FilterVendorsVars in ../index.d.ts -const { data } = await FilterVendors(dataConnect, filterVendorsVars); - // Operation CreateVendorRate: For variables, look at type CreateVendorRateVars in ../index.d.ts const { data } = await CreateVendorRate(dataConnect, createVendorRateVars); @@ -102,8 +96,14 @@ const { data } = await UpdateVendorRate(dataConnect, updateVendorRateVars); // Operation DeleteVendorRate: For variables, look at type DeleteVendorRateVars in ../index.d.ts const { data } = await DeleteVendorRate(dataConnect, deleteVendorRateVars); -// Operation listVendorRate: -const { data } = await ListVendorRate(dataConnect); +// Operation CreateEvent: For variables, look at type CreateEventVars in ../index.d.ts +const { data } = await CreateEvent(dataConnect, createEventVars); + +// Operation UpdateEvent: For variables, look at type UpdateEventVars in ../index.d.ts +const { data } = await UpdateEvent(dataConnect, updateEventVars); + +// Operation DeleteEvent: For variables, look at type DeleteEventVars in ../index.d.ts +const { data } = await DeleteEvent(dataConnect, deleteEventVars); ``` \ No newline at end of file diff --git a/frontend-web/src/dataconnect-generated/README.md b/frontend-web/src/dataconnect-generated/README.md index 66a2306d..705808e2 100644 --- a/frontend-web/src/dataconnect-generated/README.md +++ b/frontend-web/src/dataconnect-generated/README.md @@ -10,16 +10,19 @@ This README will guide you through the process of using the generated JavaScript - [**Accessing the connector**](#accessing-the-connector) - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) - [**Queries**](#queries) - - [*listVendor*](#listvendor) - - [*getVendorById*](#getvendorbyid) - - [*filterVendors*](#filtervendors) - - [*listVendorRate*](#listvendorrate) - - [*getVendorRateById*](#getvendorratebyid) - - [*filterVendorRates*](#filtervendorrates) + - [*listStaff*](#liststaff) - [*listEvents*](#listevents) - [*getEventById*](#geteventbyid) - [*filterEvents*](#filterevents) - - [*listStaff*](#liststaff) + - [*listVendor*](#listvendor) + - [*getVendorById*](#getvendorbyid) + - [*filterVendors*](#filtervendors) + - [*listVendorDefaultSettings*](#listvendordefaultsettings) + - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) + - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) + - [*listVendorRate*](#listvendorrate) + - [*getVendorRateById*](#getvendorratebyid) + - [*filterVendorRates*](#filtervendorrates) - [**Mutations**](#mutations) - [*CreateVendor*](#createvendor) - [*UpdateVendor*](#updatevendor) @@ -31,6 +34,9 @@ This README will guide you through the process of using the generated JavaScript - [*UpdateEvent*](#updateevent) - [*DeleteEvent*](#deleteevent) - [*CreateStaff*](#createstaff) + - [*CreateVendorDefaultSetting*](#createvendordefaultsetting) + - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting) + - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting) # Accessing the connector A connector is a collection of Queries and Mutations. One SDK is generated for each connector - this SDK is generated for the connector `krow-connector`. You can find more information about connectors in the [Data Connect documentation](https://firebase.google.com/docs/data-connect#how-does). @@ -77,716 +83,105 @@ The following is true for both the action shortcut function and the `QueryRef` f Below are examples of how to use the `krow-connector` connector's generated functions to execute each query. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#using-queries). -## listVendor -You can execute the `listVendor` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +## listStaff +You can execute the `listStaff` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): ```typescript -listVendor(): QueryPromise; +listStaff(): QueryPromise; -interface ListVendorRef { +interface ListStaffRef { ... /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; + (): QueryRef; } -export const listVendorRef: ListVendorRef; +export const listStaffRef: ListStaffRef; ``` You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. ```typescript -listVendor(dc: DataConnect): QueryPromise; +listStaff(dc: DataConnect): QueryPromise; -interface ListVendorRef { +interface ListStaffRef { ... - (dc: DataConnect): QueryRef; + (dc: DataConnect): QueryRef; } -export const listVendorRef: ListVendorRef; +export const listStaffRef: ListStaffRef; ``` -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRef: +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listStaffRef: ```typescript -const name = listVendorRef.operationName; +const name = listStaffRef.operationName; console.log(name); ``` ### Variables -The `listVendor` query has no variables. +The `listStaff` query has no variables. ### Return Type -Recall that executing the `listVendor` query returns a `QueryPromise` that resolves to an object with a `data` property. +Recall that executing the `listStaff` query returns a `QueryPromise` that resolves to an object with a `data` property. -The `data` property is an object of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +The `data` property is an object of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: ```typescript -export interface ListVendorData { - vendors: ({ +export interface ListStaffData { + staffs: ({ id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_Key)[]; + employeeName: string; + vendorId?: UUIDString | null; + email?: string | null; + position?: string | null; + employmentType: EmploymentType; + rating?: number | null; + reliabilityScore?: number | null; + backgroundCheckStatus: BackgroundCheckStatus; + certifications?: string | null; + } & Staff_Key)[]; } ``` -### Using `listVendor`'s action shortcut function +### Using `listStaff`'s action shortcut function ```typescript import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, listVendor } from '@dataconnect/generated'; +import { connectorConfig, listStaff } from '@dataconnect/generated'; -// Call the `listVendor()` function to execute the query. +// Call the `listStaff()` function to execute the query. // You can use the `await` keyword to wait for the promise to resolve. -const { data } = await listVendor(); +const { data } = await listStaff(); // You can also pass in a `DataConnect` instance to the action shortcut function. const dataConnect = getDataConnect(connectorConfig); -const { data } = await listVendor(dataConnect); +const { data } = await listStaff(dataConnect); -console.log(data.vendors); +console.log(data.staffs); // Or, you can use the `Promise` API. -listVendor().then((response) => { +listStaff().then((response) => { const data = response.data; - console.log(data.vendors); + console.log(data.staffs); }); ``` -### Using `listVendor`'s `QueryRef` function +### Using `listStaff`'s `QueryRef` function ```typescript import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, listVendorRef } from '@dataconnect/generated'; +import { connectorConfig, listStaffRef } from '@dataconnect/generated'; -// Call the `listVendorRef()` function to get a reference to the query. -const ref = listVendorRef(); +// Call the `listStaffRef()` function to get a reference to the query. +const ref = listStaffRef(); // You can also pass in a `DataConnect` instance to the `QueryRef` function. const dataConnect = getDataConnect(connectorConfig); -const ref = listVendorRef(dataConnect); +const ref = listStaffRef(dataConnect); // Call `executeQuery()` on the reference to execute the query. // You can use the `await` keyword to wait for the promise to resolve. const { data } = await executeQuery(ref); -console.log(data.vendors); +console.log(data.staffs); // Or, you can use the `Promise` API. executeQuery(ref).then((response) => { const data = response.data; - console.log(data.vendors); -}); -``` - -## getVendorById -You can execute the `getVendorById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -getVendorById(vars: GetVendorByIdVariables): QueryPromise; - -interface GetVendorByIdRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorByIdVariables): QueryRef; -} -export const getVendorByIdRef: GetVendorByIdRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise; - -interface GetVendorByIdRef { - ... - (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef; -} -export const getVendorByIdRef: GetVendorByIdRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorByIdRef: -```typescript -const name = getVendorByIdRef.operationName; -console.log(name); -``` - -### Variables -The `getVendorById` query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface GetVendorByIdVariables { - id: UUIDString; -} -``` -### Return Type -Recall that executing the `getVendorById` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface GetVendorByIdData { - vendor?: { - id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_Key; -} -``` -### Using `getVendorById`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, getVendorById, GetVendorByIdVariables } from '@dataconnect/generated'; - -// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`: -const getVendorByIdVars: GetVendorByIdVariables = { - id: ..., -}; - -// Call the `getVendorById()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await getVendorById(getVendorByIdVars); -// Variables can be defined inline as well. -const { data } = await getVendorById({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await getVendorById(dataConnect, getVendorByIdVars); - -console.log(data.vendor); - -// Or, you can use the `Promise` API. -getVendorById(getVendorByIdVars).then((response) => { - const data = response.data; - console.log(data.vendor); -}); -``` - -### Using `getVendorById`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, getVendorByIdRef, GetVendorByIdVariables } from '@dataconnect/generated'; - -// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`: -const getVendorByIdVars: GetVendorByIdVariables = { - id: ..., -}; - -// Call the `getVendorByIdRef()` function to get a reference to the query. -const ref = getVendorByIdRef(getVendorByIdVars); -// Variables can be defined inline as well. -const ref = getVendorByIdRef({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = getVendorByIdRef(dataConnect, getVendorByIdVars); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendor); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendor); -}); -``` - -## filterVendors -You can execute the `filterVendors` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -filterVendors(vars?: FilterVendorsVariables): QueryPromise; - -interface FilterVendorsRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorsVariables): QueryRef; -} -export const filterVendorsRef: FilterVendorsRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise; - -interface FilterVendorsRef { - ... - (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef; -} -export const filterVendorsRef: FilterVendorsRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorsRef: -```typescript -const name = filterVendorsRef.operationName; -console.log(name); -``` - -### Variables -The `filterVendors` query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface FilterVendorsVariables { - region?: VendorRegion | null; - approvalStatus?: VendorApprovalStatus | null; - isActive?: boolean | null; - vendorNumber?: string | null; - primaryContactEmail?: string | null; - legalName?: string | null; - platformType?: VendorPlatformType | null; -} -``` -### Return Type -Recall that executing the `filterVendors` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface FilterVendorsData { - vendors: ({ - id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_Key)[]; -} -``` -### Using `filterVendors`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, filterVendors, FilterVendorsVariables } from '@dataconnect/generated'; - -// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`: -const filterVendorsVars: FilterVendorsVariables = { - region: ..., // optional - approvalStatus: ..., // optional - isActive: ..., // optional - vendorNumber: ..., // optional - primaryContactEmail: ..., // optional - legalName: ..., // optional - platformType: ..., // optional -}; - -// Call the `filterVendors()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await filterVendors(filterVendorsVars); -// Variables can be defined inline as well. -const { data } = await filterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); -// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument. -const { data } = await filterVendors(); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await filterVendors(dataConnect, filterVendorsVars); - -console.log(data.vendors); - -// Or, you can use the `Promise` API. -filterVendors(filterVendorsVars).then((response) => { - const data = response.data; - console.log(data.vendors); -}); -``` - -### Using `filterVendors`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, filterVendorsRef, FilterVendorsVariables } from '@dataconnect/generated'; - -// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`: -const filterVendorsVars: FilterVendorsVariables = { - region: ..., // optional - approvalStatus: ..., // optional - isActive: ..., // optional - vendorNumber: ..., // optional - primaryContactEmail: ..., // optional - legalName: ..., // optional - platformType: ..., // optional -}; - -// Call the `filterVendorsRef()` function to get a reference to the query. -const ref = filterVendorsRef(filterVendorsVars); -// Variables can be defined inline as well. -const ref = filterVendorsRef({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); -// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument. -const ref = filterVendorsRef(); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = filterVendorsRef(dataConnect, filterVendorsVars); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendors); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendors); -}); -``` - -## listVendorRate -You can execute the `listVendorRate` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -listVendorRate(): QueryPromise; - -interface ListVendorRateRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; -} -export const listVendorRateRef: ListVendorRateRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -listVendorRate(dc: DataConnect): QueryPromise; - -interface ListVendorRateRef { - ... - (dc: DataConnect): QueryRef; -} -export const listVendorRateRef: ListVendorRateRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRateRef: -```typescript -const name = listVendorRateRef.operationName; -console.log(name); -``` - -### Variables -The `listVendorRate` query has no variables. -### Return Type -Recall that executing the `listVendorRate` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface ListVendorRateData { - vendorRates: ({ - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - } & VendorRate_Key)[]; -} -``` -### Using `listVendorRate`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, listVendorRate } from '@dataconnect/generated'; - - -// Call the `listVendorRate()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await listVendorRate(); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await listVendorRate(dataConnect); - -console.log(data.vendorRates); - -// Or, you can use the `Promise` API. -listVendorRate().then((response) => { - const data = response.data; - console.log(data.vendorRates); -}); -``` - -### Using `listVendorRate`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, listVendorRateRef } from '@dataconnect/generated'; - - -// Call the `listVendorRateRef()` function to get a reference to the query. -const ref = listVendorRateRef(); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = listVendorRateRef(dataConnect); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendorRates); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendorRates); -}); -``` - -## getVendorRateById -You can execute the `getVendorRateById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise; - -interface GetVendorRateByIdRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorRateByIdVariables): QueryRef; -} -export const getVendorRateByIdRef: GetVendorRateByIdRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise; - -interface GetVendorRateByIdRef { - ... - (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef; -} -export const getVendorRateByIdRef: GetVendorRateByIdRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorRateByIdRef: -```typescript -const name = getVendorRateByIdRef.operationName; -console.log(name); -``` - -### Variables -The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface GetVendorRateByIdVariables { - id: UUIDString; -} -``` -### Return Type -Recall that executing the `getVendorRateById` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface GetVendorRateByIdData { - vendorRate?: { - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - createdDate?: TimestampString | null; - updatedDate?: TimestampString | null; - createdBy?: string | null; - } & VendorRate_Key; -} -``` -### Using `getVendorRateById`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, getVendorRateById, GetVendorRateByIdVariables } from '@dataconnect/generated'; - -// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`: -const getVendorRateByIdVars: GetVendorRateByIdVariables = { - id: ..., -}; - -// Call the `getVendorRateById()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await getVendorRateById(getVendorRateByIdVars); -// Variables can be defined inline as well. -const { data } = await getVendorRateById({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await getVendorRateById(dataConnect, getVendorRateByIdVars); - -console.log(data.vendorRate); - -// Or, you can use the `Promise` API. -getVendorRateById(getVendorRateByIdVars).then((response) => { - const data = response.data; - console.log(data.vendorRate); -}); -``` - -### Using `getVendorRateById`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, getVendorRateByIdRef, GetVendorRateByIdVariables } from '@dataconnect/generated'; - -// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`: -const getVendorRateByIdVars: GetVendorRateByIdVariables = { - id: ..., -}; - -// Call the `getVendorRateByIdRef()` function to get a reference to the query. -const ref = getVendorRateByIdRef(getVendorRateByIdVars); -// Variables can be defined inline as well. -const ref = getVendorRateByIdRef({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = getVendorRateByIdRef(dataConnect, getVendorRateByIdVars); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendorRate); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendorRate); -}); -``` - -## filterVendorRates -You can execute the `filterVendorRates` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise; - -interface FilterVendorRatesRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorRatesVariables): QueryRef; -} -export const filterVendorRatesRef: FilterVendorRatesRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise; - -interface FilterVendorRatesRef { - ... - (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef; -} -export const filterVendorRatesRef: FilterVendorRatesRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorRatesRef: -```typescript -const name = filterVendorRatesRef.operationName; -console.log(name); -``` - -### Variables -The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface FilterVendorRatesVariables { - vendorName?: string | null; - category?: VendorRateCategory | null; - roleName?: string | null; - minClientRate?: number | null; - maxClientRate?: number | null; -} -``` -### Return Type -Recall that executing the `filterVendorRates` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface FilterVendorRatesData { - vendorRates: ({ - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - } & VendorRate_Key)[]; -} -``` -### Using `filterVendorRates`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, filterVendorRates, FilterVendorRatesVariables } from '@dataconnect/generated'; - -// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`: -const filterVendorRatesVars: FilterVendorRatesVariables = { - vendorName: ..., // optional - category: ..., // optional - roleName: ..., // optional - minClientRate: ..., // optional - maxClientRate: ..., // optional -}; - -// Call the `filterVendorRates()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await filterVendorRates(filterVendorRatesVars); -// Variables can be defined inline as well. -const { data } = await filterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); -// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument. -const { data } = await filterVendorRates(); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await filterVendorRates(dataConnect, filterVendorRatesVars); - -console.log(data.vendorRates); - -// Or, you can use the `Promise` API. -filterVendorRates(filterVendorRatesVars).then((response) => { - const data = response.data; - console.log(data.vendorRates); -}); -``` - -### Using `filterVendorRates`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, filterVendorRatesRef, FilterVendorRatesVariables } from '@dataconnect/generated'; - -// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`: -const filterVendorRatesVars: FilterVendorRatesVariables = { - vendorName: ..., // optional - category: ..., // optional - roleName: ..., // optional - minClientRate: ..., // optional - maxClientRate: ..., // optional -}; - -// Call the `filterVendorRatesRef()` function to get a reference to the query. -const ref = filterVendorRatesRef(filterVendorRatesVars); -// Variables can be defined inline as well. -const ref = filterVendorRatesRef({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); -// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument. -const ref = filterVendorRatesRef(); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = filterVendorRatesRef(dataConnect, filterVendorRatesVars); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendorRates); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendorRates); + console.log(data.staffs); }); ``` @@ -1244,105 +639,1050 @@ executeQuery(ref).then((response) => { }); ``` -## listStaff -You can execute the `listStaff` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +## listVendor +You can execute the `listVendor` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): ```typescript -listStaff(): QueryPromise; +listVendor(): QueryPromise; -interface ListStaffRef { +interface ListVendorRef { ... /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; + (): QueryRef; } -export const listStaffRef: ListStaffRef; +export const listVendorRef: ListVendorRef; ``` You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. ```typescript -listStaff(dc: DataConnect): QueryPromise; +listVendor(dc: DataConnect): QueryPromise; -interface ListStaffRef { +interface ListVendorRef { ... - (dc: DataConnect): QueryRef; + (dc: DataConnect): QueryRef; } -export const listStaffRef: ListStaffRef; +export const listVendorRef: ListVendorRef; ``` -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listStaffRef: +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRef: ```typescript -const name = listStaffRef.operationName; +const name = listVendorRef.operationName; console.log(name); ``` ### Variables -The `listStaff` query has no variables. +The `listVendor` query has no variables. ### Return Type -Recall that executing the `listStaff` query returns a `QueryPromise` that resolves to an object with a `data` property. +Recall that executing the `listVendor` query returns a `QueryPromise` that resolves to an object with a `data` property. -The `data` property is an object of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +The `data` property is an object of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: ```typescript -export interface ListStaffData { - staffs: ({ +export interface ListVendorData { + vendors: ({ id: UUIDString; - employeeName: string; - vendorId?: UUIDString | null; - email?: string | null; - position?: string | null; - employmentType: EmploymentType; - rating?: number | null; - reliabilityScore?: number | null; - backgroundCheckStatus: BackgroundCheckStatus; - certifications?: string | null; - } & Staff_Key)[]; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_Key)[]; } ``` -### Using `listStaff`'s action shortcut function +### Using `listVendor`'s action shortcut function ```typescript import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, listStaff } from '@dataconnect/generated'; +import { connectorConfig, listVendor } from '@dataconnect/generated'; -// Call the `listStaff()` function to execute the query. +// Call the `listVendor()` function to execute the query. // You can use the `await` keyword to wait for the promise to resolve. -const { data } = await listStaff(); +const { data } = await listVendor(); // You can also pass in a `DataConnect` instance to the action shortcut function. const dataConnect = getDataConnect(connectorConfig); -const { data } = await listStaff(dataConnect); +const { data } = await listVendor(dataConnect); -console.log(data.staffs); +console.log(data.vendors); // Or, you can use the `Promise` API. -listStaff().then((response) => { +listVendor().then((response) => { const data = response.data; - console.log(data.staffs); + console.log(data.vendors); }); ``` -### Using `listStaff`'s `QueryRef` function +### Using `listVendor`'s `QueryRef` function ```typescript import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, listStaffRef } from '@dataconnect/generated'; +import { connectorConfig, listVendorRef } from '@dataconnect/generated'; -// Call the `listStaffRef()` function to get a reference to the query. -const ref = listStaffRef(); +// Call the `listVendorRef()` function to get a reference to the query. +const ref = listVendorRef(); // You can also pass in a `DataConnect` instance to the `QueryRef` function. const dataConnect = getDataConnect(connectorConfig); -const ref = listStaffRef(dataConnect); +const ref = listVendorRef(dataConnect); // Call `executeQuery()` on the reference to execute the query. // You can use the `await` keyword to wait for the promise to resolve. const { data } = await executeQuery(ref); -console.log(data.staffs); +console.log(data.vendors); // Or, you can use the `Promise` API. executeQuery(ref).then((response) => { const data = response.data; - console.log(data.staffs); + console.log(data.vendors); +}); +``` + +## getVendorById +You can execute the `getVendorById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +getVendorById(vars: GetVendorByIdVariables): QueryPromise; + +interface GetVendorByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorByIdVariables): QueryRef; +} +export const getVendorByIdRef: GetVendorByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise; + +interface GetVendorByIdRef { + ... + (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef; +} +export const getVendorByIdRef: GetVendorByIdRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorByIdRef: +```typescript +const name = getVendorByIdRef.operationName; +console.log(name); +``` + +### Variables +The `getVendorById` query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetVendorByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `getVendorById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetVendorByIdData { + vendor?: { + id: UUIDString; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_Key; +} +``` +### Using `getVendorById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getVendorById, GetVendorByIdVariables } from '@dataconnect/generated'; + +// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`: +const getVendorByIdVars: GetVendorByIdVariables = { + id: ..., +}; + +// Call the `getVendorById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getVendorById(getVendorByIdVars); +// Variables can be defined inline as well. +const { data } = await getVendorById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getVendorById(dataConnect, getVendorByIdVars); + +console.log(data.vendor); + +// Or, you can use the `Promise` API. +getVendorById(getVendorByIdVars).then((response) => { + const data = response.data; + console.log(data.vendor); +}); +``` + +### Using `getVendorById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getVendorByIdRef, GetVendorByIdVariables } from '@dataconnect/generated'; + +// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`: +const getVendorByIdVars: GetVendorByIdVariables = { + id: ..., +}; + +// Call the `getVendorByIdRef()` function to get a reference to the query. +const ref = getVendorByIdRef(getVendorByIdVars); +// Variables can be defined inline as well. +const ref = getVendorByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getVendorByIdRef(dataConnect, getVendorByIdVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendor); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendor); +}); +``` + +## filterVendors +You can execute the `filterVendors` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +filterVendors(vars?: FilterVendorsVariables): QueryPromise; + +interface FilterVendorsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorsVariables): QueryRef; +} +export const filterVendorsRef: FilterVendorsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise; + +interface FilterVendorsRef { + ... + (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef; +} +export const filterVendorsRef: FilterVendorsRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorsRef: +```typescript +const name = filterVendorsRef.operationName; +console.log(name); +``` + +### Variables +The `filterVendors` query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface FilterVendorsVariables { + region?: VendorRegion | null; + approvalStatus?: VendorApprovalStatus | null; + isActive?: boolean | null; + vendorNumber?: string | null; + primaryContactEmail?: string | null; + legalName?: string | null; + platformType?: VendorPlatformType | null; +} +``` +### Return Type +Recall that executing the `filterVendors` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface FilterVendorsData { + vendors: ({ + id: UUIDString; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_Key)[]; +} +``` +### Using `filterVendors`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, filterVendors, FilterVendorsVariables } from '@dataconnect/generated'; + +// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`: +const filterVendorsVars: FilterVendorsVariables = { + region: ..., // optional + approvalStatus: ..., // optional + isActive: ..., // optional + vendorNumber: ..., // optional + primaryContactEmail: ..., // optional + legalName: ..., // optional + platformType: ..., // optional +}; + +// Call the `filterVendors()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await filterVendors(filterVendorsVars); +// Variables can be defined inline as well. +const { data } = await filterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument. +const { data } = await filterVendors(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await filterVendors(dataConnect, filterVendorsVars); + +console.log(data.vendors); + +// Or, you can use the `Promise` API. +filterVendors(filterVendorsVars).then((response) => { + const data = response.data; + console.log(data.vendors); +}); +``` + +### Using `filterVendors`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, filterVendorsRef, FilterVendorsVariables } from '@dataconnect/generated'; + +// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`: +const filterVendorsVars: FilterVendorsVariables = { + region: ..., // optional + approvalStatus: ..., // optional + isActive: ..., // optional + vendorNumber: ..., // optional + primaryContactEmail: ..., // optional + legalName: ..., // optional + platformType: ..., // optional +}; + +// Call the `filterVendorsRef()` function to get a reference to the query. +const ref = filterVendorsRef(filterVendorsVars); +// Variables can be defined inline as well. +const ref = filterVendorsRef({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument. +const ref = filterVendorsRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = filterVendorsRef(dataConnect, filterVendorsVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendors); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendors); +}); +``` + +## listVendorDefaultSettings +You can execute the `listVendorDefaultSettings` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +listVendorDefaultSettings(): QueryPromise; + +interface ListVendorDefaultSettingsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (): QueryRef; +} +export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listVendorDefaultSettings(dc: DataConnect): QueryPromise; + +interface ListVendorDefaultSettingsRef { + ... + (dc: DataConnect): QueryRef; +} +export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorDefaultSettingsRef: +```typescript +const name = listVendorDefaultSettingsRef.operationName; +console.log(name); +``` + +### Variables +The `listVendorDefaultSettings` query has no variables. +### Return Type +Recall that executing the `listVendorDefaultSettings` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key)[]; +} +``` +### Using `listVendorDefaultSettings`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listVendorDefaultSettings } from '@dataconnect/generated'; + + +// Call the `listVendorDefaultSettings()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listVendorDefaultSettings(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listVendorDefaultSettings(dataConnect); + +console.log(data.vendorDefaultSettings); + +// Or, you can use the `Promise` API. +listVendorDefaultSettings().then((response) => { + const data = response.data; + console.log(data.vendorDefaultSettings); +}); +``` + +### Using `listVendorDefaultSettings`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listVendorDefaultSettingsRef } from '@dataconnect/generated'; + + +// Call the `listVendorDefaultSettingsRef()` function to get a reference to the query. +const ref = listVendorDefaultSettingsRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listVendorDefaultSettingsRef(dataConnect); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorDefaultSettings); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSettings); +}); +``` + +## getVendorDefaultSettingById +You can execute the `getVendorDefaultSettingById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise; + +interface GetVendorDefaultSettingByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorDefaultSettingByIdVariables): QueryRef; +} +export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise; + +interface GetVendorDefaultSettingByIdRef { + ... + (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef; +} +export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorDefaultSettingByIdRef: +```typescript +const name = getVendorDefaultSettingByIdRef.operationName; +console.log(name); +``` + +### Variables +The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetVendorDefaultSettingByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `getVendorDefaultSettingById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetVendorDefaultSettingByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetVendorDefaultSettingByIdData { + vendorDefaultSetting?: { + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key; +} +``` +### Using `getVendorDefaultSettingById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getVendorDefaultSettingById, GetVendorDefaultSettingByIdVariables } from '@dataconnect/generated'; + +// The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`: +const getVendorDefaultSettingByIdVars: GetVendorDefaultSettingByIdVariables = { + id: ..., +}; + +// Call the `getVendorDefaultSettingById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getVendorDefaultSettingById(getVendorDefaultSettingByIdVars); +// Variables can be defined inline as well. +const { data } = await getVendorDefaultSettingById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars); + +console.log(data.vendorDefaultSetting); + +// Or, you can use the `Promise` API. +getVendorDefaultSettingById(getVendorDefaultSettingByIdVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting); +}); +``` + +### Using `getVendorDefaultSettingById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getVendorDefaultSettingByIdRef, GetVendorDefaultSettingByIdVariables } from '@dataconnect/generated'; + +// The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`: +const getVendorDefaultSettingByIdVars: GetVendorDefaultSettingByIdVariables = { + id: ..., +}; + +// Call the `getVendorDefaultSettingByIdRef()` function to get a reference to the query. +const ref = getVendorDefaultSettingByIdRef(getVendorDefaultSettingByIdVars); +// Variables can be defined inline as well. +const ref = getVendorDefaultSettingByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getVendorDefaultSettingByIdRef(dataConnect, getVendorDefaultSettingByIdVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorDefaultSetting); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting); +}); +``` + +## filterVendorDefaultSettings +You can execute the `filterVendorDefaultSettings` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise; + +interface FilterVendorDefaultSettingsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorDefaultSettingsVariables): QueryRef; +} +export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise; + +interface FilterVendorDefaultSettingsRef { + ... + (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef; +} +export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorDefaultSettingsRef: +```typescript +const name = filterVendorDefaultSettingsRef.operationName; +console.log(name); +``` + +### Variables +The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface FilterVendorDefaultSettingsVariables { + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} +``` +### Return Type +Recall that executing the `filterVendorDefaultSettings` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `FilterVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface FilterVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key)[]; +} +``` +### Using `filterVendorDefaultSettings`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, filterVendorDefaultSettings, FilterVendorDefaultSettingsVariables } from '@dataconnect/generated'; + +// The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`: +const filterVendorDefaultSettingsVars: FilterVendorDefaultSettingsVariables = { + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional +}; + +// Call the `filterVendorDefaultSettings()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await filterVendorDefaultSettings(filterVendorDefaultSettingsVars); +// Variables can be defined inline as well. +const { data } = await filterVendorDefaultSettings({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorDefaultSettingsVariables` argument. +const { data } = await filterVendorDefaultSettings(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await filterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars); + +console.log(data.vendorDefaultSettings); + +// Or, you can use the `Promise` API. +filterVendorDefaultSettings(filterVendorDefaultSettingsVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSettings); +}); +``` + +### Using `filterVendorDefaultSettings`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, filterVendorDefaultSettingsRef, FilterVendorDefaultSettingsVariables } from '@dataconnect/generated'; + +// The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`: +const filterVendorDefaultSettingsVars: FilterVendorDefaultSettingsVariables = { + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional +}; + +// Call the `filterVendorDefaultSettingsRef()` function to get a reference to the query. +const ref = filterVendorDefaultSettingsRef(filterVendorDefaultSettingsVars); +// Variables can be defined inline as well. +const ref = filterVendorDefaultSettingsRef({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorDefaultSettingsVariables` argument. +const ref = filterVendorDefaultSettingsRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = filterVendorDefaultSettingsRef(dataConnect, filterVendorDefaultSettingsVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorDefaultSettings); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSettings); +}); +``` + +## listVendorRate +You can execute the `listVendorRate` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +listVendorRate(): QueryPromise; + +interface ListVendorRateRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (): QueryRef; +} +export const listVendorRateRef: ListVendorRateRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listVendorRate(dc: DataConnect): QueryPromise; + +interface ListVendorRateRef { + ... + (dc: DataConnect): QueryRef; +} +export const listVendorRateRef: ListVendorRateRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRateRef: +```typescript +const name = listVendorRateRef.operationName; +console.log(name); +``` + +### Variables +The `listVendorRate` query has no variables. +### Return Type +Recall that executing the `listVendorRate` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListVendorRateData { + vendorRates: ({ + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + } & VendorRate_Key)[]; +} +``` +### Using `listVendorRate`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listVendorRate } from '@dataconnect/generated'; + + +// Call the `listVendorRate()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listVendorRate(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listVendorRate(dataConnect); + +console.log(data.vendorRates); + +// Or, you can use the `Promise` API. +listVendorRate().then((response) => { + const data = response.data; + console.log(data.vendorRates); +}); +``` + +### Using `listVendorRate`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listVendorRateRef } from '@dataconnect/generated'; + + +// Call the `listVendorRateRef()` function to get a reference to the query. +const ref = listVendorRateRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listVendorRateRef(dataConnect); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorRates); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorRates); +}); +``` + +## getVendorRateById +You can execute the `getVendorRateById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise; + +interface GetVendorRateByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorRateByIdVariables): QueryRef; +} +export const getVendorRateByIdRef: GetVendorRateByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise; + +interface GetVendorRateByIdRef { + ... + (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef; +} +export const getVendorRateByIdRef: GetVendorRateByIdRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorRateByIdRef: +```typescript +const name = getVendorRateByIdRef.operationName; +console.log(name); +``` + +### Variables +The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetVendorRateByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `getVendorRateById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetVendorRateByIdData { + vendorRate?: { + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + createdDate?: TimestampString | null; + updatedDate?: TimestampString | null; + createdBy?: string | null; + } & VendorRate_Key; +} +``` +### Using `getVendorRateById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getVendorRateById, GetVendorRateByIdVariables } from '@dataconnect/generated'; + +// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`: +const getVendorRateByIdVars: GetVendorRateByIdVariables = { + id: ..., +}; + +// Call the `getVendorRateById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getVendorRateById(getVendorRateByIdVars); +// Variables can be defined inline as well. +const { data } = await getVendorRateById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getVendorRateById(dataConnect, getVendorRateByIdVars); + +console.log(data.vendorRate); + +// Or, you can use the `Promise` API. +getVendorRateById(getVendorRateByIdVars).then((response) => { + const data = response.data; + console.log(data.vendorRate); +}); +``` + +### Using `getVendorRateById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getVendorRateByIdRef, GetVendorRateByIdVariables } from '@dataconnect/generated'; + +// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`: +const getVendorRateByIdVars: GetVendorRateByIdVariables = { + id: ..., +}; + +// Call the `getVendorRateByIdRef()` function to get a reference to the query. +const ref = getVendorRateByIdRef(getVendorRateByIdVars); +// Variables can be defined inline as well. +const ref = getVendorRateByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getVendorRateByIdRef(dataConnect, getVendorRateByIdVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorRate); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorRate); +}); +``` + +## filterVendorRates +You can execute the `filterVendorRates` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise; + +interface FilterVendorRatesRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorRatesVariables): QueryRef; +} +export const filterVendorRatesRef: FilterVendorRatesRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise; + +interface FilterVendorRatesRef { + ... + (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef; +} +export const filterVendorRatesRef: FilterVendorRatesRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorRatesRef: +```typescript +const name = filterVendorRatesRef.operationName; +console.log(name); +``` + +### Variables +The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface FilterVendorRatesVariables { + vendorName?: string | null; + category?: VendorRateCategory | null; + roleName?: string | null; + minClientRate?: number | null; + maxClientRate?: number | null; +} +``` +### Return Type +Recall that executing the `filterVendorRates` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface FilterVendorRatesData { + vendorRates: ({ + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + } & VendorRate_Key)[]; +} +``` +### Using `filterVendorRates`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, filterVendorRates, FilterVendorRatesVariables } from '@dataconnect/generated'; + +// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`: +const filterVendorRatesVars: FilterVendorRatesVariables = { + vendorName: ..., // optional + category: ..., // optional + roleName: ..., // optional + minClientRate: ..., // optional + maxClientRate: ..., // optional +}; + +// Call the `filterVendorRates()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await filterVendorRates(filterVendorRatesVars); +// Variables can be defined inline as well. +const { data } = await filterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument. +const { data } = await filterVendorRates(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await filterVendorRates(dataConnect, filterVendorRatesVars); + +console.log(data.vendorRates); + +// Or, you can use the `Promise` API. +filterVendorRates(filterVendorRatesVars).then((response) => { + const data = response.data; + console.log(data.vendorRates); +}); +``` + +### Using `filterVendorRates`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, filterVendorRatesRef, FilterVendorRatesVariables } from '@dataconnect/generated'; + +// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`: +const filterVendorRatesVars: FilterVendorRatesVariables = { + vendorName: ..., // optional + category: ..., // optional + roleName: ..., // optional + minClientRate: ..., // optional + maxClientRate: ..., // optional +}; + +// Call the `filterVendorRatesRef()` function to get a reference to the query. +const ref = filterVendorRatesRef(filterVendorRatesVars); +// Variables can be defined inline as well. +const ref = filterVendorRatesRef({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument. +const ref = filterVendorRatesRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = filterVendorRatesRef(dataConnect, filterVendorRatesVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorRates); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorRates); }); ``` @@ -2754,3 +3094,345 @@ executeMutation(ref).then((response) => { }); ``` +## CreateVendorDefaultSetting +You can execute the `CreateVendorDefaultSetting` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +createVendorDefaultSetting(vars: CreateVendorDefaultSettingVariables): MutationPromise; + +interface CreateVendorDefaultSettingRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateVendorDefaultSettingVariables): MutationRef; +} +export const createVendorDefaultSettingRef: CreateVendorDefaultSettingRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createVendorDefaultSetting(dc: DataConnect, vars: CreateVendorDefaultSettingVariables): MutationPromise; + +interface CreateVendorDefaultSettingRef { + ... + (dc: DataConnect, vars: CreateVendorDefaultSettingVariables): MutationRef; +} +export const createVendorDefaultSettingRef: CreateVendorDefaultSettingRef; +``` + +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 createVendorDefaultSettingRef: +```typescript +const name = createVendorDefaultSettingRef.operationName; +console.log(name); +``` + +### Variables +The `CreateVendorDefaultSetting` mutation requires an argument of type `CreateVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateVendorDefaultSettingVariables { + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; +} +``` +### Return Type +Recall that executing the `CreateVendorDefaultSetting` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateVendorDefaultSettingData { + vendorDefaultSetting_insert: VendorDefaultSetting_Key; +} +``` +### Using `CreateVendorDefaultSetting`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createVendorDefaultSetting, CreateVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `CreateVendorDefaultSetting` mutation requires an argument of type `CreateVendorDefaultSettingVariables`: +const createVendorDefaultSettingVars: CreateVendorDefaultSettingVariables = { + vendorName: ..., + defaultMarkupPercentage: ..., + defaultVendorFeePercentage: ..., +}; + +// Call the `createVendorDefaultSetting()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createVendorDefaultSetting(createVendorDefaultSettingVars); +// Variables can be defined inline as well. +const { data } = await createVendorDefaultSetting({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createVendorDefaultSetting(dataConnect, createVendorDefaultSettingVars); + +console.log(data.vendorDefaultSetting_insert); + +// Or, you can use the `Promise` API. +createVendorDefaultSetting(createVendorDefaultSettingVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_insert); +}); +``` + +### Using `CreateVendorDefaultSetting`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createVendorDefaultSettingRef, CreateVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `CreateVendorDefaultSetting` mutation requires an argument of type `CreateVendorDefaultSettingVariables`: +const createVendorDefaultSettingVars: CreateVendorDefaultSettingVariables = { + vendorName: ..., + defaultMarkupPercentage: ..., + defaultVendorFeePercentage: ..., +}; + +// Call the `createVendorDefaultSettingRef()` function to get a reference to the mutation. +const ref = createVendorDefaultSettingRef(createVendorDefaultSettingVars); +// Variables can be defined inline as well. +const ref = createVendorDefaultSettingRef({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createVendorDefaultSettingRef(dataConnect, createVendorDefaultSettingVars); + +// 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.vendorDefaultSetting_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_insert); +}); +``` + +## UpdateVendorDefaultSetting +You can execute the `UpdateVendorDefaultSetting` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +updateVendorDefaultSetting(vars: UpdateVendorDefaultSettingVariables): MutationPromise; + +interface UpdateVendorDefaultSettingRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateVendorDefaultSettingVariables): MutationRef; +} +export const updateVendorDefaultSettingRef: UpdateVendorDefaultSettingRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateVendorDefaultSetting(dc: DataConnect, vars: UpdateVendorDefaultSettingVariables): MutationPromise; + +interface UpdateVendorDefaultSettingRef { + ... + (dc: DataConnect, vars: UpdateVendorDefaultSettingVariables): MutationRef; +} +export const updateVendorDefaultSettingRef: UpdateVendorDefaultSettingRef; +``` + +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 updateVendorDefaultSettingRef: +```typescript +const name = updateVendorDefaultSettingRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateVendorDefaultSetting` mutation requires an argument of type `UpdateVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateVendorDefaultSettingVariables { + id: UUIDString; + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} +``` +### Return Type +Recall that executing the `UpdateVendorDefaultSetting` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateVendorDefaultSettingData { + vendorDefaultSetting_update?: VendorDefaultSetting_Key | null; +} +``` +### Using `UpdateVendorDefaultSetting`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateVendorDefaultSetting, UpdateVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `UpdateVendorDefaultSetting` mutation requires an argument of type `UpdateVendorDefaultSettingVariables`: +const updateVendorDefaultSettingVars: UpdateVendorDefaultSettingVariables = { + id: ..., + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional +}; + +// Call the `updateVendorDefaultSetting()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateVendorDefaultSetting(updateVendorDefaultSettingVars); +// Variables can be defined inline as well. +const { data } = await updateVendorDefaultSetting({ id: ..., vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateVendorDefaultSetting(dataConnect, updateVendorDefaultSettingVars); + +console.log(data.vendorDefaultSetting_update); + +// Or, you can use the `Promise` API. +updateVendorDefaultSetting(updateVendorDefaultSettingVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_update); +}); +``` + +### Using `UpdateVendorDefaultSetting`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateVendorDefaultSettingRef, UpdateVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `UpdateVendorDefaultSetting` mutation requires an argument of type `UpdateVendorDefaultSettingVariables`: +const updateVendorDefaultSettingVars: UpdateVendorDefaultSettingVariables = { + id: ..., + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional +}; + +// Call the `updateVendorDefaultSettingRef()` function to get a reference to the mutation. +const ref = updateVendorDefaultSettingRef(updateVendorDefaultSettingVars); +// Variables can be defined inline as well. +const ref = updateVendorDefaultSettingRef({ id: ..., vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateVendorDefaultSettingRef(dataConnect, updateVendorDefaultSettingVars); + +// 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.vendorDefaultSetting_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_update); +}); +``` + +## DeleteVendorDefaultSetting +You can execute the `DeleteVendorDefaultSetting` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +deleteVendorDefaultSetting(vars: DeleteVendorDefaultSettingVariables): MutationPromise; + +interface DeleteVendorDefaultSettingRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteVendorDefaultSettingVariables): MutationRef; +} +export const deleteVendorDefaultSettingRef: DeleteVendorDefaultSettingRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteVendorDefaultSetting(dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationPromise; + +interface DeleteVendorDefaultSettingRef { + ... + (dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationRef; +} +export const deleteVendorDefaultSettingRef: DeleteVendorDefaultSettingRef; +``` + +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 deleteVendorDefaultSettingRef: +```typescript +const name = deleteVendorDefaultSettingRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteVendorDefaultSetting` mutation requires an argument of type `DeleteVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteVendorDefaultSettingVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteVendorDefaultSetting` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteVendorDefaultSettingData { + vendorDefaultSetting_delete?: VendorDefaultSetting_Key | null; +} +``` +### Using `DeleteVendorDefaultSetting`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteVendorDefaultSetting, DeleteVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `DeleteVendorDefaultSetting` mutation requires an argument of type `DeleteVendorDefaultSettingVariables`: +const deleteVendorDefaultSettingVars: DeleteVendorDefaultSettingVariables = { + id: ..., +}; + +// Call the `deleteVendorDefaultSetting()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteVendorDefaultSetting(deleteVendorDefaultSettingVars); +// Variables can be defined inline as well. +const { data } = await deleteVendorDefaultSetting({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteVendorDefaultSetting(dataConnect, deleteVendorDefaultSettingVars); + +console.log(data.vendorDefaultSetting_delete); + +// Or, you can use the `Promise` API. +deleteVendorDefaultSetting(deleteVendorDefaultSettingVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_delete); +}); +``` + +### Using `DeleteVendorDefaultSetting`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteVendorDefaultSettingRef, DeleteVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `DeleteVendorDefaultSetting` mutation requires an argument of type `DeleteVendorDefaultSettingVariables`: +const deleteVendorDefaultSettingVars: DeleteVendorDefaultSettingVariables = { + id: ..., +}; + +// Call the `deleteVendorDefaultSettingRef()` function to get a reference to the mutation. +const ref = deleteVendorDefaultSettingRef(deleteVendorDefaultSettingVars); +// Variables can be defined inline as well. +const ref = deleteVendorDefaultSettingRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteVendorDefaultSettingRef(dataConnect, deleteVendorDefaultSettingVars); + +// 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.vendorDefaultSetting_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_delete); +}); +``` + diff --git a/frontend-web/src/dataconnect-generated/esm/index.esm.js b/frontend-web/src/dataconnect-generated/esm/index.esm.js index e8f12f67..5bc51f99 100644 --- a/frontend-web/src/dataconnect-generated/esm/index.esm.js +++ b/frontend-web/src/dataconnect-generated/esm/index.esm.js @@ -80,6 +80,17 @@ export const connectorConfig = { location: 'us-central1' }; +export const listStaffRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listStaff'); +} +listStaffRef.operationName = 'listStaff'; + +export function listStaff(dc) { + return executeQuery(listStaffRef(dc)); +} + export const createVendorRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -113,39 +124,6 @@ export function deleteVendor(dcOrVars, vars) { return executeMutation(deleteVendorRef(dcOrVars, vars)); } -export const listVendorRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listVendor'); -} -listVendorRef.operationName = 'listVendor'; - -export function listVendor(dc) { - return executeQuery(listVendorRef(dc)); -} - -export const getVendorByIdRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorById', inputVars); -} -getVendorByIdRef.operationName = 'getVendorById'; - -export function getVendorById(dcOrVars, vars) { - return executeQuery(getVendorByIdRef(dcOrVars, vars)); -} - -export const filterVendorsRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendors', inputVars); -} -filterVendorsRef.operationName = 'filterVendors'; - -export function filterVendors(dcOrVars, vars) { - return executeQuery(filterVendorsRef(dcOrVars, vars)); -} - export const createVendorRateRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -179,39 +157,6 @@ export function deleteVendorRate(dcOrVars, vars) { return executeMutation(deleteVendorRateRef(dcOrVars, vars)); } -export const listVendorRateRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listVendorRate'); -} -listVendorRateRef.operationName = 'listVendorRate'; - -export function listVendorRate(dc) { - return executeQuery(listVendorRateRef(dc)); -} - -export const getVendorRateByIdRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorRateById', inputVars); -} -getVendorRateByIdRef.operationName = 'getVendorRateById'; - -export function getVendorRateById(dcOrVars, vars) { - return executeQuery(getVendorRateByIdRef(dcOrVars, vars)); -} - -export const filterVendorRatesRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendorRates', inputVars); -} -filterVendorRatesRef.operationName = 'filterVendorRates'; - -export function filterVendorRates(dcOrVars, vars) { - return executeQuery(filterVendorRatesRef(dcOrVars, vars)); -} - export const createEventRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -289,14 +234,135 @@ export function createStaff(dcOrVars, vars) { return executeMutation(createStaffRef(dcOrVars, vars)); } -export const listStaffRef = (dc) => { +export const listVendorRef = (dc) => { const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listStaff'); + return queryRef(dcInstance, 'listVendor'); } -listStaffRef.operationName = 'listStaff'; +listVendorRef.operationName = 'listVendor'; -export function listStaff(dc) { - return executeQuery(listStaffRef(dc)); +export function listVendor(dc) { + return executeQuery(listVendorRef(dc)); +} + +export const getVendorByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorById', inputVars); +} +getVendorByIdRef.operationName = 'getVendorById'; + +export function getVendorById(dcOrVars, vars) { + return executeQuery(getVendorByIdRef(dcOrVars, vars)); +} + +export const filterVendorsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendors', inputVars); +} +filterVendorsRef.operationName = 'filterVendors'; + +export function filterVendors(dcOrVars, vars) { + return executeQuery(filterVendorsRef(dcOrVars, vars)); +} + +export const createVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateVendorDefaultSetting', inputVars); +} +createVendorDefaultSettingRef.operationName = 'CreateVendorDefaultSetting'; + +export function createVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(createVendorDefaultSettingRef(dcOrVars, vars)); +} + +export const updateVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateVendorDefaultSetting', inputVars); +} +updateVendorDefaultSettingRef.operationName = 'UpdateVendorDefaultSetting'; + +export function updateVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(updateVendorDefaultSettingRef(dcOrVars, vars)); +} + +export const deleteVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteVendorDefaultSetting', inputVars); +} +deleteVendorDefaultSettingRef.operationName = 'DeleteVendorDefaultSetting'; + +export function deleteVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(deleteVendorDefaultSettingRef(dcOrVars, vars)); +} + +export const listVendorDefaultSettingsRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listVendorDefaultSettings'); +} +listVendorDefaultSettingsRef.operationName = 'listVendorDefaultSettings'; + +export function listVendorDefaultSettings(dc) { + return executeQuery(listVendorDefaultSettingsRef(dc)); +} + +export const getVendorDefaultSettingByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); +} +getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; + +export function getVendorDefaultSettingById(dcOrVars, vars) { + return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); +} + +export const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); +} +filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; + +export function filterVendorDefaultSettings(dcOrVars, vars) { + return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); +} + +export const listVendorRateRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listVendorRate'); +} +listVendorRateRef.operationName = 'listVendorRate'; + +export function listVendorRate(dc) { + return executeQuery(listVendorRateRef(dc)); +} + +export const getVendorRateByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorRateById', inputVars); +} +getVendorRateByIdRef.operationName = 'getVendorRateById'; + +export function getVendorRateById(dcOrVars, vars) { + return executeQuery(getVendorRateByIdRef(dcOrVars, vars)); +} + +export const filterVendorRatesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendorRates', inputVars); +} +filterVendorRatesRef.operationName = 'filterVendorRates'; + +export function filterVendorRates(dcOrVars, vars) { + return executeQuery(filterVendorRatesRef(dcOrVars, vars)); } diff --git a/frontend-web/src/dataconnect-generated/index.cjs.js b/frontend-web/src/dataconnect-generated/index.cjs.js index 17689443..b132fc8b 100644 --- a/frontend-web/src/dataconnect-generated/index.cjs.js +++ b/frontend-web/src/dataconnect-generated/index.cjs.js @@ -90,6 +90,18 @@ const connectorConfig = { }; exports.connectorConfig = connectorConfig; +const listStaffRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listStaff'); +} +listStaffRef.operationName = 'listStaff'; +exports.listStaffRef = listStaffRef; + +exports.listStaff = function listStaff(dc) { + return executeQuery(listStaffRef(dc)); +}; + const createVendorRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -126,42 +138,6 @@ exports.deleteVendor = function deleteVendor(dcOrVars, vars) { return executeMutation(deleteVendorRef(dcOrVars, vars)); }; -const listVendorRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listVendor'); -} -listVendorRef.operationName = 'listVendor'; -exports.listVendorRef = listVendorRef; - -exports.listVendor = function listVendor(dc) { - return executeQuery(listVendorRef(dc)); -}; - -const getVendorByIdRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorById', inputVars); -} -getVendorByIdRef.operationName = 'getVendorById'; -exports.getVendorByIdRef = getVendorByIdRef; - -exports.getVendorById = function getVendorById(dcOrVars, vars) { - return executeQuery(getVendorByIdRef(dcOrVars, vars)); -}; - -const filterVendorsRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendors', inputVars); -} -filterVendorsRef.operationName = 'filterVendors'; -exports.filterVendorsRef = filterVendorsRef; - -exports.filterVendors = function filterVendors(dcOrVars, vars) { - return executeQuery(filterVendorsRef(dcOrVars, vars)); -}; - const createVendorRateRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -198,42 +174,6 @@ exports.deleteVendorRate = function deleteVendorRate(dcOrVars, vars) { return executeMutation(deleteVendorRateRef(dcOrVars, vars)); }; -const listVendorRateRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listVendorRate'); -} -listVendorRateRef.operationName = 'listVendorRate'; -exports.listVendorRateRef = listVendorRateRef; - -exports.listVendorRate = function listVendorRate(dc) { - return executeQuery(listVendorRateRef(dc)); -}; - -const getVendorRateByIdRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorRateById', inputVars); -} -getVendorRateByIdRef.operationName = 'getVendorRateById'; -exports.getVendorRateByIdRef = getVendorRateByIdRef; - -exports.getVendorRateById = function getVendorRateById(dcOrVars, vars) { - return executeQuery(getVendorRateByIdRef(dcOrVars, vars)); -}; - -const filterVendorRatesRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendorRates', inputVars); -} -filterVendorRatesRef.operationName = 'filterVendorRates'; -exports.filterVendorRatesRef = filterVendorRatesRef; - -exports.filterVendorRates = function filterVendorRates(dcOrVars, vars) { - return executeQuery(filterVendorRatesRef(dcOrVars, vars)); -}; - const createEventRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -318,14 +258,146 @@ exports.createStaff = function createStaff(dcOrVars, vars) { return executeMutation(createStaffRef(dcOrVars, vars)); }; -const listStaffRef = (dc) => { +const listVendorRef = (dc) => { const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listStaff'); + return queryRef(dcInstance, 'listVendor'); } -listStaffRef.operationName = 'listStaff'; -exports.listStaffRef = listStaffRef; +listVendorRef.operationName = 'listVendor'; +exports.listVendorRef = listVendorRef; -exports.listStaff = function listStaff(dc) { - return executeQuery(listStaffRef(dc)); +exports.listVendor = function listVendor(dc) { + return executeQuery(listVendorRef(dc)); +}; + +const getVendorByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorById', inputVars); +} +getVendorByIdRef.operationName = 'getVendorById'; +exports.getVendorByIdRef = getVendorByIdRef; + +exports.getVendorById = function getVendorById(dcOrVars, vars) { + return executeQuery(getVendorByIdRef(dcOrVars, vars)); +}; + +const filterVendorsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendors', inputVars); +} +filterVendorsRef.operationName = 'filterVendors'; +exports.filterVendorsRef = filterVendorsRef; + +exports.filterVendors = function filterVendors(dcOrVars, vars) { + return executeQuery(filterVendorsRef(dcOrVars, vars)); +}; + +const createVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateVendorDefaultSetting', inputVars); +} +createVendorDefaultSettingRef.operationName = 'CreateVendorDefaultSetting'; +exports.createVendorDefaultSettingRef = createVendorDefaultSettingRef; + +exports.createVendorDefaultSetting = function createVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(createVendorDefaultSettingRef(dcOrVars, vars)); +}; + +const updateVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateVendorDefaultSetting', inputVars); +} +updateVendorDefaultSettingRef.operationName = 'UpdateVendorDefaultSetting'; +exports.updateVendorDefaultSettingRef = updateVendorDefaultSettingRef; + +exports.updateVendorDefaultSetting = function updateVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(updateVendorDefaultSettingRef(dcOrVars, vars)); +}; + +const deleteVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteVendorDefaultSetting', inputVars); +} +deleteVendorDefaultSettingRef.operationName = 'DeleteVendorDefaultSetting'; +exports.deleteVendorDefaultSettingRef = deleteVendorDefaultSettingRef; + +exports.deleteVendorDefaultSetting = function deleteVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(deleteVendorDefaultSettingRef(dcOrVars, vars)); +}; + +const listVendorDefaultSettingsRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listVendorDefaultSettings'); +} +listVendorDefaultSettingsRef.operationName = 'listVendorDefaultSettings'; +exports.listVendorDefaultSettingsRef = listVendorDefaultSettingsRef; + +exports.listVendorDefaultSettings = function listVendorDefaultSettings(dc) { + return executeQuery(listVendorDefaultSettingsRef(dc)); +}; + +const getVendorDefaultSettingByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); +} +getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; +exports.getVendorDefaultSettingByIdRef = getVendorDefaultSettingByIdRef; + +exports.getVendorDefaultSettingById = function getVendorDefaultSettingById(dcOrVars, vars) { + return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); +}; + +const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); +} +filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; +exports.filterVendorDefaultSettingsRef = filterVendorDefaultSettingsRef; + +exports.filterVendorDefaultSettings = function filterVendorDefaultSettings(dcOrVars, vars) { + return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); +}; + +const listVendorRateRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listVendorRate'); +} +listVendorRateRef.operationName = 'listVendorRate'; +exports.listVendorRateRef = listVendorRateRef; + +exports.listVendorRate = function listVendorRate(dc) { + return executeQuery(listVendorRateRef(dc)); +}; + +const getVendorRateByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorRateById', inputVars); +} +getVendorRateByIdRef.operationName = 'getVendorRateById'; +exports.getVendorRateByIdRef = getVendorRateByIdRef; + +exports.getVendorRateById = function getVendorRateById(dcOrVars, vars) { + return executeQuery(getVendorRateByIdRef(dcOrVars, vars)); +}; + +const filterVendorRatesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendorRates', inputVars); +} +filterVendorRatesRef.operationName = 'filterVendorRates'; +exports.filterVendorRatesRef = filterVendorRatesRef; + +exports.filterVendorRates = function filterVendorRates(dcOrVars, vars) { + return executeQuery(filterVendorRatesRef(dcOrVars, vars)); }; diff --git a/frontend-web/src/dataconnect-generated/index.d.ts b/frontend-web/src/dataconnect-generated/index.d.ts index fa6cd96a..042cb070 100644 --- a/frontend-web/src/dataconnect-generated/index.d.ts +++ b/frontend-web/src/dataconnect-generated/index.d.ts @@ -145,6 +145,16 @@ export interface CreateVendorData { vendor_insert: Vendor_Key; } +export interface CreateVendorDefaultSettingData { + vendorDefaultSetting_insert: VendorDefaultSetting_Key; +} + +export interface CreateVendorDefaultSettingVariables { + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; +} + export interface CreateVendorRateData { vendorRate_insert: VendorRate_Key; } @@ -181,6 +191,14 @@ export interface DeleteVendorData { vendor_delete?: Vendor_Key | null; } +export interface DeleteVendorDefaultSettingData { + vendorDefaultSetting_delete?: VendorDefaultSetting_Key | null; +} + +export interface DeleteVendorDefaultSettingVariables { + id: UUIDString; +} + export interface DeleteVendorRateData { vendorRate_delete?: VendorRate_Key | null; } @@ -253,6 +271,21 @@ export interface FilterEventsVariables { clientEmail?: string | null; } +export interface FilterVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key)[]; +} + +export interface FilterVendorDefaultSettingsVariables { + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} + export interface FilterVendorRatesData { vendorRates: ({ id: UUIDString; @@ -358,6 +391,19 @@ export interface GetVendorByIdVariables { id: UUIDString; } +export interface GetVendorDefaultSettingByIdData { + vendorDefaultSetting?: { + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key; +} + +export interface GetVendorDefaultSettingByIdVariables { + id: UUIDString; +} + export interface GetVendorRateByIdData { vendorRate?: { id: UUIDString; @@ -446,6 +492,15 @@ export interface ListVendorData { } & Vendor_Key)[]; } +export interface ListVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key)[]; +} + export interface ListVendorRateData { vendorRates: ({ id: UUIDString; @@ -510,6 +565,17 @@ export interface UpdateVendorData { vendor_update?: Vendor_Key | null; } +export interface UpdateVendorDefaultSettingData { + vendorDefaultSetting_update?: VendorDefaultSetting_Key | null; +} + +export interface UpdateVendorDefaultSettingVariables { + id: UUIDString; + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} + export interface UpdateVendorRateData { vendorRate_update?: VendorRate_Key | null; } @@ -536,6 +602,11 @@ export interface UpdateVendorVariables { isActive?: boolean | null; } +export interface VendorDefaultSetting_Key { + id: UUIDString; + __typename?: 'VendorDefaultSetting_Key'; +} + export interface VendorRate_Key { id: UUIDString; __typename?: 'VendorRate_Key'; @@ -546,6 +617,18 @@ export interface Vendor_Key { __typename?: 'Vendor_Key'; } +interface ListStaffRef { + /* 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 listStaffRef: ListStaffRef; + +export function listStaff(): QueryPromise; +export function listStaff(dc: DataConnect): QueryPromise; + interface CreateVendorRef { /* Allow users to create refs without passing in DataConnect */ (vars: CreateVendorVariables): MutationRef; @@ -582,42 +665,6 @@ export const deleteVendorRef: DeleteVendorRef; export function deleteVendor(vars: DeleteVendorVariables): MutationPromise; export function deleteVendor(dc: DataConnect, vars: DeleteVendorVariables): MutationPromise; -interface ListVendorRef { - /* 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 listVendorRef: ListVendorRef; - -export function listVendor(): QueryPromise; -export function listVendor(dc: DataConnect): QueryPromise; - -interface GetVendorByIdRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorByIdVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef; - operationName: string; -} -export const getVendorByIdRef: GetVendorByIdRef; - -export function getVendorById(vars: GetVendorByIdVariables): QueryPromise; -export function getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise; - -interface FilterVendorsRef { - /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorsVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef; - operationName: string; -} -export const filterVendorsRef: FilterVendorsRef; - -export function filterVendors(vars?: FilterVendorsVariables): QueryPromise; -export function filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise; - interface CreateVendorRateRef { /* Allow users to create refs without passing in DataConnect */ (vars: CreateVendorRateVariables): MutationRef; @@ -654,42 +701,6 @@ export const deleteVendorRateRef: DeleteVendorRateRef; export function deleteVendorRate(vars: DeleteVendorRateVariables): MutationPromise; export function deleteVendorRate(dc: DataConnect, vars: DeleteVendorRateVariables): MutationPromise; -interface ListVendorRateRef { - /* 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 listVendorRateRef: ListVendorRateRef; - -export function listVendorRate(): QueryPromise; -export function listVendorRate(dc: DataConnect): QueryPromise; - -interface GetVendorRateByIdRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorRateByIdVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef; - operationName: string; -} -export const getVendorRateByIdRef: GetVendorRateByIdRef; - -export function getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise; -export function getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise; - -interface FilterVendorRatesRef { - /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorRatesVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef; - operationName: string; -} -export const filterVendorRatesRef: FilterVendorRatesRef; - -export function filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise; -export function filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise; - interface CreateEventRef { /* Allow users to create refs without passing in DataConnect */ (vars: CreateEventVariables): MutationRef; @@ -774,15 +785,147 @@ export const createStaffRef: CreateStaffRef; export function createStaff(vars: CreateStaffVariables): MutationPromise; export function createStaff(dc: DataConnect, vars: CreateStaffVariables): MutationPromise; -interface ListStaffRef { +interface ListVendorRef { /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; + (): QueryRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect): QueryRef; + (dc: DataConnect): QueryRef; operationName: string; } -export const listStaffRef: ListStaffRef; +export const listVendorRef: ListVendorRef; -export function listStaff(): QueryPromise; -export function listStaff(dc: DataConnect): QueryPromise; +export function listVendor(): QueryPromise; +export function listVendor(dc: DataConnect): QueryPromise; + +interface GetVendorByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef; + operationName: string; +} +export const getVendorByIdRef: GetVendorByIdRef; + +export function getVendorById(vars: GetVendorByIdVariables): QueryPromise; +export function getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise; + +interface FilterVendorsRef { + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorsVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef; + operationName: string; +} +export const filterVendorsRef: FilterVendorsRef; + +export function filterVendors(vars?: FilterVendorsVariables): QueryPromise; +export function filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise; + +interface CreateVendorDefaultSettingRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateVendorDefaultSettingVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateVendorDefaultSettingVariables): MutationRef; + operationName: string; +} +export const createVendorDefaultSettingRef: CreateVendorDefaultSettingRef; + +export function createVendorDefaultSetting(vars: CreateVendorDefaultSettingVariables): MutationPromise; +export function createVendorDefaultSetting(dc: DataConnect, vars: CreateVendorDefaultSettingVariables): MutationPromise; + +interface UpdateVendorDefaultSettingRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateVendorDefaultSettingVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateVendorDefaultSettingVariables): MutationRef; + operationName: string; +} +export const updateVendorDefaultSettingRef: UpdateVendorDefaultSettingRef; + +export function updateVendorDefaultSetting(vars: UpdateVendorDefaultSettingVariables): MutationPromise; +export function updateVendorDefaultSetting(dc: DataConnect, vars: UpdateVendorDefaultSettingVariables): MutationPromise; + +interface DeleteVendorDefaultSettingRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteVendorDefaultSettingVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationRef; + operationName: string; +} +export const deleteVendorDefaultSettingRef: DeleteVendorDefaultSettingRef; + +export function deleteVendorDefaultSetting(vars: DeleteVendorDefaultSettingVariables): MutationPromise; +export function deleteVendorDefaultSetting(dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationPromise; + +interface ListVendorDefaultSettingsRef { + /* 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 listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; + +export function listVendorDefaultSettings(): QueryPromise; +export function listVendorDefaultSettings(dc: DataConnect): QueryPromise; + +interface GetVendorDefaultSettingByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorDefaultSettingByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef; + operationName: string; +} +export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; + +export function getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise; +export function getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise; + +interface FilterVendorDefaultSettingsRef { + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorDefaultSettingsVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef; + operationName: string; +} +export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; + +export function filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise; +export function filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise; + +interface ListVendorRateRef { + /* 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 listVendorRateRef: ListVendorRateRef; + +export function listVendorRate(): QueryPromise; +export function listVendorRate(dc: DataConnect): QueryPromise; + +interface GetVendorRateByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorRateByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef; + operationName: string; +} +export const getVendorRateByIdRef: GetVendorRateByIdRef; + +export function getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise; +export function getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise; + +interface FilterVendorRatesRef { + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorRatesVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef; + operationName: string; +} +export const filterVendorRatesRef: FilterVendorRatesRef; + +export function filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise; +export function filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise; diff --git a/frontend-web/src/dataconnect-generated/react/README.md b/frontend-web/src/dataconnect-generated/react/README.md index b53a3d0f..0712a844 100644 --- a/frontend-web/src/dataconnect-generated/react/README.md +++ b/frontend-web/src/dataconnect-generated/react/README.md @@ -17,16 +17,19 @@ You can also follow the instructions from the [Data Connect documentation](https - [**Accessing the connector**](#accessing-the-connector) - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) - [**Queries**](#queries) - - [*listVendor*](#listvendor) - - [*getVendorById*](#getvendorbyid) - - [*filterVendors*](#filtervendors) - - [*listVendorRate*](#listvendorrate) - - [*getVendorRateById*](#getvendorratebyid) - - [*filterVendorRates*](#filtervendorrates) + - [*listStaff*](#liststaff) - [*listEvents*](#listevents) - [*getEventById*](#geteventbyid) - [*filterEvents*](#filterevents) - - [*listStaff*](#liststaff) + - [*listVendor*](#listvendor) + - [*getVendorById*](#getvendorbyid) + - [*filterVendors*](#filtervendors) + - [*listVendorDefaultSettings*](#listvendordefaultsettings) + - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) + - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) + - [*listVendorRate*](#listvendorrate) + - [*getVendorRateById*](#getvendorratebyid) + - [*filterVendorRates*](#filtervendorrates) - [**Mutations**](#mutations) - [*CreateVendor*](#createvendor) - [*UpdateVendor*](#updatevendor) @@ -38,6 +41,9 @@ You can also follow the instructions from the [Data Connect documentation](https - [*UpdateEvent*](#updateevent) - [*DeleteEvent*](#deleteevent) - [*CreateStaff*](#createstaff) + - [*CreateVendorDefaultSetting*](#createvendordefaultsetting) + - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting) + - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting) # 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 `krow-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). @@ -129,66 +135,68 @@ Here's a general overview of how to use the generated Query hooks in your code: Below are examples of how to use the `krow-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). -## listVendor -You can execute the `listVendor` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): +## listStaff +You can execute the `listStaff` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): ```javascript -useListVendor(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +useListStaff(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; ``` You can also pass in a `DataConnect` instance to the Query hook function. ```javascript -useListVendor(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +useListStaff(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; ``` ### Variables -The `listVendor` Query has no variables. +The `listStaff` Query has no variables. ### Return Type -Recall that calling the `listVendor` 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. +Recall that calling the `listStaff` 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 `listVendor` Query is of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `listStaff` Query is of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: ```javascript -export interface ListVendorData { - vendors: ({ +export interface ListStaffData { + staffs: ({ id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_Key)[]; + employeeName: string; + vendorId?: UUIDString | null; + email?: string | null; + position?: string | null; + employmentType: EmploymentType; + rating?: number | null; + reliabilityScore?: number | null; + backgroundCheckStatus: BackgroundCheckStatus; + certifications?: string | null; + } & Staff_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 `listVendor`'s Query hook function +### Using `listStaff`'s Query hook function ```javascript import { getDataConnect } from 'firebase/data-connect'; import { connectorConfig } from '@dataconnect/generated'; -import { useListVendor } from '@dataconnect/generated/react' +import { useListStaff } from '@dataconnect/generated/react' -export default function ListVendorComponent() { +export default function ListStaffComponent() { // 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 = useListVendor(); + const query = useListStaff(); // You can also pass in a `DataConnect` instance to the Query hook function. const dataConnect = getDataConnect(connectorConfig); - const query = useListVendor(dataConnect); + const query = useListStaff(dataConnect); // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. const options = { staleTime: 5 * 1000 }; - const query = useListVendor(options); + const query = useListStaff(options); // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. const dataConnect = getDataConnect(connectorConfig); const options = { staleTime: 5 * 1000 }; - const query = useListVendor(dataConnect, options); + const query = useListStaff(dataConnect, options); // Then, you can render your component dynamically based on the status of the Query. if (query.isPending) { @@ -201,484 +209,7 @@ export default function ListVendorComponent() { // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. if (query.isSuccess) { - console.log(query.data.vendors); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## getVendorById -You can execute the `getVendorById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useGetVendorById(dc: DataConnect, vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useGetVendorById(vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `getVendorById` Query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface GetVendorByIdVariables { - id: UUIDString; -} -``` -### Return Type -Recall that calling the `getVendorById` 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 `getVendorById` Query is of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface GetVendorByIdData { - vendor?: { - id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_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 `getVendorById`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, GetVendorByIdVariables } from '@dataconnect/generated'; -import { useGetVendorById } from '@dataconnect/generated/react' - -export default function GetVendorByIdComponent() { - // The `useGetVendorById` Query hook requires an argument of type `GetVendorByIdVariables`: - const getVendorByIdVars: GetVendorByIdVariables = { - 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 = useGetVendorById(getVendorByIdVars); - // Variables can be defined inline as well. - const query = useGetVendorById({ id: ..., }); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useGetVendorById(dataConnect, getVendorByIdVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useGetVendorById(getVendorByIdVars, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useGetVendorById(dataConnect, getVendorByIdVars, 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.vendor); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## filterVendors -You can execute the `filterVendors` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useFilterVendors(vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `filterVendors` Query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface FilterVendorsVariables { - region?: VendorRegion | null; - approvalStatus?: VendorApprovalStatus | null; - isActive?: boolean | null; - vendorNumber?: string | null; - primaryContactEmail?: string | null; - legalName?: string | null; - platformType?: VendorPlatformType | null; -} -``` -### Return Type -Recall that calling the `filterVendors` 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 `filterVendors` Query is of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface FilterVendorsData { - vendors: ({ - id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_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 `filterVendors`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, FilterVendorsVariables } from '@dataconnect/generated'; -import { useFilterVendors } from '@dataconnect/generated/react' - -export default function FilterVendorsComponent() { - // The `useFilterVendors` Query hook has an optional argument of type `FilterVendorsVariables`: - const filterVendorsVars: FilterVendorsVariables = { - region: ..., // optional - approvalStatus: ..., // optional - isActive: ..., // optional - vendorNumber: ..., // optional - primaryContactEmail: ..., // optional - legalName: ..., // optional - platformType: ..., // optional - }; - - // 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 = useFilterVendors(filterVendorsVars); - // Variables can be defined inline as well. - const query = useFilterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); - // Since all variables are optional for this Query, you can omit the `FilterVendorsVariables` argument. - // (as long as you don't want to provide any `options`!) - const query = useFilterVendors(); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useFilterVendors(dataConnect, filterVendorsVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useFilterVendors(filterVendorsVars, options); - // If you'd like to provide options without providing any variables, you must - // pass `undefined` where you would normally pass the variables. - const query = useFilterVendors(undefined, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useFilterVendors(dataConnect, filterVendorsVars /** or undefined */, 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.vendors); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## listVendorRate -You can execute the `listVendorRate` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useListVendorRate(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useListVendorRate(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `listVendorRate` Query has no variables. -### Return Type -Recall that calling the `listVendorRate` 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 `listVendorRate` Query is of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface ListVendorRateData { - vendorRates: ({ - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - } & VendorRate_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 `listVendorRate`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig } from '@dataconnect/generated'; -import { useListVendorRate } from '@dataconnect/generated/react' - -export default function ListVendorRateComponent() { - // 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 = useListVendorRate(); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useListVendorRate(dataConnect); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useListVendorRate(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useListVendorRate(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.vendorRates); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## getVendorRateById -You can execute the `getVendorRateById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useGetVendorRateById(vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `getVendorRateById` Query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface GetVendorRateByIdVariables { - id: UUIDString; -} -``` -### Return Type -Recall that calling the `getVendorRateById` 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 `getVendorRateById` Query is of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface GetVendorRateByIdData { - vendorRate?: { - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - createdDate?: TimestampString | null; - updatedDate?: TimestampString | null; - createdBy?: string | null; - } & VendorRate_Key; -} -``` - -To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). - -### Using `getVendorRateById`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, GetVendorRateByIdVariables } from '@dataconnect/generated'; -import { useGetVendorRateById } from '@dataconnect/generated/react' - -export default function GetVendorRateByIdComponent() { - // The `useGetVendorRateById` Query hook requires an argument of type `GetVendorRateByIdVariables`: - const getVendorRateByIdVars: GetVendorRateByIdVariables = { - 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 = useGetVendorRateById(getVendorRateByIdVars); - // Variables can be defined inline as well. - const query = useGetVendorRateById({ id: ..., }); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useGetVendorRateById(dataConnect, getVendorRateByIdVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useGetVendorRateById(getVendorRateByIdVars, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useGetVendorRateById(dataConnect, getVendorRateByIdVars, 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.vendorRate); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## filterVendorRates -You can execute the `filterVendorRates` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useFilterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useFilterVendorRates(vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `filterVendorRates` Query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface FilterVendorRatesVariables { - vendorName?: string | null; - category?: VendorRateCategory | null; - roleName?: string | null; - minClientRate?: number | null; - maxClientRate?: number | null; -} -``` -### Return Type -Recall that calling the `filterVendorRates` 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 `filterVendorRates` Query is of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface FilterVendorRatesData { - vendorRates: ({ - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - } & VendorRate_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 `filterVendorRates`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, FilterVendorRatesVariables } from '@dataconnect/generated'; -import { useFilterVendorRates } from '@dataconnect/generated/react' - -export default function FilterVendorRatesComponent() { - // The `useFilterVendorRates` Query hook has an optional argument of type `FilterVendorRatesVariables`: - const filterVendorRatesVars: FilterVendorRatesVariables = { - vendorName: ..., // optional - category: ..., // optional - roleName: ..., // optional - minClientRate: ..., // optional - maxClientRate: ..., // optional - }; - - // 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 = useFilterVendorRates(filterVendorRatesVars); - // Variables can be defined inline as well. - const query = useFilterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); - // Since all variables are optional for this Query, you can omit the `FilterVendorRatesVariables` argument. - // (as long as you don't want to provide any `options`!) - const query = useFilterVendorRates(); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useFilterVendorRates(dataConnect, filterVendorRatesVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useFilterVendorRates(filterVendorRatesVars, options); - // If you'd like to provide options without providing any variables, you must - // pass `undefined` where you would normally pass the variables. - const query = useFilterVendorRates(undefined, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useFilterVendorRates(dataConnect, filterVendorRatesVars /** or undefined */, 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.vendorRates); + console.log(query.data.staffs); } return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; } @@ -1053,68 +584,66 @@ export default function FilterEventsComponent() { } ``` -## listStaff -You can execute the `listStaff` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): +## listVendor +You can execute the `listVendor` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): ```javascript -useListStaff(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +useListVendor(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; ``` You can also pass in a `DataConnect` instance to the Query hook function. ```javascript -useListStaff(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +useListVendor(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; ``` ### Variables -The `listStaff` Query has no variables. +The `listVendor` Query has no variables. ### Return Type -Recall that calling the `listStaff` 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. +Recall that calling the `listVendor` 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 `listStaff` Query is of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `listVendor` Query is of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: ```javascript -export interface ListStaffData { - staffs: ({ +export interface ListVendorData { + vendors: ({ id: UUIDString; - employeeName: string; - vendorId?: UUIDString | null; - email?: string | null; - position?: string | null; - employmentType: EmploymentType; - rating?: number | null; - reliabilityScore?: number | null; - backgroundCheckStatus: BackgroundCheckStatus; - certifications?: string | null; - } & Staff_Key)[]; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_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 `listStaff`'s Query hook function +### Using `listVendor`'s Query hook function ```javascript import { getDataConnect } from 'firebase/data-connect'; import { connectorConfig } from '@dataconnect/generated'; -import { useListStaff } from '@dataconnect/generated/react' +import { useListVendor } from '@dataconnect/generated/react' -export default function ListStaffComponent() { +export default function ListVendorComponent() { // 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 = useListStaff(); + const query = useListVendor(); // You can also pass in a `DataConnect` instance to the Query hook function. const dataConnect = getDataConnect(connectorConfig); - const query = useListStaff(dataConnect); + const query = useListVendor(dataConnect); // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. const options = { staleTime: 5 * 1000 }; - const query = useListStaff(options); + const query = useListVendor(options); // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. const dataConnect = getDataConnect(connectorConfig); const options = { staleTime: 5 * 1000 }; - const query = useListStaff(dataConnect, options); + const query = useListVendor(dataConnect, options); // Then, you can render your component dynamically based on the status of the Query. if (query.isPending) { @@ -1127,7 +656,742 @@ export default function ListStaffComponent() { // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. if (query.isSuccess) { - console.log(query.data.staffs); + console.log(query.data.vendors); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## getVendorById +You can execute the `getVendorById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useGetVendorById(dc: DataConnect, vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetVendorById(vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `getVendorById` Query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetVendorByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `getVendorById` 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 `getVendorById` Query is of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetVendorByIdData { + vendor?: { + id: UUIDString; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_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 `getVendorById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetVendorByIdVariables } from '@dataconnect/generated'; +import { useGetVendorById } from '@dataconnect/generated/react' + +export default function GetVendorByIdComponent() { + // The `useGetVendorById` Query hook requires an argument of type `GetVendorByIdVariables`: + const getVendorByIdVars: GetVendorByIdVariables = { + 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 = useGetVendorById(getVendorByIdVars); + // Variables can be defined inline as well. + const query = useGetVendorById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetVendorById(dataConnect, getVendorByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorById(getVendorByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorById(dataConnect, getVendorByIdVars, 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.vendor); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## filterVendors +You can execute the `filterVendors` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useFilterVendors(vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `filterVendors` Query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface FilterVendorsVariables { + region?: VendorRegion | null; + approvalStatus?: VendorApprovalStatus | null; + isActive?: boolean | null; + vendorNumber?: string | null; + primaryContactEmail?: string | null; + legalName?: string | null; + platformType?: VendorPlatformType | null; +} +``` +### Return Type +Recall that calling the `filterVendors` 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 `filterVendors` Query is of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface FilterVendorsData { + vendors: ({ + id: UUIDString; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_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 `filterVendors`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, FilterVendorsVariables } from '@dataconnect/generated'; +import { useFilterVendors } from '@dataconnect/generated/react' + +export default function FilterVendorsComponent() { + // The `useFilterVendors` Query hook has an optional argument of type `FilterVendorsVariables`: + const filterVendorsVars: FilterVendorsVariables = { + region: ..., // optional + approvalStatus: ..., // optional + isActive: ..., // optional + vendorNumber: ..., // optional + primaryContactEmail: ..., // optional + legalName: ..., // optional + platformType: ..., // optional + }; + + // 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 = useFilterVendors(filterVendorsVars); + // Variables can be defined inline as well. + const query = useFilterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); + // Since all variables are optional for this Query, you can omit the `FilterVendorsVariables` argument. + // (as long as you don't want to provide any `options`!) + const query = useFilterVendors(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useFilterVendors(dataConnect, filterVendorsVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendors(filterVendorsVars, options); + // If you'd like to provide options without providing any variables, you must + // pass `undefined` where you would normally pass the variables. + const query = useFilterVendors(undefined, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendors(dataConnect, filterVendorsVars /** or undefined */, 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.vendors); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## listVendorDefaultSettings +You can execute the `listVendorDefaultSettings` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useListVendorDefaultSettings(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListVendorDefaultSettings(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `listVendorDefaultSettings` Query has no variables. +### Return Type +Recall that calling the `listVendorDefaultSettings` 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 `listVendorDefaultSettings` Query is of type `ListVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_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 `listVendorDefaultSettings`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@dataconnect/generated'; +import { useListVendorDefaultSettings } from '@dataconnect/generated/react' + +export default function ListVendorDefaultSettingsComponent() { + // 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 = useListVendorDefaultSettings(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListVendorDefaultSettings(dataConnect); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListVendorDefaultSettings(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListVendorDefaultSettings(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.vendorDefaultSettings); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## getVendorDefaultSettingById +You can execute the `getVendorDefaultSettingById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useGetVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `getVendorDefaultSettingById` Query requires an argument of type `GetVendorDefaultSettingByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetVendorDefaultSettingByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `getVendorDefaultSettingById` 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 `getVendorDefaultSettingById` Query is of type `GetVendorDefaultSettingByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetVendorDefaultSettingByIdData { + vendorDefaultSetting?: { + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_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 `getVendorDefaultSettingById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetVendorDefaultSettingByIdVariables } from '@dataconnect/generated'; +import { useGetVendorDefaultSettingById } from '@dataconnect/generated/react' + +export default function GetVendorDefaultSettingByIdComponent() { + // The `useGetVendorDefaultSettingById` Query hook requires an argument of type `GetVendorDefaultSettingByIdVariables`: + const getVendorDefaultSettingByIdVars: GetVendorDefaultSettingByIdVariables = { + 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 = useGetVendorDefaultSettingById(getVendorDefaultSettingByIdVars); + // Variables can be defined inline as well. + const query = useGetVendorDefaultSettingById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorDefaultSettingById(getVendorDefaultSettingByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars, 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.vendorDefaultSetting); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## filterVendorDefaultSettings +You can execute the `filterVendorDefaultSettings` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useFilterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useFilterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `filterVendorDefaultSettings` Query has an optional argument of type `FilterVendorDefaultSettingsVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface FilterVendorDefaultSettingsVariables { + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} +``` +### Return Type +Recall that calling the `filterVendorDefaultSettings` 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 `filterVendorDefaultSettings` Query is of type `FilterVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface FilterVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_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 `filterVendorDefaultSettings`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, FilterVendorDefaultSettingsVariables } from '@dataconnect/generated'; +import { useFilterVendorDefaultSettings } from '@dataconnect/generated/react' + +export default function FilterVendorDefaultSettingsComponent() { + // The `useFilterVendorDefaultSettings` Query hook has an optional argument of type `FilterVendorDefaultSettingsVariables`: + const filterVendorDefaultSettingsVars: FilterVendorDefaultSettingsVariables = { + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional + }; + + // 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 = useFilterVendorDefaultSettings(filterVendorDefaultSettingsVars); + // Variables can be defined inline as well. + const query = useFilterVendorDefaultSettings({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + // Since all variables are optional for this Query, you can omit the `FilterVendorDefaultSettingsVariables` argument. + // (as long as you don't want to provide any `options`!) + const query = useFilterVendorDefaultSettings(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useFilterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendorDefaultSettings(filterVendorDefaultSettingsVars, options); + // If you'd like to provide options without providing any variables, you must + // pass `undefined` where you would normally pass the variables. + const query = useFilterVendorDefaultSettings(undefined, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars /** or undefined */, 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.vendorDefaultSettings); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## listVendorRate +You can execute the `listVendorRate` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useListVendorRate(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListVendorRate(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `listVendorRate` Query has no variables. +### Return Type +Recall that calling the `listVendorRate` 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 `listVendorRate` Query is of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListVendorRateData { + vendorRates: ({ + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + } & VendorRate_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 `listVendorRate`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@dataconnect/generated'; +import { useListVendorRate } from '@dataconnect/generated/react' + +export default function ListVendorRateComponent() { + // 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 = useListVendorRate(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListVendorRate(dataConnect); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListVendorRate(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListVendorRate(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.vendorRates); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## getVendorRateById +You can execute the `getVendorRateById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetVendorRateById(vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `getVendorRateById` Query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetVendorRateByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `getVendorRateById` 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 `getVendorRateById` Query is of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetVendorRateByIdData { + vendorRate?: { + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + createdDate?: TimestampString | null; + updatedDate?: TimestampString | null; + createdBy?: string | null; + } & VendorRate_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `getVendorRateById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetVendorRateByIdVariables } from '@dataconnect/generated'; +import { useGetVendorRateById } from '@dataconnect/generated/react' + +export default function GetVendorRateByIdComponent() { + // The `useGetVendorRateById` Query hook requires an argument of type `GetVendorRateByIdVariables`: + const getVendorRateByIdVars: GetVendorRateByIdVariables = { + 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 = useGetVendorRateById(getVendorRateByIdVars); + // Variables can be defined inline as well. + const query = useGetVendorRateById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetVendorRateById(dataConnect, getVendorRateByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorRateById(getVendorRateByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorRateById(dataConnect, getVendorRateByIdVars, 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.vendorRate); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## filterVendorRates +You can execute the `filterVendorRates` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useFilterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useFilterVendorRates(vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `filterVendorRates` Query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface FilterVendorRatesVariables { + vendorName?: string | null; + category?: VendorRateCategory | null; + roleName?: string | null; + minClientRate?: number | null; + maxClientRate?: number | null; +} +``` +### Return Type +Recall that calling the `filterVendorRates` 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 `filterVendorRates` Query is of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface FilterVendorRatesData { + vendorRates: ({ + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + } & VendorRate_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 `filterVendorRates`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, FilterVendorRatesVariables } from '@dataconnect/generated'; +import { useFilterVendorRates } from '@dataconnect/generated/react' + +export default function FilterVendorRatesComponent() { + // The `useFilterVendorRates` Query hook has an optional argument of type `FilterVendorRatesVariables`: + const filterVendorRatesVars: FilterVendorRatesVariables = { + vendorName: ..., // optional + category: ..., // optional + roleName: ..., // optional + minClientRate: ..., // optional + maxClientRate: ..., // optional + }; + + // 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 = useFilterVendorRates(filterVendorRatesVars); + // Variables can be defined inline as well. + const query = useFilterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); + // Since all variables are optional for this Query, you can omit the `FilterVendorRatesVariables` argument. + // (as long as you don't want to provide any `options`!) + const query = useFilterVendorRates(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useFilterVendorRates(dataConnect, filterVendorRatesVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendorRates(filterVendorRatesVars, options); + // If you'd like to provide options without providing any variables, you must + // pass `undefined` where you would normally pass the variables. + const query = useFilterVendorRates(undefined, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendorRates(dataConnect, filterVendorRatesVars /** or undefined */, 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.vendorRates); } return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; } @@ -2300,3 +2564,295 @@ export default function CreateStaffComponent() { } ``` +## CreateVendorDefaultSetting +You can execute the `CreateVendorDefaultSetting` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)): +```javascript +useCreateVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateVendorDefaultSetting` Mutation requires an argument of type `CreateVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateVendorDefaultSettingVariables { + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; +} +``` +### Return Type +Recall that calling the `CreateVendorDefaultSetting` 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 `CreateVendorDefaultSetting` Mutation is of type `CreateVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateVendorDefaultSettingData { + vendorDefaultSetting_insert: VendorDefaultSetting_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 `CreateVendorDefaultSetting`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateVendorDefaultSettingVariables } from '@dataconnect/generated'; +import { useCreateVendorDefaultSetting } from '@dataconnect/generated/react' + +export default function CreateVendorDefaultSettingComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateVendorDefaultSetting(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateVendorDefaultSetting(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateVendorDefaultSetting(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 = useCreateVendorDefaultSetting(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateVendorDefaultSetting` Mutation requires an argument of type `CreateVendorDefaultSettingVariables`: + const createVendorDefaultSettingVars: CreateVendorDefaultSettingVariables = { + vendorName: ..., + defaultMarkupPercentage: ..., + defaultVendorFeePercentage: ..., + }; + mutation.mutate(createVendorDefaultSettingVars); + // Variables can be defined inline as well. + mutation.mutate({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createVendorDefaultSettingVars, 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.vendorDefaultSetting_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateVendorDefaultSetting +You can execute the `UpdateVendorDefaultSetting` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateVendorDefaultSetting` Mutation requires an argument of type `UpdateVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateVendorDefaultSettingVariables { + id: UUIDString; + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} +``` +### Return Type +Recall that calling the `UpdateVendorDefaultSetting` 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 `UpdateVendorDefaultSetting` Mutation is of type `UpdateVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateVendorDefaultSettingData { + vendorDefaultSetting_update?: VendorDefaultSetting_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 `UpdateVendorDefaultSetting`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateVendorDefaultSettingVariables } from '@dataconnect/generated'; +import { useUpdateVendorDefaultSetting } from '@dataconnect/generated/react' + +export default function UpdateVendorDefaultSettingComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateVendorDefaultSetting(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateVendorDefaultSetting(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateVendorDefaultSetting(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 = useUpdateVendorDefaultSetting(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateVendorDefaultSetting` Mutation requires an argument of type `UpdateVendorDefaultSettingVariables`: + const updateVendorDefaultSettingVars: UpdateVendorDefaultSettingVariables = { + id: ..., + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional + }; + mutation.mutate(updateVendorDefaultSettingVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateVendorDefaultSettingVars, 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.vendorDefaultSetting_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteVendorDefaultSetting +You can execute the `DeleteVendorDefaultSetting` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteVendorDefaultSetting` Mutation requires an argument of type `DeleteVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteVendorDefaultSettingVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteVendorDefaultSetting` 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 `DeleteVendorDefaultSetting` Mutation is of type `DeleteVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteVendorDefaultSettingData { + vendorDefaultSetting_delete?: VendorDefaultSetting_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 `DeleteVendorDefaultSetting`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteVendorDefaultSettingVariables } from '@dataconnect/generated'; +import { useDeleteVendorDefaultSetting } from '@dataconnect/generated/react' + +export default function DeleteVendorDefaultSettingComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteVendorDefaultSetting(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteVendorDefaultSetting(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteVendorDefaultSetting(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 = useDeleteVendorDefaultSetting(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteVendorDefaultSetting` Mutation requires an argument of type `DeleteVendorDefaultSettingVariables`: + const deleteVendorDefaultSettingVars: DeleteVendorDefaultSettingVariables = { + id: ..., + }; + mutation.mutate(deleteVendorDefaultSettingVars); + // 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(deleteVendorDefaultSettingVars, 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.vendorDefaultSetting_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + diff --git a/frontend-web/src/dataconnect-generated/react/esm/index.esm.js b/frontend-web/src/dataconnect-generated/react/esm/index.esm.js index e0722a51..d1f156c2 100644 --- a/frontend-web/src/dataconnect-generated/react/esm/index.esm.js +++ b/frontend-web/src/dataconnect-generated/react/esm/index.esm.js @@ -1,7 +1,13 @@ -import { createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, createStaffRef, listStaffRef, connectorConfig } from '../../esm/index.esm.js'; +import { listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, createStaffRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorDefaultSettingRef, updateVendorDefaultSettingRef, deleteVendorDefaultSettingRef, listVendorDefaultSettingsRef, getVendorDefaultSettingByIdRef, filterVendorDefaultSettingsRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, 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 useListStaff(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listStaffRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} export function useCreateVendor(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -26,24 +32,6 @@ export function useDeleteVendor(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } - -export function useListVendor(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listVendorRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useGetVendorById(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getVendorByIdRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useFilterVendors(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); - const ref = filterVendorsRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} export function useCreateVendorRate(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -68,24 +56,6 @@ export function useDeleteVendorRate(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } - -export function useListVendorRate(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listVendorRateRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useGetVendorRateById(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getVendorRateByIdRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useFilterVendorRates(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); - const ref = filterVendorRatesRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} export function useCreateEvent(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -137,8 +107,80 @@ export function useCreateStaff(dcOrOptions, options) { } -export function useListStaff(dcOrOptions, options) { +export function useListVendor(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listStaffRef(dcInstance); + const ref = listVendorRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetVendorById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useFilterVendors(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +export function useCreateVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useListVendorDefaultSettings(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listVendorDefaultSettingsRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetVendorDefaultSettingById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorDefaultSettingByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useFilterVendorDefaultSettings(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorDefaultSettingsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useListVendorRate(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listVendorRateRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetVendorRateById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorRateByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useFilterVendorRates(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorRatesRef(dcInstance, inputVars); return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); } \ No newline at end of file diff --git a/frontend-web/src/dataconnect-generated/react/index.cjs.js b/frontend-web/src/dataconnect-generated/react/index.cjs.js index a4e8fecb..918c7066 100644 --- a/frontend-web/src/dataconnect-generated/react/index.cjs.js +++ b/frontend-web/src/dataconnect-generated/react/index.cjs.js @@ -1,7 +1,13 @@ -const { createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, createStaffRef, listStaffRef, connectorConfig } = require('../index.cjs.js'); +const { listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, createStaffRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorDefaultSettingRef, updateVendorDefaultSettingRef, deleteVendorDefaultSettingRef, listVendorDefaultSettingsRef, getVendorDefaultSettingByIdRef, filterVendorDefaultSettingsRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, connectorConfig } = require('../index.cjs.js'); const { validateArgs, CallerSdkTypeEnum } = require('firebase/data-connect'); const { useDataConnectQuery, useDataConnectMutation, validateReactArgs } = require('@tanstack-query-firebase/react/data-connect'); + +exports.useListStaff = function useListStaff(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listStaffRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} exports.useCreateVendor = function useCreateVendor(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -26,24 +32,6 @@ exports.useDeleteVendor = function useDeleteVendor(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } - -exports.useListVendor = function useListVendor(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listVendorRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useGetVendorById = function useGetVendorById(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getVendorByIdRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useFilterVendors = function useFilterVendors(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); - const ref = filterVendorsRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} exports.useCreateVendorRate = function useCreateVendorRate(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -68,24 +56,6 @@ exports.useDeleteVendorRate = function useDeleteVendorRate(dcOrOptions, options) return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } - -exports.useListVendorRate = function useListVendorRate(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listVendorRateRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useGetVendorRateById = function useGetVendorRateById(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getVendorRateByIdRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useFilterVendorRates = function useFilterVendorRates(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); - const ref = filterVendorRatesRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} exports.useCreateEvent = function useCreateEvent(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -137,8 +107,80 @@ exports.useCreateStaff = function useCreateStaff(dcOrOptions, options) { } -exports.useListStaff = function useListStaff(dcOrOptions, options) { +exports.useListVendor = function useListVendor(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listStaffRef(dcInstance); + const ref = listVendorRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetVendorById = function useGetVendorById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useFilterVendors = function useFilterVendors(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +exports.useCreateVendorDefaultSetting = function useCreateVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateVendorDefaultSetting = function useUpdateVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteVendorDefaultSetting = function useDeleteVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useListVendorDefaultSettings = function useListVendorDefaultSettings(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listVendorDefaultSettingsRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetVendorDefaultSettingById = function useGetVendorDefaultSettingById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorDefaultSettingByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useFilterVendorDefaultSettings = function useFilterVendorDefaultSettings(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorDefaultSettingsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useListVendorRate = function useListVendorRate(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listVendorRateRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetVendorRateById = function useGetVendorRateById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorRateByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useFilterVendorRates = function useFilterVendorRates(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorRatesRef(dcInstance, inputVars); return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); } \ No newline at end of file diff --git a/frontend-web/src/dataconnect-generated/react/index.d.ts b/frontend-web/src/dataconnect-generated/react/index.d.ts index 0cdeedc4..29eef557 100644 --- a/frontend-web/src/dataconnect-generated/react/index.d.ts +++ b/frontend-web/src/dataconnect-generated/react/index.d.ts @@ -1,10 +1,13 @@ -import { CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateVendorRateData, CreateVendorRateVariables, UpdateVendorRateData, UpdateVendorRateVariables, DeleteVendorRateData, DeleteVendorRateVariables, ListVendorRateData, GetVendorRateByIdData, GetVendorRateByIdVariables, FilterVendorRatesData, FilterVendorRatesVariables, CreateEventData, CreateEventVariables, UpdateEventData, UpdateEventVariables, DeleteEventData, DeleteEventVariables, ListEventsData, GetEventByIdData, GetEventByIdVariables, FilterEventsData, FilterEventsVariables, CreateStaffData, CreateStaffVariables, ListStaffData } from '../'; +import { ListStaffData, CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, CreateVendorRateData, CreateVendorRateVariables, UpdateVendorRateData, UpdateVendorRateVariables, DeleteVendorRateData, DeleteVendorRateVariables, CreateEventData, CreateEventVariables, UpdateEventData, UpdateEventVariables, DeleteEventData, DeleteEventVariables, ListEventsData, GetEventByIdData, GetEventByIdVariables, FilterEventsData, FilterEventsVariables, CreateStaffData, CreateStaffVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateVendorDefaultSettingData, CreateVendorDefaultSettingVariables, UpdateVendorDefaultSettingData, UpdateVendorDefaultSettingVariables, DeleteVendorDefaultSettingData, DeleteVendorDefaultSettingVariables, ListVendorDefaultSettingsData, GetVendorDefaultSettingByIdData, GetVendorDefaultSettingByIdVariables, FilterVendorDefaultSettingsData, FilterVendorDefaultSettingsVariables, ListVendorRateData, GetVendorRateByIdData, GetVendorRateByIdVariables, FilterVendorRatesData, FilterVendorRatesVariables } 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 useListStaff(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListStaff(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + export function useCreateVendor(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateVendor(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; @@ -14,15 +17,6 @@ export function useUpdateVendor(dc: DataConnect, options?: useDataConnectMutatio export function useDeleteVendor(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useDeleteVendor(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useListVendor(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useListVendor(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useGetVendorById(vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useGetVendorById(dc: DataConnect, vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useFilterVendors(vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - export function useCreateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; @@ -32,15 +26,6 @@ export function useUpdateVendorRate(dc: DataConnect, options?: useDataConnectMut export function useDeleteVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useDeleteVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useListVendorRate(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useListVendorRate(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useGetVendorRateById(vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useFilterVendorRates(vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useFilterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - export function useCreateEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; @@ -62,5 +47,38 @@ export function useFilterEvents(dc: DataConnect, vars?: FilterEventsVariables, o export function useCreateStaff(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useListStaff(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useListStaff(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendor(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendor(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetVendorById(vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetVendorById(dc: DataConnect, vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useFilterVendors(vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useCreateVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useListVendorDefaultSettings(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendorDefaultSettings(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useFilterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useListVendorRate(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendorRate(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetVendorRateById(vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useFilterVendorRates(vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; diff --git a/internal-api-harness/src/dataconnect-generated/.guides/usage.md b/internal-api-harness/src/dataconnect-generated/.guides/usage.md index 98ae3760..d83b82a0 100644 --- a/internal-api-harness/src/dataconnect-generated/.guides/usage.md +++ b/internal-api-harness/src/dataconnect-generated/.guides/usage.md @@ -12,28 +12,28 @@ For each operation, there is a wrapper hook that can be used to call the operati Here are all of the hooks that get generated: ```ts -import { useCreateVendor, useUpdateVendor, useDeleteVendor, useListVendor, useGetVendorById, useFilterVendors, useCreateVendorRate, useUpdateVendorRate, useDeleteVendorRate, useListVendorRate } from '@dataconnect/generated/react'; +import { useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useCreateVendorRate, useUpdateVendorRate, useDeleteVendorRate, useCreateEvent, useUpdateEvent, useDeleteEvent } from '@dataconnect/generated/react'; // The types of these hooks are available in react/index.d.ts +const { data, isPending, isSuccess, isError, error } = useListStaff(); + const { data, isPending, isSuccess, isError, error } = useCreateVendor(createVendorVars); const { data, isPending, isSuccess, isError, error } = useUpdateVendor(updateVendorVars); const { data, isPending, isSuccess, isError, error } = useDeleteVendor(deleteVendorVars); -const { data, isPending, isSuccess, isError, error } = useListVendor(); - -const { data, isPending, isSuccess, isError, error } = useGetVendorById(getVendorByIdVars); - -const { data, isPending, isSuccess, isError, error } = useFilterVendors(filterVendorsVars); - const { data, isPending, isSuccess, isError, error } = useCreateVendorRate(createVendorRateVars); const { data, isPending, isSuccess, isError, error } = useUpdateVendorRate(updateVendorRateVars); const { data, isPending, isSuccess, isError, error } = useDeleteVendorRate(deleteVendorRateVars); -const { data, isPending, isSuccess, isError, error } = useListVendorRate(); +const { data, isPending, isSuccess, isError, error } = useCreateEvent(createEventVars); + +const { data, isPending, isSuccess, isError, error } = useUpdateEvent(updateEventVars); + +const { data, isPending, isSuccess, isError, error } = useDeleteEvent(deleteEventVars); ``` @@ -72,9 +72,12 @@ If a user is not using a supported framework, they can use the generated SDK dir Here's an example of how to use it with the first 5 operations: ```js -import { createVendor, updateVendor, deleteVendor, listVendor, getVendorById, filterVendors, createVendorRate, updateVendorRate, deleteVendorRate, listVendorRate } from '@dataconnect/generated'; +import { listStaff, createVendor, updateVendor, deleteVendor, createVendorRate, updateVendorRate, deleteVendorRate, createEvent, updateEvent, deleteEvent } from '@dataconnect/generated'; +// Operation listStaff: +const { data } = await ListStaff(dataConnect); + // Operation CreateVendor: For variables, look at type CreateVendorVars in ../index.d.ts const { data } = await CreateVendor(dataConnect, createVendorVars); @@ -84,15 +87,6 @@ const { data } = await UpdateVendor(dataConnect, updateVendorVars); // Operation DeleteVendor: For variables, look at type DeleteVendorVars in ../index.d.ts const { data } = await DeleteVendor(dataConnect, deleteVendorVars); -// Operation listVendor: -const { data } = await ListVendor(dataConnect); - -// Operation getVendorById: For variables, look at type GetVendorByIdVars in ../index.d.ts -const { data } = await GetVendorById(dataConnect, getVendorByIdVars); - -// Operation filterVendors: For variables, look at type FilterVendorsVars in ../index.d.ts -const { data } = await FilterVendors(dataConnect, filterVendorsVars); - // Operation CreateVendorRate: For variables, look at type CreateVendorRateVars in ../index.d.ts const { data } = await CreateVendorRate(dataConnect, createVendorRateVars); @@ -102,8 +96,14 @@ const { data } = await UpdateVendorRate(dataConnect, updateVendorRateVars); // Operation DeleteVendorRate: For variables, look at type DeleteVendorRateVars in ../index.d.ts const { data } = await DeleteVendorRate(dataConnect, deleteVendorRateVars); -// Operation listVendorRate: -const { data } = await ListVendorRate(dataConnect); +// Operation CreateEvent: For variables, look at type CreateEventVars in ../index.d.ts +const { data } = await CreateEvent(dataConnect, createEventVars); + +// Operation UpdateEvent: For variables, look at type UpdateEventVars in ../index.d.ts +const { data } = await UpdateEvent(dataConnect, updateEventVars); + +// Operation DeleteEvent: For variables, look at type DeleteEventVars in ../index.d.ts +const { data } = await DeleteEvent(dataConnect, deleteEventVars); ``` \ No newline at end of file diff --git a/internal-api-harness/src/dataconnect-generated/README.md b/internal-api-harness/src/dataconnect-generated/README.md index 66a2306d..705808e2 100644 --- a/internal-api-harness/src/dataconnect-generated/README.md +++ b/internal-api-harness/src/dataconnect-generated/README.md @@ -10,16 +10,19 @@ This README will guide you through the process of using the generated JavaScript - [**Accessing the connector**](#accessing-the-connector) - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) - [**Queries**](#queries) - - [*listVendor*](#listvendor) - - [*getVendorById*](#getvendorbyid) - - [*filterVendors*](#filtervendors) - - [*listVendorRate*](#listvendorrate) - - [*getVendorRateById*](#getvendorratebyid) - - [*filterVendorRates*](#filtervendorrates) + - [*listStaff*](#liststaff) - [*listEvents*](#listevents) - [*getEventById*](#geteventbyid) - [*filterEvents*](#filterevents) - - [*listStaff*](#liststaff) + - [*listVendor*](#listvendor) + - [*getVendorById*](#getvendorbyid) + - [*filterVendors*](#filtervendors) + - [*listVendorDefaultSettings*](#listvendordefaultsettings) + - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) + - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) + - [*listVendorRate*](#listvendorrate) + - [*getVendorRateById*](#getvendorratebyid) + - [*filterVendorRates*](#filtervendorrates) - [**Mutations**](#mutations) - [*CreateVendor*](#createvendor) - [*UpdateVendor*](#updatevendor) @@ -31,6 +34,9 @@ This README will guide you through the process of using the generated JavaScript - [*UpdateEvent*](#updateevent) - [*DeleteEvent*](#deleteevent) - [*CreateStaff*](#createstaff) + - [*CreateVendorDefaultSetting*](#createvendordefaultsetting) + - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting) + - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting) # Accessing the connector A connector is a collection of Queries and Mutations. One SDK is generated for each connector - this SDK is generated for the connector `krow-connector`. You can find more information about connectors in the [Data Connect documentation](https://firebase.google.com/docs/data-connect#how-does). @@ -77,716 +83,105 @@ The following is true for both the action shortcut function and the `QueryRef` f Below are examples of how to use the `krow-connector` connector's generated functions to execute each query. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#using-queries). -## listVendor -You can execute the `listVendor` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +## listStaff +You can execute the `listStaff` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): ```typescript -listVendor(): QueryPromise; +listStaff(): QueryPromise; -interface ListVendorRef { +interface ListStaffRef { ... /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; + (): QueryRef; } -export const listVendorRef: ListVendorRef; +export const listStaffRef: ListStaffRef; ``` You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. ```typescript -listVendor(dc: DataConnect): QueryPromise; +listStaff(dc: DataConnect): QueryPromise; -interface ListVendorRef { +interface ListStaffRef { ... - (dc: DataConnect): QueryRef; + (dc: DataConnect): QueryRef; } -export const listVendorRef: ListVendorRef; +export const listStaffRef: ListStaffRef; ``` -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRef: +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listStaffRef: ```typescript -const name = listVendorRef.operationName; +const name = listStaffRef.operationName; console.log(name); ``` ### Variables -The `listVendor` query has no variables. +The `listStaff` query has no variables. ### Return Type -Recall that executing the `listVendor` query returns a `QueryPromise` that resolves to an object with a `data` property. +Recall that executing the `listStaff` query returns a `QueryPromise` that resolves to an object with a `data` property. -The `data` property is an object of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +The `data` property is an object of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: ```typescript -export interface ListVendorData { - vendors: ({ +export interface ListStaffData { + staffs: ({ id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_Key)[]; + employeeName: string; + vendorId?: UUIDString | null; + email?: string | null; + position?: string | null; + employmentType: EmploymentType; + rating?: number | null; + reliabilityScore?: number | null; + backgroundCheckStatus: BackgroundCheckStatus; + certifications?: string | null; + } & Staff_Key)[]; } ``` -### Using `listVendor`'s action shortcut function +### Using `listStaff`'s action shortcut function ```typescript import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, listVendor } from '@dataconnect/generated'; +import { connectorConfig, listStaff } from '@dataconnect/generated'; -// Call the `listVendor()` function to execute the query. +// Call the `listStaff()` function to execute the query. // You can use the `await` keyword to wait for the promise to resolve. -const { data } = await listVendor(); +const { data } = await listStaff(); // You can also pass in a `DataConnect` instance to the action shortcut function. const dataConnect = getDataConnect(connectorConfig); -const { data } = await listVendor(dataConnect); +const { data } = await listStaff(dataConnect); -console.log(data.vendors); +console.log(data.staffs); // Or, you can use the `Promise` API. -listVendor().then((response) => { +listStaff().then((response) => { const data = response.data; - console.log(data.vendors); + console.log(data.staffs); }); ``` -### Using `listVendor`'s `QueryRef` function +### Using `listStaff`'s `QueryRef` function ```typescript import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, listVendorRef } from '@dataconnect/generated'; +import { connectorConfig, listStaffRef } from '@dataconnect/generated'; -// Call the `listVendorRef()` function to get a reference to the query. -const ref = listVendorRef(); +// Call the `listStaffRef()` function to get a reference to the query. +const ref = listStaffRef(); // You can also pass in a `DataConnect` instance to the `QueryRef` function. const dataConnect = getDataConnect(connectorConfig); -const ref = listVendorRef(dataConnect); +const ref = listStaffRef(dataConnect); // Call `executeQuery()` on the reference to execute the query. // You can use the `await` keyword to wait for the promise to resolve. const { data } = await executeQuery(ref); -console.log(data.vendors); +console.log(data.staffs); // Or, you can use the `Promise` API. executeQuery(ref).then((response) => { const data = response.data; - console.log(data.vendors); -}); -``` - -## getVendorById -You can execute the `getVendorById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -getVendorById(vars: GetVendorByIdVariables): QueryPromise; - -interface GetVendorByIdRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorByIdVariables): QueryRef; -} -export const getVendorByIdRef: GetVendorByIdRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise; - -interface GetVendorByIdRef { - ... - (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef; -} -export const getVendorByIdRef: GetVendorByIdRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorByIdRef: -```typescript -const name = getVendorByIdRef.operationName; -console.log(name); -``` - -### Variables -The `getVendorById` query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface GetVendorByIdVariables { - id: UUIDString; -} -``` -### Return Type -Recall that executing the `getVendorById` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface GetVendorByIdData { - vendor?: { - id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_Key; -} -``` -### Using `getVendorById`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, getVendorById, GetVendorByIdVariables } from '@dataconnect/generated'; - -// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`: -const getVendorByIdVars: GetVendorByIdVariables = { - id: ..., -}; - -// Call the `getVendorById()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await getVendorById(getVendorByIdVars); -// Variables can be defined inline as well. -const { data } = await getVendorById({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await getVendorById(dataConnect, getVendorByIdVars); - -console.log(data.vendor); - -// Or, you can use the `Promise` API. -getVendorById(getVendorByIdVars).then((response) => { - const data = response.data; - console.log(data.vendor); -}); -``` - -### Using `getVendorById`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, getVendorByIdRef, GetVendorByIdVariables } from '@dataconnect/generated'; - -// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`: -const getVendorByIdVars: GetVendorByIdVariables = { - id: ..., -}; - -// Call the `getVendorByIdRef()` function to get a reference to the query. -const ref = getVendorByIdRef(getVendorByIdVars); -// Variables can be defined inline as well. -const ref = getVendorByIdRef({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = getVendorByIdRef(dataConnect, getVendorByIdVars); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendor); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendor); -}); -``` - -## filterVendors -You can execute the `filterVendors` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -filterVendors(vars?: FilterVendorsVariables): QueryPromise; - -interface FilterVendorsRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorsVariables): QueryRef; -} -export const filterVendorsRef: FilterVendorsRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise; - -interface FilterVendorsRef { - ... - (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef; -} -export const filterVendorsRef: FilterVendorsRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorsRef: -```typescript -const name = filterVendorsRef.operationName; -console.log(name); -``` - -### Variables -The `filterVendors` query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface FilterVendorsVariables { - region?: VendorRegion | null; - approvalStatus?: VendorApprovalStatus | null; - isActive?: boolean | null; - vendorNumber?: string | null; - primaryContactEmail?: string | null; - legalName?: string | null; - platformType?: VendorPlatformType | null; -} -``` -### Return Type -Recall that executing the `filterVendors` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface FilterVendorsData { - vendors: ({ - id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_Key)[]; -} -``` -### Using `filterVendors`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, filterVendors, FilterVendorsVariables } from '@dataconnect/generated'; - -// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`: -const filterVendorsVars: FilterVendorsVariables = { - region: ..., // optional - approvalStatus: ..., // optional - isActive: ..., // optional - vendorNumber: ..., // optional - primaryContactEmail: ..., // optional - legalName: ..., // optional - platformType: ..., // optional -}; - -// Call the `filterVendors()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await filterVendors(filterVendorsVars); -// Variables can be defined inline as well. -const { data } = await filterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); -// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument. -const { data } = await filterVendors(); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await filterVendors(dataConnect, filterVendorsVars); - -console.log(data.vendors); - -// Or, you can use the `Promise` API. -filterVendors(filterVendorsVars).then((response) => { - const data = response.data; - console.log(data.vendors); -}); -``` - -### Using `filterVendors`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, filterVendorsRef, FilterVendorsVariables } from '@dataconnect/generated'; - -// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`: -const filterVendorsVars: FilterVendorsVariables = { - region: ..., // optional - approvalStatus: ..., // optional - isActive: ..., // optional - vendorNumber: ..., // optional - primaryContactEmail: ..., // optional - legalName: ..., // optional - platformType: ..., // optional -}; - -// Call the `filterVendorsRef()` function to get a reference to the query. -const ref = filterVendorsRef(filterVendorsVars); -// Variables can be defined inline as well. -const ref = filterVendorsRef({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); -// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument. -const ref = filterVendorsRef(); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = filterVendorsRef(dataConnect, filterVendorsVars); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendors); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendors); -}); -``` - -## listVendorRate -You can execute the `listVendorRate` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -listVendorRate(): QueryPromise; - -interface ListVendorRateRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; -} -export const listVendorRateRef: ListVendorRateRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -listVendorRate(dc: DataConnect): QueryPromise; - -interface ListVendorRateRef { - ... - (dc: DataConnect): QueryRef; -} -export const listVendorRateRef: ListVendorRateRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRateRef: -```typescript -const name = listVendorRateRef.operationName; -console.log(name); -``` - -### Variables -The `listVendorRate` query has no variables. -### Return Type -Recall that executing the `listVendorRate` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface ListVendorRateData { - vendorRates: ({ - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - } & VendorRate_Key)[]; -} -``` -### Using `listVendorRate`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, listVendorRate } from '@dataconnect/generated'; - - -// Call the `listVendorRate()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await listVendorRate(); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await listVendorRate(dataConnect); - -console.log(data.vendorRates); - -// Or, you can use the `Promise` API. -listVendorRate().then((response) => { - const data = response.data; - console.log(data.vendorRates); -}); -``` - -### Using `listVendorRate`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, listVendorRateRef } from '@dataconnect/generated'; - - -// Call the `listVendorRateRef()` function to get a reference to the query. -const ref = listVendorRateRef(); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = listVendorRateRef(dataConnect); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendorRates); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendorRates); -}); -``` - -## getVendorRateById -You can execute the `getVendorRateById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise; - -interface GetVendorRateByIdRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorRateByIdVariables): QueryRef; -} -export const getVendorRateByIdRef: GetVendorRateByIdRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise; - -interface GetVendorRateByIdRef { - ... - (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef; -} -export const getVendorRateByIdRef: GetVendorRateByIdRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorRateByIdRef: -```typescript -const name = getVendorRateByIdRef.operationName; -console.log(name); -``` - -### Variables -The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface GetVendorRateByIdVariables { - id: UUIDString; -} -``` -### Return Type -Recall that executing the `getVendorRateById` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface GetVendorRateByIdData { - vendorRate?: { - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - createdDate?: TimestampString | null; - updatedDate?: TimestampString | null; - createdBy?: string | null; - } & VendorRate_Key; -} -``` -### Using `getVendorRateById`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, getVendorRateById, GetVendorRateByIdVariables } from '@dataconnect/generated'; - -// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`: -const getVendorRateByIdVars: GetVendorRateByIdVariables = { - id: ..., -}; - -// Call the `getVendorRateById()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await getVendorRateById(getVendorRateByIdVars); -// Variables can be defined inline as well. -const { data } = await getVendorRateById({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await getVendorRateById(dataConnect, getVendorRateByIdVars); - -console.log(data.vendorRate); - -// Or, you can use the `Promise` API. -getVendorRateById(getVendorRateByIdVars).then((response) => { - const data = response.data; - console.log(data.vendorRate); -}); -``` - -### Using `getVendorRateById`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, getVendorRateByIdRef, GetVendorRateByIdVariables } from '@dataconnect/generated'; - -// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`: -const getVendorRateByIdVars: GetVendorRateByIdVariables = { - id: ..., -}; - -// Call the `getVendorRateByIdRef()` function to get a reference to the query. -const ref = getVendorRateByIdRef(getVendorRateByIdVars); -// Variables can be defined inline as well. -const ref = getVendorRateByIdRef({ id: ..., }); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = getVendorRateByIdRef(dataConnect, getVendorRateByIdVars); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendorRate); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendorRate); -}); -``` - -## filterVendorRates -You can execute the `filterVendorRates` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): -```typescript -filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise; - -interface FilterVendorRatesRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorRatesVariables): QueryRef; -} -export const filterVendorRatesRef: FilterVendorRatesRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. -```typescript -filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise; - -interface FilterVendorRatesRef { - ... - (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef; -} -export const filterVendorRatesRef: FilterVendorRatesRef; -``` - -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorRatesRef: -```typescript -const name = filterVendorRatesRef.operationName; -console.log(name); -``` - -### Variables -The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface FilterVendorRatesVariables { - vendorName?: string | null; - category?: VendorRateCategory | null; - roleName?: string | null; - minClientRate?: number | null; - maxClientRate?: number | null; -} -``` -### Return Type -Recall that executing the `filterVendorRates` query returns a `QueryPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface FilterVendorRatesData { - vendorRates: ({ - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - } & VendorRate_Key)[]; -} -``` -### Using `filterVendorRates`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, filterVendorRates, FilterVendorRatesVariables } from '@dataconnect/generated'; - -// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`: -const filterVendorRatesVars: FilterVendorRatesVariables = { - vendorName: ..., // optional - category: ..., // optional - roleName: ..., // optional - minClientRate: ..., // optional - maxClientRate: ..., // optional -}; - -// Call the `filterVendorRates()` function to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await filterVendorRates(filterVendorRatesVars); -// Variables can be defined inline as well. -const { data } = await filterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); -// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument. -const { data } = await filterVendorRates(); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await filterVendorRates(dataConnect, filterVendorRatesVars); - -console.log(data.vendorRates); - -// Or, you can use the `Promise` API. -filterVendorRates(filterVendorRatesVars).then((response) => { - const data = response.data; - console.log(data.vendorRates); -}); -``` - -### Using `filterVendorRates`'s `QueryRef` function - -```typescript -import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, filterVendorRatesRef, FilterVendorRatesVariables } from '@dataconnect/generated'; - -// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`: -const filterVendorRatesVars: FilterVendorRatesVariables = { - vendorName: ..., // optional - category: ..., // optional - roleName: ..., // optional - minClientRate: ..., // optional - maxClientRate: ..., // optional -}; - -// Call the `filterVendorRatesRef()` function to get a reference to the query. -const ref = filterVendorRatesRef(filterVendorRatesVars); -// Variables can be defined inline as well. -const ref = filterVendorRatesRef({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); -// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument. -const ref = filterVendorRatesRef(); - -// You can also pass in a `DataConnect` instance to the `QueryRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = filterVendorRatesRef(dataConnect, filterVendorRatesVars); - -// Call `executeQuery()` on the reference to execute the query. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await executeQuery(ref); - -console.log(data.vendorRates); - -// Or, you can use the `Promise` API. -executeQuery(ref).then((response) => { - const data = response.data; - console.log(data.vendorRates); + console.log(data.staffs); }); ``` @@ -1244,105 +639,1050 @@ executeQuery(ref).then((response) => { }); ``` -## listStaff -You can execute the `listStaff` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +## listVendor +You can execute the `listVendor` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): ```typescript -listStaff(): QueryPromise; +listVendor(): QueryPromise; -interface ListStaffRef { +interface ListVendorRef { ... /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; + (): QueryRef; } -export const listStaffRef: ListStaffRef; +export const listVendorRef: ListVendorRef; ``` You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. ```typescript -listStaff(dc: DataConnect): QueryPromise; +listVendor(dc: DataConnect): QueryPromise; -interface ListStaffRef { +interface ListVendorRef { ... - (dc: DataConnect): QueryRef; + (dc: DataConnect): QueryRef; } -export const listStaffRef: ListStaffRef; +export const listVendorRef: ListVendorRef; ``` -If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listStaffRef: +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRef: ```typescript -const name = listStaffRef.operationName; +const name = listVendorRef.operationName; console.log(name); ``` ### Variables -The `listStaff` query has no variables. +The `listVendor` query has no variables. ### Return Type -Recall that executing the `listStaff` query returns a `QueryPromise` that resolves to an object with a `data` property. +Recall that executing the `listVendor` query returns a `QueryPromise` that resolves to an object with a `data` property. -The `data` property is an object of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +The `data` property is an object of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: ```typescript -export interface ListStaffData { - staffs: ({ +export interface ListVendorData { + vendors: ({ id: UUIDString; - employeeName: string; - vendorId?: UUIDString | null; - email?: string | null; - position?: string | null; - employmentType: EmploymentType; - rating?: number | null; - reliabilityScore?: number | null; - backgroundCheckStatus: BackgroundCheckStatus; - certifications?: string | null; - } & Staff_Key)[]; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_Key)[]; } ``` -### Using `listStaff`'s action shortcut function +### Using `listVendor`'s action shortcut function ```typescript import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, listStaff } from '@dataconnect/generated'; +import { connectorConfig, listVendor } from '@dataconnect/generated'; -// Call the `listStaff()` function to execute the query. +// Call the `listVendor()` function to execute the query. // You can use the `await` keyword to wait for the promise to resolve. -const { data } = await listStaff(); +const { data } = await listVendor(); // You can also pass in a `DataConnect` instance to the action shortcut function. const dataConnect = getDataConnect(connectorConfig); -const { data } = await listStaff(dataConnect); +const { data } = await listVendor(dataConnect); -console.log(data.staffs); +console.log(data.vendors); // Or, you can use the `Promise` API. -listStaff().then((response) => { +listVendor().then((response) => { const data = response.data; - console.log(data.staffs); + console.log(data.vendors); }); ``` -### Using `listStaff`'s `QueryRef` function +### Using `listVendor`'s `QueryRef` function ```typescript import { getDataConnect, executeQuery } from 'firebase/data-connect'; -import { connectorConfig, listStaffRef } from '@dataconnect/generated'; +import { connectorConfig, listVendorRef } from '@dataconnect/generated'; -// Call the `listStaffRef()` function to get a reference to the query. -const ref = listStaffRef(); +// Call the `listVendorRef()` function to get a reference to the query. +const ref = listVendorRef(); // You can also pass in a `DataConnect` instance to the `QueryRef` function. const dataConnect = getDataConnect(connectorConfig); -const ref = listStaffRef(dataConnect); +const ref = listVendorRef(dataConnect); // Call `executeQuery()` on the reference to execute the query. // You can use the `await` keyword to wait for the promise to resolve. const { data } = await executeQuery(ref); -console.log(data.staffs); +console.log(data.vendors); // Or, you can use the `Promise` API. executeQuery(ref).then((response) => { const data = response.data; - console.log(data.staffs); + console.log(data.vendors); +}); +``` + +## getVendorById +You can execute the `getVendorById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +getVendorById(vars: GetVendorByIdVariables): QueryPromise; + +interface GetVendorByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorByIdVariables): QueryRef; +} +export const getVendorByIdRef: GetVendorByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise; + +interface GetVendorByIdRef { + ... + (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef; +} +export const getVendorByIdRef: GetVendorByIdRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorByIdRef: +```typescript +const name = getVendorByIdRef.operationName; +console.log(name); +``` + +### Variables +The `getVendorById` query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetVendorByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `getVendorById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetVendorByIdData { + vendor?: { + id: UUIDString; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_Key; +} +``` +### Using `getVendorById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getVendorById, GetVendorByIdVariables } from '@dataconnect/generated'; + +// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`: +const getVendorByIdVars: GetVendorByIdVariables = { + id: ..., +}; + +// Call the `getVendorById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getVendorById(getVendorByIdVars); +// Variables can be defined inline as well. +const { data } = await getVendorById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getVendorById(dataConnect, getVendorByIdVars); + +console.log(data.vendor); + +// Or, you can use the `Promise` API. +getVendorById(getVendorByIdVars).then((response) => { + const data = response.data; + console.log(data.vendor); +}); +``` + +### Using `getVendorById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getVendorByIdRef, GetVendorByIdVariables } from '@dataconnect/generated'; + +// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`: +const getVendorByIdVars: GetVendorByIdVariables = { + id: ..., +}; + +// Call the `getVendorByIdRef()` function to get a reference to the query. +const ref = getVendorByIdRef(getVendorByIdVars); +// Variables can be defined inline as well. +const ref = getVendorByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getVendorByIdRef(dataConnect, getVendorByIdVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendor); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendor); +}); +``` + +## filterVendors +You can execute the `filterVendors` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +filterVendors(vars?: FilterVendorsVariables): QueryPromise; + +interface FilterVendorsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorsVariables): QueryRef; +} +export const filterVendorsRef: FilterVendorsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise; + +interface FilterVendorsRef { + ... + (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef; +} +export const filterVendorsRef: FilterVendorsRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorsRef: +```typescript +const name = filterVendorsRef.operationName; +console.log(name); +``` + +### Variables +The `filterVendors` query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface FilterVendorsVariables { + region?: VendorRegion | null; + approvalStatus?: VendorApprovalStatus | null; + isActive?: boolean | null; + vendorNumber?: string | null; + primaryContactEmail?: string | null; + legalName?: string | null; + platformType?: VendorPlatformType | null; +} +``` +### Return Type +Recall that executing the `filterVendors` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface FilterVendorsData { + vendors: ({ + id: UUIDString; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_Key)[]; +} +``` +### Using `filterVendors`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, filterVendors, FilterVendorsVariables } from '@dataconnect/generated'; + +// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`: +const filterVendorsVars: FilterVendorsVariables = { + region: ..., // optional + approvalStatus: ..., // optional + isActive: ..., // optional + vendorNumber: ..., // optional + primaryContactEmail: ..., // optional + legalName: ..., // optional + platformType: ..., // optional +}; + +// Call the `filterVendors()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await filterVendors(filterVendorsVars); +// Variables can be defined inline as well. +const { data } = await filterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument. +const { data } = await filterVendors(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await filterVendors(dataConnect, filterVendorsVars); + +console.log(data.vendors); + +// Or, you can use the `Promise` API. +filterVendors(filterVendorsVars).then((response) => { + const data = response.data; + console.log(data.vendors); +}); +``` + +### Using `filterVendors`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, filterVendorsRef, FilterVendorsVariables } from '@dataconnect/generated'; + +// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`: +const filterVendorsVars: FilterVendorsVariables = { + region: ..., // optional + approvalStatus: ..., // optional + isActive: ..., // optional + vendorNumber: ..., // optional + primaryContactEmail: ..., // optional + legalName: ..., // optional + platformType: ..., // optional +}; + +// Call the `filterVendorsRef()` function to get a reference to the query. +const ref = filterVendorsRef(filterVendorsVars); +// Variables can be defined inline as well. +const ref = filterVendorsRef({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument. +const ref = filterVendorsRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = filterVendorsRef(dataConnect, filterVendorsVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendors); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendors); +}); +``` + +## listVendorDefaultSettings +You can execute the `listVendorDefaultSettings` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +listVendorDefaultSettings(): QueryPromise; + +interface ListVendorDefaultSettingsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (): QueryRef; +} +export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listVendorDefaultSettings(dc: DataConnect): QueryPromise; + +interface ListVendorDefaultSettingsRef { + ... + (dc: DataConnect): QueryRef; +} +export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorDefaultSettingsRef: +```typescript +const name = listVendorDefaultSettingsRef.operationName; +console.log(name); +``` + +### Variables +The `listVendorDefaultSettings` query has no variables. +### Return Type +Recall that executing the `listVendorDefaultSettings` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key)[]; +} +``` +### Using `listVendorDefaultSettings`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listVendorDefaultSettings } from '@dataconnect/generated'; + + +// Call the `listVendorDefaultSettings()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listVendorDefaultSettings(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listVendorDefaultSettings(dataConnect); + +console.log(data.vendorDefaultSettings); + +// Or, you can use the `Promise` API. +listVendorDefaultSettings().then((response) => { + const data = response.data; + console.log(data.vendorDefaultSettings); +}); +``` + +### Using `listVendorDefaultSettings`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listVendorDefaultSettingsRef } from '@dataconnect/generated'; + + +// Call the `listVendorDefaultSettingsRef()` function to get a reference to the query. +const ref = listVendorDefaultSettingsRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listVendorDefaultSettingsRef(dataConnect); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorDefaultSettings); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSettings); +}); +``` + +## getVendorDefaultSettingById +You can execute the `getVendorDefaultSettingById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise; + +interface GetVendorDefaultSettingByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorDefaultSettingByIdVariables): QueryRef; +} +export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise; + +interface GetVendorDefaultSettingByIdRef { + ... + (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef; +} +export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorDefaultSettingByIdRef: +```typescript +const name = getVendorDefaultSettingByIdRef.operationName; +console.log(name); +``` + +### Variables +The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetVendorDefaultSettingByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `getVendorDefaultSettingById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetVendorDefaultSettingByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetVendorDefaultSettingByIdData { + vendorDefaultSetting?: { + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key; +} +``` +### Using `getVendorDefaultSettingById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getVendorDefaultSettingById, GetVendorDefaultSettingByIdVariables } from '@dataconnect/generated'; + +// The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`: +const getVendorDefaultSettingByIdVars: GetVendorDefaultSettingByIdVariables = { + id: ..., +}; + +// Call the `getVendorDefaultSettingById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getVendorDefaultSettingById(getVendorDefaultSettingByIdVars); +// Variables can be defined inline as well. +const { data } = await getVendorDefaultSettingById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars); + +console.log(data.vendorDefaultSetting); + +// Or, you can use the `Promise` API. +getVendorDefaultSettingById(getVendorDefaultSettingByIdVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting); +}); +``` + +### Using `getVendorDefaultSettingById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getVendorDefaultSettingByIdRef, GetVendorDefaultSettingByIdVariables } from '@dataconnect/generated'; + +// The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`: +const getVendorDefaultSettingByIdVars: GetVendorDefaultSettingByIdVariables = { + id: ..., +}; + +// Call the `getVendorDefaultSettingByIdRef()` function to get a reference to the query. +const ref = getVendorDefaultSettingByIdRef(getVendorDefaultSettingByIdVars); +// Variables can be defined inline as well. +const ref = getVendorDefaultSettingByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getVendorDefaultSettingByIdRef(dataConnect, getVendorDefaultSettingByIdVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorDefaultSetting); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting); +}); +``` + +## filterVendorDefaultSettings +You can execute the `filterVendorDefaultSettings` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise; + +interface FilterVendorDefaultSettingsRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorDefaultSettingsVariables): QueryRef; +} +export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise; + +interface FilterVendorDefaultSettingsRef { + ... + (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef; +} +export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorDefaultSettingsRef: +```typescript +const name = filterVendorDefaultSettingsRef.operationName; +console.log(name); +``` + +### Variables +The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface FilterVendorDefaultSettingsVariables { + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} +``` +### Return Type +Recall that executing the `filterVendorDefaultSettings` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `FilterVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface FilterVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key)[]; +} +``` +### Using `filterVendorDefaultSettings`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, filterVendorDefaultSettings, FilterVendorDefaultSettingsVariables } from '@dataconnect/generated'; + +// The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`: +const filterVendorDefaultSettingsVars: FilterVendorDefaultSettingsVariables = { + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional +}; + +// Call the `filterVendorDefaultSettings()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await filterVendorDefaultSettings(filterVendorDefaultSettingsVars); +// Variables can be defined inline as well. +const { data } = await filterVendorDefaultSettings({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorDefaultSettingsVariables` argument. +const { data } = await filterVendorDefaultSettings(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await filterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars); + +console.log(data.vendorDefaultSettings); + +// Or, you can use the `Promise` API. +filterVendorDefaultSettings(filterVendorDefaultSettingsVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSettings); +}); +``` + +### Using `filterVendorDefaultSettings`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, filterVendorDefaultSettingsRef, FilterVendorDefaultSettingsVariables } from '@dataconnect/generated'; + +// The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`: +const filterVendorDefaultSettingsVars: FilterVendorDefaultSettingsVariables = { + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional +}; + +// Call the `filterVendorDefaultSettingsRef()` function to get a reference to the query. +const ref = filterVendorDefaultSettingsRef(filterVendorDefaultSettingsVars); +// Variables can be defined inline as well. +const ref = filterVendorDefaultSettingsRef({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorDefaultSettingsVariables` argument. +const ref = filterVendorDefaultSettingsRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = filterVendorDefaultSettingsRef(dataConnect, filterVendorDefaultSettingsVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorDefaultSettings); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSettings); +}); +``` + +## listVendorRate +You can execute the `listVendorRate` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +listVendorRate(): QueryPromise; + +interface ListVendorRateRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (): QueryRef; +} +export const listVendorRateRef: ListVendorRateRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listVendorRate(dc: DataConnect): QueryPromise; + +interface ListVendorRateRef { + ... + (dc: DataConnect): QueryRef; +} +export const listVendorRateRef: ListVendorRateRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRateRef: +```typescript +const name = listVendorRateRef.operationName; +console.log(name); +``` + +### Variables +The `listVendorRate` query has no variables. +### Return Type +Recall that executing the `listVendorRate` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListVendorRateData { + vendorRates: ({ + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + } & VendorRate_Key)[]; +} +``` +### Using `listVendorRate`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listVendorRate } from '@dataconnect/generated'; + + +// Call the `listVendorRate()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listVendorRate(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listVendorRate(dataConnect); + +console.log(data.vendorRates); + +// Or, you can use the `Promise` API. +listVendorRate().then((response) => { + const data = response.data; + console.log(data.vendorRates); +}); +``` + +### Using `listVendorRate`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listVendorRateRef } from '@dataconnect/generated'; + + +// Call the `listVendorRateRef()` function to get a reference to the query. +const ref = listVendorRateRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listVendorRateRef(dataConnect); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorRates); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorRates); +}); +``` + +## getVendorRateById +You can execute the `getVendorRateById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise; + +interface GetVendorRateByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorRateByIdVariables): QueryRef; +} +export const getVendorRateByIdRef: GetVendorRateByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise; + +interface GetVendorRateByIdRef { + ... + (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef; +} +export const getVendorRateByIdRef: GetVendorRateByIdRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorRateByIdRef: +```typescript +const name = getVendorRateByIdRef.operationName; +console.log(name); +``` + +### Variables +The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetVendorRateByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `getVendorRateById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetVendorRateByIdData { + vendorRate?: { + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + createdDate?: TimestampString | null; + updatedDate?: TimestampString | null; + createdBy?: string | null; + } & VendorRate_Key; +} +``` +### Using `getVendorRateById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getVendorRateById, GetVendorRateByIdVariables } from '@dataconnect/generated'; + +// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`: +const getVendorRateByIdVars: GetVendorRateByIdVariables = { + id: ..., +}; + +// Call the `getVendorRateById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getVendorRateById(getVendorRateByIdVars); +// Variables can be defined inline as well. +const { data } = await getVendorRateById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getVendorRateById(dataConnect, getVendorRateByIdVars); + +console.log(data.vendorRate); + +// Or, you can use the `Promise` API. +getVendorRateById(getVendorRateByIdVars).then((response) => { + const data = response.data; + console.log(data.vendorRate); +}); +``` + +### Using `getVendorRateById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getVendorRateByIdRef, GetVendorRateByIdVariables } from '@dataconnect/generated'; + +// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`: +const getVendorRateByIdVars: GetVendorRateByIdVariables = { + id: ..., +}; + +// Call the `getVendorRateByIdRef()` function to get a reference to the query. +const ref = getVendorRateByIdRef(getVendorRateByIdVars); +// Variables can be defined inline as well. +const ref = getVendorRateByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getVendorRateByIdRef(dataConnect, getVendorRateByIdVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorRate); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorRate); +}); +``` + +## filterVendorRates +You can execute the `filterVendorRates` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise; + +interface FilterVendorRatesRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorRatesVariables): QueryRef; +} +export const filterVendorRatesRef: FilterVendorRatesRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise; + +interface FilterVendorRatesRef { + ... + (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef; +} +export const filterVendorRatesRef: FilterVendorRatesRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorRatesRef: +```typescript +const name = filterVendorRatesRef.operationName; +console.log(name); +``` + +### Variables +The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface FilterVendorRatesVariables { + vendorName?: string | null; + category?: VendorRateCategory | null; + roleName?: string | null; + minClientRate?: number | null; + maxClientRate?: number | null; +} +``` +### Return Type +Recall that executing the `filterVendorRates` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface FilterVendorRatesData { + vendorRates: ({ + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + } & VendorRate_Key)[]; +} +``` +### Using `filterVendorRates`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, filterVendorRates, FilterVendorRatesVariables } from '@dataconnect/generated'; + +// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`: +const filterVendorRatesVars: FilterVendorRatesVariables = { + vendorName: ..., // optional + category: ..., // optional + roleName: ..., // optional + minClientRate: ..., // optional + maxClientRate: ..., // optional +}; + +// Call the `filterVendorRates()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await filterVendorRates(filterVendorRatesVars); +// Variables can be defined inline as well. +const { data } = await filterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument. +const { data } = await filterVendorRates(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await filterVendorRates(dataConnect, filterVendorRatesVars); + +console.log(data.vendorRates); + +// Or, you can use the `Promise` API. +filterVendorRates(filterVendorRatesVars).then((response) => { + const data = response.data; + console.log(data.vendorRates); +}); +``` + +### Using `filterVendorRates`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, filterVendorRatesRef, FilterVendorRatesVariables } from '@dataconnect/generated'; + +// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`: +const filterVendorRatesVars: FilterVendorRatesVariables = { + vendorName: ..., // optional + category: ..., // optional + roleName: ..., // optional + minClientRate: ..., // optional + maxClientRate: ..., // optional +}; + +// Call the `filterVendorRatesRef()` function to get a reference to the query. +const ref = filterVendorRatesRef(filterVendorRatesVars); +// Variables can be defined inline as well. +const ref = filterVendorRatesRef({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); +// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument. +const ref = filterVendorRatesRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = filterVendorRatesRef(dataConnect, filterVendorRatesVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.vendorRates); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.vendorRates); }); ``` @@ -2754,3 +3094,345 @@ executeMutation(ref).then((response) => { }); ``` +## CreateVendorDefaultSetting +You can execute the `CreateVendorDefaultSetting` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +createVendorDefaultSetting(vars: CreateVendorDefaultSettingVariables): MutationPromise; + +interface CreateVendorDefaultSettingRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateVendorDefaultSettingVariables): MutationRef; +} +export const createVendorDefaultSettingRef: CreateVendorDefaultSettingRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createVendorDefaultSetting(dc: DataConnect, vars: CreateVendorDefaultSettingVariables): MutationPromise; + +interface CreateVendorDefaultSettingRef { + ... + (dc: DataConnect, vars: CreateVendorDefaultSettingVariables): MutationRef; +} +export const createVendorDefaultSettingRef: CreateVendorDefaultSettingRef; +``` + +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 createVendorDefaultSettingRef: +```typescript +const name = createVendorDefaultSettingRef.operationName; +console.log(name); +``` + +### Variables +The `CreateVendorDefaultSetting` mutation requires an argument of type `CreateVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateVendorDefaultSettingVariables { + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; +} +``` +### Return Type +Recall that executing the `CreateVendorDefaultSetting` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateVendorDefaultSettingData { + vendorDefaultSetting_insert: VendorDefaultSetting_Key; +} +``` +### Using `CreateVendorDefaultSetting`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createVendorDefaultSetting, CreateVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `CreateVendorDefaultSetting` mutation requires an argument of type `CreateVendorDefaultSettingVariables`: +const createVendorDefaultSettingVars: CreateVendorDefaultSettingVariables = { + vendorName: ..., + defaultMarkupPercentage: ..., + defaultVendorFeePercentage: ..., +}; + +// Call the `createVendorDefaultSetting()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createVendorDefaultSetting(createVendorDefaultSettingVars); +// Variables can be defined inline as well. +const { data } = await createVendorDefaultSetting({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createVendorDefaultSetting(dataConnect, createVendorDefaultSettingVars); + +console.log(data.vendorDefaultSetting_insert); + +// Or, you can use the `Promise` API. +createVendorDefaultSetting(createVendorDefaultSettingVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_insert); +}); +``` + +### Using `CreateVendorDefaultSetting`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createVendorDefaultSettingRef, CreateVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `CreateVendorDefaultSetting` mutation requires an argument of type `CreateVendorDefaultSettingVariables`: +const createVendorDefaultSettingVars: CreateVendorDefaultSettingVariables = { + vendorName: ..., + defaultMarkupPercentage: ..., + defaultVendorFeePercentage: ..., +}; + +// Call the `createVendorDefaultSettingRef()` function to get a reference to the mutation. +const ref = createVendorDefaultSettingRef(createVendorDefaultSettingVars); +// Variables can be defined inline as well. +const ref = createVendorDefaultSettingRef({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createVendorDefaultSettingRef(dataConnect, createVendorDefaultSettingVars); + +// 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.vendorDefaultSetting_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_insert); +}); +``` + +## UpdateVendorDefaultSetting +You can execute the `UpdateVendorDefaultSetting` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +updateVendorDefaultSetting(vars: UpdateVendorDefaultSettingVariables): MutationPromise; + +interface UpdateVendorDefaultSettingRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateVendorDefaultSettingVariables): MutationRef; +} +export const updateVendorDefaultSettingRef: UpdateVendorDefaultSettingRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateVendorDefaultSetting(dc: DataConnect, vars: UpdateVendorDefaultSettingVariables): MutationPromise; + +interface UpdateVendorDefaultSettingRef { + ... + (dc: DataConnect, vars: UpdateVendorDefaultSettingVariables): MutationRef; +} +export const updateVendorDefaultSettingRef: UpdateVendorDefaultSettingRef; +``` + +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 updateVendorDefaultSettingRef: +```typescript +const name = updateVendorDefaultSettingRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateVendorDefaultSetting` mutation requires an argument of type `UpdateVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateVendorDefaultSettingVariables { + id: UUIDString; + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} +``` +### Return Type +Recall that executing the `UpdateVendorDefaultSetting` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateVendorDefaultSettingData { + vendorDefaultSetting_update?: VendorDefaultSetting_Key | null; +} +``` +### Using `UpdateVendorDefaultSetting`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateVendorDefaultSetting, UpdateVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `UpdateVendorDefaultSetting` mutation requires an argument of type `UpdateVendorDefaultSettingVariables`: +const updateVendorDefaultSettingVars: UpdateVendorDefaultSettingVariables = { + id: ..., + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional +}; + +// Call the `updateVendorDefaultSetting()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateVendorDefaultSetting(updateVendorDefaultSettingVars); +// Variables can be defined inline as well. +const { data } = await updateVendorDefaultSetting({ id: ..., vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateVendorDefaultSetting(dataConnect, updateVendorDefaultSettingVars); + +console.log(data.vendorDefaultSetting_update); + +// Or, you can use the `Promise` API. +updateVendorDefaultSetting(updateVendorDefaultSettingVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_update); +}); +``` + +### Using `UpdateVendorDefaultSetting`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateVendorDefaultSettingRef, UpdateVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `UpdateVendorDefaultSetting` mutation requires an argument of type `UpdateVendorDefaultSettingVariables`: +const updateVendorDefaultSettingVars: UpdateVendorDefaultSettingVariables = { + id: ..., + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional +}; + +// Call the `updateVendorDefaultSettingRef()` function to get a reference to the mutation. +const ref = updateVendorDefaultSettingRef(updateVendorDefaultSettingVars); +// Variables can be defined inline as well. +const ref = updateVendorDefaultSettingRef({ id: ..., vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateVendorDefaultSettingRef(dataConnect, updateVendorDefaultSettingVars); + +// 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.vendorDefaultSetting_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_update); +}); +``` + +## DeleteVendorDefaultSetting +You can execute the `DeleteVendorDefaultSetting` mutation using the following action shortcut function, or by calling `executeMutation()` after calling the following `MutationRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +deleteVendorDefaultSetting(vars: DeleteVendorDefaultSettingVariables): MutationPromise; + +interface DeleteVendorDefaultSettingRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteVendorDefaultSettingVariables): MutationRef; +} +export const deleteVendorDefaultSettingRef: DeleteVendorDefaultSettingRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteVendorDefaultSetting(dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationPromise; + +interface DeleteVendorDefaultSettingRef { + ... + (dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationRef; +} +export const deleteVendorDefaultSettingRef: DeleteVendorDefaultSettingRef; +``` + +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 deleteVendorDefaultSettingRef: +```typescript +const name = deleteVendorDefaultSettingRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteVendorDefaultSetting` mutation requires an argument of type `DeleteVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteVendorDefaultSettingVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteVendorDefaultSetting` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteVendorDefaultSettingData { + vendorDefaultSetting_delete?: VendorDefaultSetting_Key | null; +} +``` +### Using `DeleteVendorDefaultSetting`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteVendorDefaultSetting, DeleteVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `DeleteVendorDefaultSetting` mutation requires an argument of type `DeleteVendorDefaultSettingVariables`: +const deleteVendorDefaultSettingVars: DeleteVendorDefaultSettingVariables = { + id: ..., +}; + +// Call the `deleteVendorDefaultSetting()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteVendorDefaultSetting(deleteVendorDefaultSettingVars); +// Variables can be defined inline as well. +const { data } = await deleteVendorDefaultSetting({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteVendorDefaultSetting(dataConnect, deleteVendorDefaultSettingVars); + +console.log(data.vendorDefaultSetting_delete); + +// Or, you can use the `Promise` API. +deleteVendorDefaultSetting(deleteVendorDefaultSettingVars).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_delete); +}); +``` + +### Using `DeleteVendorDefaultSetting`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteVendorDefaultSettingRef, DeleteVendorDefaultSettingVariables } from '@dataconnect/generated'; + +// The `DeleteVendorDefaultSetting` mutation requires an argument of type `DeleteVendorDefaultSettingVariables`: +const deleteVendorDefaultSettingVars: DeleteVendorDefaultSettingVariables = { + id: ..., +}; + +// Call the `deleteVendorDefaultSettingRef()` function to get a reference to the mutation. +const ref = deleteVendorDefaultSettingRef(deleteVendorDefaultSettingVars); +// Variables can be defined inline as well. +const ref = deleteVendorDefaultSettingRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteVendorDefaultSettingRef(dataConnect, deleteVendorDefaultSettingVars); + +// 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.vendorDefaultSetting_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.vendorDefaultSetting_delete); +}); +``` + diff --git a/internal-api-harness/src/dataconnect-generated/esm/index.esm.js b/internal-api-harness/src/dataconnect-generated/esm/index.esm.js index e8f12f67..5bc51f99 100644 --- a/internal-api-harness/src/dataconnect-generated/esm/index.esm.js +++ b/internal-api-harness/src/dataconnect-generated/esm/index.esm.js @@ -80,6 +80,17 @@ export const connectorConfig = { location: 'us-central1' }; +export const listStaffRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listStaff'); +} +listStaffRef.operationName = 'listStaff'; + +export function listStaff(dc) { + return executeQuery(listStaffRef(dc)); +} + export const createVendorRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -113,39 +124,6 @@ export function deleteVendor(dcOrVars, vars) { return executeMutation(deleteVendorRef(dcOrVars, vars)); } -export const listVendorRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listVendor'); -} -listVendorRef.operationName = 'listVendor'; - -export function listVendor(dc) { - return executeQuery(listVendorRef(dc)); -} - -export const getVendorByIdRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorById', inputVars); -} -getVendorByIdRef.operationName = 'getVendorById'; - -export function getVendorById(dcOrVars, vars) { - return executeQuery(getVendorByIdRef(dcOrVars, vars)); -} - -export const filterVendorsRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendors', inputVars); -} -filterVendorsRef.operationName = 'filterVendors'; - -export function filterVendors(dcOrVars, vars) { - return executeQuery(filterVendorsRef(dcOrVars, vars)); -} - export const createVendorRateRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -179,39 +157,6 @@ export function deleteVendorRate(dcOrVars, vars) { return executeMutation(deleteVendorRateRef(dcOrVars, vars)); } -export const listVendorRateRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listVendorRate'); -} -listVendorRateRef.operationName = 'listVendorRate'; - -export function listVendorRate(dc) { - return executeQuery(listVendorRateRef(dc)); -} - -export const getVendorRateByIdRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorRateById', inputVars); -} -getVendorRateByIdRef.operationName = 'getVendorRateById'; - -export function getVendorRateById(dcOrVars, vars) { - return executeQuery(getVendorRateByIdRef(dcOrVars, vars)); -} - -export const filterVendorRatesRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendorRates', inputVars); -} -filterVendorRatesRef.operationName = 'filterVendorRates'; - -export function filterVendorRates(dcOrVars, vars) { - return executeQuery(filterVendorRatesRef(dcOrVars, vars)); -} - export const createEventRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -289,14 +234,135 @@ export function createStaff(dcOrVars, vars) { return executeMutation(createStaffRef(dcOrVars, vars)); } -export const listStaffRef = (dc) => { +export const listVendorRef = (dc) => { const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listStaff'); + return queryRef(dcInstance, 'listVendor'); } -listStaffRef.operationName = 'listStaff'; +listVendorRef.operationName = 'listVendor'; -export function listStaff(dc) { - return executeQuery(listStaffRef(dc)); +export function listVendor(dc) { + return executeQuery(listVendorRef(dc)); +} + +export const getVendorByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorById', inputVars); +} +getVendorByIdRef.operationName = 'getVendorById'; + +export function getVendorById(dcOrVars, vars) { + return executeQuery(getVendorByIdRef(dcOrVars, vars)); +} + +export const filterVendorsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendors', inputVars); +} +filterVendorsRef.operationName = 'filterVendors'; + +export function filterVendors(dcOrVars, vars) { + return executeQuery(filterVendorsRef(dcOrVars, vars)); +} + +export const createVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateVendorDefaultSetting', inputVars); +} +createVendorDefaultSettingRef.operationName = 'CreateVendorDefaultSetting'; + +export function createVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(createVendorDefaultSettingRef(dcOrVars, vars)); +} + +export const updateVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateVendorDefaultSetting', inputVars); +} +updateVendorDefaultSettingRef.operationName = 'UpdateVendorDefaultSetting'; + +export function updateVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(updateVendorDefaultSettingRef(dcOrVars, vars)); +} + +export const deleteVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteVendorDefaultSetting', inputVars); +} +deleteVendorDefaultSettingRef.operationName = 'DeleteVendorDefaultSetting'; + +export function deleteVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(deleteVendorDefaultSettingRef(dcOrVars, vars)); +} + +export const listVendorDefaultSettingsRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listVendorDefaultSettings'); +} +listVendorDefaultSettingsRef.operationName = 'listVendorDefaultSettings'; + +export function listVendorDefaultSettings(dc) { + return executeQuery(listVendorDefaultSettingsRef(dc)); +} + +export const getVendorDefaultSettingByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); +} +getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; + +export function getVendorDefaultSettingById(dcOrVars, vars) { + return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); +} + +export const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); +} +filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; + +export function filterVendorDefaultSettings(dcOrVars, vars) { + return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); +} + +export const listVendorRateRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listVendorRate'); +} +listVendorRateRef.operationName = 'listVendorRate'; + +export function listVendorRate(dc) { + return executeQuery(listVendorRateRef(dc)); +} + +export const getVendorRateByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorRateById', inputVars); +} +getVendorRateByIdRef.operationName = 'getVendorRateById'; + +export function getVendorRateById(dcOrVars, vars) { + return executeQuery(getVendorRateByIdRef(dcOrVars, vars)); +} + +export const filterVendorRatesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendorRates', inputVars); +} +filterVendorRatesRef.operationName = 'filterVendorRates'; + +export function filterVendorRates(dcOrVars, vars) { + return executeQuery(filterVendorRatesRef(dcOrVars, vars)); } diff --git a/internal-api-harness/src/dataconnect-generated/index.cjs.js b/internal-api-harness/src/dataconnect-generated/index.cjs.js index 17689443..b132fc8b 100644 --- a/internal-api-harness/src/dataconnect-generated/index.cjs.js +++ b/internal-api-harness/src/dataconnect-generated/index.cjs.js @@ -90,6 +90,18 @@ const connectorConfig = { }; exports.connectorConfig = connectorConfig; +const listStaffRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listStaff'); +} +listStaffRef.operationName = 'listStaff'; +exports.listStaffRef = listStaffRef; + +exports.listStaff = function listStaff(dc) { + return executeQuery(listStaffRef(dc)); +}; + const createVendorRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -126,42 +138,6 @@ exports.deleteVendor = function deleteVendor(dcOrVars, vars) { return executeMutation(deleteVendorRef(dcOrVars, vars)); }; -const listVendorRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listVendor'); -} -listVendorRef.operationName = 'listVendor'; -exports.listVendorRef = listVendorRef; - -exports.listVendor = function listVendor(dc) { - return executeQuery(listVendorRef(dc)); -}; - -const getVendorByIdRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorById', inputVars); -} -getVendorByIdRef.operationName = 'getVendorById'; -exports.getVendorByIdRef = getVendorByIdRef; - -exports.getVendorById = function getVendorById(dcOrVars, vars) { - return executeQuery(getVendorByIdRef(dcOrVars, vars)); -}; - -const filterVendorsRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendors', inputVars); -} -filterVendorsRef.operationName = 'filterVendors'; -exports.filterVendorsRef = filterVendorsRef; - -exports.filterVendors = function filterVendors(dcOrVars, vars) { - return executeQuery(filterVendorsRef(dcOrVars, vars)); -}; - const createVendorRateRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -198,42 +174,6 @@ exports.deleteVendorRate = function deleteVendorRate(dcOrVars, vars) { return executeMutation(deleteVendorRateRef(dcOrVars, vars)); }; -const listVendorRateRef = (dc) => { - const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listVendorRate'); -} -listVendorRateRef.operationName = 'listVendorRate'; -exports.listVendorRateRef = listVendorRateRef; - -exports.listVendorRate = function listVendorRate(dc) { - return executeQuery(listVendorRateRef(dc)); -}; - -const getVendorRateByIdRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorRateById', inputVars); -} -getVendorRateByIdRef.operationName = 'getVendorRateById'; -exports.getVendorRateByIdRef = getVendorRateByIdRef; - -exports.getVendorRateById = function getVendorRateById(dcOrVars, vars) { - return executeQuery(getVendorRateByIdRef(dcOrVars, vars)); -}; - -const filterVendorRatesRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); - dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendorRates', inputVars); -} -filterVendorRatesRef.operationName = 'filterVendorRates'; -exports.filterVendorRatesRef = filterVendorRatesRef; - -exports.filterVendorRates = function filterVendorRates(dcOrVars, vars) { - return executeQuery(filterVendorRatesRef(dcOrVars, vars)); -}; - const createEventRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -318,14 +258,146 @@ exports.createStaff = function createStaff(dcOrVars, vars) { return executeMutation(createStaffRef(dcOrVars, vars)); }; -const listStaffRef = (dc) => { +const listVendorRef = (dc) => { const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'listStaff'); + return queryRef(dcInstance, 'listVendor'); } -listStaffRef.operationName = 'listStaff'; -exports.listStaffRef = listStaffRef; +listVendorRef.operationName = 'listVendor'; +exports.listVendorRef = listVendorRef; -exports.listStaff = function listStaff(dc) { - return executeQuery(listStaffRef(dc)); +exports.listVendor = function listVendor(dc) { + return executeQuery(listVendorRef(dc)); +}; + +const getVendorByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorById', inputVars); +} +getVendorByIdRef.operationName = 'getVendorById'; +exports.getVendorByIdRef = getVendorByIdRef; + +exports.getVendorById = function getVendorById(dcOrVars, vars) { + return executeQuery(getVendorByIdRef(dcOrVars, vars)); +}; + +const filterVendorsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendors', inputVars); +} +filterVendorsRef.operationName = 'filterVendors'; +exports.filterVendorsRef = filterVendorsRef; + +exports.filterVendors = function filterVendors(dcOrVars, vars) { + return executeQuery(filterVendorsRef(dcOrVars, vars)); +}; + +const createVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateVendorDefaultSetting', inputVars); +} +createVendorDefaultSettingRef.operationName = 'CreateVendorDefaultSetting'; +exports.createVendorDefaultSettingRef = createVendorDefaultSettingRef; + +exports.createVendorDefaultSetting = function createVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(createVendorDefaultSettingRef(dcOrVars, vars)); +}; + +const updateVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateVendorDefaultSetting', inputVars); +} +updateVendorDefaultSettingRef.operationName = 'UpdateVendorDefaultSetting'; +exports.updateVendorDefaultSettingRef = updateVendorDefaultSettingRef; + +exports.updateVendorDefaultSetting = function updateVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(updateVendorDefaultSettingRef(dcOrVars, vars)); +}; + +const deleteVendorDefaultSettingRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteVendorDefaultSetting', inputVars); +} +deleteVendorDefaultSettingRef.operationName = 'DeleteVendorDefaultSetting'; +exports.deleteVendorDefaultSettingRef = deleteVendorDefaultSettingRef; + +exports.deleteVendorDefaultSetting = function deleteVendorDefaultSetting(dcOrVars, vars) { + return executeMutation(deleteVendorDefaultSettingRef(dcOrVars, vars)); +}; + +const listVendorDefaultSettingsRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listVendorDefaultSettings'); +} +listVendorDefaultSettingsRef.operationName = 'listVendorDefaultSettings'; +exports.listVendorDefaultSettingsRef = listVendorDefaultSettingsRef; + +exports.listVendorDefaultSettings = function listVendorDefaultSettings(dc) { + return executeQuery(listVendorDefaultSettingsRef(dc)); +}; + +const getVendorDefaultSettingByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); +} +getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; +exports.getVendorDefaultSettingByIdRef = getVendorDefaultSettingByIdRef; + +exports.getVendorDefaultSettingById = function getVendorDefaultSettingById(dcOrVars, vars) { + return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); +}; + +const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); +} +filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; +exports.filterVendorDefaultSettingsRef = filterVendorDefaultSettingsRef; + +exports.filterVendorDefaultSettings = function filterVendorDefaultSettings(dcOrVars, vars) { + return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); +}; + +const listVendorRateRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listVendorRate'); +} +listVendorRateRef.operationName = 'listVendorRate'; +exports.listVendorRateRef = listVendorRateRef; + +exports.listVendorRate = function listVendorRate(dc) { + return executeQuery(listVendorRateRef(dc)); +}; + +const getVendorRateByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getVendorRateById', inputVars); +} +getVendorRateByIdRef.operationName = 'getVendorRateById'; +exports.getVendorRateByIdRef = getVendorRateByIdRef; + +exports.getVendorRateById = function getVendorRateById(dcOrVars, vars) { + return executeQuery(getVendorRateByIdRef(dcOrVars, vars)); +}; + +const filterVendorRatesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterVendorRates', inputVars); +} +filterVendorRatesRef.operationName = 'filterVendorRates'; +exports.filterVendorRatesRef = filterVendorRatesRef; + +exports.filterVendorRates = function filterVendorRates(dcOrVars, vars) { + return executeQuery(filterVendorRatesRef(dcOrVars, vars)); }; diff --git a/internal-api-harness/src/dataconnect-generated/index.d.ts b/internal-api-harness/src/dataconnect-generated/index.d.ts index fa6cd96a..042cb070 100644 --- a/internal-api-harness/src/dataconnect-generated/index.d.ts +++ b/internal-api-harness/src/dataconnect-generated/index.d.ts @@ -145,6 +145,16 @@ export interface CreateVendorData { vendor_insert: Vendor_Key; } +export interface CreateVendorDefaultSettingData { + vendorDefaultSetting_insert: VendorDefaultSetting_Key; +} + +export interface CreateVendorDefaultSettingVariables { + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; +} + export interface CreateVendorRateData { vendorRate_insert: VendorRate_Key; } @@ -181,6 +191,14 @@ export interface DeleteVendorData { vendor_delete?: Vendor_Key | null; } +export interface DeleteVendorDefaultSettingData { + vendorDefaultSetting_delete?: VendorDefaultSetting_Key | null; +} + +export interface DeleteVendorDefaultSettingVariables { + id: UUIDString; +} + export interface DeleteVendorRateData { vendorRate_delete?: VendorRate_Key | null; } @@ -253,6 +271,21 @@ export interface FilterEventsVariables { clientEmail?: string | null; } +export interface FilterVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key)[]; +} + +export interface FilterVendorDefaultSettingsVariables { + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} + export interface FilterVendorRatesData { vendorRates: ({ id: UUIDString; @@ -358,6 +391,19 @@ export interface GetVendorByIdVariables { id: UUIDString; } +export interface GetVendorDefaultSettingByIdData { + vendorDefaultSetting?: { + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key; +} + +export interface GetVendorDefaultSettingByIdVariables { + id: UUIDString; +} + export interface GetVendorRateByIdData { vendorRate?: { id: UUIDString; @@ -446,6 +492,15 @@ export interface ListVendorData { } & Vendor_Key)[]; } +export interface ListVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_Key)[]; +} + export interface ListVendorRateData { vendorRates: ({ id: UUIDString; @@ -510,6 +565,17 @@ export interface UpdateVendorData { vendor_update?: Vendor_Key | null; } +export interface UpdateVendorDefaultSettingData { + vendorDefaultSetting_update?: VendorDefaultSetting_Key | null; +} + +export interface UpdateVendorDefaultSettingVariables { + id: UUIDString; + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} + export interface UpdateVendorRateData { vendorRate_update?: VendorRate_Key | null; } @@ -536,6 +602,11 @@ export interface UpdateVendorVariables { isActive?: boolean | null; } +export interface VendorDefaultSetting_Key { + id: UUIDString; + __typename?: 'VendorDefaultSetting_Key'; +} + export interface VendorRate_Key { id: UUIDString; __typename?: 'VendorRate_Key'; @@ -546,6 +617,18 @@ export interface Vendor_Key { __typename?: 'Vendor_Key'; } +interface ListStaffRef { + /* 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 listStaffRef: ListStaffRef; + +export function listStaff(): QueryPromise; +export function listStaff(dc: DataConnect): QueryPromise; + interface CreateVendorRef { /* Allow users to create refs without passing in DataConnect */ (vars: CreateVendorVariables): MutationRef; @@ -582,42 +665,6 @@ export const deleteVendorRef: DeleteVendorRef; export function deleteVendor(vars: DeleteVendorVariables): MutationPromise; export function deleteVendor(dc: DataConnect, vars: DeleteVendorVariables): MutationPromise; -interface ListVendorRef { - /* 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 listVendorRef: ListVendorRef; - -export function listVendor(): QueryPromise; -export function listVendor(dc: DataConnect): QueryPromise; - -interface GetVendorByIdRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorByIdVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef; - operationName: string; -} -export const getVendorByIdRef: GetVendorByIdRef; - -export function getVendorById(vars: GetVendorByIdVariables): QueryPromise; -export function getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise; - -interface FilterVendorsRef { - /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorsVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef; - operationName: string; -} -export const filterVendorsRef: FilterVendorsRef; - -export function filterVendors(vars?: FilterVendorsVariables): QueryPromise; -export function filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise; - interface CreateVendorRateRef { /* Allow users to create refs without passing in DataConnect */ (vars: CreateVendorRateVariables): MutationRef; @@ -654,42 +701,6 @@ export const deleteVendorRateRef: DeleteVendorRateRef; export function deleteVendorRate(vars: DeleteVendorRateVariables): MutationPromise; export function deleteVendorRate(dc: DataConnect, vars: DeleteVendorRateVariables): MutationPromise; -interface ListVendorRateRef { - /* 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 listVendorRateRef: ListVendorRateRef; - -export function listVendorRate(): QueryPromise; -export function listVendorRate(dc: DataConnect): QueryPromise; - -interface GetVendorRateByIdRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorRateByIdVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef; - operationName: string; -} -export const getVendorRateByIdRef: GetVendorRateByIdRef; - -export function getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise; -export function getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise; - -interface FilterVendorRatesRef { - /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorRatesVariables): QueryRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef; - operationName: string; -} -export const filterVendorRatesRef: FilterVendorRatesRef; - -export function filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise; -export function filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise; - interface CreateEventRef { /* Allow users to create refs without passing in DataConnect */ (vars: CreateEventVariables): MutationRef; @@ -774,15 +785,147 @@ export const createStaffRef: CreateStaffRef; export function createStaff(vars: CreateStaffVariables): MutationPromise; export function createStaff(dc: DataConnect, vars: CreateStaffVariables): MutationPromise; -interface ListStaffRef { +interface ListVendorRef { /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; + (): QueryRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect): QueryRef; + (dc: DataConnect): QueryRef; operationName: string; } -export const listStaffRef: ListStaffRef; +export const listVendorRef: ListVendorRef; -export function listStaff(): QueryPromise; -export function listStaff(dc: DataConnect): QueryPromise; +export function listVendor(): QueryPromise; +export function listVendor(dc: DataConnect): QueryPromise; + +interface GetVendorByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef; + operationName: string; +} +export const getVendorByIdRef: GetVendorByIdRef; + +export function getVendorById(vars: GetVendorByIdVariables): QueryPromise; +export function getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise; + +interface FilterVendorsRef { + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorsVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef; + operationName: string; +} +export const filterVendorsRef: FilterVendorsRef; + +export function filterVendors(vars?: FilterVendorsVariables): QueryPromise; +export function filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise; + +interface CreateVendorDefaultSettingRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateVendorDefaultSettingVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateVendorDefaultSettingVariables): MutationRef; + operationName: string; +} +export const createVendorDefaultSettingRef: CreateVendorDefaultSettingRef; + +export function createVendorDefaultSetting(vars: CreateVendorDefaultSettingVariables): MutationPromise; +export function createVendorDefaultSetting(dc: DataConnect, vars: CreateVendorDefaultSettingVariables): MutationPromise; + +interface UpdateVendorDefaultSettingRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateVendorDefaultSettingVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateVendorDefaultSettingVariables): MutationRef; + operationName: string; +} +export const updateVendorDefaultSettingRef: UpdateVendorDefaultSettingRef; + +export function updateVendorDefaultSetting(vars: UpdateVendorDefaultSettingVariables): MutationPromise; +export function updateVendorDefaultSetting(dc: DataConnect, vars: UpdateVendorDefaultSettingVariables): MutationPromise; + +interface DeleteVendorDefaultSettingRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteVendorDefaultSettingVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationRef; + operationName: string; +} +export const deleteVendorDefaultSettingRef: DeleteVendorDefaultSettingRef; + +export function deleteVendorDefaultSetting(vars: DeleteVendorDefaultSettingVariables): MutationPromise; +export function deleteVendorDefaultSetting(dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationPromise; + +interface ListVendorDefaultSettingsRef { + /* 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 listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; + +export function listVendorDefaultSettings(): QueryPromise; +export function listVendorDefaultSettings(dc: DataConnect): QueryPromise; + +interface GetVendorDefaultSettingByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorDefaultSettingByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef; + operationName: string; +} +export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; + +export function getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise; +export function getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise; + +interface FilterVendorDefaultSettingsRef { + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorDefaultSettingsVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef; + operationName: string; +} +export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; + +export function filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise; +export function filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise; + +interface ListVendorRateRef { + /* 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 listVendorRateRef: ListVendorRateRef; + +export function listVendorRate(): QueryPromise; +export function listVendorRate(dc: DataConnect): QueryPromise; + +interface GetVendorRateByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetVendorRateByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef; + operationName: string; +} +export const getVendorRateByIdRef: GetVendorRateByIdRef; + +export function getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise; +export function getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise; + +interface FilterVendorRatesRef { + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterVendorRatesVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef; + operationName: string; +} +export const filterVendorRatesRef: FilterVendorRatesRef; + +export function filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise; +export function filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise; diff --git a/internal-api-harness/src/dataconnect-generated/react/README.md b/internal-api-harness/src/dataconnect-generated/react/README.md index b53a3d0f..0712a844 100644 --- a/internal-api-harness/src/dataconnect-generated/react/README.md +++ b/internal-api-harness/src/dataconnect-generated/react/README.md @@ -17,16 +17,19 @@ You can also follow the instructions from the [Data Connect documentation](https - [**Accessing the connector**](#accessing-the-connector) - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) - [**Queries**](#queries) - - [*listVendor*](#listvendor) - - [*getVendorById*](#getvendorbyid) - - [*filterVendors*](#filtervendors) - - [*listVendorRate*](#listvendorrate) - - [*getVendorRateById*](#getvendorratebyid) - - [*filterVendorRates*](#filtervendorrates) + - [*listStaff*](#liststaff) - [*listEvents*](#listevents) - [*getEventById*](#geteventbyid) - [*filterEvents*](#filterevents) - - [*listStaff*](#liststaff) + - [*listVendor*](#listvendor) + - [*getVendorById*](#getvendorbyid) + - [*filterVendors*](#filtervendors) + - [*listVendorDefaultSettings*](#listvendordefaultsettings) + - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) + - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) + - [*listVendorRate*](#listvendorrate) + - [*getVendorRateById*](#getvendorratebyid) + - [*filterVendorRates*](#filtervendorrates) - [**Mutations**](#mutations) - [*CreateVendor*](#createvendor) - [*UpdateVendor*](#updatevendor) @@ -38,6 +41,9 @@ You can also follow the instructions from the [Data Connect documentation](https - [*UpdateEvent*](#updateevent) - [*DeleteEvent*](#deleteevent) - [*CreateStaff*](#createstaff) + - [*CreateVendorDefaultSetting*](#createvendordefaultsetting) + - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting) + - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting) # 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 `krow-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). @@ -129,66 +135,68 @@ Here's a general overview of how to use the generated Query hooks in your code: Below are examples of how to use the `krow-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). -## listVendor -You can execute the `listVendor` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): +## listStaff +You can execute the `listStaff` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): ```javascript -useListVendor(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +useListStaff(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; ``` You can also pass in a `DataConnect` instance to the Query hook function. ```javascript -useListVendor(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +useListStaff(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; ``` ### Variables -The `listVendor` Query has no variables. +The `listStaff` Query has no variables. ### Return Type -Recall that calling the `listVendor` 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. +Recall that calling the `listStaff` 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 `listVendor` Query is of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `listStaff` Query is of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: ```javascript -export interface ListVendorData { - vendors: ({ +export interface ListStaffData { + staffs: ({ id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_Key)[]; + employeeName: string; + vendorId?: UUIDString | null; + email?: string | null; + position?: string | null; + employmentType: EmploymentType; + rating?: number | null; + reliabilityScore?: number | null; + backgroundCheckStatus: BackgroundCheckStatus; + certifications?: string | null; + } & Staff_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 `listVendor`'s Query hook function +### Using `listStaff`'s Query hook function ```javascript import { getDataConnect } from 'firebase/data-connect'; import { connectorConfig } from '@dataconnect/generated'; -import { useListVendor } from '@dataconnect/generated/react' +import { useListStaff } from '@dataconnect/generated/react' -export default function ListVendorComponent() { +export default function ListStaffComponent() { // 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 = useListVendor(); + const query = useListStaff(); // You can also pass in a `DataConnect` instance to the Query hook function. const dataConnect = getDataConnect(connectorConfig); - const query = useListVendor(dataConnect); + const query = useListStaff(dataConnect); // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. const options = { staleTime: 5 * 1000 }; - const query = useListVendor(options); + const query = useListStaff(options); // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. const dataConnect = getDataConnect(connectorConfig); const options = { staleTime: 5 * 1000 }; - const query = useListVendor(dataConnect, options); + const query = useListStaff(dataConnect, options); // Then, you can render your component dynamically based on the status of the Query. if (query.isPending) { @@ -201,484 +209,7 @@ export default function ListVendorComponent() { // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. if (query.isSuccess) { - console.log(query.data.vendors); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## getVendorById -You can execute the `getVendorById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useGetVendorById(dc: DataConnect, vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useGetVendorById(vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `getVendorById` Query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface GetVendorByIdVariables { - id: UUIDString; -} -``` -### Return Type -Recall that calling the `getVendorById` 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 `getVendorById` Query is of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface GetVendorByIdData { - vendor?: { - id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_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 `getVendorById`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, GetVendorByIdVariables } from '@dataconnect/generated'; -import { useGetVendorById } from '@dataconnect/generated/react' - -export default function GetVendorByIdComponent() { - // The `useGetVendorById` Query hook requires an argument of type `GetVendorByIdVariables`: - const getVendorByIdVars: GetVendorByIdVariables = { - 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 = useGetVendorById(getVendorByIdVars); - // Variables can be defined inline as well. - const query = useGetVendorById({ id: ..., }); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useGetVendorById(dataConnect, getVendorByIdVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useGetVendorById(getVendorByIdVars, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useGetVendorById(dataConnect, getVendorByIdVars, 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.vendor); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## filterVendors -You can execute the `filterVendors` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useFilterVendors(vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `filterVendors` Query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface FilterVendorsVariables { - region?: VendorRegion | null; - approvalStatus?: VendorApprovalStatus | null; - isActive?: boolean | null; - vendorNumber?: string | null; - primaryContactEmail?: string | null; - legalName?: string | null; - platformType?: VendorPlatformType | null; -} -``` -### Return Type -Recall that calling the `filterVendors` 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 `filterVendors` Query is of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface FilterVendorsData { - vendors: ({ - id: UUIDString; - vendorNumber: string; - legalName: string; - region: VendorRegion; - platformType: VendorPlatformType; - primaryContactEmail: string; - approvalStatus: VendorApprovalStatus; - isActive?: boolean | null; - } & Vendor_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 `filterVendors`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, FilterVendorsVariables } from '@dataconnect/generated'; -import { useFilterVendors } from '@dataconnect/generated/react' - -export default function FilterVendorsComponent() { - // The `useFilterVendors` Query hook has an optional argument of type `FilterVendorsVariables`: - const filterVendorsVars: FilterVendorsVariables = { - region: ..., // optional - approvalStatus: ..., // optional - isActive: ..., // optional - vendorNumber: ..., // optional - primaryContactEmail: ..., // optional - legalName: ..., // optional - platformType: ..., // optional - }; - - // 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 = useFilterVendors(filterVendorsVars); - // Variables can be defined inline as well. - const query = useFilterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); - // Since all variables are optional for this Query, you can omit the `FilterVendorsVariables` argument. - // (as long as you don't want to provide any `options`!) - const query = useFilterVendors(); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useFilterVendors(dataConnect, filterVendorsVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useFilterVendors(filterVendorsVars, options); - // If you'd like to provide options without providing any variables, you must - // pass `undefined` where you would normally pass the variables. - const query = useFilterVendors(undefined, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useFilterVendors(dataConnect, filterVendorsVars /** or undefined */, 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.vendors); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## listVendorRate -You can execute the `listVendorRate` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useListVendorRate(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useListVendorRate(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `listVendorRate` Query has no variables. -### Return Type -Recall that calling the `listVendorRate` 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 `listVendorRate` Query is of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface ListVendorRateData { - vendorRates: ({ - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - } & VendorRate_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 `listVendorRate`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig } from '@dataconnect/generated'; -import { useListVendorRate } from '@dataconnect/generated/react' - -export default function ListVendorRateComponent() { - // 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 = useListVendorRate(); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useListVendorRate(dataConnect); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useListVendorRate(options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useListVendorRate(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.vendorRates); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## getVendorRateById -You can execute the `getVendorRateById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useGetVendorRateById(vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `getVendorRateById` Query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface GetVendorRateByIdVariables { - id: UUIDString; -} -``` -### Return Type -Recall that calling the `getVendorRateById` 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 `getVendorRateById` Query is of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface GetVendorRateByIdData { - vendorRate?: { - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - createdDate?: TimestampString | null; - updatedDate?: TimestampString | null; - createdBy?: string | null; - } & VendorRate_Key; -} -``` - -To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). - -### Using `getVendorRateById`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, GetVendorRateByIdVariables } from '@dataconnect/generated'; -import { useGetVendorRateById } from '@dataconnect/generated/react' - -export default function GetVendorRateByIdComponent() { - // The `useGetVendorRateById` Query hook requires an argument of type `GetVendorRateByIdVariables`: - const getVendorRateByIdVars: GetVendorRateByIdVariables = { - 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 = useGetVendorRateById(getVendorRateByIdVars); - // Variables can be defined inline as well. - const query = useGetVendorRateById({ id: ..., }); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useGetVendorRateById(dataConnect, getVendorRateByIdVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useGetVendorRateById(getVendorRateByIdVars, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useGetVendorRateById(dataConnect, getVendorRateByIdVars, 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.vendorRate); - } - return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## filterVendorRates -You can execute the `filterVendorRates` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): - -```javascript -useFilterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` -You can also pass in a `DataConnect` instance to the Query hook function. -```javascript -useFilterVendorRates(vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -``` - -### Variables -The `filterVendorRates` Query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface FilterVendorRatesVariables { - vendorName?: string | null; - category?: VendorRateCategory | null; - roleName?: string | null; - minClientRate?: number | null; - maxClientRate?: number | null; -} -``` -### Return Type -Recall that calling the `filterVendorRates` 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 `filterVendorRates` Query is of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface FilterVendorRatesData { - vendorRates: ({ - id: UUIDString; - vendorName: string; - category: VendorRateCategory; - roleName: string; - employeeWage: number; - markupPercentage?: number | null; - vendorFeePercentage?: number | null; - clientRate: number; - } & VendorRate_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 `filterVendorRates`'s Query hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, FilterVendorRatesVariables } from '@dataconnect/generated'; -import { useFilterVendorRates } from '@dataconnect/generated/react' - -export default function FilterVendorRatesComponent() { - // The `useFilterVendorRates` Query hook has an optional argument of type `FilterVendorRatesVariables`: - const filterVendorRatesVars: FilterVendorRatesVariables = { - vendorName: ..., // optional - category: ..., // optional - roleName: ..., // optional - minClientRate: ..., // optional - maxClientRate: ..., // optional - }; - - // 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 = useFilterVendorRates(filterVendorRatesVars); - // Variables can be defined inline as well. - const query = useFilterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); - // Since all variables are optional for this Query, you can omit the `FilterVendorRatesVariables` argument. - // (as long as you don't want to provide any `options`!) - const query = useFilterVendorRates(); - - // You can also pass in a `DataConnect` instance to the Query hook function. - const dataConnect = getDataConnect(connectorConfig); - const query = useFilterVendorRates(dataConnect, filterVendorRatesVars); - - // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. - const options = { staleTime: 5 * 1000 }; - const query = useFilterVendorRates(filterVendorRatesVars, options); - // If you'd like to provide options without providing any variables, you must - // pass `undefined` where you would normally pass the variables. - const query = useFilterVendorRates(undefined, options); - - // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. - const dataConnect = getDataConnect(connectorConfig); - const options = { staleTime: 5 * 1000 }; - const query = useFilterVendorRates(dataConnect, filterVendorRatesVars /** or undefined */, 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.vendorRates); + console.log(query.data.staffs); } return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; } @@ -1053,68 +584,66 @@ export default function FilterEventsComponent() { } ``` -## listStaff -You can execute the `listStaff` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): +## listVendor +You can execute the `listVendor` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): ```javascript -useListStaff(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +useListVendor(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; ``` You can also pass in a `DataConnect` instance to the Query hook function. ```javascript -useListStaff(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +useListVendor(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; ``` ### Variables -The `listStaff` Query has no variables. +The `listVendor` Query has no variables. ### Return Type -Recall that calling the `listStaff` 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. +Recall that calling the `listVendor` 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 `listStaff` Query is of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `listVendor` Query is of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: ```javascript -export interface ListStaffData { - staffs: ({ +export interface ListVendorData { + vendors: ({ id: UUIDString; - employeeName: string; - vendorId?: UUIDString | null; - email?: string | null; - position?: string | null; - employmentType: EmploymentType; - rating?: number | null; - reliabilityScore?: number | null; - backgroundCheckStatus: BackgroundCheckStatus; - certifications?: string | null; - } & Staff_Key)[]; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_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 `listStaff`'s Query hook function +### Using `listVendor`'s Query hook function ```javascript import { getDataConnect } from 'firebase/data-connect'; import { connectorConfig } from '@dataconnect/generated'; -import { useListStaff } from '@dataconnect/generated/react' +import { useListVendor } from '@dataconnect/generated/react' -export default function ListStaffComponent() { +export default function ListVendorComponent() { // 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 = useListStaff(); + const query = useListVendor(); // You can also pass in a `DataConnect` instance to the Query hook function. const dataConnect = getDataConnect(connectorConfig); - const query = useListStaff(dataConnect); + const query = useListVendor(dataConnect); // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. const options = { staleTime: 5 * 1000 }; - const query = useListStaff(options); + const query = useListVendor(options); // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. const dataConnect = getDataConnect(connectorConfig); const options = { staleTime: 5 * 1000 }; - const query = useListStaff(dataConnect, options); + const query = useListVendor(dataConnect, options); // Then, you can render your component dynamically based on the status of the Query. if (query.isPending) { @@ -1127,7 +656,742 @@ export default function ListStaffComponent() { // If the Query is successful, you can access the data returned using the `UseQueryResult.data` field. if (query.isSuccess) { - console.log(query.data.staffs); + console.log(query.data.vendors); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## getVendorById +You can execute the `getVendorById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useGetVendorById(dc: DataConnect, vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetVendorById(vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `getVendorById` Query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetVendorByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `getVendorById` 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 `getVendorById` Query is of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetVendorByIdData { + vendor?: { + id: UUIDString; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_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 `getVendorById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetVendorByIdVariables } from '@dataconnect/generated'; +import { useGetVendorById } from '@dataconnect/generated/react' + +export default function GetVendorByIdComponent() { + // The `useGetVendorById` Query hook requires an argument of type `GetVendorByIdVariables`: + const getVendorByIdVars: GetVendorByIdVariables = { + 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 = useGetVendorById(getVendorByIdVars); + // Variables can be defined inline as well. + const query = useGetVendorById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetVendorById(dataConnect, getVendorByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorById(getVendorByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorById(dataConnect, getVendorByIdVars, 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.vendor); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## filterVendors +You can execute the `filterVendors` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useFilterVendors(vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `filterVendors` Query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface FilterVendorsVariables { + region?: VendorRegion | null; + approvalStatus?: VendorApprovalStatus | null; + isActive?: boolean | null; + vendorNumber?: string | null; + primaryContactEmail?: string | null; + legalName?: string | null; + platformType?: VendorPlatformType | null; +} +``` +### Return Type +Recall that calling the `filterVendors` 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 `filterVendors` Query is of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface FilterVendorsData { + vendors: ({ + id: UUIDString; + vendorNumber: string; + legalName: string; + region: VendorRegion; + platformType: VendorPlatformType; + primaryContactEmail: string; + approvalStatus: VendorApprovalStatus; + isActive?: boolean | null; + } & Vendor_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 `filterVendors`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, FilterVendorsVariables } from '@dataconnect/generated'; +import { useFilterVendors } from '@dataconnect/generated/react' + +export default function FilterVendorsComponent() { + // The `useFilterVendors` Query hook has an optional argument of type `FilterVendorsVariables`: + const filterVendorsVars: FilterVendorsVariables = { + region: ..., // optional + approvalStatus: ..., // optional + isActive: ..., // optional + vendorNumber: ..., // optional + primaryContactEmail: ..., // optional + legalName: ..., // optional + platformType: ..., // optional + }; + + // 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 = useFilterVendors(filterVendorsVars); + // Variables can be defined inline as well. + const query = useFilterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., }); + // Since all variables are optional for this Query, you can omit the `FilterVendorsVariables` argument. + // (as long as you don't want to provide any `options`!) + const query = useFilterVendors(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useFilterVendors(dataConnect, filterVendorsVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendors(filterVendorsVars, options); + // If you'd like to provide options without providing any variables, you must + // pass `undefined` where you would normally pass the variables. + const query = useFilterVendors(undefined, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendors(dataConnect, filterVendorsVars /** or undefined */, 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.vendors); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## listVendorDefaultSettings +You can execute the `listVendorDefaultSettings` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useListVendorDefaultSettings(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListVendorDefaultSettings(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `listVendorDefaultSettings` Query has no variables. +### Return Type +Recall that calling the `listVendorDefaultSettings` 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 `listVendorDefaultSettings` Query is of type `ListVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_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 `listVendorDefaultSettings`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@dataconnect/generated'; +import { useListVendorDefaultSettings } from '@dataconnect/generated/react' + +export default function ListVendorDefaultSettingsComponent() { + // 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 = useListVendorDefaultSettings(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListVendorDefaultSettings(dataConnect); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListVendorDefaultSettings(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListVendorDefaultSettings(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.vendorDefaultSettings); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## getVendorDefaultSettingById +You can execute the `getVendorDefaultSettingById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useGetVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `getVendorDefaultSettingById` Query requires an argument of type `GetVendorDefaultSettingByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetVendorDefaultSettingByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `getVendorDefaultSettingById` 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 `getVendorDefaultSettingById` Query is of type `GetVendorDefaultSettingByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetVendorDefaultSettingByIdData { + vendorDefaultSetting?: { + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_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 `getVendorDefaultSettingById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetVendorDefaultSettingByIdVariables } from '@dataconnect/generated'; +import { useGetVendorDefaultSettingById } from '@dataconnect/generated/react' + +export default function GetVendorDefaultSettingByIdComponent() { + // The `useGetVendorDefaultSettingById` Query hook requires an argument of type `GetVendorDefaultSettingByIdVariables`: + const getVendorDefaultSettingByIdVars: GetVendorDefaultSettingByIdVariables = { + 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 = useGetVendorDefaultSettingById(getVendorDefaultSettingByIdVars); + // Variables can be defined inline as well. + const query = useGetVendorDefaultSettingById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorDefaultSettingById(getVendorDefaultSettingByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars, 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.vendorDefaultSetting); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## filterVendorDefaultSettings +You can execute the `filterVendorDefaultSettings` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useFilterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useFilterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `filterVendorDefaultSettings` Query has an optional argument of type `FilterVendorDefaultSettingsVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface FilterVendorDefaultSettingsVariables { + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} +``` +### Return Type +Recall that calling the `filterVendorDefaultSettings` 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 `filterVendorDefaultSettings` Query is of type `FilterVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface FilterVendorDefaultSettingsData { + vendorDefaultSettings: ({ + id: UUIDString; + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; + } & VendorDefaultSetting_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 `filterVendorDefaultSettings`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, FilterVendorDefaultSettingsVariables } from '@dataconnect/generated'; +import { useFilterVendorDefaultSettings } from '@dataconnect/generated/react' + +export default function FilterVendorDefaultSettingsComponent() { + // The `useFilterVendorDefaultSettings` Query hook has an optional argument of type `FilterVendorDefaultSettingsVariables`: + const filterVendorDefaultSettingsVars: FilterVendorDefaultSettingsVariables = { + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional + }; + + // 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 = useFilterVendorDefaultSettings(filterVendorDefaultSettingsVars); + // Variables can be defined inline as well. + const query = useFilterVendorDefaultSettings({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + // Since all variables are optional for this Query, you can omit the `FilterVendorDefaultSettingsVariables` argument. + // (as long as you don't want to provide any `options`!) + const query = useFilterVendorDefaultSettings(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useFilterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendorDefaultSettings(filterVendorDefaultSettingsVars, options); + // If you'd like to provide options without providing any variables, you must + // pass `undefined` where you would normally pass the variables. + const query = useFilterVendorDefaultSettings(undefined, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars /** or undefined */, 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.vendorDefaultSettings); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## listVendorRate +You can execute the `listVendorRate` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useListVendorRate(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListVendorRate(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `listVendorRate` Query has no variables. +### Return Type +Recall that calling the `listVendorRate` 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 `listVendorRate` Query is of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListVendorRateData { + vendorRates: ({ + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + } & VendorRate_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 `listVendorRate`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@dataconnect/generated'; +import { useListVendorRate } from '@dataconnect/generated/react' + +export default function ListVendorRateComponent() { + // 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 = useListVendorRate(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListVendorRate(dataConnect); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListVendorRate(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListVendorRate(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.vendorRates); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## getVendorRateById +You can execute the `getVendorRateById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetVendorRateById(vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `getVendorRateById` Query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetVendorRateByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `getVendorRateById` 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 `getVendorRateById` Query is of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetVendorRateByIdData { + vendorRate?: { + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + createdDate?: TimestampString | null; + updatedDate?: TimestampString | null; + createdBy?: string | null; + } & VendorRate_Key; +} +``` + +To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery). + +### Using `getVendorRateById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetVendorRateByIdVariables } from '@dataconnect/generated'; +import { useGetVendorRateById } from '@dataconnect/generated/react' + +export default function GetVendorRateByIdComponent() { + // The `useGetVendorRateById` Query hook requires an argument of type `GetVendorRateByIdVariables`: + const getVendorRateByIdVars: GetVendorRateByIdVariables = { + 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 = useGetVendorRateById(getVendorRateByIdVars); + // Variables can be defined inline as well. + const query = useGetVendorRateById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetVendorRateById(dataConnect, getVendorRateByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorRateById(getVendorRateByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetVendorRateById(dataConnect, getVendorRateByIdVars, 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.vendorRate); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## filterVendorRates +You can execute the `filterVendorRates` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useFilterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useFilterVendorRates(vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `filterVendorRates` Query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface FilterVendorRatesVariables { + vendorName?: string | null; + category?: VendorRateCategory | null; + roleName?: string | null; + minClientRate?: number | null; + maxClientRate?: number | null; +} +``` +### Return Type +Recall that calling the `filterVendorRates` 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 `filterVendorRates` Query is of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface FilterVendorRatesData { + vendorRates: ({ + id: UUIDString; + vendorName: string; + category: VendorRateCategory; + roleName: string; + employeeWage: number; + markupPercentage?: number | null; + vendorFeePercentage?: number | null; + clientRate: number; + } & VendorRate_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 `filterVendorRates`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, FilterVendorRatesVariables } from '@dataconnect/generated'; +import { useFilterVendorRates } from '@dataconnect/generated/react' + +export default function FilterVendorRatesComponent() { + // The `useFilterVendorRates` Query hook has an optional argument of type `FilterVendorRatesVariables`: + const filterVendorRatesVars: FilterVendorRatesVariables = { + vendorName: ..., // optional + category: ..., // optional + roleName: ..., // optional + minClientRate: ..., // optional + maxClientRate: ..., // optional + }; + + // 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 = useFilterVendorRates(filterVendorRatesVars); + // Variables can be defined inline as well. + const query = useFilterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., }); + // Since all variables are optional for this Query, you can omit the `FilterVendorRatesVariables` argument. + // (as long as you don't want to provide any `options`!) + const query = useFilterVendorRates(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useFilterVendorRates(dataConnect, filterVendorRatesVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendorRates(filterVendorRatesVars, options); + // If you'd like to provide options without providing any variables, you must + // pass `undefined` where you would normally pass the variables. + const query = useFilterVendorRates(undefined, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useFilterVendorRates(dataConnect, filterVendorRatesVars /** or undefined */, 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.vendorRates); } return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; } @@ -2300,3 +2564,295 @@ export default function CreateStaffComponent() { } ``` +## CreateVendorDefaultSetting +You can execute the `CreateVendorDefaultSetting` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)): +```javascript +useCreateVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateVendorDefaultSetting` Mutation requires an argument of type `CreateVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateVendorDefaultSettingVariables { + vendorName: string; + defaultMarkupPercentage: number; + defaultVendorFeePercentage: number; +} +``` +### Return Type +Recall that calling the `CreateVendorDefaultSetting` 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 `CreateVendorDefaultSetting` Mutation is of type `CreateVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateVendorDefaultSettingData { + vendorDefaultSetting_insert: VendorDefaultSetting_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 `CreateVendorDefaultSetting`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateVendorDefaultSettingVariables } from '@dataconnect/generated'; +import { useCreateVendorDefaultSetting } from '@dataconnect/generated/react' + +export default function CreateVendorDefaultSettingComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateVendorDefaultSetting(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateVendorDefaultSetting(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateVendorDefaultSetting(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 = useCreateVendorDefaultSetting(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateVendorDefaultSetting` Mutation requires an argument of type `CreateVendorDefaultSettingVariables`: + const createVendorDefaultSettingVars: CreateVendorDefaultSettingVariables = { + vendorName: ..., + defaultMarkupPercentage: ..., + defaultVendorFeePercentage: ..., + }; + mutation.mutate(createVendorDefaultSettingVars); + // Variables can be defined inline as well. + mutation.mutate({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createVendorDefaultSettingVars, 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.vendorDefaultSetting_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateVendorDefaultSetting +You can execute the `UpdateVendorDefaultSetting` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)): +```javascript +useUpdateVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateVendorDefaultSetting` Mutation requires an argument of type `UpdateVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateVendorDefaultSettingVariables { + id: UUIDString; + vendorName?: string | null; + defaultMarkupPercentage?: number | null; + defaultVendorFeePercentage?: number | null; +} +``` +### Return Type +Recall that calling the `UpdateVendorDefaultSetting` 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 `UpdateVendorDefaultSetting` Mutation is of type `UpdateVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateVendorDefaultSettingData { + vendorDefaultSetting_update?: VendorDefaultSetting_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 `UpdateVendorDefaultSetting`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateVendorDefaultSettingVariables } from '@dataconnect/generated'; +import { useUpdateVendorDefaultSetting } from '@dataconnect/generated/react' + +export default function UpdateVendorDefaultSettingComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateVendorDefaultSetting(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateVendorDefaultSetting(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateVendorDefaultSetting(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 = useUpdateVendorDefaultSetting(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateVendorDefaultSetting` Mutation requires an argument of type `UpdateVendorDefaultSettingVariables`: + const updateVendorDefaultSettingVars: UpdateVendorDefaultSettingVariables = { + id: ..., + vendorName: ..., // optional + defaultMarkupPercentage: ..., // optional + defaultVendorFeePercentage: ..., // optional + }; + mutation.mutate(updateVendorDefaultSettingVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateVendorDefaultSettingVars, 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.vendorDefaultSetting_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteVendorDefaultSetting +You can execute the `DeleteVendorDefaultSetting` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)): +```javascript +useDeleteVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteVendorDefaultSetting` Mutation requires an argument of type `DeleteVendorDefaultSettingVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteVendorDefaultSettingVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteVendorDefaultSetting` 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 `DeleteVendorDefaultSetting` Mutation is of type `DeleteVendorDefaultSettingData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteVendorDefaultSettingData { + vendorDefaultSetting_delete?: VendorDefaultSetting_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 `DeleteVendorDefaultSetting`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteVendorDefaultSettingVariables } from '@dataconnect/generated'; +import { useDeleteVendorDefaultSetting } from '@dataconnect/generated/react' + +export default function DeleteVendorDefaultSettingComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteVendorDefaultSetting(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteVendorDefaultSetting(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteVendorDefaultSetting(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 = useDeleteVendorDefaultSetting(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteVendorDefaultSetting` Mutation requires an argument of type `DeleteVendorDefaultSettingVariables`: + const deleteVendorDefaultSettingVars: DeleteVendorDefaultSettingVariables = { + id: ..., + }; + mutation.mutate(deleteVendorDefaultSettingVars); + // 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(deleteVendorDefaultSettingVars, 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.vendorDefaultSetting_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + diff --git a/internal-api-harness/src/dataconnect-generated/react/esm/index.esm.js b/internal-api-harness/src/dataconnect-generated/react/esm/index.esm.js index e0722a51..d1f156c2 100644 --- a/internal-api-harness/src/dataconnect-generated/react/esm/index.esm.js +++ b/internal-api-harness/src/dataconnect-generated/react/esm/index.esm.js @@ -1,7 +1,13 @@ -import { createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, createStaffRef, listStaffRef, connectorConfig } from '../../esm/index.esm.js'; +import { listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, createStaffRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorDefaultSettingRef, updateVendorDefaultSettingRef, deleteVendorDefaultSettingRef, listVendorDefaultSettingsRef, getVendorDefaultSettingByIdRef, filterVendorDefaultSettingsRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, 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 useListStaff(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listStaffRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} export function useCreateVendor(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -26,24 +32,6 @@ export function useDeleteVendor(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } - -export function useListVendor(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listVendorRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useGetVendorById(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getVendorByIdRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useFilterVendors(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); - const ref = filterVendorsRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} export function useCreateVendorRate(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -68,24 +56,6 @@ export function useDeleteVendorRate(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } - -export function useListVendorRate(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listVendorRateRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useGetVendorRateById(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getVendorRateByIdRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useFilterVendorRates(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); - const ref = filterVendorRatesRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} export function useCreateEvent(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -137,8 +107,80 @@ export function useCreateStaff(dcOrOptions, options) { } -export function useListStaff(dcOrOptions, options) { +export function useListVendor(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listStaffRef(dcInstance); + const ref = listVendorRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetVendorById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useFilterVendors(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +export function useCreateVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useListVendorDefaultSettings(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listVendorDefaultSettingsRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetVendorDefaultSettingById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorDefaultSettingByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useFilterVendorDefaultSettings(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorDefaultSettingsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useListVendorRate(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listVendorRateRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetVendorRateById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorRateByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useFilterVendorRates(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorRatesRef(dcInstance, inputVars); return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); } \ No newline at end of file diff --git a/internal-api-harness/src/dataconnect-generated/react/index.cjs.js b/internal-api-harness/src/dataconnect-generated/react/index.cjs.js index a4e8fecb..918c7066 100644 --- a/internal-api-harness/src/dataconnect-generated/react/index.cjs.js +++ b/internal-api-harness/src/dataconnect-generated/react/index.cjs.js @@ -1,7 +1,13 @@ -const { createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, createStaffRef, listStaffRef, connectorConfig } = require('../index.cjs.js'); +const { listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, createStaffRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorDefaultSettingRef, updateVendorDefaultSettingRef, deleteVendorDefaultSettingRef, listVendorDefaultSettingsRef, getVendorDefaultSettingByIdRef, filterVendorDefaultSettingsRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, connectorConfig } = require('../index.cjs.js'); const { validateArgs, CallerSdkTypeEnum } = require('firebase/data-connect'); const { useDataConnectQuery, useDataConnectMutation, validateReactArgs } = require('@tanstack-query-firebase/react/data-connect'); + +exports.useListStaff = function useListStaff(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listStaffRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} exports.useCreateVendor = function useCreateVendor(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -26,24 +32,6 @@ exports.useDeleteVendor = function useDeleteVendor(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } - -exports.useListVendor = function useListVendor(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listVendorRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useGetVendorById = function useGetVendorById(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getVendorByIdRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useFilterVendors = function useFilterVendors(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); - const ref = filterVendorsRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} exports.useCreateVendorRate = function useCreateVendorRate(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -68,24 +56,6 @@ exports.useDeleteVendorRate = function useDeleteVendorRate(dcOrOptions, options) return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } - -exports.useListVendorRate = function useListVendorRate(dcOrOptions, options) { - const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listVendorRateRef(dcInstance); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useGetVendorRateById = function useGetVendorRateById(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); - const ref = getVendorRateByIdRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useFilterVendorRates = function useFilterVendorRates(dcOrVars, varsOrOptions, options) { - const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); - const ref = filterVendorRatesRef(dcInstance, inputVars); - return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} exports.useCreateEvent = function useCreateEvent(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -137,8 +107,80 @@ exports.useCreateStaff = function useCreateStaff(dcOrOptions, options) { } -exports.useListStaff = function useListStaff(dcOrOptions, options) { +exports.useListVendor = function useListVendor(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); - const ref = listStaffRef(dcInstance); + const ref = listVendorRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetVendorById = function useGetVendorById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useFilterVendors = function useFilterVendors(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} +exports.useCreateVendorDefaultSetting = function useCreateVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateVendorDefaultSetting = function useUpdateVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteVendorDefaultSetting = function useDeleteVendorDefaultSetting(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteVendorDefaultSettingRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useListVendorDefaultSettings = function useListVendorDefaultSettings(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listVendorDefaultSettingsRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetVendorDefaultSettingById = function useGetVendorDefaultSettingById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorDefaultSettingByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useFilterVendorDefaultSettings = function useFilterVendorDefaultSettings(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorDefaultSettingsRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useListVendorRate = function useListVendorRate(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listVendorRateRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetVendorRateById = function useGetVendorRateById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getVendorRateByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useFilterVendorRates = function useFilterVendorRates(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterVendorRatesRef(dcInstance, inputVars); return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); } \ No newline at end of file diff --git a/internal-api-harness/src/dataconnect-generated/react/index.d.ts b/internal-api-harness/src/dataconnect-generated/react/index.d.ts index 0cdeedc4..29eef557 100644 --- a/internal-api-harness/src/dataconnect-generated/react/index.d.ts +++ b/internal-api-harness/src/dataconnect-generated/react/index.d.ts @@ -1,10 +1,13 @@ -import { CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateVendorRateData, CreateVendorRateVariables, UpdateVendorRateData, UpdateVendorRateVariables, DeleteVendorRateData, DeleteVendorRateVariables, ListVendorRateData, GetVendorRateByIdData, GetVendorRateByIdVariables, FilterVendorRatesData, FilterVendorRatesVariables, CreateEventData, CreateEventVariables, UpdateEventData, UpdateEventVariables, DeleteEventData, DeleteEventVariables, ListEventsData, GetEventByIdData, GetEventByIdVariables, FilterEventsData, FilterEventsVariables, CreateStaffData, CreateStaffVariables, ListStaffData } from '../'; +import { ListStaffData, CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, CreateVendorRateData, CreateVendorRateVariables, UpdateVendorRateData, UpdateVendorRateVariables, DeleteVendorRateData, DeleteVendorRateVariables, CreateEventData, CreateEventVariables, UpdateEventData, UpdateEventVariables, DeleteEventData, DeleteEventVariables, ListEventsData, GetEventByIdData, GetEventByIdVariables, FilterEventsData, FilterEventsVariables, CreateStaffData, CreateStaffVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateVendorDefaultSettingData, CreateVendorDefaultSettingVariables, UpdateVendorDefaultSettingData, UpdateVendorDefaultSettingVariables, DeleteVendorDefaultSettingData, DeleteVendorDefaultSettingVariables, ListVendorDefaultSettingsData, GetVendorDefaultSettingByIdData, GetVendorDefaultSettingByIdVariables, FilterVendorDefaultSettingsData, FilterVendorDefaultSettingsVariables, ListVendorRateData, GetVendorRateByIdData, GetVendorRateByIdVariables, FilterVendorRatesData, FilterVendorRatesVariables } 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 useListStaff(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListStaff(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + export function useCreateVendor(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateVendor(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; @@ -14,15 +17,6 @@ export function useUpdateVendor(dc: DataConnect, options?: useDataConnectMutatio export function useDeleteVendor(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useDeleteVendor(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useListVendor(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useListVendor(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useGetVendorById(vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useGetVendorById(dc: DataConnect, vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useFilterVendors(vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - export function useCreateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; @@ -32,15 +26,6 @@ export function useUpdateVendorRate(dc: DataConnect, options?: useDataConnectMut export function useDeleteVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useDeleteVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useListVendorRate(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useListVendorRate(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useGetVendorRateById(vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - -export function useFilterVendorRates(vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useFilterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; - export function useCreateEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; @@ -62,5 +47,38 @@ export function useFilterEvents(dc: DataConnect, vars?: FilterEventsVariables, o export function useCreateStaff(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useListStaff(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useListStaff(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendor(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendor(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetVendorById(vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetVendorById(dc: DataConnect, vars: GetVendorByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useFilterVendors(vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useCreateVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteVendorDefaultSetting(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteVendorDefaultSetting(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useListVendorDefaultSettings(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendorDefaultSettings(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useFilterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useListVendorRate(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendorRate(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetVendorRateById(vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useFilterVendorRates(vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult;