@wix/auto_sdk_get-paid_receipts 1.0.145 → 1.0.146

package/build/internal/cjs/index.typings.d.ts

@@ -1244,13 +1244,10 @@ interface ReceiptCreatedEnvelope {
  * Triggered when a receipt is created.
  * @permissionScope Manage Receipts
  * @permissionScopeId SCOPE.RECEIPTS.MANAGE
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionId RECEIPTS.RECEIPT_READ
  * @webhook
  * @eventType wix.receipts.v1.receipt_created
  * @slug created
- * @documentationMaturity preview
  */
 declare function onReceiptCreated(handler: (event: ReceiptCreatedEnvelope) => void | Promise<void>): void;
 interface ReceiptSentEnvelope {
@@ -1261,13 +1258,10 @@ interface ReceiptSentEnvelope {
  * Triggered when a receipt is sent.
  * @permissionScope Manage Receipts
  * @permissionScopeId SCOPE.RECEIPTS.MANAGE
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionId RECEIPTS.RECEIPT_READ
  * @webhook
  * @eventType wix.receipts.v1.receipt_sent
  * @slug sent
- * @documentationMaturity preview
  */
 declare function onReceiptSent(handler: (event: ReceiptSentEnvelope) => void | Promise<void>): void;
 interface ReceiptUpdatedEnvelope {
@@ -1278,13 +1272,10 @@ interface ReceiptUpdatedEnvelope {
  * Triggered when a receipt's number allocation is updated or a receipt document is generated.
  * @permissionScope Manage Receipts
  * @permissionScopeId SCOPE.RECEIPTS.MANAGE
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionId RECEIPTS.RECEIPT_READ
  * @webhook
  * @eventType wix.receipts.v1.receipt_updated
  * @slug updated
- * @documentationMaturity preview
  */
 declare function onReceiptUpdated(handler: (event: ReceiptUpdatedEnvelope) => void | Promise<void>): void;
 /**
@@ -1293,7 +1284,6 @@ declare function onReceiptUpdated(handler: (event: ReceiptUpdatedEnvelope) => vo
  * Receipt number is assigned later and will be provided in the Get Receipt response.
  * @param receipt - Receipt to create.
  * @public
- * @documentationMaturity preview
  * @requiredField receipt
  * @requiredField receipt.currency
  * @requiredField receipt.lineItems
@@ -1327,7 +1317,6 @@ declare function createReceipt(receipt: NonNullablePaths<Receipt, `currency` | `
  * Retrieves a receipt.
  * @param receiptId - Receipt ID.
  * @public
- * @documentationMaturity preview
  * @requiredField receiptId
  * @permissionId RECEIPTS.RECEIPT_READ
  * @applicableIdentity APP
@@ -1338,7 +1327,6 @@ declare function getReceipt(receiptId: string): Promise<NonNullablePaths<Receipt
 /**
  * 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)).
  * @public
- * @documentationMaturity preview
  * @permissionId RECEIPTS.RECEIPT_READ
  * @applicableIdentity APP
  * @fqn wix.receipts.v1.Receipts.QueryReceipts
@@ -1360,65 +1348,46 @@ interface ReceiptsQueryResult extends QueryCursorResult {
 interface ReceiptsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
      */
     startsWith: (propertyName: '_id' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: string) => ReceiptsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
-     * @documentationMaturity preview
      */
     hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any[]) => ReceiptsQueryBuilder;
-    /** @documentationMaturity preview */
     in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
-    /** @documentationMaturity preview */
     exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.wixPaymentOrder.transactionId' | 'sourceReference.wixEcomOrder.transactionId' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: boolean) => ReceiptsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     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;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     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;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => ReceiptsQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
+    /** @param cursor - A pointer to specific record */
     skipTo: (cursor: string) => ReceiptsQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<ReceiptsQueryResult>;
 }
 /**
@@ -1427,7 +1396,6 @@ interface ReceiptsQueryBuilder {
  * Note that you can access a receipt document with an `AVAILABLE` status with the URL provided in `document.downloadUrl` without regenerating.
  * @param receiptId - Receipt ID.
  * @public
- * @documentationMaturity preview
  * @requiredField receiptId
  * @permissionId RECEIPTS.RECEIPT_UPDATE
  * @applicableIdentity APP
@@ -1444,7 +1412,6 @@ declare function regenerateReceiptDocument(receiptId: string): Promise<void & {
  * Note that if the specified contact ID doesn't have an associated email address, the call will fail.
  * @param receiptId - Receipt ID to send.
  * @public
- * @documentationMaturity preview
  * @requiredField receiptId
  * @param options - Field options. The `contactId` object must be passed if one was not already specified upon receipt creation.
  * @permissionId RECEIPTS.RECEIPT_SEND
@@ -1467,7 +1434,6 @@ interface SendReceiptEmailOptions {
  *
  * Receipt numbering is managed in the Receipts Settings API.
  * @public
- * @documentationMaturity preview
  * @param options - Field options.
  * @permissionId RECEIPTS.RECEIPT_READ
  * @applicableIdentity APP
@@ -1487,7 +1453,6 @@ interface GetLatestReceiptNumberOptions {
  * @param _id - ID of the entity to update.
  * @param namespace - Identifier for the app whose extended fields are being updated.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField namespace
  * @requiredField options