@wix/auto_sdk_payments_payment-acceptance-configurations 1.0.42 → 1.0.44

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

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /** PaymentAcceptanceConfiguration */
 interface PaymentAcceptanceConfiguration {
@@ -238,6 +238,33 @@ interface RemovePaymentAcceptanceConfigurationRulesResponse {
     /** Updated PaymentAcceptanceConfiguration */
     paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
 }
+interface ModifyPaymentAcceptanceConfigurationRulesRequest {
+    /**
+     * Id of payment acceptance configuration to update
+     * @format GUID
+     */
+    paymentAcceptanceConfigurationId: string;
+    /**
+     * Payment acceptance configuration revision
+     * @readonly
+     */
+    paymentAcceptanceConfigurationRevision?: string | null;
+    /**
+     * Rules to add
+     * @maxSize 1000
+     */
+    rulesToAdd?: PaymentAcceptanceRule[];
+    /**
+     * IDs of the rules to remove
+     * @format GUID
+     * @maxSize 1000
+     */
+    rulesToRemoveIds?: string[];
+}
+interface ModifyPaymentAcceptanceConfigurationRulesResponse {
+    /** Updated PaymentAcceptanceConfiguration */
+    paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
+}
 interface DeletePaymentAcceptanceConfigurationRequest {
     /**
      * Id of payment acceptance configuration to delete
@@ -1118,8 +1145,7 @@ interface UpdatePaymentAcceptanceConfiguration {
 }
 /**
  * Add PaymentAcceptanceConfiguration Rules
- * as result new rules wll be validated and added to existing ones
- * some extra rules may be added
+ * as result new rules will be validated and added to existing ones
  * @param paymentAcceptanceConfigurationId - Id of payment acceptance configuration to update
  * @internal
  * @documentationMaturity preview
@@ -1169,6 +1195,37 @@ interface RemovePaymentAcceptanceConfigurationRulesOptions {
      */
     ruleIds: string[];
 }
+/**
+ * Modify PaymentAcceptanceConfiguration Rules
+ * as result new rules will be validated and added to existing ones
+ * rules to removed will be removed, may remove extra rules depending on app_id specific logic
+ * some extra rules may be added
+ * @param paymentAcceptanceConfigurationId - Id of payment acceptance configuration to update
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField paymentAcceptanceConfigurationId
+ * @permissionId PAYMENTS.PAYMENT_ACCEPTANCE_CONFIGURATION_UPDATE
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.ModifyPaymentAcceptanceConfigurationRules
+ */
+declare function modifyPaymentAcceptanceConfigurationRules(paymentAcceptanceConfigurationId: string, options?: ModifyPaymentAcceptanceConfigurationRulesOptions): Promise<NonNullablePaths<ModifyPaymentAcceptanceConfigurationRulesResponse, `paymentAcceptanceConfiguration.rules` | `paymentAcceptanceConfiguration.rules.${number}.paymentMethodTypeId` | `paymentAcceptanceConfiguration.rules.${number}.accountConnectionId` | `paymentAcceptanceConfiguration.rules.${number}.merchantEnabled` | `paymentAcceptanceConfiguration.tags.tags.tagIds`, 5>>;
+interface ModifyPaymentAcceptanceConfigurationRulesOptions {
+    /**
+     * Payment acceptance configuration revision
+     * @readonly
+     */
+    paymentAcceptanceConfigurationRevision?: string | null;
+    /**
+     * Rules to add
+     * @maxSize 1000
+     */
+    rulesToAdd?: PaymentAcceptanceRule[];
+    /**
+     * IDs of the rules to remove
+     * @format GUID
+     * @maxSize 1000
+     */
+    rulesToRemoveIds?: string[];
+}
 /**
  * Delete a PaymentAcceptanceConfiguration
  * @param paymentAcceptanceConfigurationId - Id of payment acceptance configuration to delete
@@ -1276,7 +1333,72 @@ interface PaymentAcceptanceConfigurationsQueryBuilder {
  * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.QueryPaymentAcceptanceConfigurations
  * @requiredField query
  */
-declare function typedQueryPaymentAcceptanceConfigurations(query: CursorQuery): Promise<NonNullablePaths<QueryPaymentAcceptanceConfigurationsResponse, `paymentAcceptanceConfigurations`, 2>>;
+declare function typedQueryPaymentAcceptanceConfigurations(query: PaymentAcceptanceConfigurationQuery): Promise<NonNullablePaths<QueryPaymentAcceptanceConfigurationsResponse, `paymentAcceptanceConfigurations`, 2>>;
+interface PaymentAcceptanceConfigurationQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: [
+                'rules.accountConnectionId',
+                'rules.merchantEnabled',
+                'rules.paymentMethodTypeId'
+            ];
+            operators: ['$hasAll', '$hasSome'];
+            sort: 'BOTH';
+        },
+        {
+            fields: ['_createdDate', '_id', '_updatedDate', 'appId'];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<PaymentAcceptanceConfiguration, PaymentAcceptanceConfigurationQuerySpec>;
+type PaymentAcceptanceConfigurationQuery = {
+    /**
+    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?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object in the following format:
+    `"filter" : {
+    "fieldName1": "value1",
+    "fieldName2":{"$operator":"value2"}
+    }`
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object in the following format:
+    `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * 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
@@ -1313,4 +1435,4 @@ interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions {
     unassignTags?: Tags;
 }
 
-export { type ActionEvent, type AddPaymentAcceptanceConfigurationRulesOptions, type AddPaymentAcceptanceConfigurationRulesRequest, type AddPaymentAcceptanceConfigurationRulesResponse, type ApplicationError, type Asset, type BulkActionMetadata, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsResult, type Countries, type CreatePaymentAcceptanceConfigurationRequest, type CreatePaymentAcceptanceConfigurationResponse, type Currencies, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteContext, type DeletePaymentAcceptanceConfigurationRequest, type DeletePaymentAcceptanceConfigurationResponse, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetPaymentAcceptanceConfigurationRequest, type GetPaymentAcceptanceConfigurationResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PaymentAcceptanceConfiguration, type PaymentAcceptanceConfigurationsQueryBuilder, type PaymentAcceptanceConfigurationsQueryResult, type PaymentAcceptanceRule, type PaymentBrands, type PicassoAssigned, type PicassoUnassigned, type QueryPaymentAcceptanceConfigurationsRequest, type QueryPaymentAcceptanceConfigurationsResponse, type RemovePaymentAcceptanceConfigurationRulesOptions, type RemovePaymentAcceptanceConfigurationRulesRequest, type RemovePaymentAcceptanceConfigurationRulesResponse, type RestoreInfo, type Restrictions, type RestrictionsCountriesOneOf, type RestrictionsCurrenciesOneOf, type RestrictionsPaymentBrandsOneOf, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type TagList, type Tags, type UpdatePaymentAcceptanceConfiguration, type UpdatePaymentAcceptanceConfigurationRequest, type UpdatePaymentAcceptanceConfigurationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, addPaymentAcceptanceConfigurationRules, bulkUpdatePaymentAcceptanceConfigurationTags, bulkUpdatePaymentAcceptanceConfigurationTagsByFilter, createPaymentAcceptanceConfiguration, deletePaymentAcceptanceConfiguration, getPaymentAcceptanceConfiguration, queryPaymentAcceptanceConfigurations, removePaymentAcceptanceConfigurationRules, typedQueryPaymentAcceptanceConfigurations, updatePaymentAcceptanceConfiguration };
+export { type ActionEvent, type AddPaymentAcceptanceConfigurationRulesOptions, type AddPaymentAcceptanceConfigurationRulesRequest, type AddPaymentAcceptanceConfigurationRulesResponse, type ApplicationError, type Asset, type BulkActionMetadata, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsResult, type CommonQueryWithEntityContext, type Countries, type CreatePaymentAcceptanceConfigurationRequest, type CreatePaymentAcceptanceConfigurationResponse, type Currencies, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteContext, type DeletePaymentAcceptanceConfigurationRequest, type DeletePaymentAcceptanceConfigurationResponse, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetPaymentAcceptanceConfigurationRequest, type GetPaymentAcceptanceConfigurationResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type ModifyPaymentAcceptanceConfigurationRulesOptions, type ModifyPaymentAcceptanceConfigurationRulesRequest, type ModifyPaymentAcceptanceConfigurationRulesResponse, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PaymentAcceptanceConfiguration, type PaymentAcceptanceConfigurationQuery, type PaymentAcceptanceConfigurationQuerySpec, type PaymentAcceptanceConfigurationsQueryBuilder, type PaymentAcceptanceConfigurationsQueryResult, type PaymentAcceptanceRule, type PaymentBrands, type PicassoAssigned, type PicassoUnassigned, type QueryPaymentAcceptanceConfigurationsRequest, type QueryPaymentAcceptanceConfigurationsResponse, type RemovePaymentAcceptanceConfigurationRulesOptions, type RemovePaymentAcceptanceConfigurationRulesRequest, type RemovePaymentAcceptanceConfigurationRulesResponse, type RestoreInfo, type Restrictions, type RestrictionsCountriesOneOf, type RestrictionsCurrenciesOneOf, type RestrictionsPaymentBrandsOneOf, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type TagList, type Tags, type UpdatePaymentAcceptanceConfiguration, type UpdatePaymentAcceptanceConfigurationRequest, type UpdatePaymentAcceptanceConfigurationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, addPaymentAcceptanceConfigurationRules, bulkUpdatePaymentAcceptanceConfigurationTags, bulkUpdatePaymentAcceptanceConfigurationTagsByFilter, createPaymentAcceptanceConfiguration, deletePaymentAcceptanceConfiguration, getPaymentAcceptanceConfiguration, modifyPaymentAcceptanceConfigurationRules, queryPaymentAcceptanceConfigurations, removePaymentAcceptanceConfigurationRules, typedQueryPaymentAcceptanceConfigurations, updatePaymentAcceptanceConfiguration };

package/build/internal/cjs/index.typings.js

@@ -32,6 +32,7 @@ __export(index_typings_exports, {
   createPaymentAcceptanceConfiguration: () => createPaymentAcceptanceConfiguration2,
   deletePaymentAcceptanceConfiguration: () => deletePaymentAcceptanceConfiguration2,
   getPaymentAcceptanceConfiguration: () => getPaymentAcceptanceConfiguration2,
+  modifyPaymentAcceptanceConfigurationRules: () => modifyPaymentAcceptanceConfigurationRules2,
   queryPaymentAcceptanceConfigurations: () => queryPaymentAcceptanceConfigurations2,
   removePaymentAcceptanceConfigurationRules: () => removePaymentAcceptanceConfigurationRules2,
   typedQueryPaymentAcceptanceConfigurations: () => typedQueryPaymentAcceptanceConfigurations,
@@ -269,6 +270,38 @@ function removePaymentAcceptanceConfigurationRules(payload) {
   }
   return __removePaymentAcceptanceConfigurationRules;
 }
+function modifyPaymentAcceptanceConfigurationRules(payload) {
+  function __modifyPaymentAcceptanceConfigurationRules({ host }) {
+    const metadata = {
+      entityFqdn: "wix.payments.payment_acceptance_configurations.v1.payment_acceptance_configuration",
+      method: "POST",
+      methodFqn: "wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.ModifyPaymentAcceptanceConfigurationRules",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixPaymentsPaymentAcceptanceConfigurationsV1PaymentAcceptanceConfigurationServiceUrl(
+        {
+          protoPath: "/v1/payment-acceptance-configurations/{paymentAcceptanceConfigurationId}/modify-rules",
+          data: payload,
+          host
+        }
+      ),
+      data: payload,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "paymentAcceptanceConfiguration.createdDate" },
+            { path: "paymentAcceptanceConfiguration.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __modifyPaymentAcceptanceConfigurationRules;
+}
 function deletePaymentAcceptanceConfiguration(payload) {
   function __deletePaymentAcceptanceConfiguration({ host }) {
     const metadata = {
@@ -614,6 +647,41 @@ async function removePaymentAcceptanceConfigurationRules2(paymentAcceptanceConfi
     throw transformedError;
   }
 }
+async function modifyPaymentAcceptanceConfigurationRules2(paymentAcceptanceConfigurationId, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    paymentAcceptanceConfigurationId,
+    paymentAcceptanceConfigurationRevision: options?.paymentAcceptanceConfigurationRevision,
+    rulesToAdd: options?.rulesToAdd,
+    rulesToRemoveIds: options?.rulesToRemoveIds
+  });
+  const reqOpts = modifyPaymentAcceptanceConfigurationRules(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          paymentAcceptanceConfigurationId: "$[0]",
+          paymentAcceptanceConfigurationRevision: "$[1].paymentAcceptanceConfigurationRevision",
+          rulesToAdd: "$[1].rulesToAdd",
+          rulesToRemoveIds: "$[1].rulesToRemoveIds"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["paymentAcceptanceConfigurationId", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function deletePaymentAcceptanceConfiguration2(paymentAcceptanceConfigurationId) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -792,6 +860,7 @@ async function bulkUpdatePaymentAcceptanceConfigurationTagsByFilter2(filter, opt
   createPaymentAcceptanceConfiguration,
   deletePaymentAcceptanceConfiguration,
   getPaymentAcceptanceConfiguration,
+  modifyPaymentAcceptanceConfigurationRules,
   queryPaymentAcceptanceConfigurations,
   removePaymentAcceptanceConfigurationRules,
   typedQueryPaymentAcceptanceConfigurations,