@wix/auto_sdk_payments_payment-acceptance-configurations 1.0.7 → 1.0.8

package/build/internal/{payments-payment-acceptance-configurations-v1-payment-acceptance-configuration-payment-acceptance-configurations.universal-jqObRsin.d.ts → es/src/payments-payment-acceptance-configurations-v1-payment-acceptance-configuration-payment-acceptance-configurations.universal.d.ts}

@@ -1,5 +1,6 @@
+import { NonNullablePaths } from '@wix/sdk-types';
 /** PaymentAcceptanceConfiguration */
-interface PaymentAcceptanceConfiguration {
+export interface PaymentAcceptanceConfiguration {
     /**
      * id
      * @format GUID
@@ -39,7 +40,7 @@ interface PaymentAcceptanceConfiguration {
     /** Tags */
     tags?: Tags;
 }
-interface PaymentAcceptanceRule {
+export interface PaymentAcceptanceRule {
     /**
      * payment_method_type_id
      * @format GUID
@@ -53,7 +54,7 @@ interface PaymentAcceptanceRule {
     /** merchant_enabled */
     merchantEnabled?: boolean;
 }
-interface ExtendedFields {
+export interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -86,11 +87,11 @@ interface ExtendedFields {
  * }
  * }
  */
-interface Tags {
+export interface Tags {
     /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
     tags?: TagList;
 }
-interface TagList {
+export interface TagList {
     /**
      * List of tag IDs
      * @maxSize 100
@@ -98,47 +99,47 @@ interface TagList {
      */
     tagIds?: string[];
 }
-interface CreatePaymentAcceptanceConfigurationRequest {
+export interface CreatePaymentAcceptanceConfigurationRequest {
     /** PaymentAcceptanceConfiguration to be created. */
     paymentAcceptanceConfiguration: PaymentAcceptanceConfiguration;
 }
-interface CreatePaymentAcceptanceConfigurationResponse {
+export interface CreatePaymentAcceptanceConfigurationResponse {
     /** The created PaymentAcceptanceConfiguration. */
     paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
 }
-interface GetPaymentAcceptanceConfigurationRequest {
+export interface GetPaymentAcceptanceConfigurationRequest {
     /**
      * ID of the PaymentAcceptanceConfiguration to retrieve.
      * @format GUID
      */
     paymentAcceptanceConfigurationId: string;
 }
-interface GetPaymentAcceptanceConfigurationResponse {
+export interface GetPaymentAcceptanceConfigurationResponse {
     /** The requested PaymentAcceptanceConfiguration. */
     paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
 }
-interface UpdatePaymentAcceptanceConfigurationRequest {
+export interface UpdatePaymentAcceptanceConfigurationRequest {
     /** PaymentAcceptanceConfiguration to be updated, may be partial. */
     paymentAcceptanceConfiguration: PaymentAcceptanceConfiguration;
 }
-interface UpdatePaymentAcceptanceConfigurationResponse {
+export interface UpdatePaymentAcceptanceConfigurationResponse {
     /** Updated PaymentAcceptanceConfiguration. */
     paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
 }
-interface DeletePaymentAcceptanceConfigurationRequest {
+export interface DeletePaymentAcceptanceConfigurationRequest {
     /**
      * Id of payment acceptance configuration to delete
      * @format GUID
      */
     paymentAcceptanceConfigurationId: string;
 }
-interface DeletePaymentAcceptanceConfigurationResponse {
+export interface DeletePaymentAcceptanceConfigurationResponse {
 }
-interface QueryPaymentAcceptanceConfigurationsRequest {
+export interface QueryPaymentAcceptanceConfigurationsRequest {
     /** WQL expression. */
     query?: CursorQuery;
 }
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
@@ -158,11 +159,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface CursorQueryPagingMethodOneOf {
+export interface CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -171,11 +172,11 @@ interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -190,13 +191,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryPaymentAcceptanceConfigurationsResponse {
+export interface QueryPaymentAcceptanceConfigurationsResponse {
     /** List of PaymentAcceptanceConfigurations. */
     paymentAcceptanceConfigurations?: PaymentAcceptanceConfiguration[];
     /** Paging metadata */
     pagingMetadata?: CursorPagingMetadata;
 }
-interface CursorPagingMetadata {
+export interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -209,7 +210,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -221,7 +222,7 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface BulkUpdatePaymentAcceptanceConfigurationTagsRequest {
+export interface BulkUpdatePaymentAcceptanceConfigurationTagsRequest {
     /**
      * List of NileProtoTagsEntities that their tags will update.
      * @minSize 1
@@ -234,7 +235,7 @@ interface BulkUpdatePaymentAcceptanceConfigurationTagsRequest {
     /** List of Tags to unAssign */
     unassignTags?: Tags;
 }
-interface BulkUpdatePaymentAcceptanceConfigurationTagsResponse {
+export interface BulkUpdatePaymentAcceptanceConfigurationTagsResponse {
     /**
      * Results
      * @minSize 1
@@ -244,7 +245,7 @@ interface BulkUpdatePaymentAcceptanceConfigurationTagsResponse {
     /** Metadata regarding the bulk update operation */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface ItemMetadata {
+export interface ItemMetadata {
     /**
      * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
      * @format GUID
@@ -257,7 +258,7 @@ interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-interface ApplicationError {
+export interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -265,11 +266,11 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface BulkUpdatePaymentAcceptanceConfigurationTagsResult {
+export interface BulkUpdatePaymentAcceptanceConfigurationTagsResult {
     /** Metadata regarding the specific single update operation */
     itemMetadata?: ItemMetadata;
 }
-interface BulkActionMetadata {
+export interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -277,7 +278,7 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest {
+export interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest {
     /** Filter */
     filter: Record<string, any> | null;
     /** List of Tags to assign */
@@ -285,14 +286,14 @@ interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest {
     /** List of Tags to unAssign */
     unassignTags?: Tags;
 }
-interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse {
+export interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse {
     /**
      * Job ID
      * @format GUID
      */
     jobId?: string;
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -335,19 +336,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+export 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.
@@ -355,14 +356,14 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -378,7 +379,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -403,7 +404,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -425,14 +426,57 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface UpdatePaymentAcceptanceConfiguration {
+type PaymentAcceptanceConfigurationNonNullablePaths = `rules` | `rules.${number}.paymentMethodTypeId` | `rules.${number}.accountConnectionId` | `rules.${number}.merchantEnabled` | `tags.tags.tagIds`;
+/**
+ * Creates a PaymentAcceptanceConfiguration.
+ * @param paymentAcceptanceConfiguration - PaymentAcceptanceConfiguration to be created.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField paymentAcceptanceConfiguration
+ * @permissionId PAYMENTS.PAYMENT_ACCEPTANCE_CONFIGURATION_CREATE
+ * @returns The created PaymentAcceptanceConfiguration.
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.CreatePaymentAcceptanceConfiguration
+ */
+export declare function createPaymentAcceptanceConfiguration(paymentAcceptanceConfiguration: PaymentAcceptanceConfiguration): Promise<NonNullablePaths<PaymentAcceptanceConfiguration, PaymentAcceptanceConfigurationNonNullablePaths>>;
+/**
+ * Retrieves a PaymentAcceptanceConfiguration.
+ * @param paymentAcceptanceConfigurationId - ID of the PaymentAcceptanceConfiguration to retrieve.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField paymentAcceptanceConfigurationId
+ * @permissionId PAYMENTS.PAYMENT_ACCEPTANCE_CONFIGURATION_READ
+ * @returns The requested PaymentAcceptanceConfiguration.
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.GetPaymentAcceptanceConfiguration
+ */
+export declare function getPaymentAcceptanceConfiguration(paymentAcceptanceConfigurationId: string): Promise<NonNullablePaths<PaymentAcceptanceConfiguration, PaymentAcceptanceConfigurationNonNullablePaths>>;
+/**
+ * Updates a PaymentAcceptanceConfiguration.
+ *
+ *
+ * Each time the PaymentAcceptanceConfiguration is updated,
+ * `revision` increments by 1.
+ * The current `revision` must be passed when updating the PaymentAcceptanceConfiguration.
+ * This ensures you're working with the latest PaymentAcceptanceConfiguration
+ * and prevents unintended overwrites.
+ * @param _id - id
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField paymentAcceptanceConfiguration
+ * @requiredField paymentAcceptanceConfiguration.revision
+ * @permissionId PAYMENTS.PAYMENT_ACCEPTANCE_CONFIGURATION_UPDATE
+ * @returns Updated PaymentAcceptanceConfiguration.
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.UpdatePaymentAcceptanceConfiguration
+ */
+export declare function updatePaymentAcceptanceConfiguration(_id: string, paymentAcceptanceConfiguration: NonNullablePaths<UpdatePaymentAcceptanceConfiguration, `revision`>): Promise<NonNullablePaths<PaymentAcceptanceConfiguration, PaymentAcceptanceConfigurationNonNullablePaths>>;
+export interface UpdatePaymentAcceptanceConfiguration {
     /**
      * id
      * @format GUID
@@ -472,6 +516,31 @@ interface UpdatePaymentAcceptanceConfiguration {
     /** Tags */
     tags?: Tags;
 }
+/**
+ * Delete a PaymentAcceptanceConfiguration
+ * @param paymentAcceptanceConfigurationId - Id of payment acceptance configuration to delete
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField paymentAcceptanceConfigurationId
+ * @permissionId PAYMENTS.PAYMENT_ACCEPTANCE_CONFIGURATION_DELETE
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.DeletePaymentAcceptanceConfiguration
+ */
+export declare function deletePaymentAcceptanceConfiguration(paymentAcceptanceConfigurationId: string): Promise<void>;
+/**
+ * Retrieves a list of PaymentAcceptanceConfigurations, given the provided [paging, filtering, and sorting][1].
+ *
+ * Up to 1,000 PaymentAcceptanceConfigurations can be returned per request.
+ *
+ * To learn how to query PaymentAcceptanceConfigurations, see [API Query Language][2].
+ *
+ * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
+ * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId PAYMENTS.PAYMENT_ACCEPTANCE_CONFIGURATION_READ
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.QueryPaymentAcceptanceConfigurations
+ */
+export declare function queryPaymentAcceptanceConfigurations(): PaymentAcceptanceConfigurationsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -479,13 +548,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface PaymentAcceptanceConfigurationsQueryResult extends QueryCursorResult {
+export interface PaymentAcceptanceConfigurationsQueryResult extends QueryCursorResult {
     items: PaymentAcceptanceConfiguration[];
     query: PaymentAcceptanceConfigurationsQueryBuilder;
     next: () => Promise<PaymentAcceptanceConfigurationsQueryResult>;
     prev: () => Promise<PaymentAcceptanceConfigurationsQueryResult>;
 }
-interface PaymentAcceptanceConfigurationsQueryBuilder {
+export interface PaymentAcceptanceConfigurationsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -529,17 +598,39 @@ interface PaymentAcceptanceConfigurationsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<PaymentAcceptanceConfigurationsQueryResult>;
 }
-interface BulkUpdatePaymentAcceptanceConfigurationTagsOptions {
+/**
+ * Synchronously update tags on multiple PaymentAcceptanceConfigurations, by list of PaymentAcceptanceConfigurations ids
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
+ * @param ids - List of NileProtoTagsEntities that their tags will update.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId PAYMENTS.PAYMENT_ACCEPTANCE_CONFIGURATION_UPDATE_TAGS
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.BulkUpdatePaymentAcceptanceConfigurationTags
+ */
+export declare function bulkUpdatePaymentAcceptanceConfigurationTags(ids: string[], options?: BulkUpdatePaymentAcceptanceConfigurationTagsOptions): Promise<NonNullablePaths<BulkUpdatePaymentAcceptanceConfigurationTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+export interface BulkUpdatePaymentAcceptanceConfigurationTagsOptions {
     /** List of Tags to assign */
     assignTags?: Tags;
     /** List of Tags to unAssign */
     unassignTags?: Tags;
 }
-interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions {
+/**
+ * Asynchronously update tags on multiple PaymentAcceptanceConfigurations, by provided filter
+ * An empty filter will update all PaymentAcceptanceConfigurations
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
+ * @param filter - Filter
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId PAYMENTS.PAYMENT_ACCEPTANCE_CONFIGURATION_UPDATE_TAGS
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.BulkUpdatePaymentAcceptanceConfigurationTagsByFilter
+ */
+export declare function bulkUpdatePaymentAcceptanceConfigurationTagsByFilter(filter: Record<string, any>, options?: BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse, `jobId`>>;
+export interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions {
     /** List of Tags to assign */
     assignTags?: Tags;
     /** List of Tags to unAssign */
     unassignTags?: Tags;
 }
-
-export { type ApplicationError as A, type BulkUpdatePaymentAcceptanceConfigurationTagsOptions as B, type CreatePaymentAcceptanceConfigurationRequest as C, type DeletePaymentAcceptanceConfigurationRequest as D, type ExtendedFields as E, type EntityDeletedEvent as F, type GetPaymentAcceptanceConfigurationRequest as G, type ActionEvent as H, type ItemMetadata as I, type IdentificationData as J, type IdentificationDataIdOneOf as K, type PaymentAcceptanceConfigurationsQueryResult as L, type MessageEnvelope as M, type PaymentAcceptanceConfiguration as P, type QueryPaymentAcceptanceConfigurationsRequest as Q, type RestoreInfo as R, SortOrder as S, type Tags as T, type UpdatePaymentAcceptanceConfiguration as U, WebhookIdentityType as W, type PaymentAcceptanceConfigurationsQueryBuilder as a, type BulkUpdatePaymentAcceptanceConfigurationTagsResponse as b, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions as c, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse as d, type PaymentAcceptanceRule as e, type TagList as f, type CreatePaymentAcceptanceConfigurationResponse as g, type GetPaymentAcceptanceConfigurationResponse as h, type UpdatePaymentAcceptanceConfigurationRequest as i, type UpdatePaymentAcceptanceConfigurationResponse as j, type DeletePaymentAcceptanceConfigurationResponse as k, type CursorQuery as l, type CursorQueryPagingMethodOneOf as m, type Sorting as n, type CursorPaging as o, type QueryPaymentAcceptanceConfigurationsResponse as p, type CursorPagingMetadata as q, type Cursors as r, type BulkUpdatePaymentAcceptanceConfigurationTagsRequest as s, type BulkUpdatePaymentAcceptanceConfigurationTagsResult as t, type BulkActionMetadata as u, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest as v, type DomainEvent as w, type DomainEventBodyOneOf as x, type EntityCreatedEvent as y, type EntityUpdatedEvent as z };
+export {};