@revenexx/sdk 0.0.4 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/sdk.js +13491 -6163
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +13464 -6162
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +13491 -6163
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/enums/address-type.ts +4 -0
- package/src/enums/cart-export-format.ts +4 -0
- package/src/enums/cart-io-apply-mode.ts +5 -0
- package/src/enums/cart-io-direction.ts +4 -0
- package/src/enums/cart-io-entity.ts +4 -0
- package/src/enums/cart-io-format.ts +4 -0
- package/src/enums/cart-item-type.ts +5 -0
- package/src/enums/channel-status.ts +4 -0
- package/src/enums/channel-type.ts +7 -0
- package/src/enums/contact-role.ts +6 -0
- package/src/enums/contact-status.ts +5 -0
- package/src/enums/location-type.ts +6 -0
- package/src/enums/market-status.ts +4 -0
- package/src/enums/order-comment-visibility.ts +4 -0
- package/src/enums/order-item-type.ts +5 -0
- package/src/enums/order-list-kind.ts +4 -0
- package/src/enums/order-payment-status.ts +9 -0
- package/src/enums/organization-status.ts +4 -0
- package/src/enums/page-status.ts +5 -0
- package/src/enums/payment-fee-type.ts +5 -0
- package/src/enums/payment-method-kind.ts +4 -0
- package/src/enums/price-entry-type.ts +4 -0
- package/src/enums/price-list-status.ts +4 -0
- package/src/enums/shipping-method-matrix-basis.ts +6 -0
- package/src/enums/shipping-method-pricing-type.ts +5 -0
- package/src/enums/store-asset-request-visibility.ts +4 -0
- package/src/enums/visibility.ts +4 -0
- package/src/index.ts +28 -2
- package/src/models.ts +5309 -1009
- package/src/services/apps.ts +154 -154
- package/src/services/avatars.ts +57 -57
- package/src/services/carts.ts +739 -104
- package/src/services/channels.ts +147 -19
- package/src/services/customers.ts +809 -69
- package/src/services/greetings.ts +18 -18
- package/src/services/inventories.ts +620 -65
- package/src/services/locale.ts +16 -16
- package/src/services/markets.ts +690 -75
- package/src/services/messaging.ts +273 -273
- package/src/services/orderlists.ts +889 -0
- package/src/services/orders.ts +692 -137
- package/src/services/pages.ts +661 -155
- package/src/services/payments.ts +591 -64
- package/src/services/prices.ts +585 -59
- package/src/services/products.ts +1908 -272
- package/src/services/search.ts +24 -24
- package/src/services/shipping.ts +451 -59
- package/src/services/sites.ts +116 -116
- package/src/services/storage.ts +933 -599
- package/src/services/tokens.ts +14 -14
- package/types/enums/address-type.d.ts +4 -0
- package/types/enums/cart-export-format.d.ts +4 -0
- package/types/enums/cart-io-apply-mode.d.ts +5 -0
- package/types/enums/cart-io-direction.d.ts +4 -0
- package/types/enums/cart-io-entity.d.ts +4 -0
- package/types/enums/cart-io-format.d.ts +4 -0
- package/types/enums/cart-item-type.d.ts +5 -0
- package/types/enums/channel-status.d.ts +4 -0
- package/types/enums/channel-type.d.ts +7 -0
- package/types/enums/contact-role.d.ts +6 -0
- package/types/enums/contact-status.d.ts +5 -0
- package/types/enums/location-type.d.ts +6 -0
- package/types/enums/market-status.d.ts +4 -0
- package/types/enums/order-comment-visibility.d.ts +4 -0
- package/types/enums/order-item-type.d.ts +5 -0
- package/types/enums/order-list-kind.d.ts +4 -0
- package/types/enums/order-payment-status.d.ts +9 -0
- package/types/enums/organization-status.d.ts +4 -0
- package/types/enums/page-status.d.ts +5 -0
- package/types/enums/payment-fee-type.d.ts +5 -0
- package/types/enums/payment-method-kind.d.ts +4 -0
- package/types/enums/price-entry-type.d.ts +4 -0
- package/types/enums/price-list-status.d.ts +4 -0
- package/types/enums/shipping-method-matrix-basis.d.ts +6 -0
- package/types/enums/shipping-method-pricing-type.d.ts +5 -0
- package/types/enums/store-asset-request-visibility.d.ts +4 -0
- package/types/enums/visibility.d.ts +4 -0
- package/types/index.d.ts +28 -2
- package/types/models.d.ts +5170 -1010
- package/types/services/carts.d.ts +271 -12
- package/types/services/channels.d.ts +54 -2
- package/types/services/customers.d.ts +298 -12
- package/types/services/inventories.d.ts +225 -11
- package/types/services/markets.d.ts +235 -6
- package/types/services/orderlists.d.ts +324 -0
- package/types/services/orders.d.ts +238 -16
- package/types/services/pages.d.ts +190 -6
- package/types/services/payments.d.ts +221 -7
- package/types/services/prices.d.ts +218 -6
- package/types/services/products.d.ts +672 -32
- package/types/services/shipping.d.ts +168 -6
- package/types/services/storage.d.ts +353 -285
|
@@ -1,8 +1,15 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
+
import { PageStatus } from '../enums/page-status';
|
|
3
4
|
export declare class Pages {
|
|
4
5
|
client: Client;
|
|
5
6
|
constructor(client: Client);
|
|
7
|
+
/**
|
|
8
|
+
*
|
|
9
|
+
* @throws {RevenexxException}
|
|
10
|
+
* @returns {Promise<{}>}
|
|
11
|
+
*/
|
|
12
|
+
pagesDeliveryMenus(): Promise<{}>;
|
|
6
13
|
/**
|
|
7
14
|
*
|
|
8
15
|
* @throws {RevenexxException}
|
|
@@ -320,20 +327,29 @@ export declare class Pages {
|
|
|
320
327
|
/**
|
|
321
328
|
*
|
|
322
329
|
* @param {string} params.pageId -
|
|
330
|
+
* @param {string} params.plugin - Mutation plugin id (add, move, delete, duplicate, update_field_value, ...).
|
|
331
|
+
* @param {string} params.langcode -
|
|
332
|
+
* @param {object} params.payload -
|
|
323
333
|
* @throws {RevenexxException}
|
|
324
334
|
* @returns {Promise<Models.MutationResponse>}
|
|
325
335
|
*/
|
|
326
336
|
pagesEditorMutate(params: {
|
|
327
337
|
pageId: string;
|
|
338
|
+
plugin: string;
|
|
339
|
+
langcode?: string;
|
|
340
|
+
payload?: object;
|
|
328
341
|
}): Promise<Models.MutationResponse>;
|
|
329
342
|
/**
|
|
330
343
|
*
|
|
331
344
|
* @param {string} pageId -
|
|
345
|
+
* @param {string} plugin - Mutation plugin id (add, move, delete, duplicate, update_field_value, ...).
|
|
346
|
+
* @param {string} langcode -
|
|
347
|
+
* @param {object} payload -
|
|
332
348
|
* @throws {RevenexxException}
|
|
333
349
|
* @returns {Promise<Models.MutationResponse>}
|
|
334
350
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
335
351
|
*/
|
|
336
|
-
pagesEditorMutate(pageId: string): Promise<Models.MutationResponse>;
|
|
352
|
+
pagesEditorMutate(pageId: string, plugin: string, langcode?: string, payload?: object): Promise<Models.MutationResponse>;
|
|
337
353
|
/**
|
|
338
354
|
*
|
|
339
355
|
* @param {string} params.pageId -
|
|
@@ -543,20 +559,115 @@ export declare class Pages {
|
|
|
543
559
|
/**
|
|
544
560
|
*
|
|
545
561
|
* @param {string} params.id -
|
|
562
|
+
* @param {string} params.bundle -
|
|
563
|
+
* @param {string} params.label -
|
|
564
|
+
* @param {object} params.tree - Serialized block tree ({ bundle, props, props_i18n, options, children }).
|
|
546
565
|
* @throws {RevenexxException}
|
|
547
566
|
* @returns {Promise<Models.LibraryItem>}
|
|
548
567
|
*/
|
|
549
568
|
pagesLibraryUpdate(params: {
|
|
550
569
|
id: string;
|
|
570
|
+
bundle?: string;
|
|
571
|
+
label?: string;
|
|
572
|
+
tree?: object;
|
|
551
573
|
}): Promise<Models.LibraryItem>;
|
|
552
574
|
/**
|
|
553
575
|
*
|
|
554
576
|
* @param {string} id -
|
|
577
|
+
* @param {string} bundle -
|
|
578
|
+
* @param {string} label -
|
|
579
|
+
* @param {object} tree - Serialized block tree ({ bundle, props, props_i18n, options, children }).
|
|
555
580
|
* @throws {RevenexxException}
|
|
556
581
|
* @returns {Promise<Models.LibraryItem>}
|
|
557
582
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
558
583
|
*/
|
|
559
|
-
pagesLibraryUpdate(id: string): Promise<Models.LibraryItem>;
|
|
584
|
+
pagesLibraryUpdate(id: string, bundle?: string, label?: string, tree?: object): Promise<Models.LibraryItem>;
|
|
585
|
+
/**
|
|
586
|
+
*
|
|
587
|
+
* @throws {RevenexxException}
|
|
588
|
+
* @returns {Promise<{}>}
|
|
589
|
+
*/
|
|
590
|
+
pagesMenusList(): Promise<{}>;
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @param {string} params.label -
|
|
594
|
+
* @param {string} params.menuKey - Stable menu identifier, e.g. "main", "footer", "account".
|
|
595
|
+
* @param {object[]} params.items - Ordered menu entries ({ label, to?, items? }).
|
|
596
|
+
* @throws {RevenexxException}
|
|
597
|
+
* @returns {Promise<Models.Menu>}
|
|
598
|
+
*/
|
|
599
|
+
pagesMenusUpsert(params: {
|
|
600
|
+
label: string;
|
|
601
|
+
menuKey: string;
|
|
602
|
+
items?: object[];
|
|
603
|
+
}): Promise<Models.Menu>;
|
|
604
|
+
/**
|
|
605
|
+
*
|
|
606
|
+
* @param {string} label -
|
|
607
|
+
* @param {string} menuKey - Stable menu identifier, e.g. "main", "footer", "account".
|
|
608
|
+
* @param {object[]} items - Ordered menu entries ({ label, to?, items? }).
|
|
609
|
+
* @throws {RevenexxException}
|
|
610
|
+
* @returns {Promise<Models.Menu>}
|
|
611
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
612
|
+
*/
|
|
613
|
+
pagesMenusUpsert(label: string, menuKey: string, items?: object[]): Promise<Models.Menu>;
|
|
614
|
+
/**
|
|
615
|
+
*
|
|
616
|
+
* @param {string} params.id -
|
|
617
|
+
* @throws {RevenexxException}
|
|
618
|
+
* @returns {Promise<{}>}
|
|
619
|
+
*/
|
|
620
|
+
pagesMenusDelete(params: {
|
|
621
|
+
id: string;
|
|
622
|
+
}): Promise<{}>;
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @param {string} id -
|
|
626
|
+
* @throws {RevenexxException}
|
|
627
|
+
* @returns {Promise<{}>}
|
|
628
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
629
|
+
*/
|
|
630
|
+
pagesMenusDelete(id: string): Promise<{}>;
|
|
631
|
+
/**
|
|
632
|
+
*
|
|
633
|
+
* @param {string} params.id -
|
|
634
|
+
* @throws {RevenexxException}
|
|
635
|
+
* @returns {Promise<Models.Menu>}
|
|
636
|
+
*/
|
|
637
|
+
pagesMenusGet(params: {
|
|
638
|
+
id: string;
|
|
639
|
+
}): Promise<Models.Menu>;
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
* @param {string} id -
|
|
643
|
+
* @throws {RevenexxException}
|
|
644
|
+
* @returns {Promise<Models.Menu>}
|
|
645
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
646
|
+
*/
|
|
647
|
+
pagesMenusGet(id: string): Promise<Models.Menu>;
|
|
648
|
+
/**
|
|
649
|
+
*
|
|
650
|
+
* @param {string} params.id -
|
|
651
|
+
* @param {object[]} params.items -
|
|
652
|
+
* @param {string} params.label -
|
|
653
|
+
* @throws {RevenexxException}
|
|
654
|
+
* @returns {Promise<Models.Menu>}
|
|
655
|
+
*/
|
|
656
|
+
pagesMenusUpdate(params: {
|
|
657
|
+
id: string;
|
|
658
|
+
items?: object[];
|
|
659
|
+
label?: string;
|
|
660
|
+
}): Promise<Models.Menu>;
|
|
661
|
+
/**
|
|
662
|
+
*
|
|
663
|
+
* @param {string} id -
|
|
664
|
+
* @param {object[]} items -
|
|
665
|
+
* @param {string} label -
|
|
666
|
+
* @throws {RevenexxException}
|
|
667
|
+
* @returns {Promise<Models.Menu>}
|
|
668
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
669
|
+
*/
|
|
670
|
+
pagesMenusUpdate(id: string, items?: object[], label?: string): Promise<Models.Menu>;
|
|
560
671
|
/**
|
|
561
672
|
*
|
|
562
673
|
* @throws {RevenexxException}
|
|
@@ -565,10 +676,36 @@ export declare class Pages {
|
|
|
565
676
|
pagesPagesList(): Promise<{}>;
|
|
566
677
|
/**
|
|
567
678
|
*
|
|
679
|
+
* @param {string} params.title -
|
|
680
|
+
* @param {string} params.bundle -
|
|
681
|
+
* @param {object} params.hostOptions -
|
|
682
|
+
* @param {object} params.meta -
|
|
683
|
+
* @param {string} params.slug -
|
|
684
|
+
* @param {string} params.sourceLanguage -
|
|
568
685
|
* @throws {RevenexxException}
|
|
569
686
|
* @returns {Promise<Models.Page>}
|
|
570
687
|
*/
|
|
571
|
-
pagesPagesCreate(
|
|
688
|
+
pagesPagesCreate(params: {
|
|
689
|
+
title: string;
|
|
690
|
+
bundle?: string;
|
|
691
|
+
hostOptions?: object;
|
|
692
|
+
meta?: object;
|
|
693
|
+
slug?: string;
|
|
694
|
+
sourceLanguage?: string;
|
|
695
|
+
}): Promise<Models.Page>;
|
|
696
|
+
/**
|
|
697
|
+
*
|
|
698
|
+
* @param {string} title -
|
|
699
|
+
* @param {string} bundle -
|
|
700
|
+
* @param {object} hostOptions -
|
|
701
|
+
* @param {object} meta -
|
|
702
|
+
* @param {string} slug -
|
|
703
|
+
* @param {string} sourceLanguage -
|
|
704
|
+
* @throws {RevenexxException}
|
|
705
|
+
* @returns {Promise<Models.Page>}
|
|
706
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
707
|
+
*/
|
|
708
|
+
pagesPagesCreate(title: string, bundle?: string, hostOptions?: object, meta?: object, slug?: string, sourceLanguage?: string): Promise<Models.Page>;
|
|
572
709
|
/**
|
|
573
710
|
*
|
|
574
711
|
* @param {string} params.id -
|
|
@@ -606,20 +743,35 @@ export declare class Pages {
|
|
|
606
743
|
/**
|
|
607
744
|
*
|
|
608
745
|
* @param {string} params.id -
|
|
746
|
+
* @param {string} params.bundle -
|
|
747
|
+
* @param {object} params.meta -
|
|
748
|
+
* @param {string} params.slug -
|
|
749
|
+
* @param {PageStatus} params.status -
|
|
750
|
+
* @param {string} params.title -
|
|
609
751
|
* @throws {RevenexxException}
|
|
610
752
|
* @returns {Promise<Models.Page>}
|
|
611
753
|
*/
|
|
612
754
|
pagesPagesUpdate(params: {
|
|
613
755
|
id: string;
|
|
756
|
+
bundle?: string;
|
|
757
|
+
meta?: object;
|
|
758
|
+
slug?: string;
|
|
759
|
+
status?: PageStatus;
|
|
760
|
+
title?: string;
|
|
614
761
|
}): Promise<Models.Page>;
|
|
615
762
|
/**
|
|
616
763
|
*
|
|
617
764
|
* @param {string} id -
|
|
765
|
+
* @param {string} bundle -
|
|
766
|
+
* @param {object} meta -
|
|
767
|
+
* @param {string} slug -
|
|
768
|
+
* @param {PageStatus} status -
|
|
769
|
+
* @param {string} title -
|
|
618
770
|
* @throws {RevenexxException}
|
|
619
771
|
* @returns {Promise<Models.Page>}
|
|
620
772
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
621
773
|
*/
|
|
622
|
-
pagesPagesUpdate(id: string): Promise<Models.Page>;
|
|
774
|
+
pagesPagesUpdate(id: string, bundle?: string, meta?: object, slug?: string, status?: PageStatus, title?: string): Promise<Models.Page>;
|
|
623
775
|
/**
|
|
624
776
|
*
|
|
625
777
|
* @param {string} params.id -
|
|
@@ -639,10 +791,24 @@ export declare class Pages {
|
|
|
639
791
|
pagesPagesRevisions(id: string): Promise<{}>;
|
|
640
792
|
/**
|
|
641
793
|
*
|
|
794
|
+
* @param {object[]} params.menus -
|
|
795
|
+
* @param {object[]} params.pages -
|
|
642
796
|
* @throws {RevenexxException}
|
|
643
797
|
* @returns {Promise<{}>}
|
|
644
798
|
*/
|
|
645
|
-
pagesSeed(
|
|
799
|
+
pagesSeed(params?: {
|
|
800
|
+
menus?: object[];
|
|
801
|
+
pages?: object[];
|
|
802
|
+
}): Promise<{}>;
|
|
803
|
+
/**
|
|
804
|
+
*
|
|
805
|
+
* @param {object[]} menus -
|
|
806
|
+
* @param {object[]} pages -
|
|
807
|
+
* @throws {RevenexxException}
|
|
808
|
+
* @returns {Promise<{}>}
|
|
809
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
810
|
+
*/
|
|
811
|
+
pagesSeed(menus?: object[], pages?: object[]): Promise<{}>;
|
|
646
812
|
/**
|
|
647
813
|
*
|
|
648
814
|
* @throws {RevenexxException}
|
|
@@ -686,18 +852,36 @@ export declare class Pages {
|
|
|
686
852
|
/**
|
|
687
853
|
*
|
|
688
854
|
* @param {string} params.id -
|
|
855
|
+
* @param {string} params.description -
|
|
856
|
+
* @param {string} params.fieldName -
|
|
857
|
+
* @param {boolean} params.isDefault -
|
|
858
|
+
* @param {string} params.label -
|
|
859
|
+
* @param {string} params.pageBundle -
|
|
860
|
+
* @param {object[]} params.tree - Serialized block trees ({ bundle, props, props_i18n, options, children }).
|
|
689
861
|
* @throws {RevenexxException}
|
|
690
862
|
* @returns {Promise<Models.Template>}
|
|
691
863
|
*/
|
|
692
864
|
pagesTemplatesUpdate(params: {
|
|
693
865
|
id: string;
|
|
866
|
+
description?: string;
|
|
867
|
+
fieldName?: string;
|
|
868
|
+
isDefault?: boolean;
|
|
869
|
+
label?: string;
|
|
870
|
+
pageBundle?: string;
|
|
871
|
+
tree?: object[];
|
|
694
872
|
}): Promise<Models.Template>;
|
|
695
873
|
/**
|
|
696
874
|
*
|
|
697
875
|
* @param {string} id -
|
|
876
|
+
* @param {string} description -
|
|
877
|
+
* @param {string} fieldName -
|
|
878
|
+
* @param {boolean} isDefault -
|
|
879
|
+
* @param {string} label -
|
|
880
|
+
* @param {string} pageBundle -
|
|
881
|
+
* @param {object[]} tree - Serialized block trees ({ bundle, props, props_i18n, options, children }).
|
|
698
882
|
* @throws {RevenexxException}
|
|
699
883
|
* @returns {Promise<Models.Template>}
|
|
700
884
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
701
885
|
*/
|
|
702
|
-
pagesTemplatesUpdate(id: string): Promise<Models.Template>;
|
|
886
|
+
pagesTemplatesUpdate(id: string, description?: string, fieldName?: string, isDefault?: boolean, label?: string, pageBundle?: string, tree?: object[]): Promise<Models.Template>;
|
|
703
887
|
}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
+
import { PaymentFeeType } from '../enums/payment-fee-type';
|
|
4
|
+
import { PaymentMethodKind } from '../enums/payment-method-kind';
|
|
3
5
|
export declare class Payments {
|
|
4
6
|
client: Client;
|
|
5
7
|
constructor(client: Client);
|
|
@@ -11,10 +13,48 @@ export declare class Payments {
|
|
|
11
13
|
paymentsList(): Promise<{}>;
|
|
12
14
|
/**
|
|
13
15
|
*
|
|
16
|
+
* @param {number} params.amount - Order amount — 0 is legal (free orders), negative is not.
|
|
17
|
+
* @param {string} params.methodCode - Code of a configured payment method.
|
|
18
|
+
* @param {string} params.cartId - The cart this payment pays for.
|
|
19
|
+
* @param {string} params.contactId - Paying customer contact.
|
|
20
|
+
* @param {string} params.country - Buyer ISO country code for the eligibility check.
|
|
21
|
+
* @param {string} params.currency - ISO 4217 code (default EUR).
|
|
22
|
+
* @param {string} params.idempotencyKey - Same key answers the same payment instead of a duplicate.
|
|
23
|
+
* @param {object} params.metadata - Free-form metadata.
|
|
24
|
+
* @param {string} params.orderRef - External order reference — also the webhook fallback key.
|
|
25
|
+
* @param {string} params.returnUrl - Where the PSP redirect flow returns the buyer to.
|
|
14
26
|
* @throws {RevenexxException}
|
|
15
27
|
* @returns {Promise<Models.Payment>}
|
|
16
28
|
*/
|
|
17
|
-
paymentsCreate(
|
|
29
|
+
paymentsCreate(params: {
|
|
30
|
+
amount: number;
|
|
31
|
+
methodCode: string;
|
|
32
|
+
cartId?: string;
|
|
33
|
+
contactId?: string;
|
|
34
|
+
country?: string;
|
|
35
|
+
currency?: string;
|
|
36
|
+
idempotencyKey?: string;
|
|
37
|
+
metadata?: object;
|
|
38
|
+
orderRef?: string;
|
|
39
|
+
returnUrl?: string;
|
|
40
|
+
}): Promise<Models.Payment>;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @param {number} amount - Order amount — 0 is legal (free orders), negative is not.
|
|
44
|
+
* @param {string} methodCode - Code of a configured payment method.
|
|
45
|
+
* @param {string} cartId - The cart this payment pays for.
|
|
46
|
+
* @param {string} contactId - Paying customer contact.
|
|
47
|
+
* @param {string} country - Buyer ISO country code for the eligibility check.
|
|
48
|
+
* @param {string} currency - ISO 4217 code (default EUR).
|
|
49
|
+
* @param {string} idempotencyKey - Same key answers the same payment instead of a duplicate.
|
|
50
|
+
* @param {object} metadata - Free-form metadata.
|
|
51
|
+
* @param {string} orderRef - External order reference — also the webhook fallback key.
|
|
52
|
+
* @param {string} returnUrl - Where the PSP redirect flow returns the buyer to.
|
|
53
|
+
* @throws {RevenexxException}
|
|
54
|
+
* @returns {Promise<Models.Payment>}
|
|
55
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
56
|
+
*/
|
|
57
|
+
paymentsCreate(amount: number, methodCode: string, cartId?: string, contactId?: string, country?: string, currency?: string, idempotencyKey?: string, metadata?: object, orderRef?: string, returnUrl?: string): Promise<Models.Payment>;
|
|
18
58
|
/**
|
|
19
59
|
*
|
|
20
60
|
* @throws {RevenexxException}
|
|
@@ -23,10 +63,66 @@ export declare class Payments {
|
|
|
23
63
|
paymentsMethodsList(): Promise<{}>;
|
|
24
64
|
/**
|
|
25
65
|
*
|
|
66
|
+
* @param {string} params.code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
|
|
67
|
+
* @param {string} params.name - Display name.
|
|
68
|
+
* @param {string[]} params.countries - Allowed ISO country codes — empty/omitted = unrestricted.
|
|
69
|
+
* @param {string} params.description -
|
|
70
|
+
* @param {boolean} params.enabled - Disabled methods are never eligible (default false).
|
|
71
|
+
* @param {number} params.feeAmount - Fixed amount or percent value, per fee_type (default 0).
|
|
72
|
+
* @param {string} params.feeCurrency - ISO 4217 code (default EUR).
|
|
73
|
+
* @param {PaymentFeeType} params.feeType - How 'fee_amount' applies (default 'none').
|
|
74
|
+
* @param {PaymentMethodKind} params.kind - Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact).
|
|
75
|
+
* @param {object} params.labels - Localized display names ({ de, en, … }).
|
|
76
|
+
* @param {number} params.maxOrderValue - Maximum order amount — omitted = no upper bound.
|
|
77
|
+
* @param {object} params.metadata - Free-form metadata.
|
|
78
|
+
* @param {number} params.minOrderValue - Minimum order amount — omitted = no lower bound.
|
|
79
|
+
* @param {number} params.position - Sort position in the checkout (default 0).
|
|
80
|
+
* @param {string} params.provider - PSP code from the catalog — only for kind 'psp'.
|
|
81
|
+
* @param {string} params.providerMethod - The provider's payment method id (e.g. 'card', 'paypal').
|
|
26
82
|
* @throws {RevenexxException}
|
|
27
83
|
* @returns {Promise<Models.PaymentMethod>}
|
|
28
84
|
*/
|
|
29
|
-
paymentsMethodsCreate(
|
|
85
|
+
paymentsMethodsCreate(params: {
|
|
86
|
+
code: string;
|
|
87
|
+
name: string;
|
|
88
|
+
countries?: string[];
|
|
89
|
+
description?: string;
|
|
90
|
+
enabled?: boolean;
|
|
91
|
+
feeAmount?: number;
|
|
92
|
+
feeCurrency?: string;
|
|
93
|
+
feeType?: PaymentFeeType;
|
|
94
|
+
kind?: PaymentMethodKind;
|
|
95
|
+
labels?: object;
|
|
96
|
+
maxOrderValue?: number;
|
|
97
|
+
metadata?: object;
|
|
98
|
+
minOrderValue?: number;
|
|
99
|
+
position?: number;
|
|
100
|
+
provider?: string;
|
|
101
|
+
providerMethod?: string;
|
|
102
|
+
}): Promise<Models.PaymentMethod>;
|
|
103
|
+
/**
|
|
104
|
+
*
|
|
105
|
+
* @param {string} code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
|
|
106
|
+
* @param {string} name - Display name.
|
|
107
|
+
* @param {string[]} countries - Allowed ISO country codes — empty/omitted = unrestricted.
|
|
108
|
+
* @param {string} description -
|
|
109
|
+
* @param {boolean} enabled - Disabled methods are never eligible (default false).
|
|
110
|
+
* @param {number} feeAmount - Fixed amount or percent value, per fee_type (default 0).
|
|
111
|
+
* @param {string} feeCurrency - ISO 4217 code (default EUR).
|
|
112
|
+
* @param {PaymentFeeType} feeType - How 'fee_amount' applies (default 'none').
|
|
113
|
+
* @param {PaymentMethodKind} kind - Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact).
|
|
114
|
+
* @param {object} labels - Localized display names ({ de, en, … }).
|
|
115
|
+
* @param {number} maxOrderValue - Maximum order amount — omitted = no upper bound.
|
|
116
|
+
* @param {object} metadata - Free-form metadata.
|
|
117
|
+
* @param {number} minOrderValue - Minimum order amount — omitted = no lower bound.
|
|
118
|
+
* @param {number} position - Sort position in the checkout (default 0).
|
|
119
|
+
* @param {string} provider - PSP code from the catalog — only for kind 'psp'.
|
|
120
|
+
* @param {string} providerMethod - The provider's payment method id (e.g. 'card', 'paypal').
|
|
121
|
+
* @throws {RevenexxException}
|
|
122
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
123
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
124
|
+
*/
|
|
125
|
+
paymentsMethodsCreate(code: string, name: string, countries?: string[], description?: string, enabled?: boolean, feeAmount?: number, feeCurrency?: string, feeType?: PaymentFeeType, kind?: PaymentMethodKind, labels?: object, maxOrderValue?: number, metadata?: object, minOrderValue?: number, position?: number, provider?: string, providerMethod?: string): Promise<Models.PaymentMethod>;
|
|
30
126
|
/**
|
|
31
127
|
*
|
|
32
128
|
* @throws {RevenexxException}
|
|
@@ -35,10 +131,27 @@ export declare class Payments {
|
|
|
35
131
|
paymentsMethodsDefaults(): Promise<{}>;
|
|
36
132
|
/**
|
|
37
133
|
*
|
|
134
|
+
* @param {number} params.amount - Order amount the fees are computed against (default 0).
|
|
135
|
+
* @param {string} params.country - Buyer ISO country code — methods with country restrictions need it.
|
|
136
|
+
* @param {string} params.currency - ISO 4217 code (default EUR).
|
|
38
137
|
* @throws {RevenexxException}
|
|
39
138
|
* @returns {Promise<{}>}
|
|
40
139
|
*/
|
|
41
|
-
paymentsMethodsEligible(
|
|
140
|
+
paymentsMethodsEligible(params?: {
|
|
141
|
+
amount?: number;
|
|
142
|
+
country?: string;
|
|
143
|
+
currency?: string;
|
|
144
|
+
}): Promise<{}>;
|
|
145
|
+
/**
|
|
146
|
+
*
|
|
147
|
+
* @param {number} amount - Order amount the fees are computed against (default 0).
|
|
148
|
+
* @param {string} country - Buyer ISO country code — methods with country restrictions need it.
|
|
149
|
+
* @param {string} currency - ISO 4217 code (default EUR).
|
|
150
|
+
* @throws {RevenexxException}
|
|
151
|
+
* @returns {Promise<{}>}
|
|
152
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
153
|
+
*/
|
|
154
|
+
paymentsMethodsEligible(amount?: number, country?: string, currency?: string): Promise<{}>;
|
|
42
155
|
/**
|
|
43
156
|
*
|
|
44
157
|
* @param {string} params.id -
|
|
@@ -76,20 +189,68 @@ export declare class Payments {
|
|
|
76
189
|
/**
|
|
77
190
|
*
|
|
78
191
|
* @param {string} params.id -
|
|
192
|
+
* @param {string} params.code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
|
|
193
|
+
* @param {string[]} params.countries - Allowed ISO country codes — empty/omitted = unrestricted.
|
|
194
|
+
* @param {string} params.description -
|
|
195
|
+
* @param {boolean} params.enabled - Disabled methods are never eligible (default false).
|
|
196
|
+
* @param {number} params.feeAmount - Fixed amount or percent value, per fee_type (default 0).
|
|
197
|
+
* @param {string} params.feeCurrency - ISO 4217 code (default EUR).
|
|
198
|
+
* @param {PaymentFeeType} params.feeType - How 'fee_amount' applies (default 'none').
|
|
199
|
+
* @param {PaymentMethodKind} params.kind - Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact).
|
|
200
|
+
* @param {object} params.labels - Localized display names ({ de, en, … }).
|
|
201
|
+
* @param {number} params.maxOrderValue - Maximum order amount — omitted = no upper bound.
|
|
202
|
+
* @param {object} params.metadata - Free-form metadata.
|
|
203
|
+
* @param {number} params.minOrderValue - Minimum order amount — omitted = no lower bound.
|
|
204
|
+
* @param {string} params.name - Display name.
|
|
205
|
+
* @param {number} params.position - Sort position in the checkout (default 0).
|
|
206
|
+
* @param {string} params.provider - PSP code from the catalog — only for kind 'psp'.
|
|
207
|
+
* @param {string} params.providerMethod - The provider's payment method id (e.g. 'card', 'paypal').
|
|
79
208
|
* @throws {RevenexxException}
|
|
80
209
|
* @returns {Promise<Models.PaymentMethod>}
|
|
81
210
|
*/
|
|
82
211
|
paymentsMethodsUpdate(params: {
|
|
83
212
|
id: string;
|
|
213
|
+
code?: string;
|
|
214
|
+
countries?: string[];
|
|
215
|
+
description?: string;
|
|
216
|
+
enabled?: boolean;
|
|
217
|
+
feeAmount?: number;
|
|
218
|
+
feeCurrency?: string;
|
|
219
|
+
feeType?: PaymentFeeType;
|
|
220
|
+
kind?: PaymentMethodKind;
|
|
221
|
+
labels?: object;
|
|
222
|
+
maxOrderValue?: number;
|
|
223
|
+
metadata?: object;
|
|
224
|
+
minOrderValue?: number;
|
|
225
|
+
name?: string;
|
|
226
|
+
position?: number;
|
|
227
|
+
provider?: string;
|
|
228
|
+
providerMethod?: string;
|
|
84
229
|
}): Promise<Models.PaymentMethod>;
|
|
85
230
|
/**
|
|
86
231
|
*
|
|
87
232
|
* @param {string} id -
|
|
233
|
+
* @param {string} code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
|
|
234
|
+
* @param {string[]} countries - Allowed ISO country codes — empty/omitted = unrestricted.
|
|
235
|
+
* @param {string} description -
|
|
236
|
+
* @param {boolean} enabled - Disabled methods are never eligible (default false).
|
|
237
|
+
* @param {number} feeAmount - Fixed amount or percent value, per fee_type (default 0).
|
|
238
|
+
* @param {string} feeCurrency - ISO 4217 code (default EUR).
|
|
239
|
+
* @param {PaymentFeeType} feeType - How 'fee_amount' applies (default 'none').
|
|
240
|
+
* @param {PaymentMethodKind} kind - Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact).
|
|
241
|
+
* @param {object} labels - Localized display names ({ de, en, … }).
|
|
242
|
+
* @param {number} maxOrderValue - Maximum order amount — omitted = no upper bound.
|
|
243
|
+
* @param {object} metadata - Free-form metadata.
|
|
244
|
+
* @param {number} minOrderValue - Minimum order amount — omitted = no lower bound.
|
|
245
|
+
* @param {string} name - Display name.
|
|
246
|
+
* @param {number} position - Sort position in the checkout (default 0).
|
|
247
|
+
* @param {string} provider - PSP code from the catalog — only for kind 'psp'.
|
|
248
|
+
* @param {string} providerMethod - The provider's payment method id (e.g. 'card', 'paypal').
|
|
88
249
|
* @throws {RevenexxException}
|
|
89
250
|
* @returns {Promise<Models.PaymentMethod>}
|
|
90
251
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
91
252
|
*/
|
|
92
|
-
paymentsMethodsUpdate(id: string): Promise<Models.PaymentMethod>;
|
|
253
|
+
paymentsMethodsUpdate(id: string, code?: string, countries?: string[], description?: string, enabled?: boolean, feeAmount?: number, feeCurrency?: string, feeType?: PaymentFeeType, kind?: PaymentMethodKind, labels?: object, maxOrderValue?: number, metadata?: object, minOrderValue?: number, name?: string, position?: number, provider?: string, providerMethod?: string): Promise<Models.PaymentMethod>;
|
|
93
254
|
/**
|
|
94
255
|
*
|
|
95
256
|
* @throws {RevenexxException}
|
|
@@ -98,10 +259,39 @@ export declare class Payments {
|
|
|
98
259
|
paymentsProvidersList(): Promise<{}>;
|
|
99
260
|
/**
|
|
100
261
|
*
|
|
262
|
+
* @param {string} params.provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).
|
|
263
|
+
* @param {object} params.credentials - PSP credentials — the catalog's credential_fields say which keys the auth scheme expects.
|
|
264
|
+
* @param {boolean} params.enabled - Only enabled providers transact (default false).
|
|
265
|
+
* @param {string} params.name - Display name — defaults to the catalog label.
|
|
266
|
+
* @param {object} params.options - Free-form provider options.
|
|
267
|
+
* @param {boolean} params.testMode - Sandbox/test credentials (default true).
|
|
268
|
+
* @param {string} params.webhookSecret - Shared secret for PSP callback verification.
|
|
269
|
+
* @throws {RevenexxException}
|
|
270
|
+
* @returns {Promise<Models.PaymentProvider>}
|
|
271
|
+
*/
|
|
272
|
+
paymentsProvidersCreate(params: {
|
|
273
|
+
provider: string;
|
|
274
|
+
credentials?: object;
|
|
275
|
+
enabled?: boolean;
|
|
276
|
+
name?: string;
|
|
277
|
+
options?: object;
|
|
278
|
+
testMode?: boolean;
|
|
279
|
+
webhookSecret?: string;
|
|
280
|
+
}): Promise<Models.PaymentProvider>;
|
|
281
|
+
/**
|
|
282
|
+
*
|
|
283
|
+
* @param {string} provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).
|
|
284
|
+
* @param {object} credentials - PSP credentials — the catalog's credential_fields say which keys the auth scheme expects.
|
|
285
|
+
* @param {boolean} enabled - Only enabled providers transact (default false).
|
|
286
|
+
* @param {string} name - Display name — defaults to the catalog label.
|
|
287
|
+
* @param {object} options - Free-form provider options.
|
|
288
|
+
* @param {boolean} testMode - Sandbox/test credentials (default true).
|
|
289
|
+
* @param {string} webhookSecret - Shared secret for PSP callback verification.
|
|
101
290
|
* @throws {RevenexxException}
|
|
102
291
|
* @returns {Promise<Models.PaymentProvider>}
|
|
292
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
103
293
|
*/
|
|
104
|
-
paymentsProvidersCreate(): Promise<Models.PaymentProvider>;
|
|
294
|
+
paymentsProvidersCreate(provider: string, credentials?: object, enabled?: boolean, name?: string, options?: object, testMode?: boolean, webhookSecret?: string): Promise<Models.PaymentProvider>;
|
|
105
295
|
/**
|
|
106
296
|
*
|
|
107
297
|
* @throws {RevenexxException}
|
|
@@ -145,39 +335,63 @@ export declare class Payments {
|
|
|
145
335
|
/**
|
|
146
336
|
*
|
|
147
337
|
* @param {string} params.id -
|
|
338
|
+
* @param {object} params.credentials - PSP credentials — the catalog's credential_fields say which keys the auth scheme expects.
|
|
339
|
+
* @param {boolean} params.enabled - Only enabled providers transact (default false).
|
|
340
|
+
* @param {string} params.name - Display name — defaults to the catalog label.
|
|
341
|
+
* @param {object} params.options - Free-form provider options.
|
|
342
|
+
* @param {string} params.provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).
|
|
343
|
+
* @param {boolean} params.testMode - Sandbox/test credentials (default true).
|
|
344
|
+
* @param {string} params.webhookSecret - Shared secret for PSP callback verification.
|
|
148
345
|
* @throws {RevenexxException}
|
|
149
346
|
* @returns {Promise<Models.PaymentProvider>}
|
|
150
347
|
*/
|
|
151
348
|
paymentsProvidersUpdate(params: {
|
|
152
349
|
id: string;
|
|
350
|
+
credentials?: object;
|
|
351
|
+
enabled?: boolean;
|
|
352
|
+
name?: string;
|
|
353
|
+
options?: object;
|
|
354
|
+
provider?: string;
|
|
355
|
+
testMode?: boolean;
|
|
356
|
+
webhookSecret?: string;
|
|
153
357
|
}): Promise<Models.PaymentProvider>;
|
|
154
358
|
/**
|
|
155
359
|
*
|
|
156
360
|
* @param {string} id -
|
|
361
|
+
* @param {object} credentials - PSP credentials — the catalog's credential_fields say which keys the auth scheme expects.
|
|
362
|
+
* @param {boolean} enabled - Only enabled providers transact (default false).
|
|
363
|
+
* @param {string} name - Display name — defaults to the catalog label.
|
|
364
|
+
* @param {object} options - Free-form provider options.
|
|
365
|
+
* @param {string} provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).
|
|
366
|
+
* @param {boolean} testMode - Sandbox/test credentials (default true).
|
|
367
|
+
* @param {string} webhookSecret - Shared secret for PSP callback verification.
|
|
157
368
|
* @throws {RevenexxException}
|
|
158
369
|
* @returns {Promise<Models.PaymentProvider>}
|
|
159
370
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
160
371
|
*/
|
|
161
|
-
paymentsProvidersUpdate(id: string): Promise<Models.PaymentProvider>;
|
|
372
|
+
paymentsProvidersUpdate(id: string, credentials?: object, enabled?: boolean, name?: string, options?: object, provider?: string, testMode?: boolean, webhookSecret?: string): Promise<Models.PaymentProvider>;
|
|
162
373
|
/**
|
|
163
374
|
* Consumes the dispatch envelope from webhooks.revenexx.com: normalizes the provider callback (stripe payment intents + a generic shape), resolves the payment by psp_payment_id or order_ref and moves the ledger. Facts only move forward — provider retries and redeliveries are idempotent no-ops; unverified envelopes are refused.
|
|
164
375
|
*
|
|
165
376
|
* @param {string} params.provider -
|
|
377
|
+
* @param {object} params.data - Request body
|
|
166
378
|
* @throws {RevenexxException}
|
|
167
379
|
* @returns {Promise<{}>}
|
|
168
380
|
*/
|
|
169
381
|
paymentsWebhooksIngest(params: {
|
|
170
382
|
provider: string;
|
|
383
|
+
data: object;
|
|
171
384
|
}): Promise<{}>;
|
|
172
385
|
/**
|
|
173
386
|
* Consumes the dispatch envelope from webhooks.revenexx.com: normalizes the provider callback (stripe payment intents + a generic shape), resolves the payment by psp_payment_id or order_ref and moves the ledger. Facts only move forward — provider retries and redeliveries are idempotent no-ops; unverified envelopes are refused.
|
|
174
387
|
*
|
|
175
388
|
* @param {string} provider -
|
|
389
|
+
* @param {object} data - Request body
|
|
176
390
|
* @throws {RevenexxException}
|
|
177
391
|
* @returns {Promise<{}>}
|
|
178
392
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
179
393
|
*/
|
|
180
|
-
paymentsWebhooksIngest(provider: string): Promise<{}>;
|
|
394
|
+
paymentsWebhooksIngest(provider: string, data: object): Promise<{}>;
|
|
181
395
|
/**
|
|
182
396
|
*
|
|
183
397
|
* @param {string} params.id -
|