@wix/auto_sdk_get-paid_receipts 1.0.145 → 1.0.147

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.
@@ -1250,7 +1250,6 @@ interface ReceiptCreatedEnvelope {
1250
1250
  * @webhook
1251
1251
  * @eventType wix.receipts.v1.receipt_created
1252
1252
  * @slug created
1253
- * @documentationMaturity preview
1254
1253
  */
1255
1254
  declare function onReceiptCreated(handler: (event: ReceiptCreatedEnvelope) => void | Promise<void>): void;
1256
1255
  interface ReceiptSentEnvelope {
@@ -1267,7 +1266,6 @@ interface ReceiptSentEnvelope {
1267
1266
  * @webhook
1268
1267
  * @eventType wix.receipts.v1.receipt_sent
1269
1268
  * @slug sent
1270
- * @documentationMaturity preview
1271
1269
  */
1272
1270
  declare function onReceiptSent(handler: (event: ReceiptSentEnvelope) => void | Promise<void>): void;
1273
1271
  interface ReceiptUpdatedEnvelope {
@@ -1284,7 +1282,6 @@ interface ReceiptUpdatedEnvelope {
1284
1282
  * @webhook
1285
1283
  * @eventType wix.receipts.v1.receipt_updated
1286
1284
  * @slug updated
1287
- * @documentationMaturity preview
1288
1285
  */
1289
1286
  declare function onReceiptUpdated(handler: (event: ReceiptUpdatedEnvelope) => void | Promise<void>): void;
1290
1287
  /**
@@ -1293,7 +1290,6 @@ declare function onReceiptUpdated(handler: (event: ReceiptUpdatedEnvelope) => vo
1293
1290
  * Receipt number is assigned later and will be provided in the Get Receipt response.
1294
1291
  * @param receipt - Receipt to create.
1295
1292
  * @public
1296
- * @documentationMaturity preview
1297
1293
  * @requiredField receipt
1298
1294
  * @requiredField receipt.currency
1299
1295
  * @requiredField receipt.lineItems
@@ -1327,7 +1323,6 @@ declare function createReceipt(receipt: NonNullablePaths<Receipt, `currency` | `
1327
1323
  * Retrieves a receipt.
1328
1324
  * @param receiptId - Receipt ID.
1329
1325
  * @public
1330
- * @documentationMaturity preview
1331
1326
  * @requiredField receiptId
1332
1327
  * @permissionId RECEIPTS.RECEIPT_READ
1333
1328
  * @applicableIdentity APP
@@ -1338,7 +1333,6 @@ declare function getReceipt(receiptId: string): Promise<NonNullablePaths<Receipt
1338
1333
  /**
1339
1334
  * 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)).
1340
1335
  * @public
1341
- * @documentationMaturity preview
1342
1336
  * @permissionId RECEIPTS.RECEIPT_READ
1343
1337
  * @applicableIdentity APP
1344
1338
  * @fqn wix.receipts.v1.Receipts.QueryReceipts
@@ -1360,65 +1354,46 @@ interface ReceiptsQueryResult extends QueryCursorResult {
1360
1354
  interface ReceiptsQueryBuilder {
1361
1355
  /** @param propertyName - Property whose value is compared with `value`.
1362
1356
  * @param value - Value to compare against.
1363
- * @documentationMaturity preview
1364
1357
  */
1365
1358
  eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1366
1359
  /** @param propertyName - Property whose value is compared with `value`.
1367
1360
  * @param value - Value to compare against.
1368
- * @documentationMaturity preview
1369
1361
  */
1370
1362
  ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1371
1363
  /** @param propertyName - Property whose value is compared with `value`.
1372
1364
  * @param value - Value to compare against.
1373
- * @documentationMaturity preview
1374
1365
  */
1375
1366
  ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1376
1367
  /** @param propertyName - Property whose value is compared with `value`.
1377
1368
  * @param value - Value to compare against.
1378
- * @documentationMaturity preview
1379
1369
  */
1380
1370
  gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1381
1371
  /** @param propertyName - Property whose value is compared with `value`.
1382
1372
  * @param value - Value to compare against.
1383
- * @documentationMaturity preview
1384
1373
  */
1385
1374
  le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1386
1375
  /** @param propertyName - Property whose value is compared with `value`.
1387
1376
  * @param value - Value to compare against.
1388
- * @documentationMaturity preview
1389
1377
  */
1390
1378
  lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1391
1379
  /** @param propertyName - Property whose value is compared with `string`.
1392
1380
  * @param string - String to compare against. Case-insensitive.
1393
- * @documentationMaturity preview
1394
1381
  */
1395
1382
  startsWith: (propertyName: '_id' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: string) => ReceiptsQueryBuilder;
1396
1383
  /** @param propertyName - Property whose value is compared with `values`.
1397
1384
  * @param values - List of values to compare against.
1398
- * @documentationMaturity preview
1399
1385
  */
1400
1386
  hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any[]) => ReceiptsQueryBuilder;
1401
- /** @documentationMaturity preview */
1402
1387
  in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
1403
- /** @documentationMaturity preview */
1404
1388
  exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: boolean) => ReceiptsQueryBuilder;
1405
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1406
- * @documentationMaturity preview
1407
- */
1389
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
1408
1390
  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;
1409
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1410
- * @documentationMaturity preview
1411
- */
1391
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
1412
1392
  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;
1413
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1414
- * @documentationMaturity preview
1415
- */
1393
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
1416
1394
  limit: (limit: number) => ReceiptsQueryBuilder;
1417
- /** @param cursor - A pointer to specific record
1418
- * @documentationMaturity preview
1419
- */
1395
+ /** @param cursor - A pointer to specific record */
1420
1396
  skipTo: (cursor: string) => ReceiptsQueryBuilder;
1421
- /** @documentationMaturity preview */
1422
1397
  find: () => Promise<ReceiptsQueryResult>;
1423
1398
  }
1424
1399
  /**
@@ -1427,7 +1402,6 @@ interface ReceiptsQueryBuilder {
1427
1402
  * Note that you can access a receipt document with an `AVAILABLE` status with the URL provided in `document.downloadUrl` without regenerating.
1428
1403
  * @param receiptId - Receipt ID.
1429
1404
  * @public
1430
- * @documentationMaturity preview
1431
1405
  * @requiredField receiptId
1432
1406
  * @permissionId RECEIPTS.RECEIPT_UPDATE
1433
1407
  * @applicableIdentity APP
@@ -1444,7 +1418,6 @@ declare function regenerateReceiptDocument(receiptId: string): Promise<void & {
1444
1418
  * Note that if the specified contact ID doesn't have an associated email address, the call will fail.
1445
1419
  * @param receiptId - Receipt ID to send.
1446
1420
  * @public
1447
- * @documentationMaturity preview
1448
1421
  * @requiredField receiptId
1449
1422
  * @param options - Field options. The `contactId` object must be passed if one was not already specified upon receipt creation.
1450
1423
  * @permissionId RECEIPTS.RECEIPT_SEND
@@ -1467,7 +1440,6 @@ interface SendReceiptEmailOptions {
1467
1440
  *
1468
1441
  * Receipt numbering is managed in the Receipts Settings API.
1469
1442
  * @public
1470
- * @documentationMaturity preview
1471
1443
  * @param options - Field options.
1472
1444
  * @permissionId RECEIPTS.RECEIPT_READ
1473
1445
  * @applicableIdentity APP
@@ -1487,7 +1459,6 @@ interface GetLatestReceiptNumberOptions {
1487
1459
  * @param _id - ID of the entity to update.
1488
1460
  * @param namespace - Identifier for the app whose extended fields are being updated.
1489
1461
  * @public
1490
- * @documentationMaturity preview
1491
1462
  * @requiredField _id
1492
1463
  * @requiredField namespace
1493
1464
  * @requiredField options