diff --git a/dataconnect/connector/invoice/mutations.gql b/dataconnect/connector/invoice/mutations.gql new file mode 100644 index 00000000..0fabc96d --- /dev/null +++ b/dataconnect/connector/invoice/mutations.gql @@ -0,0 +1,51 @@ +mutation CreateInvoice( + $invoiceNumber: String!, + $amount: Float!, + $status: InvoiceStatus!, + $issueDate: Timestamp!, + $dueDate: Timestamp!, + $disputedItems: String, + $isAutoGenerated: Boolean +) @auth(level: USER) { + invoice_insert( + data: { + invoiceNumber: $invoiceNumber + amount: $amount + status: $status + issueDate: $issueDate + dueDate: $dueDate + disputedItems: $disputedItems + isAutoGenerated: $isAutoGenerated + } + ) +} + +mutation UpdateInvoice( + $id: UUID!, + $invoiceNumber: String, + $amount: Float, + $status: InvoiceStatus, + $issueDate: Timestamp, + $dueDate: Timestamp, + $disputedItems: String, + $isAutoGenerated: Boolean +) @auth(level: USER) { + invoice_update( + id: $id, + data: { + invoiceNumber: $invoiceNumber + amount: $amount + status: $status + issueDate: $issueDate + dueDate: $dueDate + disputedItems: $disputedItems + isAutoGenerated: $isAutoGenerated + } + ) +} + +mutation DeleteInvoice( + $id: UUID! +) @auth(level: USER) { + invoice_delete(id: $id) +} diff --git a/dataconnect/connector/invoice/queries.gql b/dataconnect/connector/invoice/queries.gql new file mode 100644 index 00000000..270f5b20 --- /dev/null +++ b/dataconnect/connector/invoice/queries.gql @@ -0,0 +1,50 @@ +query listInvoice @auth(level: USER) { + invoices { + id + invoiceNumber + amount + status + issueDate + dueDate + isAutoGenerated + } +} + +query getInvoiceById( + $id: UUID! +) @auth(level: USER) { + invoice(id: $id) { + id + invoiceNumber + amount + status + issueDate + dueDate + disputedItems + isAutoGenerated + } +} + +query filterInvoices( + $invoiceNumber: String, + $status: InvoiceStatus, + $isAutoGenerated: Boolean, + $amount: Float +) @auth(level: USER) { + invoices( + where: { + invoiceNumber: { eq: $invoiceNumber } + status: { eq: $status } + isAutoGenerated: { eq: $isAutoGenerated } + amount: { eq: $amount } + } + ) { + id + invoiceNumber + amount + status + issueDate + dueDate + isAutoGenerated + } +} diff --git a/dataconnect/schema/invoice.gql b/dataconnect/schema/invoice.gql new file mode 100644 index 00000000..a391d417 --- /dev/null +++ b/dataconnect/schema/invoice.gql @@ -0,0 +1,26 @@ +enum InvoiceStatus { + DRAFT + PENDING_REVIEW + APPROVED + DISPUTED + UNDER_REVIEW + RESOLVED + OVERDUE + PAID + RECONCILED + CANCELLED +} + +type Invoice @table(name: "invoices") { + id: UUID! @default(expr: "uuidV4()") + invoiceNumber: String! + amount: Float! + status: InvoiceStatus! + issueDate: Timestamp! + dueDate: Timestamp! + disputedItems: String + isAutoGenerated: Boolean @default(expr: "false") # is_auto_generated + createdDate: Timestamp @default(expr: "request.time") + updatedDate: Timestamp @default(expr: "request.time") + createdBy: String @default(expr: "auth.uid") +} diff --git a/frontend-web/src/dataconnect-generated/.guides/usage.md b/frontend-web/src/dataconnect-generated/.guides/usage.md index d83b82a0..29b57da6 100644 --- a/frontend-web/src/dataconnect-generated/.guides/usage.md +++ b/frontend-web/src/dataconnect-generated/.guides/usage.md @@ -12,7 +12,7 @@ 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 { useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useCreateVendorRate, useUpdateVendorRate, useDeleteVendorRate, useCreateEvent, useUpdateEvent, useDeleteEvent } from '@dataconnect/generated/react'; +import { useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useListVendorDefaultSettings, useGetVendorDefaultSettingById, useFilterVendorDefaultSettings, useListEvents, useGetEventById, useFilterEvents } from '@dataconnect/generated/react'; // The types of these hooks are available in react/index.d.ts const { data, isPending, isSuccess, isError, error } = useListStaff(); @@ -23,17 +23,17 @@ const { data, isPending, isSuccess, isError, error } = useUpdateVendor(updateVen const { data, isPending, isSuccess, isError, error } = useDeleteVendor(deleteVendorVars); -const { data, isPending, isSuccess, isError, error } = useCreateVendorRate(createVendorRateVars); +const { data, isPending, isSuccess, isError, error } = useListVendorDefaultSettings(); -const { data, isPending, isSuccess, isError, error } = useUpdateVendorRate(updateVendorRateVars); +const { data, isPending, isSuccess, isError, error } = useGetVendorDefaultSettingById(getVendorDefaultSettingByIdVars); -const { data, isPending, isSuccess, isError, error } = useDeleteVendorRate(deleteVendorRateVars); +const { data, isPending, isSuccess, isError, error } = useFilterVendorDefaultSettings(filterVendorDefaultSettingsVars); -const { data, isPending, isSuccess, isError, error } = useCreateEvent(createEventVars); +const { data, isPending, isSuccess, isError, error } = useListEvents(); -const { data, isPending, isSuccess, isError, error } = useUpdateEvent(updateEventVars); +const { data, isPending, isSuccess, isError, error } = useGetEventById(getEventByIdVars); -const { data, isPending, isSuccess, isError, error } = useDeleteEvent(deleteEventVars); +const { data, isPending, isSuccess, isError, error } = useFilterEvents(filterEventsVars); ``` @@ -72,7 +72,7 @@ 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 { listStaff, createVendor, updateVendor, deleteVendor, createVendorRate, updateVendorRate, deleteVendorRate, createEvent, updateEvent, deleteEvent } from '@dataconnect/generated'; +import { listStaff, createVendor, updateVendor, deleteVendor, listVendorDefaultSettings, getVendorDefaultSettingById, filterVendorDefaultSettings, listEvents, getEventById, filterEvents } from '@dataconnect/generated'; // Operation listStaff: @@ -87,23 +87,23 @@ 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 CreateVendorRate: For variables, look at type CreateVendorRateVars in ../index.d.ts -const { data } = await CreateVendorRate(dataConnect, createVendorRateVars); +// Operation listVendorDefaultSettings: +const { data } = await ListVendorDefaultSettings(dataConnect); -// Operation UpdateVendorRate: For variables, look at type UpdateVendorRateVars in ../index.d.ts -const { data } = await UpdateVendorRate(dataConnect, updateVendorRateVars); +// Operation getVendorDefaultSettingById: For variables, look at type GetVendorDefaultSettingByIdVars in ../index.d.ts +const { data } = await GetVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars); -// Operation DeleteVendorRate: For variables, look at type DeleteVendorRateVars in ../index.d.ts -const { data } = await DeleteVendorRate(dataConnect, deleteVendorRateVars); +// Operation filterVendorDefaultSettings: For variables, look at type FilterVendorDefaultSettingsVars in ../index.d.ts +const { data } = await FilterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars); -// Operation CreateEvent: For variables, look at type CreateEventVars in ../index.d.ts -const { data } = await CreateEvent(dataConnect, createEventVars); +// Operation listEvents: +const { data } = await ListEvents(dataConnect); -// Operation UpdateEvent: For variables, look at type UpdateEventVars in ../index.d.ts -const { data } = await UpdateEvent(dataConnect, updateEventVars); +// Operation getEventById: For variables, look at type GetEventByIdVars in ../index.d.ts +const { data } = await GetEventById(dataConnect, getEventByIdVars); -// Operation DeleteEvent: For variables, look at type DeleteEventVars in ../index.d.ts -const { data } = await DeleteEvent(dataConnect, deleteEventVars); +// Operation filterEvents: For variables, look at type FilterEventsVars in ../index.d.ts +const { data } = await FilterEvents(dataConnect, filterEventsVars); ``` \ 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 705808e2..3035cccb 100644 --- a/frontend-web/src/dataconnect-generated/README.md +++ b/frontend-web/src/dataconnect-generated/README.md @@ -11,32 +11,38 @@ This README will guide you through the process of using the generated JavaScript - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) - [**Queries**](#queries) - [*listStaff*](#liststaff) + - [*listVendorDefaultSettings*](#listvendordefaultsettings) + - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) + - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) - [*listEvents*](#listevents) - [*getEventById*](#geteventbyid) - [*filterEvents*](#filterevents) - [*listVendor*](#listvendor) - [*getVendorById*](#getvendorbyid) - [*filterVendors*](#filtervendors) - - [*listVendorDefaultSettings*](#listvendordefaultsettings) - - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) - - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) - [*listVendorRate*](#listvendorrate) - [*getVendorRateById*](#getvendorratebyid) - [*filterVendorRates*](#filtervendorrates) + - [*listInvoice*](#listinvoice) + - [*getInvoiceById*](#getinvoicebyid) + - [*filterInvoices*](#filterinvoices) - [**Mutations**](#mutations) - [*CreateVendor*](#createvendor) - [*UpdateVendor*](#updatevendor) - [*DeleteVendor*](#deletevendor) + - [*CreateInvoice*](#createinvoice) + - [*UpdateInvoice*](#updateinvoice) + - [*DeleteInvoice*](#deleteinvoice) + - [*CreateStaff*](#createstaff) + - [*CreateVendorDefaultSetting*](#createvendordefaultsetting) + - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting) + - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting) - [*CreateVendorRate*](#createvendorrate) - [*UpdateVendorRate*](#updatevendorrate) - [*DeleteVendorRate*](#deletevendorrate) - [*CreateEvent*](#createevent) - [*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). @@ -185,6 +191,340 @@ executeQuery(ref).then((response) => { }); ``` +## 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); +}); +``` + ## listEvents You can execute the `listEvents` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): ```typescript @@ -997,340 +1337,6 @@ executeQuery(ref).then((response) => { }); ``` -## 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 @@ -1686,6 +1692,353 @@ executeQuery(ref).then((response) => { }); ``` +## listInvoice +You can execute the `listInvoice` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +listInvoice(): QueryPromise; + +interface ListInvoiceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (): QueryRef; +} +export const listInvoiceRef: ListInvoiceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listInvoice(dc: DataConnect): QueryPromise; + +interface ListInvoiceRef { + ... + (dc: DataConnect): QueryRef; +} +export const listInvoiceRef: ListInvoiceRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listInvoiceRef: +```typescript +const name = listInvoiceRef.operationName; +console.log(name); +``` + +### Variables +The `listInvoice` query has no variables. +### Return Type +Recall that executing the `listInvoice` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListInvoiceData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_Key)[]; +} +``` +### Using `listInvoice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listInvoice } from '@dataconnect/generated'; + + +// Call the `listInvoice()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listInvoice(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listInvoice(dataConnect); + +console.log(data.invoices); + +// Or, you can use the `Promise` API. +listInvoice().then((response) => { + const data = response.data; + console.log(data.invoices); +}); +``` + +### Using `listInvoice`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listInvoiceRef } from '@dataconnect/generated'; + + +// Call the `listInvoiceRef()` function to get a reference to the query. +const ref = listInvoiceRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listInvoiceRef(dataConnect); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.invoices); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.invoices); +}); +``` + +## getInvoiceById +You can execute the `getInvoiceById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +getInvoiceById(vars: GetInvoiceByIdVariables): QueryPromise; + +interface GetInvoiceByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetInvoiceByIdVariables): QueryRef; +} +export const getInvoiceByIdRef: GetInvoiceByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables): QueryPromise; + +interface GetInvoiceByIdRef { + ... + (dc: DataConnect, vars: GetInvoiceByIdVariables): QueryRef; +} +export const getInvoiceByIdRef: GetInvoiceByIdRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getInvoiceByIdRef: +```typescript +const name = getInvoiceByIdRef.operationName; +console.log(name); +``` + +### Variables +The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetInvoiceByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `getInvoiceById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetInvoiceByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetInvoiceByIdData { + invoice?: { + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; + } & Invoice_Key; +} +``` +### Using `getInvoiceById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getInvoiceById, GetInvoiceByIdVariables } from '@dataconnect/generated'; + +// The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`: +const getInvoiceByIdVars: GetInvoiceByIdVariables = { + id: ..., +}; + +// Call the `getInvoiceById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getInvoiceById(getInvoiceByIdVars); +// Variables can be defined inline as well. +const { data } = await getInvoiceById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getInvoiceById(dataConnect, getInvoiceByIdVars); + +console.log(data.invoice); + +// Or, you can use the `Promise` API. +getInvoiceById(getInvoiceByIdVars).then((response) => { + const data = response.data; + console.log(data.invoice); +}); +``` + +### Using `getInvoiceById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getInvoiceByIdRef, GetInvoiceByIdVariables } from '@dataconnect/generated'; + +// The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`: +const getInvoiceByIdVars: GetInvoiceByIdVariables = { + id: ..., +}; + +// Call the `getInvoiceByIdRef()` function to get a reference to the query. +const ref = getInvoiceByIdRef(getInvoiceByIdVars); +// Variables can be defined inline as well. +const ref = getInvoiceByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getInvoiceByIdRef(dataConnect, getInvoiceByIdVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.invoice); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.invoice); +}); +``` + +## filterInvoices +You can execute the `filterInvoices` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +filterInvoices(vars?: FilterInvoicesVariables): QueryPromise; + +interface FilterInvoicesRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterInvoicesVariables): QueryRef; +} +export const filterInvoicesRef: FilterInvoicesRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +filterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables): QueryPromise; + +interface FilterInvoicesRef { + ... + (dc: DataConnect, vars?: FilterInvoicesVariables): QueryRef; +} +export const filterInvoicesRef: FilterInvoicesRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterInvoicesRef: +```typescript +const name = filterInvoicesRef.operationName; +console.log(name); +``` + +### Variables +The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface FilterInvoicesVariables { + invoiceNumber?: string | null; + status?: InvoiceStatus | null; + isAutoGenerated?: boolean | null; + amount?: number | null; +} +``` +### Return Type +Recall that executing the `filterInvoices` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `FilterInvoicesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface FilterInvoicesData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_Key)[]; +} +``` +### Using `filterInvoices`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, filterInvoices, FilterInvoicesVariables } from '@dataconnect/generated'; + +// The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`: +const filterInvoicesVars: FilterInvoicesVariables = { + invoiceNumber: ..., // optional + status: ..., // optional + isAutoGenerated: ..., // optional + amount: ..., // optional +}; + +// Call the `filterInvoices()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await filterInvoices(filterInvoicesVars); +// Variables can be defined inline as well. +const { data } = await filterInvoices({ invoiceNumber: ..., status: ..., isAutoGenerated: ..., amount: ..., }); +// Since all variables are optional for this query, you can omit the `FilterInvoicesVariables` argument. +const { data } = await filterInvoices(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await filterInvoices(dataConnect, filterInvoicesVars); + +console.log(data.invoices); + +// Or, you can use the `Promise` API. +filterInvoices(filterInvoicesVars).then((response) => { + const data = response.data; + console.log(data.invoices); +}); +``` + +### Using `filterInvoices`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, filterInvoicesRef, FilterInvoicesVariables } from '@dataconnect/generated'; + +// The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`: +const filterInvoicesVars: FilterInvoicesVariables = { + invoiceNumber: ..., // optional + status: ..., // optional + isAutoGenerated: ..., // optional + amount: ..., // optional +}; + +// Call the `filterInvoicesRef()` function to get a reference to the query. +const ref = filterInvoicesRef(filterInvoicesVars); +// Variables can be defined inline as well. +const ref = filterInvoicesRef({ invoiceNumber: ..., status: ..., isAutoGenerated: ..., amount: ..., }); +// Since all variables are optional for this query, you can omit the `FilterInvoicesVariables` argument. +const ref = filterInvoicesRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = filterInvoicesRef(dataConnect, filterInvoicesVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.invoices); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.invoices); +}); +``` + # Mutations There are two ways to execute a Data Connect Mutation using the generated Web SDK: @@ -2067,6 +2420,847 @@ executeMutation(ref).then((response) => { }); ``` +## CreateInvoice +You can execute the `CreateInvoice` 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 +createInvoice(vars: CreateInvoiceVariables): MutationPromise; + +interface CreateInvoiceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateInvoiceVariables): MutationRef; +} +export const createInvoiceRef: CreateInvoiceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createInvoice(dc: DataConnect, vars: CreateInvoiceVariables): MutationPromise; + +interface CreateInvoiceRef { + ... + (dc: DataConnect, vars: CreateInvoiceVariables): MutationRef; +} +export const createInvoiceRef: CreateInvoiceRef; +``` + +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 createInvoiceRef: +```typescript +const name = createInvoiceRef.operationName; +console.log(name); +``` + +### Variables +The `CreateInvoice` mutation requires an argument of type `CreateInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateInvoiceVariables { + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} +``` +### Return Type +Recall that executing the `CreateInvoice` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateInvoiceData { + invoice_insert: Invoice_Key; +} +``` +### Using `CreateInvoice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createInvoice, CreateInvoiceVariables } from '@dataconnect/generated'; + +// The `CreateInvoice` mutation requires an argument of type `CreateInvoiceVariables`: +const createInvoiceVars: CreateInvoiceVariables = { + invoiceNumber: ..., + amount: ..., + status: ..., + issueDate: ..., + dueDate: ..., + disputedItems: ..., // optional + isAutoGenerated: ..., // optional +}; + +// Call the `createInvoice()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createInvoice(createInvoiceVars); +// Variables can be defined inline as well. +const { data } = await createInvoice({ invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createInvoice(dataConnect, createInvoiceVars); + +console.log(data.invoice_insert); + +// Or, you can use the `Promise` API. +createInvoice(createInvoiceVars).then((response) => { + const data = response.data; + console.log(data.invoice_insert); +}); +``` + +### Using `CreateInvoice`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createInvoiceRef, CreateInvoiceVariables } from '@dataconnect/generated'; + +// The `CreateInvoice` mutation requires an argument of type `CreateInvoiceVariables`: +const createInvoiceVars: CreateInvoiceVariables = { + invoiceNumber: ..., + amount: ..., + status: ..., + issueDate: ..., + dueDate: ..., + disputedItems: ..., // optional + isAutoGenerated: ..., // optional +}; + +// Call the `createInvoiceRef()` function to get a reference to the mutation. +const ref = createInvoiceRef(createInvoiceVars); +// Variables can be defined inline as well. +const ref = createInvoiceRef({ invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createInvoiceRef(dataConnect, createInvoiceVars); + +// 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.invoice_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.invoice_insert); +}); +``` + +## UpdateInvoice +You can execute the `UpdateInvoice` 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 +updateInvoice(vars: UpdateInvoiceVariables): MutationPromise; + +interface UpdateInvoiceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateInvoiceVariables): MutationRef; +} +export const updateInvoiceRef: UpdateInvoiceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateInvoice(dc: DataConnect, vars: UpdateInvoiceVariables): MutationPromise; + +interface UpdateInvoiceRef { + ... + (dc: DataConnect, vars: UpdateInvoiceVariables): MutationRef; +} +export const updateInvoiceRef: UpdateInvoiceRef; +``` + +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 updateInvoiceRef: +```typescript +const name = updateInvoiceRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateInvoice` mutation requires an argument of type `UpdateInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateInvoiceVariables { + id: UUIDString; + invoiceNumber?: string | null; + amount?: number | null; + status?: InvoiceStatus | null; + issueDate?: TimestampString | null; + dueDate?: TimestampString | null; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} +``` +### Return Type +Recall that executing the `UpdateInvoice` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateInvoiceData { + invoice_update?: Invoice_Key | null; +} +``` +### Using `UpdateInvoice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateInvoice, UpdateInvoiceVariables } from '@dataconnect/generated'; + +// The `UpdateInvoice` mutation requires an argument of type `UpdateInvoiceVariables`: +const updateInvoiceVars: UpdateInvoiceVariables = { + id: ..., + invoiceNumber: ..., // optional + amount: ..., // optional + status: ..., // optional + issueDate: ..., // optional + dueDate: ..., // optional + disputedItems: ..., // optional + isAutoGenerated: ..., // optional +}; + +// Call the `updateInvoice()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateInvoice(updateInvoiceVars); +// Variables can be defined inline as well. +const { data } = await updateInvoice({ id: ..., invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateInvoice(dataConnect, updateInvoiceVars); + +console.log(data.invoice_update); + +// Or, you can use the `Promise` API. +updateInvoice(updateInvoiceVars).then((response) => { + const data = response.data; + console.log(data.invoice_update); +}); +``` + +### Using `UpdateInvoice`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateInvoiceRef, UpdateInvoiceVariables } from '@dataconnect/generated'; + +// The `UpdateInvoice` mutation requires an argument of type `UpdateInvoiceVariables`: +const updateInvoiceVars: UpdateInvoiceVariables = { + id: ..., + invoiceNumber: ..., // optional + amount: ..., // optional + status: ..., // optional + issueDate: ..., // optional + dueDate: ..., // optional + disputedItems: ..., // optional + isAutoGenerated: ..., // optional +}; + +// Call the `updateInvoiceRef()` function to get a reference to the mutation. +const ref = updateInvoiceRef(updateInvoiceVars); +// Variables can be defined inline as well. +const ref = updateInvoiceRef({ id: ..., invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateInvoiceRef(dataConnect, updateInvoiceVars); + +// 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.invoice_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.invoice_update); +}); +``` + +## DeleteInvoice +You can execute the `DeleteInvoice` 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 +deleteInvoice(vars: DeleteInvoiceVariables): MutationPromise; + +interface DeleteInvoiceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteInvoiceVariables): MutationRef; +} +export const deleteInvoiceRef: DeleteInvoiceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteInvoice(dc: DataConnect, vars: DeleteInvoiceVariables): MutationPromise; + +interface DeleteInvoiceRef { + ... + (dc: DataConnect, vars: DeleteInvoiceVariables): MutationRef; +} +export const deleteInvoiceRef: DeleteInvoiceRef; +``` + +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 deleteInvoiceRef: +```typescript +const name = deleteInvoiceRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteInvoice` mutation requires an argument of type `DeleteInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteInvoiceVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteInvoice` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteInvoiceData { + invoice_delete?: Invoice_Key | null; +} +``` +### Using `DeleteInvoice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteInvoice, DeleteInvoiceVariables } from '@dataconnect/generated'; + +// The `DeleteInvoice` mutation requires an argument of type `DeleteInvoiceVariables`: +const deleteInvoiceVars: DeleteInvoiceVariables = { + id: ..., +}; + +// Call the `deleteInvoice()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteInvoice(deleteInvoiceVars); +// Variables can be defined inline as well. +const { data } = await deleteInvoice({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteInvoice(dataConnect, deleteInvoiceVars); + +console.log(data.invoice_delete); + +// Or, you can use the `Promise` API. +deleteInvoice(deleteInvoiceVars).then((response) => { + const data = response.data; + console.log(data.invoice_delete); +}); +``` + +### Using `DeleteInvoice`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteInvoiceRef, DeleteInvoiceVariables } from '@dataconnect/generated'; + +// The `DeleteInvoice` mutation requires an argument of type `DeleteInvoiceVariables`: +const deleteInvoiceVars: DeleteInvoiceVariables = { + id: ..., +}; + +// Call the `deleteInvoiceRef()` function to get a reference to the mutation. +const ref = deleteInvoiceRef(deleteInvoiceVars); +// Variables can be defined inline as well. +const ref = deleteInvoiceRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteInvoiceRef(dataConnect, deleteInvoiceVars); + +// 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.invoice_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.invoice_delete); +}); +``` + +## CreateStaff +You can execute the `CreateStaff` 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 +createStaff(vars: CreateStaffVariables): MutationPromise; + +interface CreateStaffRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateStaffVariables): MutationRef; +} +export const createStaffRef: CreateStaffRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createStaff(dc: DataConnect, vars: CreateStaffVariables): MutationPromise; + +interface CreateStaffRef { + ... + (dc: DataConnect, vars: CreateStaffVariables): MutationRef; +} +export const createStaffRef: CreateStaffRef; +``` + +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 createStaffRef: +```typescript +const name = createStaffRef.operationName; +console.log(name); +``` + +### Variables +The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateStaffVariables { + employeeName: string; + vendorId?: UUIDString | null; + email?: string | null; + position?: string | null; + employmentType: EmploymentType; + rating?: number | null; + reliabilityScore?: number | null; + backgroundCheckStatus: BackgroundCheckStatus; + certifications?: string | null; +} +``` +### Return Type +Recall that executing the `CreateStaff` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateStaffData { + staff_insert: Staff_Key; +} +``` +### Using `CreateStaff`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createStaff, CreateStaffVariables } from '@dataconnect/generated'; + +// The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`: +const createStaffVars: CreateStaffVariables = { + employeeName: ..., + vendorId: ..., // optional + email: ..., // optional + position: ..., // optional + employmentType: ..., + rating: ..., // optional + reliabilityScore: ..., // optional + backgroundCheckStatus: ..., + certifications: ..., // optional +}; + +// Call the `createStaff()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createStaff(createStaffVars); +// Variables can be defined inline as well. +const { data } = await createStaff({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createStaff(dataConnect, createStaffVars); + +console.log(data.staff_insert); + +// Or, you can use the `Promise` API. +createStaff(createStaffVars).then((response) => { + const data = response.data; + console.log(data.staff_insert); +}); +``` + +### Using `CreateStaff`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createStaffRef, CreateStaffVariables } from '@dataconnect/generated'; + +// The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`: +const createStaffVars: CreateStaffVariables = { + employeeName: ..., + vendorId: ..., // optional + email: ..., // optional + position: ..., // optional + employmentType: ..., + rating: ..., // optional + reliabilityScore: ..., // optional + backgroundCheckStatus: ..., + certifications: ..., // optional +}; + +// Call the `createStaffRef()` function to get a reference to the mutation. +const ref = createStaffRef(createStaffVars); +// Variables can be defined inline as well. +const ref = createStaffRef({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createStaffRef(dataConnect, createStaffVars); + +// 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.staff_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.staff_insert); +}); +``` + +## 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); +}); +``` + ## CreateVendorRate You can execute the `CreateVendorRate` 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 @@ -2961,478 +4155,3 @@ executeMutation(ref).then((response) => { }); ``` -## CreateStaff -You can execute the `CreateStaff` 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 -createStaff(vars: CreateStaffVariables): MutationPromise; - -interface CreateStaffRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateStaffVariables): MutationRef; -} -export const createStaffRef: CreateStaffRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -createStaff(dc: DataConnect, vars: CreateStaffVariables): MutationPromise; - -interface CreateStaffRef { - ... - (dc: DataConnect, vars: CreateStaffVariables): MutationRef; -} -export const createStaffRef: CreateStaffRef; -``` - -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 createStaffRef: -```typescript -const name = createStaffRef.operationName; -console.log(name); -``` - -### Variables -The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface CreateStaffVariables { - employeeName: string; - vendorId?: UUIDString | null; - email?: string | null; - position?: string | null; - employmentType: EmploymentType; - rating?: number | null; - reliabilityScore?: number | null; - backgroundCheckStatus: BackgroundCheckStatus; - certifications?: string | null; -} -``` -### Return Type -Recall that executing the `CreateStaff` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `CreateStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface CreateStaffData { - staff_insert: Staff_Key; -} -``` -### Using `CreateStaff`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, createStaff, CreateStaffVariables } from '@dataconnect/generated'; - -// The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`: -const createStaffVars: CreateStaffVariables = { - employeeName: ..., - vendorId: ..., // optional - email: ..., // optional - position: ..., // optional - employmentType: ..., - rating: ..., // optional - reliabilityScore: ..., // optional - backgroundCheckStatus: ..., - certifications: ..., // optional -}; - -// Call the `createStaff()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await createStaff(createStaffVars); -// Variables can be defined inline as well. -const { data } = await createStaff({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await createStaff(dataConnect, createStaffVars); - -console.log(data.staff_insert); - -// Or, you can use the `Promise` API. -createStaff(createStaffVars).then((response) => { - const data = response.data; - console.log(data.staff_insert); -}); -``` - -### Using `CreateStaff`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, createStaffRef, CreateStaffVariables } from '@dataconnect/generated'; - -// The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`: -const createStaffVars: CreateStaffVariables = { - employeeName: ..., - vendorId: ..., // optional - email: ..., // optional - position: ..., // optional - employmentType: ..., - rating: ..., // optional - reliabilityScore: ..., // optional - backgroundCheckStatus: ..., - certifications: ..., // optional -}; - -// Call the `createStaffRef()` function to get a reference to the mutation. -const ref = createStaffRef(createStaffVars); -// Variables can be defined inline as well. -const ref = createStaffRef({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = createStaffRef(dataConnect, createStaffVars); - -// 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.staff_insert); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.staff_insert); -}); -``` - -## 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 5bc51f99..a70452f4 100644 --- a/frontend-web/src/dataconnect-generated/esm/index.esm.js +++ b/frontend-web/src/dataconnect-generated/esm/index.esm.js @@ -31,6 +31,19 @@ export const EventStatus = { CANCELED: "CANCELED", } +export const InvoiceStatus = { + DRAFT: "DRAFT", + PENDING_REVIEW: "PENDING_REVIEW", + APPROVED: "APPROVED", + DISPUTED: "DISPUTED", + UNDER_REVIEW: "UNDER_REVIEW", + RESOLVED: "RESOLVED", + OVERDUE: "OVERDUE", + PAID: "PAID", + RECONCILED: "RECONCILED", + CANCELLED: "CANCELLED", +} + export const RecurrenceType = { SINGLE: "SINGLE", DATE_RANGE: "DATE_RANGE", @@ -124,70 +137,37 @@ export function deleteVendor(dcOrVars, vars) { return executeMutation(deleteVendorRef(dcOrVars, vars)); } -export const createVendorRateRef = (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 mutationRef(dcInstance, 'CreateVendorRate', inputVars); + return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); } -createVendorRateRef.operationName = 'CreateVendorRate'; +getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; -export function createVendorRate(dcOrVars, vars) { - return executeMutation(createVendorRateRef(dcOrVars, vars)); +export function getVendorDefaultSettingById(dcOrVars, vars) { + return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); } -export const updateVendorRateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); +export const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateVendorRate', inputVars); + return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); } -updateVendorRateRef.operationName = 'UpdateVendorRate'; +filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; -export function updateVendorRate(dcOrVars, vars) { - return executeMutation(updateVendorRateRef(dcOrVars, vars)); -} - -export const deleteVendorRateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteVendorRate', inputVars); -} -deleteVendorRateRef.operationName = 'DeleteVendorRate'; - -export function deleteVendorRate(dcOrVars, vars) { - return executeMutation(deleteVendorRateRef(dcOrVars, vars)); -} - -export const createEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateEvent', inputVars); -} -createEventRef.operationName = 'CreateEvent'; - -export function createEvent(dcOrVars, vars) { - return executeMutation(createEventRef(dcOrVars, vars)); -} - -export const updateEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateEvent', inputVars); -} -updateEventRef.operationName = 'UpdateEvent'; - -export function updateEvent(dcOrVars, vars) { - return executeMutation(updateEventRef(dcOrVars, vars)); -} - -export const deleteEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteEvent', inputVars); -} -deleteEventRef.operationName = 'DeleteEvent'; - -export function deleteEvent(dcOrVars, vars) { - return executeMutation(deleteEventRef(dcOrVars, vars)); +export function filterVendorDefaultSettings(dcOrVars, vars) { + return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); } export const listEventsRef = (dc) => { @@ -223,6 +203,39 @@ export function filterEvents(dcOrVars, vars) { return executeQuery(filterEventsRef(dcOrVars, vars)); } +export const createInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateInvoice', inputVars); +} +createInvoiceRef.operationName = 'CreateInvoice'; + +export function createInvoice(dcOrVars, vars) { + return executeMutation(createInvoiceRef(dcOrVars, vars)); +} + +export const updateInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateInvoice', inputVars); +} +updateInvoiceRef.operationName = 'UpdateInvoice'; + +export function updateInvoice(dcOrVars, vars) { + return executeMutation(updateInvoiceRef(dcOrVars, vars)); +} + +export const deleteInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteInvoice', inputVars); +} +deleteInvoiceRef.operationName = 'DeleteInvoice'; + +export function deleteInvoice(dcOrVars, vars) { + return executeMutation(deleteInvoiceRef(dcOrVars, vars)); +} + export const createStaffRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -300,37 +313,37 @@ 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) => { +export const createVendorRateRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); + return mutationRef(dcInstance, 'CreateVendorRate', inputVars); } -getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; +createVendorRateRef.operationName = 'CreateVendorRate'; -export function getVendorDefaultSettingById(dcOrVars, vars) { - return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); +export function createVendorRate(dcOrVars, vars) { + return executeMutation(createVendorRateRef(dcOrVars, vars)); } -export const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); +export const updateVendorRateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); + return mutationRef(dcInstance, 'UpdateVendorRate', inputVars); } -filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; +updateVendorRateRef.operationName = 'UpdateVendorRate'; -export function filterVendorDefaultSettings(dcOrVars, vars) { - return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); +export function updateVendorRate(dcOrVars, vars) { + return executeMutation(updateVendorRateRef(dcOrVars, vars)); +} + +export const deleteVendorRateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteVendorRate', inputVars); +} +deleteVendorRateRef.operationName = 'DeleteVendorRate'; + +export function deleteVendorRate(dcOrVars, vars) { + return executeMutation(deleteVendorRateRef(dcOrVars, vars)); } export const listVendorRateRef = (dc) => { @@ -366,3 +379,69 @@ 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(); + return mutationRef(dcInstance, 'CreateEvent', inputVars); +} +createEventRef.operationName = 'CreateEvent'; + +export function createEvent(dcOrVars, vars) { + return executeMutation(createEventRef(dcOrVars, vars)); +} + +export const updateEventRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateEvent', inputVars); +} +updateEventRef.operationName = 'UpdateEvent'; + +export function updateEvent(dcOrVars, vars) { + return executeMutation(updateEventRef(dcOrVars, vars)); +} + +export const deleteEventRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteEvent', inputVars); +} +deleteEventRef.operationName = 'DeleteEvent'; + +export function deleteEvent(dcOrVars, vars) { + return executeMutation(deleteEventRef(dcOrVars, vars)); +} + +export const listInvoiceRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listInvoice'); +} +listInvoiceRef.operationName = 'listInvoice'; + +export function listInvoice(dc) { + return executeQuery(listInvoiceRef(dc)); +} + +export const getInvoiceByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getInvoiceById', inputVars); +} +getInvoiceByIdRef.operationName = 'getInvoiceById'; + +export function getInvoiceById(dcOrVars, vars) { + return executeQuery(getInvoiceByIdRef(dcOrVars, vars)); +} + +export const filterInvoicesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterInvoices', inputVars); +} +filterInvoicesRef.operationName = 'filterInvoices'; + +export function filterInvoices(dcOrVars, vars) { + return executeQuery(filterInvoicesRef(dcOrVars, vars)); +} + diff --git a/frontend-web/src/dataconnect-generated/index.cjs.js b/frontend-web/src/dataconnect-generated/index.cjs.js index b132fc8b..966dc199 100644 --- a/frontend-web/src/dataconnect-generated/index.cjs.js +++ b/frontend-web/src/dataconnect-generated/index.cjs.js @@ -35,6 +35,20 @@ const EventStatus = { } exports.EventStatus = EventStatus; +const InvoiceStatus = { + DRAFT: "DRAFT", + PENDING_REVIEW: "PENDING_REVIEW", + APPROVED: "APPROVED", + DISPUTED: "DISPUTED", + UNDER_REVIEW: "UNDER_REVIEW", + RESOLVED: "RESOLVED", + OVERDUE: "OVERDUE", + PAID: "PAID", + RECONCILED: "RECONCILED", + CANCELLED: "CANCELLED", +} +exports.InvoiceStatus = InvoiceStatus; + const RecurrenceType = { SINGLE: "SINGLE", DATE_RANGE: "DATE_RANGE", @@ -138,76 +152,40 @@ exports.deleteVendor = function deleteVendor(dcOrVars, vars) { return executeMutation(deleteVendorRef(dcOrVars, vars)); }; -const createVendorRateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); +const listVendorDefaultSettingsRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateVendorRate', inputVars); + return queryRef(dcInstance, 'listVendorDefaultSettings'); } -createVendorRateRef.operationName = 'CreateVendorRate'; -exports.createVendorRateRef = createVendorRateRef; +listVendorDefaultSettingsRef.operationName = 'listVendorDefaultSettings'; +exports.listVendorDefaultSettingsRef = listVendorDefaultSettingsRef; -exports.createVendorRate = function createVendorRate(dcOrVars, vars) { - return executeMutation(createVendorRateRef(dcOrVars, vars)); +exports.listVendorDefaultSettings = function listVendorDefaultSettings(dc) { + return executeQuery(listVendorDefaultSettingsRef(dc)); }; -const updateVendorRateRef = (dcOrVars, vars) => { +const getVendorDefaultSettingByIdRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateVendorRate', inputVars); + return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); } -updateVendorRateRef.operationName = 'UpdateVendorRate'; -exports.updateVendorRateRef = updateVendorRateRef; +getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; +exports.getVendorDefaultSettingByIdRef = getVendorDefaultSettingByIdRef; -exports.updateVendorRate = function updateVendorRate(dcOrVars, vars) { - return executeMutation(updateVendorRateRef(dcOrVars, vars)); +exports.getVendorDefaultSettingById = function getVendorDefaultSettingById(dcOrVars, vars) { + return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); }; -const deleteVendorRateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); +const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteVendorRate', inputVars); + return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); } -deleteVendorRateRef.operationName = 'DeleteVendorRate'; -exports.deleteVendorRateRef = deleteVendorRateRef; +filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; +exports.filterVendorDefaultSettingsRef = filterVendorDefaultSettingsRef; -exports.deleteVendorRate = function deleteVendorRate(dcOrVars, vars) { - return executeMutation(deleteVendorRateRef(dcOrVars, vars)); -}; - -const createEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateEvent', inputVars); -} -createEventRef.operationName = 'CreateEvent'; -exports.createEventRef = createEventRef; - -exports.createEvent = function createEvent(dcOrVars, vars) { - return executeMutation(createEventRef(dcOrVars, vars)); -}; - -const updateEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateEvent', inputVars); -} -updateEventRef.operationName = 'UpdateEvent'; -exports.updateEventRef = updateEventRef; - -exports.updateEvent = function updateEvent(dcOrVars, vars) { - return executeMutation(updateEventRef(dcOrVars, vars)); -}; - -const deleteEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteEvent', inputVars); -} -deleteEventRef.operationName = 'DeleteEvent'; -exports.deleteEventRef = deleteEventRef; - -exports.deleteEvent = function deleteEvent(dcOrVars, vars) { - return executeMutation(deleteEventRef(dcOrVars, vars)); +exports.filterVendorDefaultSettings = function filterVendorDefaultSettings(dcOrVars, vars) { + return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); }; const listEventsRef = (dc) => { @@ -246,6 +224,42 @@ exports.filterEvents = function filterEvents(dcOrVars, vars) { return executeQuery(filterEventsRef(dcOrVars, vars)); }; +const createInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateInvoice', inputVars); +} +createInvoiceRef.operationName = 'CreateInvoice'; +exports.createInvoiceRef = createInvoiceRef; + +exports.createInvoice = function createInvoice(dcOrVars, vars) { + return executeMutation(createInvoiceRef(dcOrVars, vars)); +}; + +const updateInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateInvoice', inputVars); +} +updateInvoiceRef.operationName = 'UpdateInvoice'; +exports.updateInvoiceRef = updateInvoiceRef; + +exports.updateInvoice = function updateInvoice(dcOrVars, vars) { + return executeMutation(updateInvoiceRef(dcOrVars, vars)); +}; + +const deleteInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteInvoice', inputVars); +} +deleteInvoiceRef.operationName = 'DeleteInvoice'; +exports.deleteInvoiceRef = deleteInvoiceRef; + +exports.deleteInvoice = function deleteInvoice(dcOrVars, vars) { + return executeMutation(deleteInvoiceRef(dcOrVars, vars)); +}; + const createStaffRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -330,40 +344,40 @@ exports.deleteVendorDefaultSetting = function deleteVendorDefaultSetting(dcOrVar 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 createVendorRateRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); + return mutationRef(dcInstance, 'CreateVendorRate', inputVars); } -getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; -exports.getVendorDefaultSettingByIdRef = getVendorDefaultSettingByIdRef; +createVendorRateRef.operationName = 'CreateVendorRate'; +exports.createVendorRateRef = createVendorRateRef; -exports.getVendorDefaultSettingById = function getVendorDefaultSettingById(dcOrVars, vars) { - return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); +exports.createVendorRate = function createVendorRate(dcOrVars, vars) { + return executeMutation(createVendorRateRef(dcOrVars, vars)); }; -const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); +const updateVendorRateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); + return mutationRef(dcInstance, 'UpdateVendorRate', inputVars); } -filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; -exports.filterVendorDefaultSettingsRef = filterVendorDefaultSettingsRef; +updateVendorRateRef.operationName = 'UpdateVendorRate'; +exports.updateVendorRateRef = updateVendorRateRef; -exports.filterVendorDefaultSettings = function filterVendorDefaultSettings(dcOrVars, vars) { - return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); +exports.updateVendorRate = function updateVendorRate(dcOrVars, vars) { + return executeMutation(updateVendorRateRef(dcOrVars, vars)); +}; + +const deleteVendorRateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteVendorRate', inputVars); +} +deleteVendorRateRef.operationName = 'DeleteVendorRate'; +exports.deleteVendorRateRef = deleteVendorRateRef; + +exports.deleteVendorRate = function deleteVendorRate(dcOrVars, vars) { + return executeMutation(deleteVendorRateRef(dcOrVars, vars)); }; const listVendorRateRef = (dc) => { @@ -401,3 +415,75 @@ 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(); + return mutationRef(dcInstance, 'CreateEvent', inputVars); +} +createEventRef.operationName = 'CreateEvent'; +exports.createEventRef = createEventRef; + +exports.createEvent = function createEvent(dcOrVars, vars) { + return executeMutation(createEventRef(dcOrVars, vars)); +}; + +const updateEventRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateEvent', inputVars); +} +updateEventRef.operationName = 'UpdateEvent'; +exports.updateEventRef = updateEventRef; + +exports.updateEvent = function updateEvent(dcOrVars, vars) { + return executeMutation(updateEventRef(dcOrVars, vars)); +}; + +const deleteEventRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteEvent', inputVars); +} +deleteEventRef.operationName = 'DeleteEvent'; +exports.deleteEventRef = deleteEventRef; + +exports.deleteEvent = function deleteEvent(dcOrVars, vars) { + return executeMutation(deleteEventRef(dcOrVars, vars)); +}; + +const listInvoiceRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listInvoice'); +} +listInvoiceRef.operationName = 'listInvoice'; +exports.listInvoiceRef = listInvoiceRef; + +exports.listInvoice = function listInvoice(dc) { + return executeQuery(listInvoiceRef(dc)); +}; + +const getInvoiceByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getInvoiceById', inputVars); +} +getInvoiceByIdRef.operationName = 'getInvoiceById'; +exports.getInvoiceByIdRef = getInvoiceByIdRef; + +exports.getInvoiceById = function getInvoiceById(dcOrVars, vars) { + return executeQuery(getInvoiceByIdRef(dcOrVars, vars)); +}; + +const filterInvoicesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterInvoices', inputVars); +} +filterInvoicesRef.operationName = 'filterInvoices'; +exports.filterInvoicesRef = filterInvoicesRef; + +exports.filterInvoices = function filterInvoices(dcOrVars, vars) { + return executeQuery(filterInvoicesRef(dcOrVars, vars)); +}; diff --git a/frontend-web/src/dataconnect-generated/index.d.ts b/frontend-web/src/dataconnect-generated/index.d.ts index 042cb070..eb1a912d 100644 --- a/frontend-web/src/dataconnect-generated/index.d.ts +++ b/frontend-web/src/dataconnect-generated/index.d.ts @@ -39,6 +39,19 @@ export enum EventStatus { CANCELED = "CANCELED", }; +export enum InvoiceStatus { + DRAFT = "DRAFT", + PENDING_REVIEW = "PENDING_REVIEW", + APPROVED = "APPROVED", + DISPUTED = "DISPUTED", + UNDER_REVIEW = "UNDER_REVIEW", + RESOLVED = "RESOLVED", + OVERDUE = "OVERDUE", + PAID = "PAID", + RECONCILED = "RECONCILED", + CANCELLED = "CANCELLED", +}; + export enum RecurrenceType { SINGLE = "SINGLE", DATE_RANGE = "DATE_RANGE", @@ -125,6 +138,20 @@ export interface CreateEventVariables { assignedStaff?: string | null; } +export interface CreateInvoiceData { + invoice_insert: Invoice_Key; +} + +export interface CreateInvoiceVariables { + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} + export interface CreateStaffData { staff_insert: Staff_Key; } @@ -187,6 +214,14 @@ export interface DeleteEventVariables { id: UUIDString; } +export interface DeleteInvoiceData { + invoice_delete?: Invoice_Key | null; +} + +export interface DeleteInvoiceVariables { + id: UUIDString; +} + export interface DeleteVendorData { vendor_delete?: Vendor_Key | null; } @@ -271,6 +306,25 @@ export interface FilterEventsVariables { clientEmail?: string | null; } +export interface FilterInvoicesData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_Key)[]; +} + +export interface FilterInvoicesVariables { + invoiceNumber?: string | null; + status?: InvoiceStatus | null; + isAutoGenerated?: boolean | null; + amount?: number | null; +} + export interface FilterVendorDefaultSettingsData { vendorDefaultSettings: ({ id: UUIDString; @@ -374,6 +428,23 @@ export interface GetEventByIdVariables { id: UUIDString; } +export interface GetInvoiceByIdData { + invoice?: { + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; + } & Invoice_Key; +} + +export interface GetInvoiceByIdVariables { + id: UUIDString; +} + export interface GetVendorByIdData { vendor?: { id: UUIDString; @@ -424,6 +495,11 @@ export interface GetVendorRateByIdVariables { id: UUIDString; } +export interface Invoice_Key { + id: UUIDString; + __typename?: 'Invoice_Key'; +} + export interface ListEventsData { events: ({ id: UUIDString; @@ -464,6 +540,18 @@ export interface ListEventsData { } & Event_Key)[]; } +export interface ListInvoiceData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_Key)[]; +} + export interface ListStaffData { staffs: ({ id: UUIDString; @@ -561,6 +649,21 @@ export interface UpdateEventVariables { assignedStaff?: string | null; } +export interface UpdateInvoiceData { + invoice_update?: Invoice_Key | null; +} + +export interface UpdateInvoiceVariables { + id: UUIDString; + invoiceNumber?: string | null; + amount?: number | null; + status?: InvoiceStatus | null; + issueDate?: TimestampString | null; + dueDate?: TimestampString | null; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} + export interface UpdateVendorData { vendor_update?: Vendor_Key | null; } @@ -665,77 +768,41 @@ export const deleteVendorRef: DeleteVendorRef; export function deleteVendor(vars: DeleteVendorVariables): MutationPromise; export function deleteVendor(dc: DataConnect, vars: DeleteVendorVariables): MutationPromise; -interface CreateVendorRateRef { +interface ListVendorDefaultSettingsRef { /* Allow users to create refs without passing in DataConnect */ - (vars: CreateVendorRateVariables): MutationRef; + (): QueryRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: CreateVendorRateVariables): MutationRef; + (dc: DataConnect): QueryRef; operationName: string; } -export const createVendorRateRef: CreateVendorRateRef; +export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; -export function createVendorRate(vars: CreateVendorRateVariables): MutationPromise; -export function createVendorRate(dc: DataConnect, vars: CreateVendorRateVariables): MutationPromise; +export function listVendorDefaultSettings(): QueryPromise; +export function listVendorDefaultSettings(dc: DataConnect): QueryPromise; -interface UpdateVendorRateRef { +interface GetVendorDefaultSettingByIdRef { /* Allow users to create refs without passing in DataConnect */ - (vars: UpdateVendorRateVariables): MutationRef; + (vars: GetVendorDefaultSettingByIdVariables): QueryRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: UpdateVendorRateVariables): MutationRef; + (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef; operationName: string; } -export const updateVendorRateRef: UpdateVendorRateRef; +export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; -export function updateVendorRate(vars: UpdateVendorRateVariables): MutationPromise; -export function updateVendorRate(dc: DataConnect, vars: UpdateVendorRateVariables): MutationPromise; +export function getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise; +export function getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise; -interface DeleteVendorRateRef { +interface FilterVendorDefaultSettingsRef { /* Allow users to create refs without passing in DataConnect */ - (vars: DeleteVendorRateVariables): MutationRef; + (vars?: FilterVendorDefaultSettingsVariables): QueryRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: DeleteVendorRateVariables): MutationRef; + (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef; operationName: string; } -export const deleteVendorRateRef: DeleteVendorRateRef; +export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; -export function deleteVendorRate(vars: DeleteVendorRateVariables): MutationPromise; -export function deleteVendorRate(dc: DataConnect, vars: DeleteVendorRateVariables): MutationPromise; - -interface CreateEventRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateEventVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: CreateEventVariables): MutationRef; - operationName: string; -} -export const createEventRef: CreateEventRef; - -export function createEvent(vars: CreateEventVariables): MutationPromise; -export function createEvent(dc: DataConnect, vars: CreateEventVariables): MutationPromise; - -interface UpdateEventRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: UpdateEventVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: UpdateEventVariables): MutationRef; - operationName: string; -} -export const updateEventRef: UpdateEventRef; - -export function updateEvent(vars: UpdateEventVariables): MutationPromise; -export function updateEvent(dc: DataConnect, vars: UpdateEventVariables): MutationPromise; - -interface DeleteEventRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: DeleteEventVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: DeleteEventVariables): MutationRef; - operationName: string; -} -export const deleteEventRef: DeleteEventRef; - -export function deleteEvent(vars: DeleteEventVariables): MutationPromise; -export function deleteEvent(dc: DataConnect, vars: DeleteEventVariables): MutationPromise; +export function filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise; +export function filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise; interface ListEventsRef { /* Allow users to create refs without passing in DataConnect */ @@ -773,6 +840,42 @@ export const filterEventsRef: FilterEventsRef; export function filterEvents(vars?: FilterEventsVariables): QueryPromise; export function filterEvents(dc: DataConnect, vars?: FilterEventsVariables): QueryPromise; +interface CreateInvoiceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateInvoiceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateInvoiceVariables): MutationRef; + operationName: string; +} +export const createInvoiceRef: CreateInvoiceRef; + +export function createInvoice(vars: CreateInvoiceVariables): MutationPromise; +export function createInvoice(dc: DataConnect, vars: CreateInvoiceVariables): MutationPromise; + +interface UpdateInvoiceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateInvoiceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateInvoiceVariables): MutationRef; + operationName: string; +} +export const updateInvoiceRef: UpdateInvoiceRef; + +export function updateInvoice(vars: UpdateInvoiceVariables): MutationPromise; +export function updateInvoice(dc: DataConnect, vars: UpdateInvoiceVariables): MutationPromise; + +interface DeleteInvoiceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteInvoiceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteInvoiceVariables): MutationRef; + operationName: string; +} +export const deleteInvoiceRef: DeleteInvoiceRef; + +export function deleteInvoice(vars: DeleteInvoiceVariables): MutationPromise; +export function deleteInvoice(dc: DataConnect, vars: DeleteInvoiceVariables): MutationPromise; + interface CreateStaffRef { /* Allow users to create refs without passing in DataConnect */ (vars: CreateStaffVariables): MutationRef; @@ -857,41 +960,41 @@ export const deleteVendorDefaultSettingRef: DeleteVendorDefaultSettingRef; export function deleteVendorDefaultSetting(vars: DeleteVendorDefaultSettingVariables): MutationPromise; export function deleteVendorDefaultSetting(dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationPromise; -interface ListVendorDefaultSettingsRef { +interface CreateVendorRateRef { /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; + (vars: CreateVendorRateVariables): MutationRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect): QueryRef; + (dc: DataConnect, vars: CreateVendorRateVariables): MutationRef; operationName: string; } -export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; +export const createVendorRateRef: CreateVendorRateRef; -export function listVendorDefaultSettings(): QueryPromise; -export function listVendorDefaultSettings(dc: DataConnect): QueryPromise; +export function createVendorRate(vars: CreateVendorRateVariables): MutationPromise; +export function createVendorRate(dc: DataConnect, vars: CreateVendorRateVariables): MutationPromise; -interface GetVendorDefaultSettingByIdRef { +interface UpdateVendorRateRef { /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorDefaultSettingByIdVariables): QueryRef; + (vars: UpdateVendorRateVariables): MutationRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef; + (dc: DataConnect, vars: UpdateVendorRateVariables): MutationRef; operationName: string; } -export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; +export const updateVendorRateRef: UpdateVendorRateRef; -export function getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise; -export function getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise; +export function updateVendorRate(vars: UpdateVendorRateVariables): MutationPromise; +export function updateVendorRate(dc: DataConnect, vars: UpdateVendorRateVariables): MutationPromise; -interface FilterVendorDefaultSettingsRef { +interface DeleteVendorRateRef { /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorDefaultSettingsVariables): QueryRef; + (vars: DeleteVendorRateVariables): MutationRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef; + (dc: DataConnect, vars: DeleteVendorRateVariables): MutationRef; operationName: string; } -export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; +export const deleteVendorRateRef: DeleteVendorRateRef; -export function filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise; -export function filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise; +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 */ @@ -929,3 +1032,75 @@ 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; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateEventVariables): MutationRef; + operationName: string; +} +export const createEventRef: CreateEventRef; + +export function createEvent(vars: CreateEventVariables): MutationPromise; +export function createEvent(dc: DataConnect, vars: CreateEventVariables): MutationPromise; + +interface UpdateEventRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateEventVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateEventVariables): MutationRef; + operationName: string; +} +export const updateEventRef: UpdateEventRef; + +export function updateEvent(vars: UpdateEventVariables): MutationPromise; +export function updateEvent(dc: DataConnect, vars: UpdateEventVariables): MutationPromise; + +interface DeleteEventRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteEventVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteEventVariables): MutationRef; + operationName: string; +} +export const deleteEventRef: DeleteEventRef; + +export function deleteEvent(vars: DeleteEventVariables): MutationPromise; +export function deleteEvent(dc: DataConnect, vars: DeleteEventVariables): MutationPromise; + +interface ListInvoiceRef { + /* 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 listInvoiceRef: ListInvoiceRef; + +export function listInvoice(): QueryPromise; +export function listInvoice(dc: DataConnect): QueryPromise; + +interface GetInvoiceByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetInvoiceByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetInvoiceByIdVariables): QueryRef; + operationName: string; +} +export const getInvoiceByIdRef: GetInvoiceByIdRef; + +export function getInvoiceById(vars: GetInvoiceByIdVariables): QueryPromise; +export function getInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables): QueryPromise; + +interface FilterInvoicesRef { + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterInvoicesVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars?: FilterInvoicesVariables): QueryRef; + operationName: string; +} +export const filterInvoicesRef: FilterInvoicesRef; + +export function filterInvoices(vars?: FilterInvoicesVariables): QueryPromise; +export function filterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables): QueryPromise; + diff --git a/frontend-web/src/dataconnect-generated/react/README.md b/frontend-web/src/dataconnect-generated/react/README.md index 0712a844..de4097eb 100644 --- a/frontend-web/src/dataconnect-generated/react/README.md +++ b/frontend-web/src/dataconnect-generated/react/README.md @@ -18,32 +18,38 @@ You can also follow the instructions from the [Data Connect documentation](https - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) - [**Queries**](#queries) - [*listStaff*](#liststaff) + - [*listVendorDefaultSettings*](#listvendordefaultsettings) + - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) + - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) - [*listEvents*](#listevents) - [*getEventById*](#geteventbyid) - [*filterEvents*](#filterevents) - [*listVendor*](#listvendor) - [*getVendorById*](#getvendorbyid) - [*filterVendors*](#filtervendors) - - [*listVendorDefaultSettings*](#listvendordefaultsettings) - - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) - - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) - [*listVendorRate*](#listvendorrate) - [*getVendorRateById*](#getvendorratebyid) - [*filterVendorRates*](#filtervendorrates) + - [*listInvoice*](#listinvoice) + - [*getInvoiceById*](#getinvoicebyid) + - [*filterInvoices*](#filterinvoices) - [**Mutations**](#mutations) - [*CreateVendor*](#createvendor) - [*UpdateVendor*](#updatevendor) - [*DeleteVendor*](#deletevendor) + - [*CreateInvoice*](#createinvoice) + - [*UpdateInvoice*](#updateinvoice) + - [*DeleteInvoice*](#deleteinvoice) + - [*CreateStaff*](#createstaff) + - [*CreateVendorDefaultSetting*](#createvendordefaultsetting) + - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting) + - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting) - [*CreateVendorRate*](#createvendorrate) - [*UpdateVendorRate*](#updatevendorrate) - [*DeleteVendorRate*](#deletevendorrate) - [*CreateEvent*](#createevent) - [*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). @@ -215,6 +221,264 @@ export default function ListStaffComponent() { } ``` +## 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'}!
; +} +``` + ## listEvents You can execute the `listEvents` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): @@ -862,264 +1126,6 @@ export default function FilterVendorsComponent() { } ``` -## 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): @@ -1397,6 +1403,276 @@ export default function FilterVendorRatesComponent() { } ``` +## listInvoice +You can execute the `listInvoice` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useListInvoice(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListInvoice(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `listInvoice` Query has no variables. +### Return Type +Recall that calling the `listInvoice` 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 `listInvoice` Query is of type `ListInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListInvoiceData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_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 `listInvoice`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@dataconnect/generated'; +import { useListInvoice } from '@dataconnect/generated/react' + +export default function ListInvoiceComponent() { + // 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 = useListInvoice(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListInvoice(dataConnect); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListInvoice(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListInvoice(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.invoices); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## getInvoiceById +You can execute the `getInvoiceById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useGetInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetInvoiceById(vars: GetInvoiceByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `getInvoiceById` Query requires an argument of type `GetInvoiceByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetInvoiceByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `getInvoiceById` 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 `getInvoiceById` Query is of type `GetInvoiceByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetInvoiceByIdData { + invoice?: { + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; + } & Invoice_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 `getInvoiceById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetInvoiceByIdVariables } from '@dataconnect/generated'; +import { useGetInvoiceById } from '@dataconnect/generated/react' + +export default function GetInvoiceByIdComponent() { + // The `useGetInvoiceById` Query hook requires an argument of type `GetInvoiceByIdVariables`: + const getInvoiceByIdVars: GetInvoiceByIdVariables = { + 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 = useGetInvoiceById(getInvoiceByIdVars); + // Variables can be defined inline as well. + const query = useGetInvoiceById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetInvoiceById(dataConnect, getInvoiceByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetInvoiceById(getInvoiceByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetInvoiceById(dataConnect, getInvoiceByIdVars, 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.invoice); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## filterInvoices +You can execute the `filterInvoices` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useFilterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useFilterInvoices(vars?: FilterInvoicesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `filterInvoices` Query has an optional argument of type `FilterInvoicesVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface FilterInvoicesVariables { + invoiceNumber?: string | null; + status?: InvoiceStatus | null; + isAutoGenerated?: boolean | null; + amount?: number | null; +} +``` +### Return Type +Recall that calling the `filterInvoices` 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 `filterInvoices` Query is of type `FilterInvoicesData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface FilterInvoicesData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_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 `filterInvoices`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, FilterInvoicesVariables } from '@dataconnect/generated'; +import { useFilterInvoices } from '@dataconnect/generated/react' + +export default function FilterInvoicesComponent() { + // The `useFilterInvoices` Query hook has an optional argument of type `FilterInvoicesVariables`: + const filterInvoicesVars: FilterInvoicesVariables = { + invoiceNumber: ..., // optional + status: ..., // optional + isAutoGenerated: ..., // optional + amount: ..., // 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 = useFilterInvoices(filterInvoicesVars); + // Variables can be defined inline as well. + const query = useFilterInvoices({ invoiceNumber: ..., status: ..., isAutoGenerated: ..., amount: ..., }); + // Since all variables are optional for this Query, you can omit the `FilterInvoicesVariables` argument. + // (as long as you don't want to provide any `options`!) + const query = useFilterInvoices(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useFilterInvoices(dataConnect, filterInvoicesVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useFilterInvoices(filterInvoicesVars, 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 = useFilterInvoices(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 = useFilterInvoices(dataConnect, filterInvoicesVars /** 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.invoices); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + # Mutations The React generated SDK provides Mutations hook functions that call and return [`useDataConnectMutation`](https://react-query-firebase.invertase.dev/react/data-connect/mutations) hooks from TanStack Query Firebase. @@ -1730,6 +2006,716 @@ export default function DeleteVendorComponent() { } ``` +## CreateInvoice +You can execute the `CreateInvoice` 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 +useCreateInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateInvoice` Mutation requires an argument of type `CreateInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateInvoiceVariables { + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} +``` +### Return Type +Recall that calling the `CreateInvoice` 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 `CreateInvoice` Mutation is of type `CreateInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateInvoiceData { + invoice_insert: Invoice_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 `CreateInvoice`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateInvoiceVariables } from '@dataconnect/generated'; +import { useCreateInvoice } from '@dataconnect/generated/react' + +export default function CreateInvoiceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateInvoice(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateInvoice(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateInvoice(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 = useCreateInvoice(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateInvoice` Mutation requires an argument of type `CreateInvoiceVariables`: + const createInvoiceVars: CreateInvoiceVariables = { + invoiceNumber: ..., + amount: ..., + status: ..., + issueDate: ..., + dueDate: ..., + disputedItems: ..., // optional + isAutoGenerated: ..., // optional + }; + mutation.mutate(createInvoiceVars); + // Variables can be defined inline as well. + mutation.mutate({ invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createInvoiceVars, 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.invoice_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateInvoice +You can execute the `UpdateInvoice` 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 +useUpdateInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateInvoice` Mutation requires an argument of type `UpdateInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateInvoiceVariables { + id: UUIDString; + invoiceNumber?: string | null; + amount?: number | null; + status?: InvoiceStatus | null; + issueDate?: TimestampString | null; + dueDate?: TimestampString | null; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} +``` +### Return Type +Recall that calling the `UpdateInvoice` 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 `UpdateInvoice` Mutation is of type `UpdateInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateInvoiceData { + invoice_update?: Invoice_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 `UpdateInvoice`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateInvoiceVariables } from '@dataconnect/generated'; +import { useUpdateInvoice } from '@dataconnect/generated/react' + +export default function UpdateInvoiceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateInvoice(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateInvoice(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateInvoice(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 = useUpdateInvoice(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateInvoice` Mutation requires an argument of type `UpdateInvoiceVariables`: + const updateInvoiceVars: UpdateInvoiceVariables = { + id: ..., + invoiceNumber: ..., // optional + amount: ..., // optional + status: ..., // optional + issueDate: ..., // optional + dueDate: ..., // optional + disputedItems: ..., // optional + isAutoGenerated: ..., // optional + }; + mutation.mutate(updateInvoiceVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateInvoiceVars, 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.invoice_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteInvoice +You can execute the `DeleteInvoice` 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 +useDeleteInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteInvoice` Mutation requires an argument of type `DeleteInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteInvoiceVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteInvoice` 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 `DeleteInvoice` Mutation is of type `DeleteInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteInvoiceData { + invoice_delete?: Invoice_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 `DeleteInvoice`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteInvoiceVariables } from '@dataconnect/generated'; +import { useDeleteInvoice } from '@dataconnect/generated/react' + +export default function DeleteInvoiceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteInvoice(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteInvoice(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteInvoice(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 = useDeleteInvoice(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteInvoice` Mutation requires an argument of type `DeleteInvoiceVariables`: + const deleteInvoiceVars: DeleteInvoiceVariables = { + id: ..., + }; + mutation.mutate(deleteInvoiceVars); + // 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(deleteInvoiceVars, 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.invoice_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateStaff +You can execute the `CreateStaff` 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 +useCreateStaff(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateStaff` Mutation requires an argument of type `CreateStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateStaffVariables { + employeeName: string; + vendorId?: UUIDString | null; + email?: string | null; + position?: string | null; + employmentType: EmploymentType; + rating?: number | null; + reliabilityScore?: number | null; + backgroundCheckStatus: BackgroundCheckStatus; + certifications?: string | null; +} +``` +### Return Type +Recall that calling the `CreateStaff` 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 `CreateStaff` Mutation is of type `CreateStaffData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateStaffData { + staff_insert: Staff_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 `CreateStaff`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateStaffVariables } from '@dataconnect/generated'; +import { useCreateStaff } from '@dataconnect/generated/react' + +export default function CreateStaffComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateStaff(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateStaff(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateStaff(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 = useCreateStaff(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateStaff` Mutation requires an argument of type `CreateStaffVariables`: + const createStaffVars: CreateStaffVariables = { + employeeName: ..., + vendorId: ..., // optional + email: ..., // optional + position: ..., // optional + employmentType: ..., + rating: ..., // optional + reliabilityScore: ..., // optional + backgroundCheckStatus: ..., + certifications: ..., // optional + }; + mutation.mutate(createStaffVars); + // Variables can be defined inline as well. + mutation.mutate({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createStaffVars, 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.staff_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## 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'}!
; +} +``` + ## CreateVendorRate You can execute the `CreateVendorRate` 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 @@ -2454,405 +3440,3 @@ export default function DeleteEventComponent() { } ``` -## CreateStaff -You can execute the `CreateStaff` 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 -useCreateStaff(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `CreateStaff` Mutation requires an argument of type `CreateStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface CreateStaffVariables { - employeeName: string; - vendorId?: UUIDString | null; - email?: string | null; - position?: string | null; - employmentType: EmploymentType; - rating?: number | null; - reliabilityScore?: number | null; - backgroundCheckStatus: BackgroundCheckStatus; - certifications?: string | null; -} -``` -### Return Type -Recall that calling the `CreateStaff` 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 `CreateStaff` Mutation is of type `CreateStaffData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface CreateStaffData { - staff_insert: Staff_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 `CreateStaff`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, CreateStaffVariables } from '@dataconnect/generated'; -import { useCreateStaff } from '@dataconnect/generated/react' - -export default function CreateStaffComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useCreateStaff(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useCreateStaff(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateStaff(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 = useCreateStaff(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useCreateStaff` Mutation requires an argument of type `CreateStaffVariables`: - const createStaffVars: CreateStaffVariables = { - employeeName: ..., - vendorId: ..., // optional - email: ..., // optional - position: ..., // optional - employmentType: ..., - rating: ..., // optional - reliabilityScore: ..., // optional - backgroundCheckStatus: ..., - certifications: ..., // optional - }; - mutation.mutate(createStaffVars); - // Variables can be defined inline as well. - mutation.mutate({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(createStaffVars, 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.staff_insert); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## 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 d1f156c2..a007882e 100644 --- a/frontend-web/src/dataconnect-generated/react/esm/index.esm.js +++ b/frontend-web/src/dataconnect-generated/react/esm/index.esm.js @@ -1,4 +1,4 @@ -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 { listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorDefaultSettingsRef, getVendorDefaultSettingByIdRef, filterVendorDefaultSettingsRef, listEventsRef, getEventByIdRef, filterEventsRef, createInvoiceRef, updateInvoiceRef, deleteInvoiceRef, createStaffRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorDefaultSettingRef, updateVendorDefaultSettingRef, deleteVendorDefaultSettingRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, createEventRef, updateEventRef, deleteEventRef, listInvoiceRef, getInvoiceByIdRef, filterInvoicesRef, connectorConfig } from '../../esm/index.esm.js'; import { validateArgs, CallerSdkTypeEnum } from 'firebase/data-connect'; import { useDataConnectQuery, useDataConnectMutation, validateReactArgs } from '@tanstack-query-firebase/react/data-connect'; @@ -32,55 +32,25 @@ export function useDeleteVendor(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } -export function useCreateVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createVendorRateRef(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 useUpdateVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateVendorRateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, 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 useDeleteVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteVendorRateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, 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 useCreateEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useUpdateEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useDeleteEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - - export function useListEvents(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); const ref = listEventsRef(dcInstance); @@ -98,6 +68,30 @@ export function useFilterEvents(dcOrVars, varsOrOptions, options) { const ref = filterEventsRef(dcInstance, inputVars); return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); } +export function useCreateInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + export function useCreateStaff(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -148,25 +142,31 @@ export function useDeleteVendorDefaultSetting(dcOrOptions, options) { 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 useCreateVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, 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 useUpdateVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, 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 useDeleteVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } + export function useListVendorRate(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); const ref = listVendorRateRef(dcInstance); @@ -183,4 +183,46 @@ 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) { + return createEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateEvent(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteEvent(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useListInvoice(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listInvoiceRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetInvoiceById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getInvoiceByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useFilterInvoices(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterInvoicesRef(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 918c7066..d7deeadc 100644 --- a/frontend-web/src/dataconnect-generated/react/index.cjs.js +++ b/frontend-web/src/dataconnect-generated/react/index.cjs.js @@ -1,4 +1,4 @@ -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 { listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorDefaultSettingsRef, getVendorDefaultSettingByIdRef, filterVendorDefaultSettingsRef, listEventsRef, getEventByIdRef, filterEventsRef, createInvoiceRef, updateInvoiceRef, deleteInvoiceRef, createStaffRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorDefaultSettingRef, updateVendorDefaultSettingRef, deleteVendorDefaultSettingRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, createEventRef, updateEventRef, deleteEventRef, listInvoiceRef, getInvoiceByIdRef, filterInvoicesRef, connectorConfig } = require('../index.cjs.js'); const { validateArgs, CallerSdkTypeEnum } = require('firebase/data-connect'); const { useDataConnectQuery, useDataConnectMutation, validateReactArgs } = require('@tanstack-query-firebase/react/data-connect'); @@ -32,55 +32,25 @@ exports.useDeleteVendor = function useDeleteVendor(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } -exports.useCreateVendorRate = function useCreateVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createVendorRateRef(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.useUpdateVendorRate = function useUpdateVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateVendorRateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, 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.useDeleteVendorRate = function useDeleteVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteVendorRateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, 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.useCreateEvent = function useCreateEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useUpdateEvent = function useUpdateEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useDeleteEvent = function useDeleteEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - - exports.useListEvents = function useListEvents(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); const ref = listEventsRef(dcInstance); @@ -98,6 +68,30 @@ exports.useFilterEvents = function useFilterEvents(dcOrVars, varsOrOptions, opti const ref = filterEventsRef(dcInstance, inputVars); return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); } +exports.useCreateInvoice = function useCreateInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateInvoice = function useUpdateInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteInvoice = function useDeleteInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + exports.useCreateStaff = function useCreateStaff(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -148,25 +142,31 @@ exports.useDeleteVendorDefaultSetting = function useDeleteVendorDefaultSetting(d 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.useCreateVendorRate = function useCreateVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, 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.useUpdateVendorRate = function useUpdateVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, 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.useDeleteVendorRate = function useDeleteVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteVendorRateRef(dcInstance, vars); + } + 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); @@ -183,4 +183,46 @@ exports.useFilterVendorRates = function useFilterVendorRates(dcOrVars, varsOrOpt 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) { + return createEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateEvent = function useUpdateEvent(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteEvent = function useDeleteEvent(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useListInvoice = function useListInvoice(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listInvoiceRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetInvoiceById = function useGetInvoiceById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getInvoiceByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useFilterInvoices = function useFilterInvoices(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterInvoicesRef(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 29eef557..e5957f90 100644 --- a/frontend-web/src/dataconnect-generated/react/index.d.ts +++ b/frontend-web/src/dataconnect-generated/react/index.d.ts @@ -1,4 +1,4 @@ -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 { ListStaffData, CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, ListVendorDefaultSettingsData, GetVendorDefaultSettingByIdData, GetVendorDefaultSettingByIdVariables, FilterVendorDefaultSettingsData, FilterVendorDefaultSettingsVariables, ListEventsData, GetEventByIdData, GetEventByIdVariables, FilterEventsData, FilterEventsVariables, CreateInvoiceData, CreateInvoiceVariables, UpdateInvoiceData, UpdateInvoiceVariables, DeleteInvoiceData, DeleteInvoiceVariables, CreateStaffData, CreateStaffVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateVendorDefaultSettingData, CreateVendorDefaultSettingVariables, UpdateVendorDefaultSettingData, UpdateVendorDefaultSettingVariables, DeleteVendorDefaultSettingData, DeleteVendorDefaultSettingVariables, CreateVendorRateData, CreateVendorRateVariables, UpdateVendorRateData, UpdateVendorRateVariables, DeleteVendorRateData, DeleteVendorRateVariables, ListVendorRateData, GetVendorRateByIdData, GetVendorRateByIdVariables, FilterVendorRatesData, FilterVendorRatesVariables, CreateEventData, CreateEventVariables, UpdateEventData, UpdateEventVariables, DeleteEventData, DeleteEventVariables, ListInvoiceData, GetInvoiceByIdData, GetInvoiceByIdVariables, FilterInvoicesData, FilterInvoicesVariables } 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'; @@ -17,23 +17,14 @@ export function useUpdateVendor(dc: DataConnect, options?: useDataConnectMutatio export function useDeleteVendor(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useDeleteVendor(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useListVendorDefaultSettings(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendorDefaultSettings(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useUpdateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useUpdateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useGetVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useDeleteVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useDeleteVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useCreateEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useUpdateEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useUpdateEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useDeleteEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useDeleteEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useFilterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; export function useListEvents(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; export function useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; @@ -44,6 +35,15 @@ export function useGetEventById(dc: DataConnect, vars: GetEventByIdVariables, op export function useFilterEvents(vars?: FilterEventsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; export function useFilterEvents(dc: DataConnect, vars?: FilterEventsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useCreateInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + export function useCreateStaff(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; @@ -65,14 +65,14 @@ export function useUpdateVendorDefaultSetting(dc: DataConnect, options?: useData 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 useCreateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useGetVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useGetVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useUpdateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useFilterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useFilterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +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; @@ -82,3 +82,21 @@ export function useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVar 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; + +export function useUpdateEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useListInvoice(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListInvoice(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetInvoiceById(vars: GetInvoiceByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useFilterInvoices(vars?: FilterInvoicesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables, 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 d83b82a0..29b57da6 100644 --- a/internal-api-harness/src/dataconnect-generated/.guides/usage.md +++ b/internal-api-harness/src/dataconnect-generated/.guides/usage.md @@ -12,7 +12,7 @@ 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 { useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useCreateVendorRate, useUpdateVendorRate, useDeleteVendorRate, useCreateEvent, useUpdateEvent, useDeleteEvent } from '@dataconnect/generated/react'; +import { useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useListVendorDefaultSettings, useGetVendorDefaultSettingById, useFilterVendorDefaultSettings, useListEvents, useGetEventById, useFilterEvents } from '@dataconnect/generated/react'; // The types of these hooks are available in react/index.d.ts const { data, isPending, isSuccess, isError, error } = useListStaff(); @@ -23,17 +23,17 @@ const { data, isPending, isSuccess, isError, error } = useUpdateVendor(updateVen const { data, isPending, isSuccess, isError, error } = useDeleteVendor(deleteVendorVars); -const { data, isPending, isSuccess, isError, error } = useCreateVendorRate(createVendorRateVars); +const { data, isPending, isSuccess, isError, error } = useListVendorDefaultSettings(); -const { data, isPending, isSuccess, isError, error } = useUpdateVendorRate(updateVendorRateVars); +const { data, isPending, isSuccess, isError, error } = useGetVendorDefaultSettingById(getVendorDefaultSettingByIdVars); -const { data, isPending, isSuccess, isError, error } = useDeleteVendorRate(deleteVendorRateVars); +const { data, isPending, isSuccess, isError, error } = useFilterVendorDefaultSettings(filterVendorDefaultSettingsVars); -const { data, isPending, isSuccess, isError, error } = useCreateEvent(createEventVars); +const { data, isPending, isSuccess, isError, error } = useListEvents(); -const { data, isPending, isSuccess, isError, error } = useUpdateEvent(updateEventVars); +const { data, isPending, isSuccess, isError, error } = useGetEventById(getEventByIdVars); -const { data, isPending, isSuccess, isError, error } = useDeleteEvent(deleteEventVars); +const { data, isPending, isSuccess, isError, error } = useFilterEvents(filterEventsVars); ``` @@ -72,7 +72,7 @@ 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 { listStaff, createVendor, updateVendor, deleteVendor, createVendorRate, updateVendorRate, deleteVendorRate, createEvent, updateEvent, deleteEvent } from '@dataconnect/generated'; +import { listStaff, createVendor, updateVendor, deleteVendor, listVendorDefaultSettings, getVendorDefaultSettingById, filterVendorDefaultSettings, listEvents, getEventById, filterEvents } from '@dataconnect/generated'; // Operation listStaff: @@ -87,23 +87,23 @@ 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 CreateVendorRate: For variables, look at type CreateVendorRateVars in ../index.d.ts -const { data } = await CreateVendorRate(dataConnect, createVendorRateVars); +// Operation listVendorDefaultSettings: +const { data } = await ListVendorDefaultSettings(dataConnect); -// Operation UpdateVendorRate: For variables, look at type UpdateVendorRateVars in ../index.d.ts -const { data } = await UpdateVendorRate(dataConnect, updateVendorRateVars); +// Operation getVendorDefaultSettingById: For variables, look at type GetVendorDefaultSettingByIdVars in ../index.d.ts +const { data } = await GetVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars); -// Operation DeleteVendorRate: For variables, look at type DeleteVendorRateVars in ../index.d.ts -const { data } = await DeleteVendorRate(dataConnect, deleteVendorRateVars); +// Operation filterVendorDefaultSettings: For variables, look at type FilterVendorDefaultSettingsVars in ../index.d.ts +const { data } = await FilterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars); -// Operation CreateEvent: For variables, look at type CreateEventVars in ../index.d.ts -const { data } = await CreateEvent(dataConnect, createEventVars); +// Operation listEvents: +const { data } = await ListEvents(dataConnect); -// Operation UpdateEvent: For variables, look at type UpdateEventVars in ../index.d.ts -const { data } = await UpdateEvent(dataConnect, updateEventVars); +// Operation getEventById: For variables, look at type GetEventByIdVars in ../index.d.ts +const { data } = await GetEventById(dataConnect, getEventByIdVars); -// Operation DeleteEvent: For variables, look at type DeleteEventVars in ../index.d.ts -const { data } = await DeleteEvent(dataConnect, deleteEventVars); +// Operation filterEvents: For variables, look at type FilterEventsVars in ../index.d.ts +const { data } = await FilterEvents(dataConnect, filterEventsVars); ``` \ 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 705808e2..3035cccb 100644 --- a/internal-api-harness/src/dataconnect-generated/README.md +++ b/internal-api-harness/src/dataconnect-generated/README.md @@ -11,32 +11,38 @@ This README will guide you through the process of using the generated JavaScript - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) - [**Queries**](#queries) - [*listStaff*](#liststaff) + - [*listVendorDefaultSettings*](#listvendordefaultsettings) + - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) + - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) - [*listEvents*](#listevents) - [*getEventById*](#geteventbyid) - [*filterEvents*](#filterevents) - [*listVendor*](#listvendor) - [*getVendorById*](#getvendorbyid) - [*filterVendors*](#filtervendors) - - [*listVendorDefaultSettings*](#listvendordefaultsettings) - - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) - - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) - [*listVendorRate*](#listvendorrate) - [*getVendorRateById*](#getvendorratebyid) - [*filterVendorRates*](#filtervendorrates) + - [*listInvoice*](#listinvoice) + - [*getInvoiceById*](#getinvoicebyid) + - [*filterInvoices*](#filterinvoices) - [**Mutations**](#mutations) - [*CreateVendor*](#createvendor) - [*UpdateVendor*](#updatevendor) - [*DeleteVendor*](#deletevendor) + - [*CreateInvoice*](#createinvoice) + - [*UpdateInvoice*](#updateinvoice) + - [*DeleteInvoice*](#deleteinvoice) + - [*CreateStaff*](#createstaff) + - [*CreateVendorDefaultSetting*](#createvendordefaultsetting) + - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting) + - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting) - [*CreateVendorRate*](#createvendorrate) - [*UpdateVendorRate*](#updatevendorrate) - [*DeleteVendorRate*](#deletevendorrate) - [*CreateEvent*](#createevent) - [*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). @@ -185,6 +191,340 @@ executeQuery(ref).then((response) => { }); ``` +## 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); +}); +``` + ## listEvents You can execute the `listEvents` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): ```typescript @@ -997,340 +1337,6 @@ executeQuery(ref).then((response) => { }); ``` -## 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 @@ -1686,6 +1692,353 @@ executeQuery(ref).then((response) => { }); ``` +## listInvoice +You can execute the `listInvoice` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +listInvoice(): QueryPromise; + +interface ListInvoiceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (): QueryRef; +} +export const listInvoiceRef: ListInvoiceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +listInvoice(dc: DataConnect): QueryPromise; + +interface ListInvoiceRef { + ... + (dc: DataConnect): QueryRef; +} +export const listInvoiceRef: ListInvoiceRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listInvoiceRef: +```typescript +const name = listInvoiceRef.operationName; +console.log(name); +``` + +### Variables +The `listInvoice` query has no variables. +### Return Type +Recall that executing the `listInvoice` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `ListInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface ListInvoiceData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_Key)[]; +} +``` +### Using `listInvoice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, listInvoice } from '@dataconnect/generated'; + + +// Call the `listInvoice()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await listInvoice(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await listInvoice(dataConnect); + +console.log(data.invoices); + +// Or, you can use the `Promise` API. +listInvoice().then((response) => { + const data = response.data; + console.log(data.invoices); +}); +``` + +### Using `listInvoice`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, listInvoiceRef } from '@dataconnect/generated'; + + +// Call the `listInvoiceRef()` function to get a reference to the query. +const ref = listInvoiceRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = listInvoiceRef(dataConnect); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.invoices); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.invoices); +}); +``` + +## getInvoiceById +You can execute the `getInvoiceById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +getInvoiceById(vars: GetInvoiceByIdVariables): QueryPromise; + +interface GetInvoiceByIdRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: GetInvoiceByIdVariables): QueryRef; +} +export const getInvoiceByIdRef: GetInvoiceByIdRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +getInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables): QueryPromise; + +interface GetInvoiceByIdRef { + ... + (dc: DataConnect, vars: GetInvoiceByIdVariables): QueryRef; +} +export const getInvoiceByIdRef: GetInvoiceByIdRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getInvoiceByIdRef: +```typescript +const name = getInvoiceByIdRef.operationName; +console.log(name); +``` + +### Variables +The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface GetInvoiceByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `getInvoiceById` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `GetInvoiceByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface GetInvoiceByIdData { + invoice?: { + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; + } & Invoice_Key; +} +``` +### Using `getInvoiceById`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, getInvoiceById, GetInvoiceByIdVariables } from '@dataconnect/generated'; + +// The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`: +const getInvoiceByIdVars: GetInvoiceByIdVariables = { + id: ..., +}; + +// Call the `getInvoiceById()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await getInvoiceById(getInvoiceByIdVars); +// Variables can be defined inline as well. +const { data } = await getInvoiceById({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await getInvoiceById(dataConnect, getInvoiceByIdVars); + +console.log(data.invoice); + +// Or, you can use the `Promise` API. +getInvoiceById(getInvoiceByIdVars).then((response) => { + const data = response.data; + console.log(data.invoice); +}); +``` + +### Using `getInvoiceById`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, getInvoiceByIdRef, GetInvoiceByIdVariables } from '@dataconnect/generated'; + +// The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`: +const getInvoiceByIdVars: GetInvoiceByIdVariables = { + id: ..., +}; + +// Call the `getInvoiceByIdRef()` function to get a reference to the query. +const ref = getInvoiceByIdRef(getInvoiceByIdVars); +// Variables can be defined inline as well. +const ref = getInvoiceByIdRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = getInvoiceByIdRef(dataConnect, getInvoiceByIdVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.invoice); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.invoice); +}); +``` + +## filterInvoices +You can execute the `filterInvoices` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts): +```typescript +filterInvoices(vars?: FilterInvoicesVariables): QueryPromise; + +interface FilterInvoicesRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterInvoicesVariables): QueryRef; +} +export const filterInvoicesRef: FilterInvoicesRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function. +```typescript +filterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables): QueryPromise; + +interface FilterInvoicesRef { + ... + (dc: DataConnect, vars?: FilterInvoicesVariables): QueryRef; +} +export const filterInvoicesRef: FilterInvoicesRef; +``` + +If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterInvoicesRef: +```typescript +const name = filterInvoicesRef.operationName; +console.log(name); +``` + +### Variables +The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface FilterInvoicesVariables { + invoiceNumber?: string | null; + status?: InvoiceStatus | null; + isAutoGenerated?: boolean | null; + amount?: number | null; +} +``` +### Return Type +Recall that executing the `filterInvoices` query returns a `QueryPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `FilterInvoicesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface FilterInvoicesData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_Key)[]; +} +``` +### Using `filterInvoices`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, filterInvoices, FilterInvoicesVariables } from '@dataconnect/generated'; + +// The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`: +const filterInvoicesVars: FilterInvoicesVariables = { + invoiceNumber: ..., // optional + status: ..., // optional + isAutoGenerated: ..., // optional + amount: ..., // optional +}; + +// Call the `filterInvoices()` function to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await filterInvoices(filterInvoicesVars); +// Variables can be defined inline as well. +const { data } = await filterInvoices({ invoiceNumber: ..., status: ..., isAutoGenerated: ..., amount: ..., }); +// Since all variables are optional for this query, you can omit the `FilterInvoicesVariables` argument. +const { data } = await filterInvoices(); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await filterInvoices(dataConnect, filterInvoicesVars); + +console.log(data.invoices); + +// Or, you can use the `Promise` API. +filterInvoices(filterInvoicesVars).then((response) => { + const data = response.data; + console.log(data.invoices); +}); +``` + +### Using `filterInvoices`'s `QueryRef` function + +```typescript +import { getDataConnect, executeQuery } from 'firebase/data-connect'; +import { connectorConfig, filterInvoicesRef, FilterInvoicesVariables } from '@dataconnect/generated'; + +// The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`: +const filterInvoicesVars: FilterInvoicesVariables = { + invoiceNumber: ..., // optional + status: ..., // optional + isAutoGenerated: ..., // optional + amount: ..., // optional +}; + +// Call the `filterInvoicesRef()` function to get a reference to the query. +const ref = filterInvoicesRef(filterInvoicesVars); +// Variables can be defined inline as well. +const ref = filterInvoicesRef({ invoiceNumber: ..., status: ..., isAutoGenerated: ..., amount: ..., }); +// Since all variables are optional for this query, you can omit the `FilterInvoicesVariables` argument. +const ref = filterInvoicesRef(); + +// You can also pass in a `DataConnect` instance to the `QueryRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = filterInvoicesRef(dataConnect, filterInvoicesVars); + +// Call `executeQuery()` on the reference to execute the query. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await executeQuery(ref); + +console.log(data.invoices); + +// Or, you can use the `Promise` API. +executeQuery(ref).then((response) => { + const data = response.data; + console.log(data.invoices); +}); +``` + # Mutations There are two ways to execute a Data Connect Mutation using the generated Web SDK: @@ -2067,6 +2420,847 @@ executeMutation(ref).then((response) => { }); ``` +## CreateInvoice +You can execute the `CreateInvoice` 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 +createInvoice(vars: CreateInvoiceVariables): MutationPromise; + +interface CreateInvoiceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateInvoiceVariables): MutationRef; +} +export const createInvoiceRef: CreateInvoiceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createInvoice(dc: DataConnect, vars: CreateInvoiceVariables): MutationPromise; + +interface CreateInvoiceRef { + ... + (dc: DataConnect, vars: CreateInvoiceVariables): MutationRef; +} +export const createInvoiceRef: CreateInvoiceRef; +``` + +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 createInvoiceRef: +```typescript +const name = createInvoiceRef.operationName; +console.log(name); +``` + +### Variables +The `CreateInvoice` mutation requires an argument of type `CreateInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateInvoiceVariables { + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} +``` +### Return Type +Recall that executing the `CreateInvoice` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateInvoiceData { + invoice_insert: Invoice_Key; +} +``` +### Using `CreateInvoice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createInvoice, CreateInvoiceVariables } from '@dataconnect/generated'; + +// The `CreateInvoice` mutation requires an argument of type `CreateInvoiceVariables`: +const createInvoiceVars: CreateInvoiceVariables = { + invoiceNumber: ..., + amount: ..., + status: ..., + issueDate: ..., + dueDate: ..., + disputedItems: ..., // optional + isAutoGenerated: ..., // optional +}; + +// Call the `createInvoice()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createInvoice(createInvoiceVars); +// Variables can be defined inline as well. +const { data } = await createInvoice({ invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createInvoice(dataConnect, createInvoiceVars); + +console.log(data.invoice_insert); + +// Or, you can use the `Promise` API. +createInvoice(createInvoiceVars).then((response) => { + const data = response.data; + console.log(data.invoice_insert); +}); +``` + +### Using `CreateInvoice`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createInvoiceRef, CreateInvoiceVariables } from '@dataconnect/generated'; + +// The `CreateInvoice` mutation requires an argument of type `CreateInvoiceVariables`: +const createInvoiceVars: CreateInvoiceVariables = { + invoiceNumber: ..., + amount: ..., + status: ..., + issueDate: ..., + dueDate: ..., + disputedItems: ..., // optional + isAutoGenerated: ..., // optional +}; + +// Call the `createInvoiceRef()` function to get a reference to the mutation. +const ref = createInvoiceRef(createInvoiceVars); +// Variables can be defined inline as well. +const ref = createInvoiceRef({ invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createInvoiceRef(dataConnect, createInvoiceVars); + +// 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.invoice_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.invoice_insert); +}); +``` + +## UpdateInvoice +You can execute the `UpdateInvoice` 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 +updateInvoice(vars: UpdateInvoiceVariables): MutationPromise; + +interface UpdateInvoiceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateInvoiceVariables): MutationRef; +} +export const updateInvoiceRef: UpdateInvoiceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +updateInvoice(dc: DataConnect, vars: UpdateInvoiceVariables): MutationPromise; + +interface UpdateInvoiceRef { + ... + (dc: DataConnect, vars: UpdateInvoiceVariables): MutationRef; +} +export const updateInvoiceRef: UpdateInvoiceRef; +``` + +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 updateInvoiceRef: +```typescript +const name = updateInvoiceRef.operationName; +console.log(name); +``` + +### Variables +The `UpdateInvoice` mutation requires an argument of type `UpdateInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface UpdateInvoiceVariables { + id: UUIDString; + invoiceNumber?: string | null; + amount?: number | null; + status?: InvoiceStatus | null; + issueDate?: TimestampString | null; + dueDate?: TimestampString | null; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} +``` +### Return Type +Recall that executing the `UpdateInvoice` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `UpdateInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface UpdateInvoiceData { + invoice_update?: Invoice_Key | null; +} +``` +### Using `UpdateInvoice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, updateInvoice, UpdateInvoiceVariables } from '@dataconnect/generated'; + +// The `UpdateInvoice` mutation requires an argument of type `UpdateInvoiceVariables`: +const updateInvoiceVars: UpdateInvoiceVariables = { + id: ..., + invoiceNumber: ..., // optional + amount: ..., // optional + status: ..., // optional + issueDate: ..., // optional + dueDate: ..., // optional + disputedItems: ..., // optional + isAutoGenerated: ..., // optional +}; + +// Call the `updateInvoice()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await updateInvoice(updateInvoiceVars); +// Variables can be defined inline as well. +const { data } = await updateInvoice({ id: ..., invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await updateInvoice(dataConnect, updateInvoiceVars); + +console.log(data.invoice_update); + +// Or, you can use the `Promise` API. +updateInvoice(updateInvoiceVars).then((response) => { + const data = response.data; + console.log(data.invoice_update); +}); +``` + +### Using `UpdateInvoice`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, updateInvoiceRef, UpdateInvoiceVariables } from '@dataconnect/generated'; + +// The `UpdateInvoice` mutation requires an argument of type `UpdateInvoiceVariables`: +const updateInvoiceVars: UpdateInvoiceVariables = { + id: ..., + invoiceNumber: ..., // optional + amount: ..., // optional + status: ..., // optional + issueDate: ..., // optional + dueDate: ..., // optional + disputedItems: ..., // optional + isAutoGenerated: ..., // optional +}; + +// Call the `updateInvoiceRef()` function to get a reference to the mutation. +const ref = updateInvoiceRef(updateInvoiceVars); +// Variables can be defined inline as well. +const ref = updateInvoiceRef({ id: ..., invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = updateInvoiceRef(dataConnect, updateInvoiceVars); + +// 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.invoice_update); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.invoice_update); +}); +``` + +## DeleteInvoice +You can execute the `DeleteInvoice` 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 +deleteInvoice(vars: DeleteInvoiceVariables): MutationPromise; + +interface DeleteInvoiceRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteInvoiceVariables): MutationRef; +} +export const deleteInvoiceRef: DeleteInvoiceRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +deleteInvoice(dc: DataConnect, vars: DeleteInvoiceVariables): MutationPromise; + +interface DeleteInvoiceRef { + ... + (dc: DataConnect, vars: DeleteInvoiceVariables): MutationRef; +} +export const deleteInvoiceRef: DeleteInvoiceRef; +``` + +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 deleteInvoiceRef: +```typescript +const name = deleteInvoiceRef.operationName; +console.log(name); +``` + +### Variables +The `DeleteInvoice` mutation requires an argument of type `DeleteInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface DeleteInvoiceVariables { + id: UUIDString; +} +``` +### Return Type +Recall that executing the `DeleteInvoice` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `DeleteInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface DeleteInvoiceData { + invoice_delete?: Invoice_Key | null; +} +``` +### Using `DeleteInvoice`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, deleteInvoice, DeleteInvoiceVariables } from '@dataconnect/generated'; + +// The `DeleteInvoice` mutation requires an argument of type `DeleteInvoiceVariables`: +const deleteInvoiceVars: DeleteInvoiceVariables = { + id: ..., +}; + +// Call the `deleteInvoice()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await deleteInvoice(deleteInvoiceVars); +// Variables can be defined inline as well. +const { data } = await deleteInvoice({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await deleteInvoice(dataConnect, deleteInvoiceVars); + +console.log(data.invoice_delete); + +// Or, you can use the `Promise` API. +deleteInvoice(deleteInvoiceVars).then((response) => { + const data = response.data; + console.log(data.invoice_delete); +}); +``` + +### Using `DeleteInvoice`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, deleteInvoiceRef, DeleteInvoiceVariables } from '@dataconnect/generated'; + +// The `DeleteInvoice` mutation requires an argument of type `DeleteInvoiceVariables`: +const deleteInvoiceVars: DeleteInvoiceVariables = { + id: ..., +}; + +// Call the `deleteInvoiceRef()` function to get a reference to the mutation. +const ref = deleteInvoiceRef(deleteInvoiceVars); +// Variables can be defined inline as well. +const ref = deleteInvoiceRef({ id: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = deleteInvoiceRef(dataConnect, deleteInvoiceVars); + +// 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.invoice_delete); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.invoice_delete); +}); +``` + +## CreateStaff +You can execute the `CreateStaff` 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 +createStaff(vars: CreateStaffVariables): MutationPromise; + +interface CreateStaffRef { + ... + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateStaffVariables): MutationRef; +} +export const createStaffRef: CreateStaffRef; +``` +You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. +```typescript +createStaff(dc: DataConnect, vars: CreateStaffVariables): MutationPromise; + +interface CreateStaffRef { + ... + (dc: DataConnect, vars: CreateStaffVariables): MutationRef; +} +export const createStaffRef: CreateStaffRef; +``` + +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 createStaffRef: +```typescript +const name = createStaffRef.operationName; +console.log(name); +``` + +### Variables +The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: + +```typescript +export interface CreateStaffVariables { + employeeName: string; + vendorId?: UUIDString | null; + email?: string | null; + position?: string | null; + employmentType: EmploymentType; + rating?: number | null; + reliabilityScore?: number | null; + backgroundCheckStatus: BackgroundCheckStatus; + certifications?: string | null; +} +``` +### Return Type +Recall that executing the `CreateStaff` mutation returns a `MutationPromise` that resolves to an object with a `data` property. + +The `data` property is an object of type `CreateStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: +```typescript +export interface CreateStaffData { + staff_insert: Staff_Key; +} +``` +### Using `CreateStaff`'s action shortcut function + +```typescript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, createStaff, CreateStaffVariables } from '@dataconnect/generated'; + +// The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`: +const createStaffVars: CreateStaffVariables = { + employeeName: ..., + vendorId: ..., // optional + email: ..., // optional + position: ..., // optional + employmentType: ..., + rating: ..., // optional + reliabilityScore: ..., // optional + backgroundCheckStatus: ..., + certifications: ..., // optional +}; + +// Call the `createStaff()` function to execute the mutation. +// You can use the `await` keyword to wait for the promise to resolve. +const { data } = await createStaff(createStaffVars); +// Variables can be defined inline as well. +const { data } = await createStaff({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); + +// You can also pass in a `DataConnect` instance to the action shortcut function. +const dataConnect = getDataConnect(connectorConfig); +const { data } = await createStaff(dataConnect, createStaffVars); + +console.log(data.staff_insert); + +// Or, you can use the `Promise` API. +createStaff(createStaffVars).then((response) => { + const data = response.data; + console.log(data.staff_insert); +}); +``` + +### Using `CreateStaff`'s `MutationRef` function + +```typescript +import { getDataConnect, executeMutation } from 'firebase/data-connect'; +import { connectorConfig, createStaffRef, CreateStaffVariables } from '@dataconnect/generated'; + +// The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`: +const createStaffVars: CreateStaffVariables = { + employeeName: ..., + vendorId: ..., // optional + email: ..., // optional + position: ..., // optional + employmentType: ..., + rating: ..., // optional + reliabilityScore: ..., // optional + backgroundCheckStatus: ..., + certifications: ..., // optional +}; + +// Call the `createStaffRef()` function to get a reference to the mutation. +const ref = createStaffRef(createStaffVars); +// Variables can be defined inline as well. +const ref = createStaffRef({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); + +// You can also pass in a `DataConnect` instance to the `MutationRef` function. +const dataConnect = getDataConnect(connectorConfig); +const ref = createStaffRef(dataConnect, createStaffVars); + +// 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.staff_insert); + +// Or, you can use the `Promise` API. +executeMutation(ref).then((response) => { + const data = response.data; + console.log(data.staff_insert); +}); +``` + +## 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); +}); +``` + ## CreateVendorRate You can execute the `CreateVendorRate` 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 @@ -2961,478 +4155,3 @@ executeMutation(ref).then((response) => { }); ``` -## CreateStaff -You can execute the `CreateStaff` 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 -createStaff(vars: CreateStaffVariables): MutationPromise; - -interface CreateStaffRef { - ... - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateStaffVariables): MutationRef; -} -export const createStaffRef: CreateStaffRef; -``` -You can also pass in a `DataConnect` instance to the action shortcut function or `MutationRef` function. -```typescript -createStaff(dc: DataConnect, vars: CreateStaffVariables): MutationPromise; - -interface CreateStaffRef { - ... - (dc: DataConnect, vars: CreateStaffVariables): MutationRef; -} -export const createStaffRef: CreateStaffRef; -``` - -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 createStaffRef: -```typescript -const name = createStaffRef.operationName; -console.log(name); -``` - -### Variables -The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: - -```typescript -export interface CreateStaffVariables { - employeeName: string; - vendorId?: UUIDString | null; - email?: string | null; - position?: string | null; - employmentType: EmploymentType; - rating?: number | null; - reliabilityScore?: number | null; - backgroundCheckStatus: BackgroundCheckStatus; - certifications?: string | null; -} -``` -### Return Type -Recall that executing the `CreateStaff` mutation returns a `MutationPromise` that resolves to an object with a `data` property. - -The `data` property is an object of type `CreateStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields: -```typescript -export interface CreateStaffData { - staff_insert: Staff_Key; -} -``` -### Using `CreateStaff`'s action shortcut function - -```typescript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, createStaff, CreateStaffVariables } from '@dataconnect/generated'; - -// The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`: -const createStaffVars: CreateStaffVariables = { - employeeName: ..., - vendorId: ..., // optional - email: ..., // optional - position: ..., // optional - employmentType: ..., - rating: ..., // optional - reliabilityScore: ..., // optional - backgroundCheckStatus: ..., - certifications: ..., // optional -}; - -// Call the `createStaff()` function to execute the mutation. -// You can use the `await` keyword to wait for the promise to resolve. -const { data } = await createStaff(createStaffVars); -// Variables can be defined inline as well. -const { data } = await createStaff({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); - -// You can also pass in a `DataConnect` instance to the action shortcut function. -const dataConnect = getDataConnect(connectorConfig); -const { data } = await createStaff(dataConnect, createStaffVars); - -console.log(data.staff_insert); - -// Or, you can use the `Promise` API. -createStaff(createStaffVars).then((response) => { - const data = response.data; - console.log(data.staff_insert); -}); -``` - -### Using `CreateStaff`'s `MutationRef` function - -```typescript -import { getDataConnect, executeMutation } from 'firebase/data-connect'; -import { connectorConfig, createStaffRef, CreateStaffVariables } from '@dataconnect/generated'; - -// The `CreateStaff` mutation requires an argument of type `CreateStaffVariables`: -const createStaffVars: CreateStaffVariables = { - employeeName: ..., - vendorId: ..., // optional - email: ..., // optional - position: ..., // optional - employmentType: ..., - rating: ..., // optional - reliabilityScore: ..., // optional - backgroundCheckStatus: ..., - certifications: ..., // optional -}; - -// Call the `createStaffRef()` function to get a reference to the mutation. -const ref = createStaffRef(createStaffVars); -// Variables can be defined inline as well. -const ref = createStaffRef({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); - -// You can also pass in a `DataConnect` instance to the `MutationRef` function. -const dataConnect = getDataConnect(connectorConfig); -const ref = createStaffRef(dataConnect, createStaffVars); - -// 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.staff_insert); - -// Or, you can use the `Promise` API. -executeMutation(ref).then((response) => { - const data = response.data; - console.log(data.staff_insert); -}); -``` - -## 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 5bc51f99..a70452f4 100644 --- a/internal-api-harness/src/dataconnect-generated/esm/index.esm.js +++ b/internal-api-harness/src/dataconnect-generated/esm/index.esm.js @@ -31,6 +31,19 @@ export const EventStatus = { CANCELED: "CANCELED", } +export const InvoiceStatus = { + DRAFT: "DRAFT", + PENDING_REVIEW: "PENDING_REVIEW", + APPROVED: "APPROVED", + DISPUTED: "DISPUTED", + UNDER_REVIEW: "UNDER_REVIEW", + RESOLVED: "RESOLVED", + OVERDUE: "OVERDUE", + PAID: "PAID", + RECONCILED: "RECONCILED", + CANCELLED: "CANCELLED", +} + export const RecurrenceType = { SINGLE: "SINGLE", DATE_RANGE: "DATE_RANGE", @@ -124,70 +137,37 @@ export function deleteVendor(dcOrVars, vars) { return executeMutation(deleteVendorRef(dcOrVars, vars)); } -export const createVendorRateRef = (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 mutationRef(dcInstance, 'CreateVendorRate', inputVars); + return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); } -createVendorRateRef.operationName = 'CreateVendorRate'; +getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; -export function createVendorRate(dcOrVars, vars) { - return executeMutation(createVendorRateRef(dcOrVars, vars)); +export function getVendorDefaultSettingById(dcOrVars, vars) { + return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); } -export const updateVendorRateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); +export const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateVendorRate', inputVars); + return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); } -updateVendorRateRef.operationName = 'UpdateVendorRate'; +filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; -export function updateVendorRate(dcOrVars, vars) { - return executeMutation(updateVendorRateRef(dcOrVars, vars)); -} - -export const deleteVendorRateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteVendorRate', inputVars); -} -deleteVendorRateRef.operationName = 'DeleteVendorRate'; - -export function deleteVendorRate(dcOrVars, vars) { - return executeMutation(deleteVendorRateRef(dcOrVars, vars)); -} - -export const createEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateEvent', inputVars); -} -createEventRef.operationName = 'CreateEvent'; - -export function createEvent(dcOrVars, vars) { - return executeMutation(createEventRef(dcOrVars, vars)); -} - -export const updateEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateEvent', inputVars); -} -updateEventRef.operationName = 'UpdateEvent'; - -export function updateEvent(dcOrVars, vars) { - return executeMutation(updateEventRef(dcOrVars, vars)); -} - -export const deleteEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteEvent', inputVars); -} -deleteEventRef.operationName = 'DeleteEvent'; - -export function deleteEvent(dcOrVars, vars) { - return executeMutation(deleteEventRef(dcOrVars, vars)); +export function filterVendorDefaultSettings(dcOrVars, vars) { + return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); } export const listEventsRef = (dc) => { @@ -223,6 +203,39 @@ export function filterEvents(dcOrVars, vars) { return executeQuery(filterEventsRef(dcOrVars, vars)); } +export const createInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateInvoice', inputVars); +} +createInvoiceRef.operationName = 'CreateInvoice'; + +export function createInvoice(dcOrVars, vars) { + return executeMutation(createInvoiceRef(dcOrVars, vars)); +} + +export const updateInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateInvoice', inputVars); +} +updateInvoiceRef.operationName = 'UpdateInvoice'; + +export function updateInvoice(dcOrVars, vars) { + return executeMutation(updateInvoiceRef(dcOrVars, vars)); +} + +export const deleteInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteInvoice', inputVars); +} +deleteInvoiceRef.operationName = 'DeleteInvoice'; + +export function deleteInvoice(dcOrVars, vars) { + return executeMutation(deleteInvoiceRef(dcOrVars, vars)); +} + export const createStaffRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -300,37 +313,37 @@ 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) => { +export const createVendorRateRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); + return mutationRef(dcInstance, 'CreateVendorRate', inputVars); } -getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; +createVendorRateRef.operationName = 'CreateVendorRate'; -export function getVendorDefaultSettingById(dcOrVars, vars) { - return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); +export function createVendorRate(dcOrVars, vars) { + return executeMutation(createVendorRateRef(dcOrVars, vars)); } -export const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); +export const updateVendorRateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); + return mutationRef(dcInstance, 'UpdateVendorRate', inputVars); } -filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; +updateVendorRateRef.operationName = 'UpdateVendorRate'; -export function filterVendorDefaultSettings(dcOrVars, vars) { - return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); +export function updateVendorRate(dcOrVars, vars) { + return executeMutation(updateVendorRateRef(dcOrVars, vars)); +} + +export const deleteVendorRateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteVendorRate', inputVars); +} +deleteVendorRateRef.operationName = 'DeleteVendorRate'; + +export function deleteVendorRate(dcOrVars, vars) { + return executeMutation(deleteVendorRateRef(dcOrVars, vars)); } export const listVendorRateRef = (dc) => { @@ -366,3 +379,69 @@ 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(); + return mutationRef(dcInstance, 'CreateEvent', inputVars); +} +createEventRef.operationName = 'CreateEvent'; + +export function createEvent(dcOrVars, vars) { + return executeMutation(createEventRef(dcOrVars, vars)); +} + +export const updateEventRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateEvent', inputVars); +} +updateEventRef.operationName = 'UpdateEvent'; + +export function updateEvent(dcOrVars, vars) { + return executeMutation(updateEventRef(dcOrVars, vars)); +} + +export const deleteEventRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteEvent', inputVars); +} +deleteEventRef.operationName = 'DeleteEvent'; + +export function deleteEvent(dcOrVars, vars) { + return executeMutation(deleteEventRef(dcOrVars, vars)); +} + +export const listInvoiceRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listInvoice'); +} +listInvoiceRef.operationName = 'listInvoice'; + +export function listInvoice(dc) { + return executeQuery(listInvoiceRef(dc)); +} + +export const getInvoiceByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getInvoiceById', inputVars); +} +getInvoiceByIdRef.operationName = 'getInvoiceById'; + +export function getInvoiceById(dcOrVars, vars) { + return executeQuery(getInvoiceByIdRef(dcOrVars, vars)); +} + +export const filterInvoicesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterInvoices', inputVars); +} +filterInvoicesRef.operationName = 'filterInvoices'; + +export function filterInvoices(dcOrVars, vars) { + return executeQuery(filterInvoicesRef(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 b132fc8b..966dc199 100644 --- a/internal-api-harness/src/dataconnect-generated/index.cjs.js +++ b/internal-api-harness/src/dataconnect-generated/index.cjs.js @@ -35,6 +35,20 @@ const EventStatus = { } exports.EventStatus = EventStatus; +const InvoiceStatus = { + DRAFT: "DRAFT", + PENDING_REVIEW: "PENDING_REVIEW", + APPROVED: "APPROVED", + DISPUTED: "DISPUTED", + UNDER_REVIEW: "UNDER_REVIEW", + RESOLVED: "RESOLVED", + OVERDUE: "OVERDUE", + PAID: "PAID", + RECONCILED: "RECONCILED", + CANCELLED: "CANCELLED", +} +exports.InvoiceStatus = InvoiceStatus; + const RecurrenceType = { SINGLE: "SINGLE", DATE_RANGE: "DATE_RANGE", @@ -138,76 +152,40 @@ exports.deleteVendor = function deleteVendor(dcOrVars, vars) { return executeMutation(deleteVendorRef(dcOrVars, vars)); }; -const createVendorRateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); +const listVendorDefaultSettingsRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateVendorRate', inputVars); + return queryRef(dcInstance, 'listVendorDefaultSettings'); } -createVendorRateRef.operationName = 'CreateVendorRate'; -exports.createVendorRateRef = createVendorRateRef; +listVendorDefaultSettingsRef.operationName = 'listVendorDefaultSettings'; +exports.listVendorDefaultSettingsRef = listVendorDefaultSettingsRef; -exports.createVendorRate = function createVendorRate(dcOrVars, vars) { - return executeMutation(createVendorRateRef(dcOrVars, vars)); +exports.listVendorDefaultSettings = function listVendorDefaultSettings(dc) { + return executeQuery(listVendorDefaultSettingsRef(dc)); }; -const updateVendorRateRef = (dcOrVars, vars) => { +const getVendorDefaultSettingByIdRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateVendorRate', inputVars); + return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); } -updateVendorRateRef.operationName = 'UpdateVendorRate'; -exports.updateVendorRateRef = updateVendorRateRef; +getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; +exports.getVendorDefaultSettingByIdRef = getVendorDefaultSettingByIdRef; -exports.updateVendorRate = function updateVendorRate(dcOrVars, vars) { - return executeMutation(updateVendorRateRef(dcOrVars, vars)); +exports.getVendorDefaultSettingById = function getVendorDefaultSettingById(dcOrVars, vars) { + return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); }; -const deleteVendorRateRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); +const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteVendorRate', inputVars); + return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); } -deleteVendorRateRef.operationName = 'DeleteVendorRate'; -exports.deleteVendorRateRef = deleteVendorRateRef; +filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; +exports.filterVendorDefaultSettingsRef = filterVendorDefaultSettingsRef; -exports.deleteVendorRate = function deleteVendorRate(dcOrVars, vars) { - return executeMutation(deleteVendorRateRef(dcOrVars, vars)); -}; - -const createEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'CreateEvent', inputVars); -} -createEventRef.operationName = 'CreateEvent'; -exports.createEventRef = createEventRef; - -exports.createEvent = function createEvent(dcOrVars, vars) { - return executeMutation(createEventRef(dcOrVars, vars)); -}; - -const updateEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'UpdateEvent', inputVars); -} -updateEventRef.operationName = 'UpdateEvent'; -exports.updateEventRef = updateEventRef; - -exports.updateEvent = function updateEvent(dcOrVars, vars) { - return executeMutation(updateEventRef(dcOrVars, vars)); -}; - -const deleteEventRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); - dcInstance._useGeneratedSdk(); - return mutationRef(dcInstance, 'DeleteEvent', inputVars); -} -deleteEventRef.operationName = 'DeleteEvent'; -exports.deleteEventRef = deleteEventRef; - -exports.deleteEvent = function deleteEvent(dcOrVars, vars) { - return executeMutation(deleteEventRef(dcOrVars, vars)); +exports.filterVendorDefaultSettings = function filterVendorDefaultSettings(dcOrVars, vars) { + return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); }; const listEventsRef = (dc) => { @@ -246,6 +224,42 @@ exports.filterEvents = function filterEvents(dcOrVars, vars) { return executeQuery(filterEventsRef(dcOrVars, vars)); }; +const createInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'CreateInvoice', inputVars); +} +createInvoiceRef.operationName = 'CreateInvoice'; +exports.createInvoiceRef = createInvoiceRef; + +exports.createInvoice = function createInvoice(dcOrVars, vars) { + return executeMutation(createInvoiceRef(dcOrVars, vars)); +}; + +const updateInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateInvoice', inputVars); +} +updateInvoiceRef.operationName = 'UpdateInvoice'; +exports.updateInvoiceRef = updateInvoiceRef; + +exports.updateInvoice = function updateInvoice(dcOrVars, vars) { + return executeMutation(updateInvoiceRef(dcOrVars, vars)); +}; + +const deleteInvoiceRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteInvoice', inputVars); +} +deleteInvoiceRef.operationName = 'DeleteInvoice'; +exports.deleteInvoiceRef = deleteInvoiceRef; + +exports.deleteInvoice = function deleteInvoice(dcOrVars, vars) { + return executeMutation(deleteInvoiceRef(dcOrVars, vars)); +}; + const createStaffRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); @@ -330,40 +344,40 @@ exports.deleteVendorDefaultSetting = function deleteVendorDefaultSetting(dcOrVar 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 createVendorRateRef = (dcOrVars, vars) => { const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'getVendorDefaultSettingById', inputVars); + return mutationRef(dcInstance, 'CreateVendorRate', inputVars); } -getVendorDefaultSettingByIdRef.operationName = 'getVendorDefaultSettingById'; -exports.getVendorDefaultSettingByIdRef = getVendorDefaultSettingByIdRef; +createVendorRateRef.operationName = 'CreateVendorRate'; +exports.createVendorRateRef = createVendorRateRef; -exports.getVendorDefaultSettingById = function getVendorDefaultSettingById(dcOrVars, vars) { - return executeQuery(getVendorDefaultSettingByIdRef(dcOrVars, vars)); +exports.createVendorRate = function createVendorRate(dcOrVars, vars) { + return executeMutation(createVendorRateRef(dcOrVars, vars)); }; -const filterVendorDefaultSettingsRef = (dcOrVars, vars) => { - const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); +const updateVendorRateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); dcInstance._useGeneratedSdk(); - return queryRef(dcInstance, 'filterVendorDefaultSettings', inputVars); + return mutationRef(dcInstance, 'UpdateVendorRate', inputVars); } -filterVendorDefaultSettingsRef.operationName = 'filterVendorDefaultSettings'; -exports.filterVendorDefaultSettingsRef = filterVendorDefaultSettingsRef; +updateVendorRateRef.operationName = 'UpdateVendorRate'; +exports.updateVendorRateRef = updateVendorRateRef; -exports.filterVendorDefaultSettings = function filterVendorDefaultSettings(dcOrVars, vars) { - return executeQuery(filterVendorDefaultSettingsRef(dcOrVars, vars)); +exports.updateVendorRate = function updateVendorRate(dcOrVars, vars) { + return executeMutation(updateVendorRateRef(dcOrVars, vars)); +}; + +const deleteVendorRateRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteVendorRate', inputVars); +} +deleteVendorRateRef.operationName = 'DeleteVendorRate'; +exports.deleteVendorRateRef = deleteVendorRateRef; + +exports.deleteVendorRate = function deleteVendorRate(dcOrVars, vars) { + return executeMutation(deleteVendorRateRef(dcOrVars, vars)); }; const listVendorRateRef = (dc) => { @@ -401,3 +415,75 @@ 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(); + return mutationRef(dcInstance, 'CreateEvent', inputVars); +} +createEventRef.operationName = 'CreateEvent'; +exports.createEventRef = createEventRef; + +exports.createEvent = function createEvent(dcOrVars, vars) { + return executeMutation(createEventRef(dcOrVars, vars)); +}; + +const updateEventRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'UpdateEvent', inputVars); +} +updateEventRef.operationName = 'UpdateEvent'; +exports.updateEventRef = updateEventRef; + +exports.updateEvent = function updateEvent(dcOrVars, vars) { + return executeMutation(updateEventRef(dcOrVars, vars)); +}; + +const deleteEventRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return mutationRef(dcInstance, 'DeleteEvent', inputVars); +} +deleteEventRef.operationName = 'DeleteEvent'; +exports.deleteEventRef = deleteEventRef; + +exports.deleteEvent = function deleteEvent(dcOrVars, vars) { + return executeMutation(deleteEventRef(dcOrVars, vars)); +}; + +const listInvoiceRef = (dc) => { + const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'listInvoice'); +} +listInvoiceRef.operationName = 'listInvoice'; +exports.listInvoiceRef = listInvoiceRef; + +exports.listInvoice = function listInvoice(dc) { + return executeQuery(listInvoiceRef(dc)); +}; + +const getInvoiceByIdRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'getInvoiceById', inputVars); +} +getInvoiceByIdRef.operationName = 'getInvoiceById'; +exports.getInvoiceByIdRef = getInvoiceByIdRef; + +exports.getInvoiceById = function getInvoiceById(dcOrVars, vars) { + return executeQuery(getInvoiceByIdRef(dcOrVars, vars)); +}; + +const filterInvoicesRef = (dcOrVars, vars) => { + const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars); + dcInstance._useGeneratedSdk(); + return queryRef(dcInstance, 'filterInvoices', inputVars); +} +filterInvoicesRef.operationName = 'filterInvoices'; +exports.filterInvoicesRef = filterInvoicesRef; + +exports.filterInvoices = function filterInvoices(dcOrVars, vars) { + return executeQuery(filterInvoicesRef(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 042cb070..eb1a912d 100644 --- a/internal-api-harness/src/dataconnect-generated/index.d.ts +++ b/internal-api-harness/src/dataconnect-generated/index.d.ts @@ -39,6 +39,19 @@ export enum EventStatus { CANCELED = "CANCELED", }; +export enum InvoiceStatus { + DRAFT = "DRAFT", + PENDING_REVIEW = "PENDING_REVIEW", + APPROVED = "APPROVED", + DISPUTED = "DISPUTED", + UNDER_REVIEW = "UNDER_REVIEW", + RESOLVED = "RESOLVED", + OVERDUE = "OVERDUE", + PAID = "PAID", + RECONCILED = "RECONCILED", + CANCELLED = "CANCELLED", +}; + export enum RecurrenceType { SINGLE = "SINGLE", DATE_RANGE = "DATE_RANGE", @@ -125,6 +138,20 @@ export interface CreateEventVariables { assignedStaff?: string | null; } +export interface CreateInvoiceData { + invoice_insert: Invoice_Key; +} + +export interface CreateInvoiceVariables { + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} + export interface CreateStaffData { staff_insert: Staff_Key; } @@ -187,6 +214,14 @@ export interface DeleteEventVariables { id: UUIDString; } +export interface DeleteInvoiceData { + invoice_delete?: Invoice_Key | null; +} + +export interface DeleteInvoiceVariables { + id: UUIDString; +} + export interface DeleteVendorData { vendor_delete?: Vendor_Key | null; } @@ -271,6 +306,25 @@ export interface FilterEventsVariables { clientEmail?: string | null; } +export interface FilterInvoicesData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_Key)[]; +} + +export interface FilterInvoicesVariables { + invoiceNumber?: string | null; + status?: InvoiceStatus | null; + isAutoGenerated?: boolean | null; + amount?: number | null; +} + export interface FilterVendorDefaultSettingsData { vendorDefaultSettings: ({ id: UUIDString; @@ -374,6 +428,23 @@ export interface GetEventByIdVariables { id: UUIDString; } +export interface GetInvoiceByIdData { + invoice?: { + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; + } & Invoice_Key; +} + +export interface GetInvoiceByIdVariables { + id: UUIDString; +} + export interface GetVendorByIdData { vendor?: { id: UUIDString; @@ -424,6 +495,11 @@ export interface GetVendorRateByIdVariables { id: UUIDString; } +export interface Invoice_Key { + id: UUIDString; + __typename?: 'Invoice_Key'; +} + export interface ListEventsData { events: ({ id: UUIDString; @@ -464,6 +540,18 @@ export interface ListEventsData { } & Event_Key)[]; } +export interface ListInvoiceData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_Key)[]; +} + export interface ListStaffData { staffs: ({ id: UUIDString; @@ -561,6 +649,21 @@ export interface UpdateEventVariables { assignedStaff?: string | null; } +export interface UpdateInvoiceData { + invoice_update?: Invoice_Key | null; +} + +export interface UpdateInvoiceVariables { + id: UUIDString; + invoiceNumber?: string | null; + amount?: number | null; + status?: InvoiceStatus | null; + issueDate?: TimestampString | null; + dueDate?: TimestampString | null; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} + export interface UpdateVendorData { vendor_update?: Vendor_Key | null; } @@ -665,77 +768,41 @@ export const deleteVendorRef: DeleteVendorRef; export function deleteVendor(vars: DeleteVendorVariables): MutationPromise; export function deleteVendor(dc: DataConnect, vars: DeleteVendorVariables): MutationPromise; -interface CreateVendorRateRef { +interface ListVendorDefaultSettingsRef { /* Allow users to create refs without passing in DataConnect */ - (vars: CreateVendorRateVariables): MutationRef; + (): QueryRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: CreateVendorRateVariables): MutationRef; + (dc: DataConnect): QueryRef; operationName: string; } -export const createVendorRateRef: CreateVendorRateRef; +export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; -export function createVendorRate(vars: CreateVendorRateVariables): MutationPromise; -export function createVendorRate(dc: DataConnect, vars: CreateVendorRateVariables): MutationPromise; +export function listVendorDefaultSettings(): QueryPromise; +export function listVendorDefaultSettings(dc: DataConnect): QueryPromise; -interface UpdateVendorRateRef { +interface GetVendorDefaultSettingByIdRef { /* Allow users to create refs without passing in DataConnect */ - (vars: UpdateVendorRateVariables): MutationRef; + (vars: GetVendorDefaultSettingByIdVariables): QueryRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: UpdateVendorRateVariables): MutationRef; + (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef; operationName: string; } -export const updateVendorRateRef: UpdateVendorRateRef; +export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; -export function updateVendorRate(vars: UpdateVendorRateVariables): MutationPromise; -export function updateVendorRate(dc: DataConnect, vars: UpdateVendorRateVariables): MutationPromise; +export function getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise; +export function getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise; -interface DeleteVendorRateRef { +interface FilterVendorDefaultSettingsRef { /* Allow users to create refs without passing in DataConnect */ - (vars: DeleteVendorRateVariables): MutationRef; + (vars?: FilterVendorDefaultSettingsVariables): QueryRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: DeleteVendorRateVariables): MutationRef; + (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef; operationName: string; } -export const deleteVendorRateRef: DeleteVendorRateRef; +export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; -export function deleteVendorRate(vars: DeleteVendorRateVariables): MutationPromise; -export function deleteVendorRate(dc: DataConnect, vars: DeleteVendorRateVariables): MutationPromise; - -interface CreateEventRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: CreateEventVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: CreateEventVariables): MutationRef; - operationName: string; -} -export const createEventRef: CreateEventRef; - -export function createEvent(vars: CreateEventVariables): MutationPromise; -export function createEvent(dc: DataConnect, vars: CreateEventVariables): MutationPromise; - -interface UpdateEventRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: UpdateEventVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: UpdateEventVariables): MutationRef; - operationName: string; -} -export const updateEventRef: UpdateEventRef; - -export function updateEvent(vars: UpdateEventVariables): MutationPromise; -export function updateEvent(dc: DataConnect, vars: UpdateEventVariables): MutationPromise; - -interface DeleteEventRef { - /* Allow users to create refs without passing in DataConnect */ - (vars: DeleteEventVariables): MutationRef; - /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: DeleteEventVariables): MutationRef; - operationName: string; -} -export const deleteEventRef: DeleteEventRef; - -export function deleteEvent(vars: DeleteEventVariables): MutationPromise; -export function deleteEvent(dc: DataConnect, vars: DeleteEventVariables): MutationPromise; +export function filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise; +export function filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise; interface ListEventsRef { /* Allow users to create refs without passing in DataConnect */ @@ -773,6 +840,42 @@ export const filterEventsRef: FilterEventsRef; export function filterEvents(vars?: FilterEventsVariables): QueryPromise; export function filterEvents(dc: DataConnect, vars?: FilterEventsVariables): QueryPromise; +interface CreateInvoiceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: CreateInvoiceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateInvoiceVariables): MutationRef; + operationName: string; +} +export const createInvoiceRef: CreateInvoiceRef; + +export function createInvoice(vars: CreateInvoiceVariables): MutationPromise; +export function createInvoice(dc: DataConnect, vars: CreateInvoiceVariables): MutationPromise; + +interface UpdateInvoiceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateInvoiceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateInvoiceVariables): MutationRef; + operationName: string; +} +export const updateInvoiceRef: UpdateInvoiceRef; + +export function updateInvoice(vars: UpdateInvoiceVariables): MutationPromise; +export function updateInvoice(dc: DataConnect, vars: UpdateInvoiceVariables): MutationPromise; + +interface DeleteInvoiceRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteInvoiceVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteInvoiceVariables): MutationRef; + operationName: string; +} +export const deleteInvoiceRef: DeleteInvoiceRef; + +export function deleteInvoice(vars: DeleteInvoiceVariables): MutationPromise; +export function deleteInvoice(dc: DataConnect, vars: DeleteInvoiceVariables): MutationPromise; + interface CreateStaffRef { /* Allow users to create refs without passing in DataConnect */ (vars: CreateStaffVariables): MutationRef; @@ -857,41 +960,41 @@ export const deleteVendorDefaultSettingRef: DeleteVendorDefaultSettingRef; export function deleteVendorDefaultSetting(vars: DeleteVendorDefaultSettingVariables): MutationPromise; export function deleteVendorDefaultSetting(dc: DataConnect, vars: DeleteVendorDefaultSettingVariables): MutationPromise; -interface ListVendorDefaultSettingsRef { +interface CreateVendorRateRef { /* Allow users to create refs without passing in DataConnect */ - (): QueryRef; + (vars: CreateVendorRateVariables): MutationRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect): QueryRef; + (dc: DataConnect, vars: CreateVendorRateVariables): MutationRef; operationName: string; } -export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef; +export const createVendorRateRef: CreateVendorRateRef; -export function listVendorDefaultSettings(): QueryPromise; -export function listVendorDefaultSettings(dc: DataConnect): QueryPromise; +export function createVendorRate(vars: CreateVendorRateVariables): MutationPromise; +export function createVendorRate(dc: DataConnect, vars: CreateVendorRateVariables): MutationPromise; -interface GetVendorDefaultSettingByIdRef { +interface UpdateVendorRateRef { /* Allow users to create refs without passing in DataConnect */ - (vars: GetVendorDefaultSettingByIdVariables): QueryRef; + (vars: UpdateVendorRateVariables): MutationRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef; + (dc: DataConnect, vars: UpdateVendorRateVariables): MutationRef; operationName: string; } -export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef; +export const updateVendorRateRef: UpdateVendorRateRef; -export function getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise; -export function getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise; +export function updateVendorRate(vars: UpdateVendorRateVariables): MutationPromise; +export function updateVendorRate(dc: DataConnect, vars: UpdateVendorRateVariables): MutationPromise; -interface FilterVendorDefaultSettingsRef { +interface DeleteVendorRateRef { /* Allow users to create refs without passing in DataConnect */ - (vars?: FilterVendorDefaultSettingsVariables): QueryRef; + (vars: DeleteVendorRateVariables): MutationRef; /* Allow users to pass in custom DataConnect instances */ - (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef; + (dc: DataConnect, vars: DeleteVendorRateVariables): MutationRef; operationName: string; } -export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef; +export const deleteVendorRateRef: DeleteVendorRateRef; -export function filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise; -export function filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise; +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 */ @@ -929,3 +1032,75 @@ 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; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: CreateEventVariables): MutationRef; + operationName: string; +} +export const createEventRef: CreateEventRef; + +export function createEvent(vars: CreateEventVariables): MutationPromise; +export function createEvent(dc: DataConnect, vars: CreateEventVariables): MutationPromise; + +interface UpdateEventRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: UpdateEventVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: UpdateEventVariables): MutationRef; + operationName: string; +} +export const updateEventRef: UpdateEventRef; + +export function updateEvent(vars: UpdateEventVariables): MutationPromise; +export function updateEvent(dc: DataConnect, vars: UpdateEventVariables): MutationPromise; + +interface DeleteEventRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: DeleteEventVariables): MutationRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: DeleteEventVariables): MutationRef; + operationName: string; +} +export const deleteEventRef: DeleteEventRef; + +export function deleteEvent(vars: DeleteEventVariables): MutationPromise; +export function deleteEvent(dc: DataConnect, vars: DeleteEventVariables): MutationPromise; + +interface ListInvoiceRef { + /* 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 listInvoiceRef: ListInvoiceRef; + +export function listInvoice(): QueryPromise; +export function listInvoice(dc: DataConnect): QueryPromise; + +interface GetInvoiceByIdRef { + /* Allow users to create refs without passing in DataConnect */ + (vars: GetInvoiceByIdVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars: GetInvoiceByIdVariables): QueryRef; + operationName: string; +} +export const getInvoiceByIdRef: GetInvoiceByIdRef; + +export function getInvoiceById(vars: GetInvoiceByIdVariables): QueryPromise; +export function getInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables): QueryPromise; + +interface FilterInvoicesRef { + /* Allow users to create refs without passing in DataConnect */ + (vars?: FilterInvoicesVariables): QueryRef; + /* Allow users to pass in custom DataConnect instances */ + (dc: DataConnect, vars?: FilterInvoicesVariables): QueryRef; + operationName: string; +} +export const filterInvoicesRef: FilterInvoicesRef; + +export function filterInvoices(vars?: FilterInvoicesVariables): QueryPromise; +export function filterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables): QueryPromise; + diff --git a/internal-api-harness/src/dataconnect-generated/react/README.md b/internal-api-harness/src/dataconnect-generated/react/README.md index 0712a844..de4097eb 100644 --- a/internal-api-harness/src/dataconnect-generated/react/README.md +++ b/internal-api-harness/src/dataconnect-generated/react/README.md @@ -18,32 +18,38 @@ You can also follow the instructions from the [Data Connect documentation](https - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator) - [**Queries**](#queries) - [*listStaff*](#liststaff) + - [*listVendorDefaultSettings*](#listvendordefaultsettings) + - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) + - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) - [*listEvents*](#listevents) - [*getEventById*](#geteventbyid) - [*filterEvents*](#filterevents) - [*listVendor*](#listvendor) - [*getVendorById*](#getvendorbyid) - [*filterVendors*](#filtervendors) - - [*listVendorDefaultSettings*](#listvendordefaultsettings) - - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid) - - [*filterVendorDefaultSettings*](#filtervendordefaultsettings) - [*listVendorRate*](#listvendorrate) - [*getVendorRateById*](#getvendorratebyid) - [*filterVendorRates*](#filtervendorrates) + - [*listInvoice*](#listinvoice) + - [*getInvoiceById*](#getinvoicebyid) + - [*filterInvoices*](#filterinvoices) - [**Mutations**](#mutations) - [*CreateVendor*](#createvendor) - [*UpdateVendor*](#updatevendor) - [*DeleteVendor*](#deletevendor) + - [*CreateInvoice*](#createinvoice) + - [*UpdateInvoice*](#updateinvoice) + - [*DeleteInvoice*](#deleteinvoice) + - [*CreateStaff*](#createstaff) + - [*CreateVendorDefaultSetting*](#createvendordefaultsetting) + - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting) + - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting) - [*CreateVendorRate*](#createvendorrate) - [*UpdateVendorRate*](#updatevendorrate) - [*DeleteVendorRate*](#deletevendorrate) - [*CreateEvent*](#createevent) - [*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). @@ -215,6 +221,264 @@ export default function ListStaffComponent() { } ``` +## 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'}!
; +} +``` + ## listEvents You can execute the `listEvents` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): @@ -862,264 +1126,6 @@ export default function FilterVendorsComponent() { } ``` -## 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): @@ -1397,6 +1403,276 @@ export default function FilterVendorRatesComponent() { } ``` +## listInvoice +You can execute the `listInvoice` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useListInvoice(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useListInvoice(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `listInvoice` Query has no variables. +### Return Type +Recall that calling the `listInvoice` 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 `listInvoice` Query is of type `ListInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface ListInvoiceData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_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 `listInvoice`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig } from '@dataconnect/generated'; +import { useListInvoice } from '@dataconnect/generated/react' + +export default function ListInvoiceComponent() { + // 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 = useListInvoice(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useListInvoice(dataConnect); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useListInvoice(options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useListInvoice(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.invoices); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## getInvoiceById +You can execute the `getInvoiceById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useGetInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useGetInvoiceById(vars: GetInvoiceByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `getInvoiceById` Query requires an argument of type `GetInvoiceByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface GetInvoiceByIdVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `getInvoiceById` 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 `getInvoiceById` Query is of type `GetInvoiceByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface GetInvoiceByIdData { + invoice?: { + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; + } & Invoice_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 `getInvoiceById`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, GetInvoiceByIdVariables } from '@dataconnect/generated'; +import { useGetInvoiceById } from '@dataconnect/generated/react' + +export default function GetInvoiceByIdComponent() { + // The `useGetInvoiceById` Query hook requires an argument of type `GetInvoiceByIdVariables`: + const getInvoiceByIdVars: GetInvoiceByIdVariables = { + 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 = useGetInvoiceById(getInvoiceByIdVars); + // Variables can be defined inline as well. + const query = useGetInvoiceById({ id: ..., }); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useGetInvoiceById(dataConnect, getInvoiceByIdVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useGetInvoiceById(getInvoiceByIdVars, options); + + // You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object. + const dataConnect = getDataConnect(connectorConfig); + const options = { staleTime: 5 * 1000 }; + const query = useGetInvoiceById(dataConnect, getInvoiceByIdVars, 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.invoice); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## filterInvoices +You can execute the `filterInvoices` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts): + +```javascript +useFilterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` +You can also pass in a `DataConnect` instance to the Query hook function. +```javascript +useFilterInvoices(vars?: FilterInvoicesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +``` + +### Variables +The `filterInvoices` Query has an optional argument of type `FilterInvoicesVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface FilterInvoicesVariables { + invoiceNumber?: string | null; + status?: InvoiceStatus | null; + isAutoGenerated?: boolean | null; + amount?: number | null; +} +``` +### Return Type +Recall that calling the `filterInvoices` 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 `filterInvoices` Query is of type `FilterInvoicesData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface FilterInvoicesData { + invoices: ({ + id: UUIDString; + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + isAutoGenerated?: boolean | null; + } & Invoice_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 `filterInvoices`'s Query hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, FilterInvoicesVariables } from '@dataconnect/generated'; +import { useFilterInvoices } from '@dataconnect/generated/react' + +export default function FilterInvoicesComponent() { + // The `useFilterInvoices` Query hook has an optional argument of type `FilterInvoicesVariables`: + const filterInvoicesVars: FilterInvoicesVariables = { + invoiceNumber: ..., // optional + status: ..., // optional + isAutoGenerated: ..., // optional + amount: ..., // 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 = useFilterInvoices(filterInvoicesVars); + // Variables can be defined inline as well. + const query = useFilterInvoices({ invoiceNumber: ..., status: ..., isAutoGenerated: ..., amount: ..., }); + // Since all variables are optional for this Query, you can omit the `FilterInvoicesVariables` argument. + // (as long as you don't want to provide any `options`!) + const query = useFilterInvoices(); + + // You can also pass in a `DataConnect` instance to the Query hook function. + const dataConnect = getDataConnect(connectorConfig); + const query = useFilterInvoices(dataConnect, filterInvoicesVars); + + // You can also pass in a `useDataConnectQueryOptions` object to the Query hook function. + const options = { staleTime: 5 * 1000 }; + const query = useFilterInvoices(filterInvoicesVars, 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 = useFilterInvoices(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 = useFilterInvoices(dataConnect, filterInvoicesVars /** 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.invoices); + } + return
Query execution {query.isSuccess ? 'successful' : 'failed'}!
; +} +``` + # Mutations The React generated SDK provides Mutations hook functions that call and return [`useDataConnectMutation`](https://react-query-firebase.invertase.dev/react/data-connect/mutations) hooks from TanStack Query Firebase. @@ -1730,6 +2006,716 @@ export default function DeleteVendorComponent() { } ``` +## CreateInvoice +You can execute the `CreateInvoice` 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 +useCreateInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateInvoice` Mutation requires an argument of type `CreateInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateInvoiceVariables { + invoiceNumber: string; + amount: number; + status: InvoiceStatus; + issueDate: TimestampString; + dueDate: TimestampString; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} +``` +### Return Type +Recall that calling the `CreateInvoice` 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 `CreateInvoice` Mutation is of type `CreateInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateInvoiceData { + invoice_insert: Invoice_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 `CreateInvoice`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateInvoiceVariables } from '@dataconnect/generated'; +import { useCreateInvoice } from '@dataconnect/generated/react' + +export default function CreateInvoiceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateInvoice(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateInvoice(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateInvoice(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 = useCreateInvoice(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateInvoice` Mutation requires an argument of type `CreateInvoiceVariables`: + const createInvoiceVars: CreateInvoiceVariables = { + invoiceNumber: ..., + amount: ..., + status: ..., + issueDate: ..., + dueDate: ..., + disputedItems: ..., // optional + isAutoGenerated: ..., // optional + }; + mutation.mutate(createInvoiceVars); + // Variables can be defined inline as well. + mutation.mutate({ invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createInvoiceVars, 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.invoice_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## UpdateInvoice +You can execute the `UpdateInvoice` 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 +useUpdateInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useUpdateInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `UpdateInvoice` Mutation requires an argument of type `UpdateInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface UpdateInvoiceVariables { + id: UUIDString; + invoiceNumber?: string | null; + amount?: number | null; + status?: InvoiceStatus | null; + issueDate?: TimestampString | null; + dueDate?: TimestampString | null; + disputedItems?: string | null; + isAutoGenerated?: boolean | null; +} +``` +### Return Type +Recall that calling the `UpdateInvoice` 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 `UpdateInvoice` Mutation is of type `UpdateInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface UpdateInvoiceData { + invoice_update?: Invoice_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 `UpdateInvoice`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, UpdateInvoiceVariables } from '@dataconnect/generated'; +import { useUpdateInvoice } from '@dataconnect/generated/react' + +export default function UpdateInvoiceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useUpdateInvoice(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useUpdateInvoice(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useUpdateInvoice(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 = useUpdateInvoice(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useUpdateInvoice` Mutation requires an argument of type `UpdateInvoiceVariables`: + const updateInvoiceVars: UpdateInvoiceVariables = { + id: ..., + invoiceNumber: ..., // optional + amount: ..., // optional + status: ..., // optional + issueDate: ..., // optional + dueDate: ..., // optional + disputedItems: ..., // optional + isAutoGenerated: ..., // optional + }; + mutation.mutate(updateInvoiceVars); + // Variables can be defined inline as well. + mutation.mutate({ id: ..., invoiceNumber: ..., amount: ..., status: ..., issueDate: ..., dueDate: ..., disputedItems: ..., isAutoGenerated: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(updateInvoiceVars, 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.invoice_update); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## DeleteInvoice +You can execute the `DeleteInvoice` 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 +useDeleteInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useDeleteInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `DeleteInvoice` Mutation requires an argument of type `DeleteInvoiceVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface DeleteInvoiceVariables { + id: UUIDString; +} +``` +### Return Type +Recall that calling the `DeleteInvoice` 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 `DeleteInvoice` Mutation is of type `DeleteInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface DeleteInvoiceData { + invoice_delete?: Invoice_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 `DeleteInvoice`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, DeleteInvoiceVariables } from '@dataconnect/generated'; +import { useDeleteInvoice } from '@dataconnect/generated/react' + +export default function DeleteInvoiceComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useDeleteInvoice(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useDeleteInvoice(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useDeleteInvoice(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 = useDeleteInvoice(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useDeleteInvoice` Mutation requires an argument of type `DeleteInvoiceVariables`: + const deleteInvoiceVars: DeleteInvoiceVariables = { + id: ..., + }; + mutation.mutate(deleteInvoiceVars); + // 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(deleteInvoiceVars, 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.invoice_delete); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## CreateStaff +You can execute the `CreateStaff` 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 +useCreateStaff(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` +You can also pass in a `DataConnect` instance to the Mutation hook function. +```javascript +useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +``` + +### Variables +The `CreateStaff` Mutation requires an argument of type `CreateStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: + +```javascript +export interface CreateStaffVariables { + employeeName: string; + vendorId?: UUIDString | null; + email?: string | null; + position?: string | null; + employmentType: EmploymentType; + rating?: number | null; + reliabilityScore?: number | null; + backgroundCheckStatus: BackgroundCheckStatus; + certifications?: string | null; +} +``` +### Return Type +Recall that calling the `CreateStaff` 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 `CreateStaff` Mutation is of type `CreateStaffData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: +```javascript +export interface CreateStaffData { + staff_insert: Staff_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 `CreateStaff`'s Mutation hook function + +```javascript +import { getDataConnect } from 'firebase/data-connect'; +import { connectorConfig, CreateStaffVariables } from '@dataconnect/generated'; +import { useCreateStaff } from '@dataconnect/generated/react' + +export default function CreateStaffComponent() { + // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. + const mutation = useCreateStaff(); + + // You can also pass in a `DataConnect` instance to the Mutation hook function. + const dataConnect = getDataConnect(connectorConfig); + const mutation = useCreateStaff(dataConnect); + + // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + const mutation = useCreateStaff(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 = useCreateStaff(dataConnect, options); + + // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. + // The `useCreateStaff` Mutation requires an argument of type `CreateStaffVariables`: + const createStaffVars: CreateStaffVariables = { + employeeName: ..., + vendorId: ..., // optional + email: ..., // optional + position: ..., // optional + employmentType: ..., + rating: ..., // optional + reliabilityScore: ..., // optional + backgroundCheckStatus: ..., + certifications: ..., // optional + }; + mutation.mutate(createStaffVars); + // Variables can be defined inline as well. + mutation.mutate({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); + + // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. + const options = { + onSuccess: () => { console.log('Mutation succeeded!'); } + }; + mutation.mutate(createStaffVars, 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.staff_insert); + } + return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; +} +``` + +## 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'}!
; +} +``` + ## CreateVendorRate You can execute the `CreateVendorRate` 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 @@ -2454,405 +3440,3 @@ export default function DeleteEventComponent() { } ``` -## CreateStaff -You can execute the `CreateStaff` 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 -useCreateStaff(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` -You can also pass in a `DataConnect` instance to the Mutation hook function. -```javascript -useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -``` - -### Variables -The `CreateStaff` Mutation requires an argument of type `CreateStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: - -```javascript -export interface CreateStaffVariables { - employeeName: string; - vendorId?: UUIDString | null; - email?: string | null; - position?: string | null; - employmentType: EmploymentType; - rating?: number | null; - reliabilityScore?: number | null; - backgroundCheckStatus: BackgroundCheckStatus; - certifications?: string | null; -} -``` -### Return Type -Recall that calling the `CreateStaff` 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 `CreateStaff` Mutation is of type `CreateStaffData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields: -```javascript -export interface CreateStaffData { - staff_insert: Staff_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 `CreateStaff`'s Mutation hook function - -```javascript -import { getDataConnect } from 'firebase/data-connect'; -import { connectorConfig, CreateStaffVariables } from '@dataconnect/generated'; -import { useCreateStaff } from '@dataconnect/generated/react' - -export default function CreateStaffComponent() { - // Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation. - const mutation = useCreateStaff(); - - // You can also pass in a `DataConnect` instance to the Mutation hook function. - const dataConnect = getDataConnect(connectorConfig); - const mutation = useCreateStaff(dataConnect); - - // You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - const mutation = useCreateStaff(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 = useCreateStaff(dataConnect, options); - - // After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation. - // The `useCreateStaff` Mutation requires an argument of type `CreateStaffVariables`: - const createStaffVars: CreateStaffVariables = { - employeeName: ..., - vendorId: ..., // optional - email: ..., // optional - position: ..., // optional - employmentType: ..., - rating: ..., // optional - reliabilityScore: ..., // optional - backgroundCheckStatus: ..., - certifications: ..., // optional - }; - mutation.mutate(createStaffVars); - // Variables can be defined inline as well. - mutation.mutate({ employeeName: ..., vendorId: ..., email: ..., position: ..., employmentType: ..., rating: ..., reliabilityScore: ..., backgroundCheckStatus: ..., certifications: ..., }); - - // You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`. - const options = { - onSuccess: () => { console.log('Mutation succeeded!'); } - }; - mutation.mutate(createStaffVars, 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.staff_insert); - } - return
Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!
; -} -``` - -## 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 d1f156c2..a007882e 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,4 +1,4 @@ -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 { listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorDefaultSettingsRef, getVendorDefaultSettingByIdRef, filterVendorDefaultSettingsRef, listEventsRef, getEventByIdRef, filterEventsRef, createInvoiceRef, updateInvoiceRef, deleteInvoiceRef, createStaffRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorDefaultSettingRef, updateVendorDefaultSettingRef, deleteVendorDefaultSettingRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, createEventRef, updateEventRef, deleteEventRef, listInvoiceRef, getInvoiceByIdRef, filterInvoicesRef, connectorConfig } from '../../esm/index.esm.js'; import { validateArgs, CallerSdkTypeEnum } from 'firebase/data-connect'; import { useDataConnectQuery, useDataConnectMutation, validateReactArgs } from '@tanstack-query-firebase/react/data-connect'; @@ -32,55 +32,25 @@ export function useDeleteVendor(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } -export function useCreateVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createVendorRateRef(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 useUpdateVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateVendorRateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, 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 useDeleteVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteVendorRateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, 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 useCreateEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useUpdateEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -export function useDeleteEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - - export function useListEvents(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); const ref = listEventsRef(dcInstance); @@ -98,6 +68,30 @@ export function useFilterEvents(dcOrVars, varsOrOptions, options) { const ref = filterEventsRef(dcInstance, inputVars); return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); } +export function useCreateInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + export function useCreateStaff(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -148,25 +142,31 @@ export function useDeleteVendorDefaultSetting(dcOrOptions, options) { 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 useCreateVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, 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 useUpdateVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, 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 useDeleteVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } + export function useListVendorRate(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); const ref = listVendorRateRef(dcInstance); @@ -183,4 +183,46 @@ 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) { + return createEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useUpdateEvent(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useDeleteEvent(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +export function useListInvoice(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listInvoiceRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useGetInvoiceById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getInvoiceByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +export function useFilterInvoices(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterInvoicesRef(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 918c7066..d7deeadc 100644 --- a/internal-api-harness/src/dataconnect-generated/react/index.cjs.js +++ b/internal-api-harness/src/dataconnect-generated/react/index.cjs.js @@ -1,4 +1,4 @@ -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 { listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorDefaultSettingsRef, getVendorDefaultSettingByIdRef, filterVendorDefaultSettingsRef, listEventsRef, getEventByIdRef, filterEventsRef, createInvoiceRef, updateInvoiceRef, deleteInvoiceRef, createStaffRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createVendorDefaultSettingRef, updateVendorDefaultSettingRef, deleteVendorDefaultSettingRef, createVendorRateRef, updateVendorRateRef, deleteVendorRateRef, listVendorRateRef, getVendorRateByIdRef, filterVendorRatesRef, createEventRef, updateEventRef, deleteEventRef, listInvoiceRef, getInvoiceByIdRef, filterInvoicesRef, connectorConfig } = require('../index.cjs.js'); const { validateArgs, CallerSdkTypeEnum } = require('firebase/data-connect'); const { useDataConnectQuery, useDataConnectMutation, validateReactArgs } = require('@tanstack-query-firebase/react/data-connect'); @@ -32,55 +32,25 @@ exports.useDeleteVendor = function useDeleteVendor(dcOrOptions, options) { return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); } -exports.useCreateVendorRate = function useCreateVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createVendorRateRef(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.useUpdateVendorRate = function useUpdateVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateVendorRateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, 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.useDeleteVendorRate = function useDeleteVendorRate(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteVendorRateRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, 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.useCreateEvent = function useCreateEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return createEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useUpdateEvent = function useUpdateEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return updateEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - -exports.useDeleteEvent = function useDeleteEvent(dcOrOptions, options) { - const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); - function refFactory(vars) { - return deleteEventRef(dcInstance, vars); - } - return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); -} - - exports.useListEvents = function useListEvents(dcOrOptions, options) { const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); const ref = listEventsRef(dcInstance); @@ -98,6 +68,30 @@ exports.useFilterEvents = function useFilterEvents(dcOrVars, varsOrOptions, opti const ref = filterEventsRef(dcInstance, inputVars); return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); } +exports.useCreateInvoice = function useCreateInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateInvoice = function useUpdateInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteInvoice = function useDeleteInvoice(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteInvoiceRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + exports.useCreateStaff = function useCreateStaff(dcOrOptions, options) { const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); function refFactory(vars) { @@ -148,25 +142,31 @@ exports.useDeleteVendorDefaultSetting = function useDeleteVendorDefaultSetting(d 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.useCreateVendorRate = function useCreateVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return createVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, 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.useUpdateVendorRate = function useUpdateVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateVendorRateRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, 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.useDeleteVendorRate = function useDeleteVendorRate(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteVendorRateRef(dcInstance, vars); + } + 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); @@ -183,4 +183,46 @@ exports.useFilterVendorRates = function useFilterVendorRates(dcOrVars, varsOrOpt 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) { + return createEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useUpdateEvent = function useUpdateEvent(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return updateEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useDeleteEvent = function useDeleteEvent(dcOrOptions, options) { + const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options); + function refFactory(vars) { + return deleteEventRef(dcInstance, vars); + } + return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + + +exports.useListInvoice = function useListInvoice(dcOrOptions, options) { + const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options); + const ref = listInvoiceRef(dcInstance); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useGetInvoiceById = function useGetInvoiceById(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true); + const ref = getInvoiceByIdRef(dcInstance, inputVars); + return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact); +} + +exports.useFilterInvoices = function useFilterInvoices(dcOrVars, varsOrOptions, options) { + const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false); + const ref = filterInvoicesRef(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 29eef557..e5957f90 100644 --- a/internal-api-harness/src/dataconnect-generated/react/index.d.ts +++ b/internal-api-harness/src/dataconnect-generated/react/index.d.ts @@ -1,4 +1,4 @@ -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 { ListStaffData, CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, ListVendorDefaultSettingsData, GetVendorDefaultSettingByIdData, GetVendorDefaultSettingByIdVariables, FilterVendorDefaultSettingsData, FilterVendorDefaultSettingsVariables, ListEventsData, GetEventByIdData, GetEventByIdVariables, FilterEventsData, FilterEventsVariables, CreateInvoiceData, CreateInvoiceVariables, UpdateInvoiceData, UpdateInvoiceVariables, DeleteInvoiceData, DeleteInvoiceVariables, CreateStaffData, CreateStaffVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateVendorDefaultSettingData, CreateVendorDefaultSettingVariables, UpdateVendorDefaultSettingData, UpdateVendorDefaultSettingVariables, DeleteVendorDefaultSettingData, DeleteVendorDefaultSettingVariables, CreateVendorRateData, CreateVendorRateVariables, UpdateVendorRateData, UpdateVendorRateVariables, DeleteVendorRateData, DeleteVendorRateVariables, ListVendorRateData, GetVendorRateByIdData, GetVendorRateByIdVariables, FilterVendorRatesData, FilterVendorRatesVariables, CreateEventData, CreateEventVariables, UpdateEventData, UpdateEventVariables, DeleteEventData, DeleteEventVariables, ListInvoiceData, GetInvoiceByIdData, GetInvoiceByIdVariables, FilterInvoicesData, FilterInvoicesVariables } 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'; @@ -17,23 +17,14 @@ export function useUpdateVendor(dc: DataConnect, options?: useDataConnectMutatio export function useDeleteVendor(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useDeleteVendor(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useListVendorDefaultSettings(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListVendorDefaultSettings(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useUpdateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useUpdateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useGetVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useDeleteVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useDeleteVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useCreateEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useCreateEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useUpdateEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useUpdateEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; - -export function useDeleteEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useDeleteEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useFilterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; export function useListEvents(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; export function useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; @@ -44,6 +35,15 @@ export function useGetEventById(dc: DataConnect, vars: GetEventByIdVariables, op export function useFilterEvents(vars?: FilterEventsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; export function useFilterEvents(dc: DataConnect, vars?: FilterEventsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useCreateInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useUpdateInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteInvoice(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteInvoice(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + export function useCreateStaff(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; export function useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; @@ -65,14 +65,14 @@ export function useUpdateVendorDefaultSetting(dc: DataConnect, options?: useData 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 useCreateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useCreateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useGetVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useGetVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useUpdateVendorRate(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateVendorRate(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; -export function useFilterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; -export function useFilterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +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; @@ -82,3 +82,21 @@ export function useGetVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVar 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; + +export function useUpdateEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useUpdateEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useDeleteEvent(options?: useDataConnectMutationOptions): UseDataConnectMutationResult; +export function useDeleteEvent(dc: DataConnect, options?: useDataConnectMutationOptions): UseDataConnectMutationResult; + +export function useListInvoice(options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useListInvoice(dc: DataConnect, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useGetInvoiceById(vars: GetInvoiceByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useGetInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; + +export function useFilterInvoices(vars?: FilterInvoicesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult; +export function useFilterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables, options?: useDataConnectQueryOptions): UseDataConnectQueryResult;