@wix/auto_sdk_payments_tax-documents 1.0.0

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

@@ -0,0 +1,493 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A tax document is a tax-related form that Wix Payments issues to a merchant, such as a US IRS Form 1099-K.
+ * Each tax document belongs to a Wix Payments account and covers a specific period.
+ * When a document's file is available, you can generate a temporary URL to download it as a PDF.
+ */
+interface TaxDocument {
+    /**
+     * Tax document ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Date and time the tax document was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the tax document was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Revision number, which increments by 1 each time the tax document is updated.
+     * @readonly
+     */
+    revision?: string;
+    /**
+     * ID of the Wix Payments account the tax document belongs to.
+     * @format GUID
+     * @immutable
+     */
+    accountId?: string;
+    /**
+     * Type of tax document.
+     * @immutable
+     */
+    type?: TaxDocumentTypeWithLiterals;
+    /**
+     * Period the tax document covers.
+     * @immutable
+     */
+    period?: TaxPeriod;
+    /**
+     * Whether a file is available to download for the tax document. When `false`, calling Generate File Download Info returns an error.
+     *
+     * At least one of `downloadable` and `problematic` is always `true`.
+     */
+    downloadable?: boolean;
+    /**
+     * Whether a problem was found with the tax document's file, for example incorrect data that's being corrected.
+     *
+     * At least one of `downloadable` and `problematic` is always `true`, and both can be `true` at the same time.
+     */
+    problematic?: boolean;
+    /**
+     * How the tax document's amounts are aggregated.
+     * @readonly
+     */
+    sourceType?: SourceTypeWithLiterals;
+    /**
+     * Human-readable name for the tax document's file.
+     * @readonly
+     * @minLength 1
+     * @maxLength 1000
+     */
+    displayName?: string | null;
+}
+/** Type of tax document. */
+declare enum TaxDocumentType {
+    /** US IRS Form 1099-K. */
+    FORM_1099_K = "FORM_1099_K"
+}
+/** @enumType */
+type TaxDocumentTypeWithLiterals = TaxDocumentType | 'FORM_1099_K';
+interface TaxPeriod extends TaxPeriodOptionsOneOf {
+    /** The tax document covers a full calendar year. */
+    yearPeriod?: YearPeriod;
+}
+/** @oneof */
+interface TaxPeriodOptionsOneOf {
+    /** The tax document covers a full calendar year. */
+    yearPeriod?: YearPeriod;
+}
+interface YearPeriod {
+    /** Calendar year the tax document covers. For example, `2024`. */
+    year?: number;
+}
+/** Source of data for tax document. */
+declare enum SourceType {
+    /** Amounts are aggregated by payment date. */
+    PAYMENT = "PAYMENT",
+    /** Amounts are aggregated by payout date. */
+    PAYOUT = "PAYOUT"
+}
+/** @enumType */
+type SourceTypeWithLiterals = SourceType | 'PAYMENT' | 'PAYOUT';
+interface GetTaxDocumentFileHistoryRequest {
+    /**
+     * Id of a tax document.
+     * @format GUID
+     */
+    taxDocumentId?: string;
+}
+interface GetTaxDocumentFileHistoryResponse {
+    /** Tax document history. */
+    taxDocumentFileHistory?: TaxDocumentFileHistory;
+}
+interface TaxDocumentFileHistory {
+    /**
+     * Tax document identifier.
+     * @format GUID
+     */
+    taxDocumentId?: string;
+    /**
+     * File history records which correspond to file versions for this tax document.
+     * Includes current file version, if it exists.
+     * Sorted in descending order by `created_date`.
+     * @maxSize 100
+     */
+    records?: TaxDocumentFileHistoryRecord[];
+}
+interface TaxDocumentFileHistoryRecord {
+    /**
+     * History record identifier.
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * Date when tax document file was uploaded.
+     * History record is created at the same moment.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+}
+interface GenerateHistoryFileDownloadInfoRequest {
+    /**
+     * Tax document to download a file for.
+     * @format GUID
+     */
+    taxDocumentId?: string;
+    /**
+     * Tax document history record to download a file for.
+     * @format GUID
+     */
+    taxDocumentFileHistoryRecordId?: string;
+}
+interface GenerateHistoryFileDownloadInfoResponse {
+    /** Information used to download a file. */
+    downloadInfo?: string;
+}
+interface UpdateTaxDocumentRequest {
+    /** Tax document to update. */
+    taxDocument?: TaxDocument;
+}
+interface UpdateTaxDocumentResponse {
+    /** Updated tax document. */
+    taxDocument?: TaxDocument;
+}
+interface RefreshTaxDocumentFileRequest {
+    /**
+     * Tax document to be updated.
+     * @format GUID
+     */
+    taxDocumentId?: string;
+    /** Flag represents whether ping notification to user should be sent if the tax document is successfully updated. */
+    notifyOnSuccess?: boolean;
+}
+interface RefreshTaxDocumentFileResponse {
+    /** Latest version of the tax document. */
+    taxDocument?: TaxDocument;
+    /** Represents whether the document was updated. */
+    updated?: boolean;
+}
+interface GenerateFileUploadTargetRequest {
+    /**
+     * Tax document for file upload.
+     * @format GUID
+     */
+    taxDocumentId?: string;
+}
+interface GenerateFileUploadTargetResponse {
+    /** Upload target. */
+    uploadTarget?: FileUploadTarget;
+}
+interface FileUploadTarget {
+    /**
+     * File upload URL.
+     * @format WEB_URL
+     */
+    uploadUrl?: string;
+    /**
+     * File upload token.
+     * @minLength 1
+     * @maxLength 1000
+     */
+    uploadToken?: string;
+}
+interface ConfirmFileUploadedRequest {
+    /**
+     * Tax document for which there was a successful upload.
+     * @format GUID
+     */
+    taxDocumentId?: string;
+}
+interface ConfirmFileUploadedResponse {
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface GetTaxDocumentRequest {
+    /**
+     * ID of the tax document to retrieve.
+     * @format GUID
+     */
+    taxDocumentId: string;
+}
+interface GetTaxDocumentResponse {
+    /** Retrieved tax document. */
+    taxDocument?: TaxDocument;
+}
+interface ListTaxDocumentsRequest {
+    /**
+     * ID of the Wix Payments account whose tax documents are retrieved.
+     * @format GUID
+     */
+    accountId: string | null;
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+    /** Filters the retrieved tax documents by type. When omitted, tax documents of all types are returned. */
+    type?: TaxDocumentTypeWithLiterals;
+}
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface ListTaxDocumentsResponse {
+    /** Retrieved tax documents. */
+    taxDocuments?: TaxDocument[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /**
+     * Cursor pointing to next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface GenerateFileDownloadInfoRequest {
+    /**
+     * ID of the tax document to download a file for.
+     * @format GUID
+     */
+    taxDocumentId: string;
+}
+interface GenerateFileDownloadInfoResponse {
+    /** Information for downloading the tax document's file. */
+    downloadInfo?: string;
+}
+/**
+ * Retrieves a tax document by ID.
+ * @param taxDocumentId - ID of the tax document to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField taxDocumentId
+ * @permissionId PAYMENTS.TAX_DOCUMENT_READ
+ * @applicableIdentity APP
+ * @returns Retrieved tax document.
+ * @fqn wix.payments.tax_documents.v1.TaxDocumentsService.GetTaxDocument
+ */
+declare function getTaxDocument(taxDocumentId: string): Promise<NonNullablePaths<TaxDocument, `revision` | `accountId` | `type` | `period.yearPeriod.year` | `downloadable` | `problematic` | `sourceType`, 4>>;
+/**
+ * Retrieves a list of tax documents that belong to a Wix Payments account.
+ *
+ * You must specify the `accountId` of the account whose tax documents you want to retrieve.
+ *
+ * Tax documents are sorted in descending order by `period`, then by `createdDate`.
+ *
+ * When `type` is omitted, tax documents of all types are returned.
+ * @param accountId - ID of the Wix Payments account whose tax documents are retrieved.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField accountId
+ * @permissionId PAYMENTS.TAX_DOCUMENT_READ
+ * @applicableIdentity APP
+ * @fqn wix.payments.tax_documents.v1.TaxDocumentsService.ListTaxDocuments
+ */
+declare function listTaxDocuments(accountId: string, options?: ListTaxDocumentsOptions): Promise<NonNullablePaths<ListTaxDocumentsResponse, `taxDocuments` | `taxDocuments.${number}.revision` | `taxDocuments.${number}.accountId` | `taxDocuments.${number}.type` | `taxDocuments.${number}.period.yearPeriod.year` | `taxDocuments.${number}.downloadable` | `taxDocuments.${number}.problematic` | `taxDocuments.${number}.sourceType`, 6>>;
+interface ListTaxDocumentsOptions {
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+    /** Filters the retrieved tax documents by type. When omitted, tax documents of all types are returned. */
+    type?: TaxDocumentTypeWithLiterals;
+}
+/**
+ * Generates temporary information for downloading a tax document's file.
+ *
+ * The returned `downloadInfo.url` is a temporary link to a PDF. It expires 10 seconds after it's generated, so follow it immediately, and don't store it as a static link. Call this method again to get a fresh URL.
+ *
+ * The tax document must have a file available, meaning its `downloadable` field is `true`.
+ * @param taxDocumentId - ID of the tax document to download a file for.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField taxDocumentId
+ * @permissionId PAYMENTS.TAX_DOCUMENT_DOWNLOAD
+ * @applicableIdentity APP
+ * @fqn wix.payments.tax_documents.v1.TaxDocumentsService.GenerateFileDownloadInfo
+ */
+declare function generateFileDownloadInfo(taxDocumentId: string): Promise<GenerateFileDownloadInfoResponse>;
+
+export { type AccountInfo, type ActionEvent, type ConfirmFileUploadedRequest, type ConfirmFileUploadedResponse, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FileUploadTarget, type GenerateFileDownloadInfoRequest, type GenerateFileDownloadInfoResponse, type GenerateFileUploadTargetRequest, type GenerateFileUploadTargetResponse, type GenerateHistoryFileDownloadInfoRequest, type GenerateHistoryFileDownloadInfoResponse, type GetTaxDocumentFileHistoryRequest, type GetTaxDocumentFileHistoryResponse, type GetTaxDocumentRequest, type GetTaxDocumentResponse, type IdentificationData, type IdentificationDataIdOneOf, type ListTaxDocumentsOptions, type ListTaxDocumentsRequest, type ListTaxDocumentsResponse, type MessageEnvelope, type PagingMetadataV2, type RefreshTaxDocumentFileRequest, type RefreshTaxDocumentFileResponse, type RestoreInfo, SourceType, type SourceTypeWithLiterals, type TaxDocument, type TaxDocumentFileHistory, type TaxDocumentFileHistoryRecord, TaxDocumentType, type TaxDocumentTypeWithLiterals, type TaxPeriod, type TaxPeriodOptionsOneOf, type UpdateTaxDocumentRequest, type UpdateTaxDocumentResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type YearPeriod, generateFileDownloadInfo, getTaxDocument, listTaxDocuments };