@pptb/types 1.0.4 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dataverseAPI.d.ts +3 -7
- package/package.json +1 -1
package/dataverseAPI.d.ts
CHANGED
|
@@ -212,13 +212,13 @@ declare namespace DataverseAPI {
|
|
|
212
212
|
* const metadata = await dataverseAPI.getEntityMetadata('account');
|
|
213
213
|
* console.log('Display Name:', metadata.DisplayName?.LocalizedLabels[0]?.Label);
|
|
214
214
|
* console.log('Attributes:', metadata.Attributes?.length);
|
|
215
|
-
*
|
|
215
|
+
*
|
|
216
216
|
* @example
|
|
217
217
|
* // Get only specific metadata columns
|
|
218
218
|
* const metadata = await dataverseAPI.getEntityMetadata('account', ['LogicalName', 'DisplayName']);
|
|
219
219
|
* console.log('Display Name:', metadata.DisplayName?.LocalizedLabels[0]?.Label);
|
|
220
220
|
*/
|
|
221
|
-
getEntityMetadata: (entityLogicalName: string, selectColumns?: string[]) => Promise<EntityMetadata>;
|
|
221
|
+
getEntityMetadata: (entityLogicalName: string, searchByLogicalName: boolean, selectColumns?: string[]) => Promise<EntityMetadata>;
|
|
222
222
|
|
|
223
223
|
/**
|
|
224
224
|
* Get metadata for all entities
|
|
@@ -290,14 +290,12 @@ declare namespace DataverseAPI {
|
|
|
290
290
|
/**
|
|
291
291
|
* Query data from Dataverse using OData query parameters
|
|
292
292
|
*
|
|
293
|
-
* @param entityLogicalName - Logical name of the entity to query (e.g., 'account', 'contact')
|
|
294
293
|
* @param odataQuery - OData query string with parameters like $select, $filter, $orderby, $top, $skip, $expand
|
|
295
294
|
* @returns Object with value array containing matching records
|
|
296
295
|
*
|
|
297
296
|
* @example
|
|
298
297
|
* // Get top 10 active accounts with specific fields
|
|
299
298
|
* const result = await dataverseAPI.queryData(
|
|
300
|
-
* 'account',
|
|
301
299
|
* '$select=name,emailaddress1,telephone1&$filter=statecode eq 0&$orderby=name&$top=10'
|
|
302
300
|
* );
|
|
303
301
|
* console.log(`Found ${result.value.length} records`);
|
|
@@ -308,18 +306,16 @@ declare namespace DataverseAPI {
|
|
|
308
306
|
* @example
|
|
309
307
|
* // Query with expand to include related records
|
|
310
308
|
* const result = await dataverseAPI.queryData(
|
|
311
|
-
* 'account',
|
|
312
309
|
* '$select=name,accountid&$expand=contact_customer_accounts($select=fullname,emailaddress1)&$top=5'
|
|
313
310
|
* );
|
|
314
311
|
*
|
|
315
312
|
* @example
|
|
316
313
|
* // Simple query with just a filter
|
|
317
314
|
* const result = await dataverseAPI.queryData(
|
|
318
|
-
* 'contact',
|
|
319
315
|
* '$filter=contains(fullname, \'Smith\')&$top=20'
|
|
320
316
|
* );
|
|
321
317
|
*/
|
|
322
|
-
queryData: (
|
|
318
|
+
queryData: (odataQuery: string) => Promise<{ value: Record<string, unknown>[] }>;
|
|
323
319
|
}
|
|
324
320
|
}
|
|
325
321
|
|