@wix/auto_sdk_get-paid_receipts 1.0.144 → 1.0.146

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.
@@ -1248,7 +1248,6 @@ interface ReceiptCreatedEnvelope {
1248
1248
  * @webhook
1249
1249
  * @eventType wix.receipts.v1.receipt_created
1250
1250
  * @slug created
1251
- * @documentationMaturity preview
1252
1251
  */
1253
1252
  declare function onReceiptCreated(handler: (event: ReceiptCreatedEnvelope) => void | Promise<void>): void;
1254
1253
  interface ReceiptSentEnvelope {
@@ -1263,7 +1262,6 @@ interface ReceiptSentEnvelope {
1263
1262
  * @webhook
1264
1263
  * @eventType wix.receipts.v1.receipt_sent
1265
1264
  * @slug sent
1266
- * @documentationMaturity preview
1267
1265
  */
1268
1266
  declare function onReceiptSent(handler: (event: ReceiptSentEnvelope) => void | Promise<void>): void;
1269
1267
  interface ReceiptUpdatedEnvelope {
@@ -1278,7 +1276,6 @@ interface ReceiptUpdatedEnvelope {
1278
1276
  * @webhook
1279
1277
  * @eventType wix.receipts.v1.receipt_updated
1280
1278
  * @slug updated
1281
- * @documentationMaturity preview
1282
1279
  */
1283
1280
  declare function onReceiptUpdated(handler: (event: ReceiptUpdatedEnvelope) => void | Promise<void>): void;
1284
1281
  /**
@@ -1287,7 +1284,6 @@ declare function onReceiptUpdated(handler: (event: ReceiptUpdatedEnvelope) => vo
1287
1284
  * Receipt number is assigned later and will be provided in the Get Receipt response.
1288
1285
  * @param receipt - Receipt to create.
1289
1286
  * @public
1290
- * @documentationMaturity preview
1291
1287
  * @requiredField receipt
1292
1288
  * @requiredField receipt.currency
1293
1289
  * @requiredField receipt.lineItems
@@ -1321,7 +1317,6 @@ declare function createReceipt(receipt: NonNullablePaths<Receipt, `currency` | `
1321
1317
  * Retrieves a receipt.
1322
1318
  * @param receiptId - Receipt ID.
1323
1319
  * @public
1324
- * @documentationMaturity preview
1325
1320
  * @requiredField receiptId
1326
1321
  * @permissionId RECEIPTS.RECEIPT_READ
1327
1322
  * @applicableIdentity APP
@@ -1332,7 +1327,6 @@ declare function getReceipt(receiptId: string): Promise<NonNullablePaths<Receipt
1332
1327
  /**
1333
1328
  * Retrieves a list of up to 100 receipts, given the specified filtering, paging, and sorting ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)).
1334
1329
  * @public
1335
- * @documentationMaturity preview
1336
1330
  * @permissionId RECEIPTS.RECEIPT_READ
1337
1331
  * @applicableIdentity APP
1338
1332
  * @fqn wix.receipts.v1.Receipts.QueryReceipts
@@ -1354,65 +1348,46 @@ interface ReceiptsQueryResult extends QueryCursorResult {
1354
1348
  interface ReceiptsQueryBuilder {
1355
1349
  /** @param propertyName - Property whose value is compared with `value`.
1356
1350
  * @param value - Value to compare against.
1357
- * @documentationMaturity preview
1358
1351
  */
1359
1352
  eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1360
1353
  /** @param propertyName - Property whose value is compared with `value`.
1361
1354
  * @param value - Value to compare against.
1362
- * @documentationMaturity preview
1363
1355
  */
1364
1356
  ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1365
1357
  /** @param propertyName - Property whose value is compared with `value`.
1366
1358
  * @param value - Value to compare against.
1367
- * @documentationMaturity preview
1368
1359
  */
1369
1360
  ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1370
1361
  /** @param propertyName - Property whose value is compared with `value`.
1371
1362
  * @param value - Value to compare against.
1372
- * @documentationMaturity preview
1373
1363
  */
1374
1364
  gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1375
1365
  /** @param propertyName - Property whose value is compared with `value`.
1376
1366
  * @param value - Value to compare against.
1377
- * @documentationMaturity preview
1378
1367
  */
1379
1368
  le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1380
1369
  /** @param propertyName - Property whose value is compared with `value`.
1381
1370
  * @param value - Value to compare against.
1382
- * @documentationMaturity preview
1383
1371
  */
1384
1372
  lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1385
1373
  /** @param propertyName - Property whose value is compared with `string`.
1386
1374
  * @param string - String to compare against. Case-insensitive.
1387
- * @documentationMaturity preview
1388
1375
  */
1389
1376
  startsWith: (propertyName: '_id' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: string) => ReceiptsQueryBuilder;
1390
1377
  /** @param propertyName - Property whose value is compared with `values`.
1391
1378
  * @param values - List of values to compare against.
1392
- * @documentationMaturity preview
1393
1379
  */
1394
1380
  hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any[]) => ReceiptsQueryBuilder;
1395
- /** @documentationMaturity preview */
1396
1381
  in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1397
- /** @documentationMaturity preview */
1398
1382
  exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: boolean) => ReceiptsQueryBuilder;
1399
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1400
- * @documentationMaturity preview
1401
- */
1383
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
1402
1384
  ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'numbering.displayNumber' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId'>) => ReceiptsQueryBuilder;
1403
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1404
- * @documentationMaturity preview
1405
- */
1385
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
1406
1386
  descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'numbering.displayNumber' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId'>) => ReceiptsQueryBuilder;
1407
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1408
- * @documentationMaturity preview
1409
- */
1387
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
1410
1388
  limit: (limit: number) => ReceiptsQueryBuilder;
1411
- /** @param cursor - A pointer to specific record
1412
- * @documentationMaturity preview
1413
- */
1389
+ /** @param cursor - A pointer to specific record */
1414
1390
  skipTo: (cursor: string) => ReceiptsQueryBuilder;
1415
- /** @documentationMaturity preview */
1416
1391
  find: () => Promise<ReceiptsQueryResult>;
1417
1392
  }
1418
1393
  /**
@@ -1421,7 +1396,6 @@ interface ReceiptsQueryBuilder {
1421
1396
  * Note that you can access a receipt document with an `AVAILABLE` status with the URL provided in `document.downloadUrl` without regenerating.
1422
1397
  * @param receiptId - Receipt ID.
1423
1398
  * @public
1424
- * @documentationMaturity preview
1425
1399
  * @requiredField receiptId
1426
1400
  * @permissionId RECEIPTS.RECEIPT_UPDATE
1427
1401
  * @applicableIdentity APP
@@ -1438,7 +1412,6 @@ declare function regenerateReceiptDocument(receiptId: string): Promise<void & {
1438
1412
  * Note that if the specified contact ID doesn't have an associated email address, the call will fail.
1439
1413
  * @param receiptId - Receipt ID to send.
1440
1414
  * @public
1441
- * @documentationMaturity preview
1442
1415
  * @requiredField receiptId
1443
1416
  * @param options - Field options. The `contactId` object must be passed if one was not already specified upon receipt creation.
1444
1417
  * @permissionId RECEIPTS.RECEIPT_SEND
@@ -1461,7 +1434,6 @@ interface SendReceiptEmailOptions {
1461
1434
  *
1462
1435
  * Receipt numbering is managed in the Receipts Settings API.
1463
1436
  * @public
1464
- * @documentationMaturity preview
1465
1437
  * @param options - Field options.
1466
1438
  * @permissionId RECEIPTS.RECEIPT_READ
1467
1439
  * @applicableIdentity APP
@@ -1481,7 +1453,6 @@ interface GetLatestReceiptNumberOptions {
1481
1453
  * @param _id - ID of the entity to update.
1482
1454
  * @param namespace - Identifier for the app whose extended fields are being updated.
1483
1455
  * @public
1484
- * @documentationMaturity preview
1485
1456
  * @requiredField _id
1486
1457
  * @requiredField namespace
1487
1458
  * @requiredField options