@wix/auto_sdk_get-paid_receipts 1.0.39 → 1.0.41

package/build/index.d.mts

@@ -0,0 +1,100 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { R as Receipt, a as ReceiptsQueryBuilder, S as SendReceiptEmailOptions, G as GetLatestReceiptNumberOptions, b as GetLatestReceiptNumberResponse, U as UpdateExtendedFieldsOptions, c as UpdateExtendedFieldsResponse, d as ReceiptCreatedEnvelope, e as ReceiptSentEnvelope, f as ReceiptUpdatedEnvelope } from './receipts-v1-receipt-receipts.universal-CA4WcjFe.mjs';
+export { a5 as ActionEvent, E as AdditionalFee, H as AdditionalFeeTax, A as Address, r as AddressLocation, p as AddressStreetOneOf, az as BaseEventMetadata, B as BusinessDetails, ag as CreateReceiptRequest, ah as CreateReceiptResponse, ao as CursorPaging, aq as CursorPagingMetadata, al as CursorQuery, am as CursorQueryPagingMethodOneOf, ar as Cursors, M as CustomField, K as CustomFields, C as Customer, I as Discount, Q as Document, D as DocumentStatus, $ as DomainEvent, a0 as DomainEventBodyOneOf, ay as Empty, a1 as EntityCreatedEvent, a4 as EntityDeletedEvent, a3 as EntityUpdatedEvent, aA as EventMetadata, X as ExtendedFields, ae as Failed, O as FooterCustomField, F as FullAddressContactDetails, af as GenerateReceiptDocument, aw as GetLatestReceiptNumberRequest, ai as GetReceiptRequest, aj as GetReceiptResponse, a7 as IdentificationData, a8 as IdentificationDataIdOneOf, v as LineItem, w as LineItemTax, x as LineItemTotals, L as Locale, a6 as MessageEnvelope, N as Numbering, P as Payment, ak as QueryReceiptsRequest, ap as QueryReceiptsResponse, ab as ReceiptDocumentHandled, ac as ReceiptDocumentHandledResultOneOf, a9 as ReceiptDocumentProcess, aa as ReceiptNumberingProcess, g as ReceiptOrderType, aB as ReceiptsQueryResult, as as RegenerateReceiptDocumentRequest, at as RegenerateReceiptDocumentResponse, k as RegionalProperties, i as RequestOrigin, a2 as RestoreInfo, au as SendReceiptEmailRequest, av as SendReceiptEmailResponse, Y as Sent, y as ShippingInfo, z as ShippingTax, j as SortOrder, an as Sorting, l as SourceReference, m as SourceReferenceOrderOneOf, t as StandardDetails, q as StreetAddress, s as Subdivision, h as SubdivisionType, ad as Succeeded, J as Tax, T as Totals, ax as UpdateExtendedFieldsRequest, Z as UpdateReceiptRequest, _ as UpdateReceiptResponse, u as VatId, V as VatType, W as WebhookIdentityType, o as WixEcom, n as WixPayment } from './receipts-v1-receipt-receipts.universal-CA4WcjFe.mjs';
+
+declare function createReceipt$1(httpClient: HttpClient): CreateReceiptSignature;
+interface CreateReceiptSignature {
+    /**
+     * Creates a receipt.
+     *
+     * Receipt number is assigned later and will be provided in the Get Receipt response.
+     * @param - Receipt to create.
+     * @returns Created receipt.
+     */
+    (receipt: Receipt): Promise<Receipt>;
+}
+declare function getReceipt$1(httpClient: HttpClient): GetReceiptSignature;
+interface GetReceiptSignature {
+    /**
+     * Retrieves a receipt.
+     * @param - Receipt ID.
+     * @returns Requested receipt.
+     */
+    (receiptId: string): Promise<Receipt>;
+}
+declare function queryReceipts$1(httpClient: HttpClient): QueryReceiptsSignature;
+interface QueryReceiptsSignature {
+    /**
+     * 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)).
+     */
+    (): ReceiptsQueryBuilder;
+}
+declare function regenerateReceiptDocument$1(httpClient: HttpClient): RegenerateReceiptDocumentSignature;
+interface RegenerateReceiptDocumentSignature {
+    /**
+     * Retries generating a receipt document that has a `FAILED` status.
+     *
+     * Note that you can access a receipt document with an `AVAILABLE` status with the URL provided in `document.downloadUrl` without regenerating.
+     * @param - Receipt ID.
+     */
+    (receiptId: string): Promise<void>;
+}
+declare function sendReceiptEmail$1(httpClient: HttpClient): SendReceiptEmailSignature;
+interface SendReceiptEmailSignature {
+    /**
+     * Sends the receipt to the specified recipient in an email.
+     *
+     * Specifying a contact ID is required only when no contact ID was specified upon receipt creation.
+     *
+     * Note that if the specified contact ID doesn't have an associated email address, the call will fail.
+     * @param - Receipt ID to send.
+     * @param - Field options. The `contactId` object must be passed if one was not already specified upon receipt creation.
+     */
+    (receiptId: string, options?: SendReceiptEmailOptions | undefined): Promise<void>;
+}
+declare function getLatestReceiptNumber$1(httpClient: HttpClient): GetLatestReceiptNumberSignature;
+interface GetLatestReceiptNumberSignature {
+    /**
+     * Retrieves the highest receipt number currently in use (the sequential identifier displayed between the prefix and suffix in receipt display numbers).
+     * Can be filtered by prefix.
+     *
+     * Receipt numbering is managed in the Receipts Settings API.
+     * @param - Field options.
+     */
+    (options?: GetLatestReceiptNumberOptions | undefined): Promise<GetLatestReceiptNumberResponse>;
+}
+declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
+interface UpdateExtendedFieldsSignature {
+    /**
+     * Updates extended fields of a receipt, without incrementing revision.
+     * @param - ID of the entity to update.
+     * @param - Identifier for the app whose extended fields are being updated.
+     * @param - Field options. The `namespaceData` object **must** be passed.
+     */
+    (_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse>;
+}
+declare const onReceiptCreated$1: EventDefinition<ReceiptCreatedEnvelope, "wix.receipts.v1.receipt_created">;
+declare const onReceiptSent$1: EventDefinition<ReceiptSentEnvelope, "wix.receipts.v1.receipt_sent">;
+declare const onReceiptUpdated$1: EventDefinition<ReceiptUpdatedEnvelope, "wix.receipts.v1.receipt_updated">;
+
+declare const createReceipt: MaybeContext<BuildRESTFunction<typeof createReceipt$1> & typeof createReceipt$1>;
+declare const getReceipt: MaybeContext<BuildRESTFunction<typeof getReceipt$1> & typeof getReceipt$1>;
+declare const queryReceipts: MaybeContext<BuildRESTFunction<typeof queryReceipts$1> & typeof queryReceipts$1>;
+declare const regenerateReceiptDocument: MaybeContext<BuildRESTFunction<typeof regenerateReceiptDocument$1> & typeof regenerateReceiptDocument$1>;
+declare const sendReceiptEmail: MaybeContext<BuildRESTFunction<typeof sendReceiptEmail$1> & typeof sendReceiptEmail$1>;
+declare const getLatestReceiptNumber: MaybeContext<BuildRESTFunction<typeof getLatestReceiptNumber$1> & typeof getLatestReceiptNumber$1>;
+declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
+/**
+ * Triggered when a receipt is created.
+ */
+declare const onReceiptCreated: BuildEventDefinition<typeof onReceiptCreated$1>;
+/**
+ * Triggered when a receipt is sent.
+ */
+declare const onReceiptSent: BuildEventDefinition<typeof onReceiptSent$1>;
+/**
+ * Triggered when a receipt's number allocation is updated or a receipt document is generated.
+ */
+declare const onReceiptUpdated: BuildEventDefinition<typeof onReceiptUpdated$1>;
+
+export { GetLatestReceiptNumberOptions, GetLatestReceiptNumberResponse, Receipt, ReceiptCreatedEnvelope, ReceiptSentEnvelope, ReceiptUpdatedEnvelope, ReceiptsQueryBuilder, SendReceiptEmailOptions, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, createReceipt, getLatestReceiptNumber, getReceipt, onReceiptCreated, onReceiptSent, onReceiptUpdated, queryReceipts, regenerateReceiptDocument, sendReceiptEmail, updateExtendedFields };

package/build/index.d.ts

@@ -0,0 +1,100 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { R as Receipt, a as ReceiptsQueryBuilder, S as SendReceiptEmailOptions, G as GetLatestReceiptNumberOptions, b as GetLatestReceiptNumberResponse, U as UpdateExtendedFieldsOptions, c as UpdateExtendedFieldsResponse, d as ReceiptCreatedEnvelope, e as ReceiptSentEnvelope, f as ReceiptUpdatedEnvelope } from './receipts-v1-receipt-receipts.universal-CA4WcjFe.js';
+export { a5 as ActionEvent, E as AdditionalFee, H as AdditionalFeeTax, A as Address, r as AddressLocation, p as AddressStreetOneOf, az as BaseEventMetadata, B as BusinessDetails, ag as CreateReceiptRequest, ah as CreateReceiptResponse, ao as CursorPaging, aq as CursorPagingMetadata, al as CursorQuery, am as CursorQueryPagingMethodOneOf, ar as Cursors, M as CustomField, K as CustomFields, C as Customer, I as Discount, Q as Document, D as DocumentStatus, $ as DomainEvent, a0 as DomainEventBodyOneOf, ay as Empty, a1 as EntityCreatedEvent, a4 as EntityDeletedEvent, a3 as EntityUpdatedEvent, aA as EventMetadata, X as ExtendedFields, ae as Failed, O as FooterCustomField, F as FullAddressContactDetails, af as GenerateReceiptDocument, aw as GetLatestReceiptNumberRequest, ai as GetReceiptRequest, aj as GetReceiptResponse, a7 as IdentificationData, a8 as IdentificationDataIdOneOf, v as LineItem, w as LineItemTax, x as LineItemTotals, L as Locale, a6 as MessageEnvelope, N as Numbering, P as Payment, ak as QueryReceiptsRequest, ap as QueryReceiptsResponse, ab as ReceiptDocumentHandled, ac as ReceiptDocumentHandledResultOneOf, a9 as ReceiptDocumentProcess, aa as ReceiptNumberingProcess, g as ReceiptOrderType, aB as ReceiptsQueryResult, as as RegenerateReceiptDocumentRequest, at as RegenerateReceiptDocumentResponse, k as RegionalProperties, i as RequestOrigin, a2 as RestoreInfo, au as SendReceiptEmailRequest, av as SendReceiptEmailResponse, Y as Sent, y as ShippingInfo, z as ShippingTax, j as SortOrder, an as Sorting, l as SourceReference, m as SourceReferenceOrderOneOf, t as StandardDetails, q as StreetAddress, s as Subdivision, h as SubdivisionType, ad as Succeeded, J as Tax, T as Totals, ax as UpdateExtendedFieldsRequest, Z as UpdateReceiptRequest, _ as UpdateReceiptResponse, u as VatId, V as VatType, W as WebhookIdentityType, o as WixEcom, n as WixPayment } from './receipts-v1-receipt-receipts.universal-CA4WcjFe.js';
+
+declare function createReceipt$1(httpClient: HttpClient): CreateReceiptSignature;
+interface CreateReceiptSignature {
+    /**
+     * Creates a receipt.
+     *
+     * Receipt number is assigned later and will be provided in the Get Receipt response.
+     * @param - Receipt to create.
+     * @returns Created receipt.
+     */
+    (receipt: Receipt): Promise<Receipt>;
+}
+declare function getReceipt$1(httpClient: HttpClient): GetReceiptSignature;
+interface GetReceiptSignature {
+    /**
+     * Retrieves a receipt.
+     * @param - Receipt ID.
+     * @returns Requested receipt.
+     */
+    (receiptId: string): Promise<Receipt>;
+}
+declare function queryReceipts$1(httpClient: HttpClient): QueryReceiptsSignature;
+interface QueryReceiptsSignature {
+    /**
+     * 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)).
+     */
+    (): ReceiptsQueryBuilder;
+}
+declare function regenerateReceiptDocument$1(httpClient: HttpClient): RegenerateReceiptDocumentSignature;
+interface RegenerateReceiptDocumentSignature {
+    /**
+     * Retries generating a receipt document that has a `FAILED` status.
+     *
+     * Note that you can access a receipt document with an `AVAILABLE` status with the URL provided in `document.downloadUrl` without regenerating.
+     * @param - Receipt ID.
+     */
+    (receiptId: string): Promise<void>;
+}
+declare function sendReceiptEmail$1(httpClient: HttpClient): SendReceiptEmailSignature;
+interface SendReceiptEmailSignature {
+    /**
+     * Sends the receipt to the specified recipient in an email.
+     *
+     * Specifying a contact ID is required only when no contact ID was specified upon receipt creation.
+     *
+     * Note that if the specified contact ID doesn't have an associated email address, the call will fail.
+     * @param - Receipt ID to send.
+     * @param - Field options. The `contactId` object must be passed if one was not already specified upon receipt creation.
+     */
+    (receiptId: string, options?: SendReceiptEmailOptions | undefined): Promise<void>;
+}
+declare function getLatestReceiptNumber$1(httpClient: HttpClient): GetLatestReceiptNumberSignature;
+interface GetLatestReceiptNumberSignature {
+    /**
+     * Retrieves the highest receipt number currently in use (the sequential identifier displayed between the prefix and suffix in receipt display numbers).
+     * Can be filtered by prefix.
+     *
+     * Receipt numbering is managed in the Receipts Settings API.
+     * @param - Field options.
+     */
+    (options?: GetLatestReceiptNumberOptions | undefined): Promise<GetLatestReceiptNumberResponse>;
+}
+declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
+interface UpdateExtendedFieldsSignature {
+    /**
+     * Updates extended fields of a receipt, without incrementing revision.
+     * @param - ID of the entity to update.
+     * @param - Identifier for the app whose extended fields are being updated.
+     * @param - Field options. The `namespaceData` object **must** be passed.
+     */
+    (_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse>;
+}
+declare const onReceiptCreated$1: EventDefinition<ReceiptCreatedEnvelope, "wix.receipts.v1.receipt_created">;
+declare const onReceiptSent$1: EventDefinition<ReceiptSentEnvelope, "wix.receipts.v1.receipt_sent">;
+declare const onReceiptUpdated$1: EventDefinition<ReceiptUpdatedEnvelope, "wix.receipts.v1.receipt_updated">;
+
+declare const createReceipt: MaybeContext<BuildRESTFunction<typeof createReceipt$1> & typeof createReceipt$1>;
+declare const getReceipt: MaybeContext<BuildRESTFunction<typeof getReceipt$1> & typeof getReceipt$1>;
+declare const queryReceipts: MaybeContext<BuildRESTFunction<typeof queryReceipts$1> & typeof queryReceipts$1>;
+declare const regenerateReceiptDocument: MaybeContext<BuildRESTFunction<typeof regenerateReceiptDocument$1> & typeof regenerateReceiptDocument$1>;
+declare const sendReceiptEmail: MaybeContext<BuildRESTFunction<typeof sendReceiptEmail$1> & typeof sendReceiptEmail$1>;
+declare const getLatestReceiptNumber: MaybeContext<BuildRESTFunction<typeof getLatestReceiptNumber$1> & typeof getLatestReceiptNumber$1>;
+declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
+/**
+ * Triggered when a receipt is created.
+ */
+declare const onReceiptCreated: BuildEventDefinition<typeof onReceiptCreated$1>;
+/**
+ * Triggered when a receipt is sent.
+ */
+declare const onReceiptSent: BuildEventDefinition<typeof onReceiptSent$1>;
+/**
+ * Triggered when a receipt's number allocation is updated or a receipt document is generated.
+ */
+declare const onReceiptUpdated: BuildEventDefinition<typeof onReceiptUpdated$1>;
+
+export { GetLatestReceiptNumberOptions, GetLatestReceiptNumberResponse, Receipt, ReceiptCreatedEnvelope, ReceiptSentEnvelope, ReceiptUpdatedEnvelope, ReceiptsQueryBuilder, SendReceiptEmailOptions, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, createReceipt, getLatestReceiptNumber, getReceipt, onReceiptCreated, onReceiptSent, onReceiptUpdated, queryReceipts, regenerateReceiptDocument, sendReceiptEmail, updateExtendedFields };