@wix/data-backend-public-sdk-poc
Advanced tools
Comparing version 1.0.20 to 1.0.21
@@ -206,5 +206,5 @@ export interface Item { | ||
items?: Record<string, any>[] | null; | ||
/** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */ | ||
/** *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query. */ | ||
totalCount?: number; | ||
/** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */ | ||
/** *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query. */ | ||
totalResults?: number; | ||
@@ -330,3 +330,3 @@ /** Whether referenced items are trimmed from the results. This occurs when there are more than 50 referenced items. */ | ||
export interface BulkInsertRequest { | ||
/** Items to add. */ | ||
/** Items to insert. */ | ||
items?: Record<string, any>[] | null; | ||
@@ -339,25 +339,25 @@ /** ID of the collection in which to insert the items. */ | ||
insertedItemIds?: string[]; | ||
/** Errors for items that couldn't be inserted. */ | ||
/** Error details for items that couldn't be inserted. */ | ||
errors?: BulkError[]; | ||
} | ||
export interface BulkError { | ||
/** ID of record in error */ | ||
/** ID of the item that couldn't be inserted. */ | ||
itemId?: string | null; | ||
/** Error message */ | ||
/** Error message. */ | ||
message?: string; | ||
/** Error details */ | ||
/** Error details. */ | ||
details?: Details; | ||
/** index of a failed record in request */ | ||
/** Index of the failed item in the `items` paramater of the request. */ | ||
originalIndex?: number; | ||
} | ||
export interface ApplicationError { | ||
/** Error code */ | ||
/** Error code. */ | ||
code?: string; | ||
/** Error description */ | ||
/** Error description. */ | ||
description?: string; | ||
/** Error data */ | ||
/** Error data. */ | ||
data?: Record<string, any> | null; | ||
} | ||
export interface Details { | ||
/** Application error */ | ||
/** Application error. */ | ||
applicationError?: ApplicationError; | ||
@@ -412,3 +412,3 @@ } | ||
export interface BulkRemoveRequest { | ||
/** List of items to remove. */ | ||
/** IDs of items to remove. */ | ||
entries?: BulkRemoveRequestEntry[]; | ||
@@ -429,9 +429,9 @@ /** ID of the collection from which to remove the items. */ | ||
export interface QueryReferencedRequest { | ||
/** Referring item ID */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** The property that contains the references to the referenced items. */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Pointer to page of results using offset. */ | ||
/** Paging preferences. */ | ||
paging?: Paging; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -444,11 +444,9 @@ } | ||
export interface QueryReferencedResponse { | ||
/** | ||
* Deprecated, use 'entities' instead. List of referenced items | ||
* This was deprecated because the response may contain string IDs (see 'entities') | ||
*/ | ||
/** *Deprecated.** Refer to `entities` instead. List of referenced items. */ | ||
items?: Record<string, any>[] | null; | ||
/** Total number of referenced item */ | ||
/** *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query. */ | ||
totalCount?: number; | ||
/** *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query. */ | ||
totalResults?: number; | ||
/** List of referenced entities */ | ||
/** List of referenced items and/or IDs. For successfully resolved references, the referenced data item appears. For references that can't be resolved, the ID appears. */ | ||
entities?: ReferencedEntity[]; | ||
@@ -458,5 +456,6 @@ /** Paging information. */ | ||
} | ||
/** Each entity can be item or the ID that could not be resolved (e.g. ID wasn't found or item is in draft state) */ | ||
export interface ReferencedEntity extends ReferencedEntityEntityOneOf { | ||
/** Data item referenced. */ | ||
item?: Record<string, any> | null; | ||
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */ | ||
referenceId?: string; | ||
@@ -466,17 +465,19 @@ } | ||
export interface ReferencedEntityEntityOneOf { | ||
/** Data item referenced. */ | ||
item?: Record<string, any> | null; | ||
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */ | ||
referenceId?: string; | ||
} | ||
export interface BulkInsertReferencesRequest { | ||
/** References */ | ||
/** References to insert. */ | ||
references?: Reference[]; | ||
/** ID of the collection that contains the referring item */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
} | ||
export interface Reference { | ||
/** The property that contains the references to the referenced items */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** Referenced item id */ | ||
/** ID of the referenced item. */ | ||
referencedItemId?: string; | ||
@@ -487,9 +488,9 @@ } | ||
export interface BulkReplaceReferencesRequest { | ||
/** Property that contains the references to the referenced items */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** A list of new referenced item ids */ | ||
/** List of new referenced item IDs to replace the existing ones. */ | ||
newReferencedItemIds?: string[]; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -500,5 +501,5 @@ } | ||
export interface BulkRemoveReferencesRequest { | ||
/** References */ | ||
/** References to be removed. */ | ||
references?: Reference[]; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -509,12 +510,13 @@ } | ||
export interface IsReferencedRequest { | ||
/** The property that contains the references to the referenced items */ | ||
/** Property that may contain a reference to the specified item. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** Referenced item id */ | ||
/** ID of the item that may be referenced. */ | ||
referencedItemId?: string; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
} | ||
export interface IsReferencedResponse { | ||
/** Whether the specified property of the referring item contains a reference to the specified referenced item. */ | ||
isReferenced?: boolean; | ||
@@ -521,0 +523,0 @@ } |
@@ -212,5 +212,5 @@ export declare const __debug: { | ||
items?: Record<string, any>[] | null; | ||
/** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */ | ||
/** *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query. */ | ||
totalCount?: number; | ||
/** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */ | ||
/** *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query. */ | ||
totalResults?: number; | ||
@@ -336,3 +336,3 @@ /** Whether referenced items are trimmed from the results. This occurs when there are more than 50 referenced items. */ | ||
export interface BulkInsertRequest { | ||
/** Items to add. */ | ||
/** Items to insert. */ | ||
items?: Record<string, any>[] | null; | ||
@@ -345,25 +345,25 @@ /** ID of the collection in which to insert the items. */ | ||
insertedItemIds?: string[]; | ||
/** Errors for items that couldn't be inserted. */ | ||
/** Error details for items that couldn't be inserted. */ | ||
errors?: BulkError[]; | ||
} | ||
export interface BulkError { | ||
/** ID of record in error */ | ||
/** ID of the item that couldn't be inserted. */ | ||
itemId?: string | null; | ||
/** Error message */ | ||
/** Error message. */ | ||
message?: string; | ||
/** Error details */ | ||
/** Error details. */ | ||
details?: Details; | ||
/** index of a failed record in request */ | ||
/** Index of the failed item in the `items` paramater of the request. */ | ||
originalIndex?: number; | ||
} | ||
export interface ApplicationError { | ||
/** Error code */ | ||
/** Error code. */ | ||
code?: string; | ||
/** Error description */ | ||
/** Error description. */ | ||
description?: string; | ||
/** Error data */ | ||
/** Error data. */ | ||
data?: Record<string, any> | null; | ||
} | ||
export interface Details { | ||
/** Application error */ | ||
/** Application error. */ | ||
applicationError?: ApplicationError; | ||
@@ -418,3 +418,3 @@ } | ||
export interface BulkRemoveRequest { | ||
/** List of items to remove. */ | ||
/** IDs of items to remove. */ | ||
entries?: BulkRemoveRequestEntry[]; | ||
@@ -435,9 +435,9 @@ /** ID of the collection from which to remove the items. */ | ||
export interface QueryReferencedRequest { | ||
/** Referring item ID */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** The property that contains the references to the referenced items. */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Pointer to page of results using offset. */ | ||
/** Paging preferences. */ | ||
paging?: Paging; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -450,11 +450,9 @@ } | ||
export interface QueryReferencedResponse { | ||
/** | ||
* Deprecated, use 'entities' instead. List of referenced items | ||
* This was deprecated because the response may contain string IDs (see 'entities') | ||
*/ | ||
/** *Deprecated.** Refer to `entities` instead. List of referenced items. */ | ||
items?: Record<string, any>[] | null; | ||
/** Total number of referenced item */ | ||
/** *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query. */ | ||
totalCount?: number; | ||
/** *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query. */ | ||
totalResults?: number; | ||
/** List of referenced entities */ | ||
/** List of referenced items and/or IDs. For successfully resolved references, the referenced data item appears. For references that can't be resolved, the ID appears. */ | ||
entities?: ReferencedEntity[]; | ||
@@ -464,5 +462,6 @@ /** Paging information. */ | ||
} | ||
/** Each entity can be item or the ID that could not be resolved (e.g. ID wasn't found or item is in draft state) */ | ||
export interface ReferencedEntity extends ReferencedEntityEntityOneOf { | ||
/** Data item referenced. */ | ||
item?: Record<string, any> | null; | ||
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */ | ||
referenceId?: string; | ||
@@ -472,17 +471,19 @@ } | ||
export interface ReferencedEntityEntityOneOf { | ||
/** Data item referenced. */ | ||
item?: Record<string, any> | null; | ||
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */ | ||
referenceId?: string; | ||
} | ||
export interface BulkInsertReferencesRequest { | ||
/** References */ | ||
/** References to insert. */ | ||
references?: Reference[]; | ||
/** ID of the collection that contains the referring item */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
} | ||
export interface Reference { | ||
/** The property that contains the references to the referenced items */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** Referenced item id */ | ||
/** ID of the referenced item. */ | ||
referencedItemId?: string; | ||
@@ -493,9 +494,9 @@ } | ||
export interface BulkReplaceReferencesRequest { | ||
/** Property that contains the references to the referenced items */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** A list of new referenced item ids */ | ||
/** List of new referenced item IDs to replace the existing ones. */ | ||
newReferencedItemIds?: string[]; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -506,5 +507,5 @@ } | ||
export interface BulkRemoveReferencesRequest { | ||
/** References */ | ||
/** References to be removed. */ | ||
references?: Reference[]; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -515,12 +516,13 @@ } | ||
export interface IsReferencedRequest { | ||
/** The property that contains the references to the referenced items */ | ||
/** Property that may contain a reference to the specified item. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** Referenced item id */ | ||
/** ID of the item that may be referenced. */ | ||
referencedItemId?: string; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
} | ||
export interface IsReferencedResponse { | ||
/** Whether the specified property of the referring item contains a reference to the specified referenced item. */ | ||
isReferenced?: boolean; | ||
@@ -527,0 +529,0 @@ } |
@@ -206,5 +206,5 @@ export interface Item { | ||
items?: Record<string, any>[] | null; | ||
/** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */ | ||
/** *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query. */ | ||
totalCount?: number; | ||
/** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */ | ||
/** *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query. */ | ||
totalResults?: number; | ||
@@ -330,3 +330,3 @@ /** Whether referenced items are trimmed from the results. This occurs when there are more than 50 referenced items. */ | ||
export interface BulkInsertRequest { | ||
/** Items to add. */ | ||
/** Items to insert. */ | ||
items?: Record<string, any>[] | null; | ||
@@ -339,25 +339,25 @@ /** ID of the collection in which to insert the items. */ | ||
insertedItemIds?: string[]; | ||
/** Errors for items that couldn't be inserted. */ | ||
/** Error details for items that couldn't be inserted. */ | ||
errors?: BulkError[]; | ||
} | ||
export interface BulkError { | ||
/** ID of record in error */ | ||
/** ID of the item that couldn't be inserted. */ | ||
itemId?: string | null; | ||
/** Error message */ | ||
/** Error message. */ | ||
message?: string; | ||
/** Error details */ | ||
/** Error details. */ | ||
details?: Details; | ||
/** index of a failed record in request */ | ||
/** Index of the failed item in the `items` paramater of the request. */ | ||
originalIndex?: number; | ||
} | ||
export interface ApplicationError { | ||
/** Error code */ | ||
/** Error code. */ | ||
code?: string; | ||
/** Error description */ | ||
/** Error description. */ | ||
description?: string; | ||
/** Error data */ | ||
/** Error data. */ | ||
data?: Record<string, any> | null; | ||
} | ||
export interface Details { | ||
/** Application error */ | ||
/** Application error. */ | ||
applicationError?: ApplicationError; | ||
@@ -412,3 +412,3 @@ } | ||
export interface BulkRemoveRequest { | ||
/** List of items to remove. */ | ||
/** IDs of items to remove. */ | ||
entries?: BulkRemoveRequestEntry[]; | ||
@@ -429,9 +429,9 @@ /** ID of the collection from which to remove the items. */ | ||
export interface QueryReferencedRequest { | ||
/** Referring item ID */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** The property that contains the references to the referenced items. */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Pointer to page of results using offset. */ | ||
/** Paging preferences. */ | ||
paging?: Paging; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -444,11 +444,9 @@ } | ||
export interface QueryReferencedResponse { | ||
/** | ||
* Deprecated, use 'entities' instead. List of referenced items | ||
* This was deprecated because the response may contain string IDs (see 'entities') | ||
*/ | ||
/** *Deprecated.** Refer to `entities` instead. List of referenced items. */ | ||
items?: Record<string, any>[] | null; | ||
/** Total number of referenced item */ | ||
/** *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query. */ | ||
totalCount?: number; | ||
/** *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query. */ | ||
totalResults?: number; | ||
/** List of referenced entities */ | ||
/** List of referenced items and/or IDs. For successfully resolved references, the referenced data item appears. For references that can't be resolved, the ID appears. */ | ||
entities?: ReferencedEntity[]; | ||
@@ -458,5 +456,6 @@ /** Paging information. */ | ||
} | ||
/** Each entity can be item or the ID that could not be resolved (e.g. ID wasn't found or item is in draft state) */ | ||
export interface ReferencedEntity extends ReferencedEntityEntityOneOf { | ||
/** Data item referenced. */ | ||
item?: Record<string, any> | null; | ||
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */ | ||
referenceId?: string; | ||
@@ -466,17 +465,19 @@ } | ||
export interface ReferencedEntityEntityOneOf { | ||
/** Data item referenced. */ | ||
item?: Record<string, any> | null; | ||
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */ | ||
referenceId?: string; | ||
} | ||
export interface BulkInsertReferencesRequest { | ||
/** References */ | ||
/** References to insert. */ | ||
references?: Reference[]; | ||
/** ID of the collection that contains the referring item */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
} | ||
export interface Reference { | ||
/** The property that contains the references to the referenced items */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** Referenced item id */ | ||
/** ID of the referenced item. */ | ||
referencedItemId?: string; | ||
@@ -487,9 +488,9 @@ } | ||
export interface BulkReplaceReferencesRequest { | ||
/** Property that contains the references to the referenced items */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** A list of new referenced item ids */ | ||
/** List of new referenced item IDs to replace the existing ones. */ | ||
newReferencedItemIds?: string[]; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -500,5 +501,5 @@ } | ||
export interface BulkRemoveReferencesRequest { | ||
/** References */ | ||
/** References to be removed. */ | ||
references?: Reference[]; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -509,12 +510,13 @@ } | ||
export interface IsReferencedRequest { | ||
/** The property that contains the references to the referenced items */ | ||
/** Property that may contain a reference to the specified item. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** Referenced item id */ | ||
/** ID of the item that may be referenced. */ | ||
referencedItemId?: string; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
} | ||
export interface IsReferencedResponse { | ||
/** Whether the specified property of the referring item contains a reference to the specified referenced item. */ | ||
isReferenced?: boolean; | ||
@@ -521,0 +523,0 @@ } |
@@ -212,5 +212,5 @@ export declare const __debug: { | ||
items?: Record<string, any>[] | null; | ||
/** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */ | ||
/** *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query. */ | ||
totalCount?: number; | ||
/** Deprecated. Use 'paging_metadata' instead. Total number of items satisfying the query. */ | ||
/** *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query. */ | ||
totalResults?: number; | ||
@@ -336,3 +336,3 @@ /** Whether referenced items are trimmed from the results. This occurs when there are more than 50 referenced items. */ | ||
export interface BulkInsertRequest { | ||
/** Items to add. */ | ||
/** Items to insert. */ | ||
items?: Record<string, any>[] | null; | ||
@@ -345,25 +345,25 @@ /** ID of the collection in which to insert the items. */ | ||
insertedItemIds?: string[]; | ||
/** Errors for items that couldn't be inserted. */ | ||
/** Error details for items that couldn't be inserted. */ | ||
errors?: BulkError[]; | ||
} | ||
export interface BulkError { | ||
/** ID of record in error */ | ||
/** ID of the item that couldn't be inserted. */ | ||
itemId?: string | null; | ||
/** Error message */ | ||
/** Error message. */ | ||
message?: string; | ||
/** Error details */ | ||
/** Error details. */ | ||
details?: Details; | ||
/** index of a failed record in request */ | ||
/** Index of the failed item in the `items` paramater of the request. */ | ||
originalIndex?: number; | ||
} | ||
export interface ApplicationError { | ||
/** Error code */ | ||
/** Error code. */ | ||
code?: string; | ||
/** Error description */ | ||
/** Error description. */ | ||
description?: string; | ||
/** Error data */ | ||
/** Error data. */ | ||
data?: Record<string, any> | null; | ||
} | ||
export interface Details { | ||
/** Application error */ | ||
/** Application error. */ | ||
applicationError?: ApplicationError; | ||
@@ -418,3 +418,3 @@ } | ||
export interface BulkRemoveRequest { | ||
/** List of items to remove. */ | ||
/** IDs of items to remove. */ | ||
entries?: BulkRemoveRequestEntry[]; | ||
@@ -435,9 +435,9 @@ /** ID of the collection from which to remove the items. */ | ||
export interface QueryReferencedRequest { | ||
/** Referring item ID */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** The property that contains the references to the referenced items. */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Pointer to page of results using offset. */ | ||
/** Paging preferences. */ | ||
paging?: Paging; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -450,11 +450,9 @@ } | ||
export interface QueryReferencedResponse { | ||
/** | ||
* Deprecated, use 'entities' instead. List of referenced items | ||
* This was deprecated because the response may contain string IDs (see 'entities') | ||
*/ | ||
/** *Deprecated.** Refer to `entities` instead. List of referenced items. */ | ||
items?: Record<string, any>[] | null; | ||
/** Total number of referenced item */ | ||
/** *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query. */ | ||
totalCount?: number; | ||
/** *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query. */ | ||
totalResults?: number; | ||
/** List of referenced entities */ | ||
/** List of referenced items and/or IDs. For successfully resolved references, the referenced data item appears. For references that can't be resolved, the ID appears. */ | ||
entities?: ReferencedEntity[]; | ||
@@ -464,5 +462,6 @@ /** Paging information. */ | ||
} | ||
/** Each entity can be item or the ID that could not be resolved (e.g. ID wasn't found or item is in draft state) */ | ||
export interface ReferencedEntity extends ReferencedEntityEntityOneOf { | ||
/** Data item referenced. */ | ||
item?: Record<string, any> | null; | ||
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */ | ||
referenceId?: string; | ||
@@ -472,17 +471,19 @@ } | ||
export interface ReferencedEntityEntityOneOf { | ||
/** Data item referenced. */ | ||
item?: Record<string, any> | null; | ||
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */ | ||
referenceId?: string; | ||
} | ||
export interface BulkInsertReferencesRequest { | ||
/** References */ | ||
/** References to insert. */ | ||
references?: Reference[]; | ||
/** ID of the collection that contains the referring item */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
} | ||
export interface Reference { | ||
/** The property that contains the references to the referenced items */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** Referenced item id */ | ||
/** ID of the referenced item. */ | ||
referencedItemId?: string; | ||
@@ -493,9 +494,9 @@ } | ||
export interface BulkReplaceReferencesRequest { | ||
/** Property that contains the references to the referenced items */ | ||
/** Property containing the references to the referenced items. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** A list of new referenced item ids */ | ||
/** List of new referenced item IDs to replace the existing ones. */ | ||
newReferencedItemIds?: string[]; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -506,5 +507,5 @@ } | ||
export interface BulkRemoveReferencesRequest { | ||
/** References */ | ||
/** References to be removed. */ | ||
references?: Reference[]; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
@@ -515,12 +516,13 @@ } | ||
export interface IsReferencedRequest { | ||
/** The property that contains the references to the referenced items */ | ||
/** Property that may contain a reference to the specified item. */ | ||
propertyName?: string; | ||
/** Referring item id */ | ||
/** ID of the referring item. */ | ||
referringItemId?: string; | ||
/** Referenced item id */ | ||
/** ID of the item that may be referenced. */ | ||
referencedItemId?: string; | ||
/** ID of the collection */ | ||
/** ID of the collection containing the referring item. */ | ||
dataCollectionId?: string; | ||
} | ||
export interface IsReferencedResponse { | ||
/** Whether the specified property of the referring item contains a reference to the specified referenced item. */ | ||
isReferenced?: boolean; | ||
@@ -527,0 +529,0 @@ } |
{ | ||
"name": "@wix/data-backend-public-sdk-poc", | ||
"version": "1.0.20", | ||
"version": "1.0.21", | ||
"publishConfig": { | ||
@@ -36,3 +36,3 @@ "registry": "https://registry.npmjs.org/", | ||
}, | ||
"falconPackageHash": "4573239549728ff122b0d47c31d021f9aeb4d29c5f7025e751bfb677" | ||
"falconPackageHash": "828db63446ba2629a170e4ab7e6a12adf4f2bcfc615390df7da053f2" | ||
} |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
124906
2995