@revenexx/sdk 0.0.4 → 0.0.5

package/types/services/pages.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { PageStatus } from '../enums/page-status';
 export declare class Pages {
     client: Client;
     constructor(client: Client);
@@ -320,20 +321,29 @@ export declare class Pages {
     /**
      *
      * @param {string} params.pageId -
+     * @param {string} params.plugin - Mutation plugin id (add, move, delete, duplicate, update_field_value, ...).
+     * @param {string} params.langcode -
+     * @param {object} params.payload -
      * @throws {RevenexxException}
      * @returns {Promise<Models.MutationResponse>}
      */
     pagesEditorMutate(params: {
         pageId: string;
+        plugin: string;
+        langcode?: string;
+        payload?: object;
     }): Promise<Models.MutationResponse>;
     /**
      *
      * @param {string} pageId -
+     * @param {string} plugin - Mutation plugin id (add, move, delete, duplicate, update_field_value, ...).
+     * @param {string} langcode -
+     * @param {object} payload -
      * @throws {RevenexxException}
      * @returns {Promise<Models.MutationResponse>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorMutate(pageId: string): Promise<Models.MutationResponse>;
+    pagesEditorMutate(pageId: string, plugin: string, langcode?: string, payload?: object): Promise<Models.MutationResponse>;
     /**
      *
      * @param {string} params.pageId -
@@ -543,20 +553,29 @@ export declare class Pages {
     /**
      *
      * @param {string} params.id -
+     * @param {string} params.bundle -
+     * @param {string} params.label -
+     * @param {object} params.tree - Serialized block tree ({ bundle, props, props_i18n, options, children }).
      * @throws {RevenexxException}
      * @returns {Promise<Models.LibraryItem>}
      */
     pagesLibraryUpdate(params: {
         id: string;
+        bundle?: string;
+        label?: string;
+        tree?: object;
     }): Promise<Models.LibraryItem>;
     /**
      *
      * @param {string} id -
+     * @param {string} bundle -
+     * @param {string} label -
+     * @param {object} tree - Serialized block tree ({ bundle, props, props_i18n, options, children }).
      * @throws {RevenexxException}
      * @returns {Promise<Models.LibraryItem>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesLibraryUpdate(id: string): Promise<Models.LibraryItem>;
+    pagesLibraryUpdate(id: string, bundle?: string, label?: string, tree?: object): Promise<Models.LibraryItem>;
     /**
      *
      * @throws {RevenexxException}
@@ -565,10 +584,36 @@ export declare class Pages {
     pagesPagesList(): Promise<{}>;
     /**
      *
+     * @param {string} params.title -
+     * @param {string} params.bundle -
+     * @param {object} params.hostOptions -
+     * @param {object} params.meta -
+     * @param {string} params.slug -
+     * @param {string} params.sourceLanguage -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Page>}
+     */
+    pagesPagesCreate(params: {
+        title: string;
+        bundle?: string;
+        hostOptions?: object;
+        meta?: object;
+        slug?: string;
+        sourceLanguage?: string;
+    }): Promise<Models.Page>;
+    /**
+     *
+     * @param {string} title -
+     * @param {string} bundle -
+     * @param {object} hostOptions -
+     * @param {object} meta -
+     * @param {string} slug -
+     * @param {string} sourceLanguage -
      * @throws {RevenexxException}
      * @returns {Promise<Models.Page>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesPagesCreate(): Promise<Models.Page>;
+    pagesPagesCreate(title: string, bundle?: string, hostOptions?: object, meta?: object, slug?: string, sourceLanguage?: string): Promise<Models.Page>;
     /**
      *
      * @param {string} params.id -
@@ -606,20 +651,35 @@ export declare class Pages {
     /**
      *
      * @param {string} params.id -
+     * @param {string} params.bundle -
+     * @param {object} params.meta -
+     * @param {string} params.slug -
+     * @param {PageStatus} params.status -
+     * @param {string} params.title -
      * @throws {RevenexxException}
      * @returns {Promise<Models.Page>}
      */
     pagesPagesUpdate(params: {
         id: string;
+        bundle?: string;
+        meta?: object;
+        slug?: string;
+        status?: PageStatus;
+        title?: string;
     }): Promise<Models.Page>;
     /**
      *
      * @param {string} id -
+     * @param {string} bundle -
+     * @param {object} meta -
+     * @param {string} slug -
+     * @param {PageStatus} status -
+     * @param {string} title -
      * @throws {RevenexxException}
      * @returns {Promise<Models.Page>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesPagesUpdate(id: string): Promise<Models.Page>;
+    pagesPagesUpdate(id: string, bundle?: string, meta?: object, slug?: string, status?: PageStatus, title?: string): Promise<Models.Page>;
     /**
      *
      * @param {string} params.id -
@@ -639,10 +699,21 @@ export declare class Pages {
     pagesPagesRevisions(id: string): Promise<{}>;
     /**
      *
+     * @param {object[]} params.pages -
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    pagesSeed(): Promise<{}>;
+    pagesSeed(params?: {
+        pages?: object[];
+    }): Promise<{}>;
+    /**
+     *
+     * @param {object[]} pages -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesSeed(pages?: object[]): Promise<{}>;
     /**
      *
      * @throws {RevenexxException}
@@ -686,18 +757,36 @@ export declare class Pages {
     /**
      *
      * @param {string} params.id -
+     * @param {string} params.description -
+     * @param {string} params.fieldName -
+     * @param {boolean} params.isDefault -
+     * @param {string} params.label -
+     * @param {string} params.pageBundle -
+     * @param {object[]} params.tree - Serialized block trees ({ bundle, props, props_i18n, options, children }).
      * @throws {RevenexxException}
      * @returns {Promise<Models.Template>}
      */
     pagesTemplatesUpdate(params: {
         id: string;
+        description?: string;
+        fieldName?: string;
+        isDefault?: boolean;
+        label?: string;
+        pageBundle?: string;
+        tree?: object[];
     }): Promise<Models.Template>;
     /**
      *
      * @param {string} id -
+     * @param {string} description -
+     * @param {string} fieldName -
+     * @param {boolean} isDefault -
+     * @param {string} label -
+     * @param {string} pageBundle -
+     * @param {object[]} tree - Serialized block trees ({ bundle, props, props_i18n, options, children }).
      * @throws {RevenexxException}
      * @returns {Promise<Models.Template>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesTemplatesUpdate(id: string): Promise<Models.Template>;
+    pagesTemplatesUpdate(id: string, description?: string, fieldName?: string, isDefault?: boolean, label?: string, pageBundle?: string, tree?: object[]): Promise<Models.Template>;
 }

package/types/services/payments.d.ts

@@ -1,5 +1,7 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { PaymentFeeType } from '../enums/payment-fee-type';
+import { PaymentMethodKind } from '../enums/payment-method-kind';
 export declare class Payments {
     client: Client;
     constructor(client: Client);
@@ -11,10 +13,48 @@ export declare class Payments {
     paymentsList(): Promise<{}>;
     /**
      *
+     * @param {number} params.amount - Order amount — 0 is legal (free orders), negative is not.
+     * @param {string} params.methodCode - Code of a configured payment method.
+     * @param {string} params.cartId - The cart this payment pays for.
+     * @param {string} params.contactId - Paying customer contact.
+     * @param {string} params.country - Buyer ISO country code for the eligibility check.
+     * @param {string} params.currency - ISO 4217 code (default EUR).
+     * @param {string} params.idempotencyKey - Same key answers the same payment instead of a duplicate.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {string} params.orderRef - External order reference — also the webhook fallback key.
+     * @param {string} params.returnUrl - Where the PSP redirect flow returns the buyer to.
      * @throws {RevenexxException}
      * @returns {Promise<Models.Payment>}
      */
-    paymentsCreate(): Promise<Models.Payment>;
+    paymentsCreate(params: {
+        amount: number;
+        methodCode: string;
+        cartId?: string;
+        contactId?: string;
+        country?: string;
+        currency?: string;
+        idempotencyKey?: string;
+        metadata?: object;
+        orderRef?: string;
+        returnUrl?: string;
+    }): Promise<Models.Payment>;
+    /**
+     *
+     * @param {number} amount - Order amount — 0 is legal (free orders), negative is not.
+     * @param {string} methodCode - Code of a configured payment method.
+     * @param {string} cartId - The cart this payment pays for.
+     * @param {string} contactId - Paying customer contact.
+     * @param {string} country - Buyer ISO country code for the eligibility check.
+     * @param {string} currency - ISO 4217 code (default EUR).
+     * @param {string} idempotencyKey - Same key answers the same payment instead of a duplicate.
+     * @param {object} metadata - Free-form metadata.
+     * @param {string} orderRef - External order reference — also the webhook fallback key.
+     * @param {string} returnUrl - Where the PSP redirect flow returns the buyer to.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Payment>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    paymentsCreate(amount: number, methodCode: string, cartId?: string, contactId?: string, country?: string, currency?: string, idempotencyKey?: string, metadata?: object, orderRef?: string, returnUrl?: string): Promise<Models.Payment>;
     /**
      *
      * @throws {RevenexxException}
@@ -23,10 +63,66 @@ export declare class Payments {
     paymentsMethodsList(): Promise<{}>;
     /**
      *
+     * @param {string} params.code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
+     * @param {string} params.name - Display name.
+     * @param {string[]} params.countries - Allowed ISO country codes — empty/omitted = unrestricted.
+     * @param {string} params.description -
+     * @param {boolean} params.enabled - Disabled methods are never eligible (default false).
+     * @param {number} params.feeAmount - Fixed amount or percent value, per fee_type (default 0).
+     * @param {string} params.feeCurrency - ISO 4217 code (default EUR).
+     * @param {PaymentFeeType} params.feeType - How 'fee_amount' applies (default 'none').
+     * @param {PaymentMethodKind} params.kind - Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact).
+     * @param {object} params.labels - Localized display names ({ de, en, … }).
+     * @param {number} params.maxOrderValue - Maximum order amount — omitted = no upper bound.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {number} params.minOrderValue - Minimum order amount — omitted = no lower bound.
+     * @param {number} params.position - Sort position in the checkout (default 0).
+     * @param {string} params.provider - PSP code from the catalog — only for kind 'psp'.
+     * @param {string} params.providerMethod - The provider's payment method id (e.g. 'card', 'paypal').
      * @throws {RevenexxException}
      * @returns {Promise<Models.PaymentMethod>}
      */
-    paymentsMethodsCreate(): Promise<Models.PaymentMethod>;
+    paymentsMethodsCreate(params: {
+        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>;
+    /**
+     *
+     * @param {string} code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
+     * @param {string} name - Display name.
+     * @param {string[]} countries - Allowed ISO country codes — empty/omitted = unrestricted.
+     * @param {string} description -
+     * @param {boolean} enabled - Disabled methods are never eligible (default false).
+     * @param {number} feeAmount - Fixed amount or percent value, per fee_type (default 0).
+     * @param {string} feeCurrency - ISO 4217 code (default EUR).
+     * @param {PaymentFeeType} feeType - How 'fee_amount' applies (default 'none').
+     * @param {PaymentMethodKind} kind - Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact).
+     * @param {object} labels - Localized display names ({ de, en, … }).
+     * @param {number} maxOrderValue - Maximum order amount — omitted = no upper bound.
+     * @param {object} metadata - Free-form metadata.
+     * @param {number} minOrderValue - Minimum order amount — omitted = no lower bound.
+     * @param {number} position - Sort position in the checkout (default 0).
+     * @param {string} provider - PSP code from the catalog — only for kind 'psp'.
+     * @param {string} providerMethod - The provider's payment method id (e.g. 'card', 'paypal').
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.PaymentMethod>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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>;
     /**
      *
      * @throws {RevenexxException}
@@ -35,10 +131,27 @@ export declare class Payments {
     paymentsMethodsDefaults(): Promise<{}>;
     /**
      *
+     * @param {number} params.amount - Order amount the fees are computed against (default 0).
+     * @param {string} params.country - Buyer ISO country code — methods with country restrictions need it.
+     * @param {string} params.currency - ISO 4217 code (default EUR).
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    paymentsMethodsEligible(): Promise<{}>;
+    paymentsMethodsEligible(params?: {
+        amount?: number;
+        country?: string;
+        currency?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {number} amount - Order amount the fees are computed against (default 0).
+     * @param {string} country - Buyer ISO country code — methods with country restrictions need it.
+     * @param {string} currency - ISO 4217 code (default EUR).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    paymentsMethodsEligible(amount?: number, country?: string, currency?: string): Promise<{}>;
     /**
      *
      * @param {string} params.id -
@@ -76,20 +189,68 @@ export declare class Payments {
     /**
      *
      * @param {string} params.id -
+     * @param {string} params.code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
+     * @param {string[]} params.countries - Allowed ISO country codes — empty/omitted = unrestricted.
+     * @param {string} params.description -
+     * @param {boolean} params.enabled - Disabled methods are never eligible (default false).
+     * @param {number} params.feeAmount - Fixed amount or percent value, per fee_type (default 0).
+     * @param {string} params.feeCurrency - ISO 4217 code (default EUR).
+     * @param {PaymentFeeType} params.feeType - How 'fee_amount' applies (default 'none').
+     * @param {PaymentMethodKind} params.kind - Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact).
+     * @param {object} params.labels - Localized display names ({ de, en, … }).
+     * @param {number} params.maxOrderValue - Maximum order amount — omitted = no upper bound.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {number} params.minOrderValue - Minimum order amount — omitted = no lower bound.
+     * @param {string} params.name - Display name.
+     * @param {number} params.position - Sort position in the checkout (default 0).
+     * @param {string} params.provider - PSP code from the catalog — only for kind 'psp'.
+     * @param {string} params.providerMethod - The provider's payment method id (e.g. 'card', 'paypal').
      * @throws {RevenexxException}
      * @returns {Promise<Models.PaymentMethod>}
      */
     paymentsMethodsUpdate(params: {
         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>;
     /**
      *
      * @param {string} id -
+     * @param {string} code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
+     * @param {string[]} countries - Allowed ISO country codes — empty/omitted = unrestricted.
+     * @param {string} description -
+     * @param {boolean} enabled - Disabled methods are never eligible (default false).
+     * @param {number} feeAmount - Fixed amount or percent value, per fee_type (default 0).
+     * @param {string} feeCurrency - ISO 4217 code (default EUR).
+     * @param {PaymentFeeType} feeType - How 'fee_amount' applies (default 'none').
+     * @param {PaymentMethodKind} kind - Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact).
+     * @param {object} labels - Localized display names ({ de, en, … }).
+     * @param {number} maxOrderValue - Maximum order amount — omitted = no upper bound.
+     * @param {object} metadata - Free-form metadata.
+     * @param {number} minOrderValue - Minimum order amount — omitted = no lower bound.
+     * @param {string} name - Display name.
+     * @param {number} position - Sort position in the checkout (default 0).
+     * @param {string} provider - PSP code from the catalog — only for kind 'psp'.
+     * @param {string} providerMethod - The provider's payment method id (e.g. 'card', 'paypal').
      * @throws {RevenexxException}
      * @returns {Promise<Models.PaymentMethod>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    paymentsMethodsUpdate(id: string): Promise<Models.PaymentMethod>;
+    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>;
     /**
      *
      * @throws {RevenexxException}
@@ -98,10 +259,39 @@ export declare class Payments {
     paymentsProvidersList(): Promise<{}>;
     /**
      *
+     * @param {string} params.provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).
+     * @param {object} params.credentials - PSP credentials — the catalog's credential_fields say which keys the auth scheme expects.
+     * @param {boolean} params.enabled - Only enabled providers transact (default false).
+     * @param {string} params.name - Display name — defaults to the catalog label.
+     * @param {object} params.options - Free-form provider options.
+     * @param {boolean} params.testMode - Sandbox/test credentials (default true).
+     * @param {string} params.webhookSecret - Shared secret for PSP callback verification.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.PaymentProvider>}
+     */
+    paymentsProvidersCreate(params: {
+        provider: string;
+        credentials?: object;
+        enabled?: boolean;
+        name?: string;
+        options?: object;
+        testMode?: boolean;
+        webhookSecret?: string;
+    }): Promise<Models.PaymentProvider>;
+    /**
+     *
+     * @param {string} provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).
+     * @param {object} credentials - PSP credentials — the catalog's credential_fields say which keys the auth scheme expects.
+     * @param {boolean} enabled - Only enabled providers transact (default false).
+     * @param {string} name - Display name — defaults to the catalog label.
+     * @param {object} options - Free-form provider options.
+     * @param {boolean} testMode - Sandbox/test credentials (default true).
+     * @param {string} webhookSecret - Shared secret for PSP callback verification.
      * @throws {RevenexxException}
      * @returns {Promise<Models.PaymentProvider>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    paymentsProvidersCreate(): Promise<Models.PaymentProvider>;
+    paymentsProvidersCreate(provider: string, credentials?: object, enabled?: boolean, name?: string, options?: object, testMode?: boolean, webhookSecret?: string): Promise<Models.PaymentProvider>;
     /**
      *
      * @throws {RevenexxException}
@@ -145,39 +335,63 @@ export declare class Payments {
     /**
      *
      * @param {string} params.id -
+     * @param {object} params.credentials - PSP credentials — the catalog's credential_fields say which keys the auth scheme expects.
+     * @param {boolean} params.enabled - Only enabled providers transact (default false).
+     * @param {string} params.name - Display name — defaults to the catalog label.
+     * @param {object} params.options - Free-form provider options.
+     * @param {string} params.provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).
+     * @param {boolean} params.testMode - Sandbox/test credentials (default true).
+     * @param {string} params.webhookSecret - Shared secret for PSP callback verification.
      * @throws {RevenexxException}
      * @returns {Promise<Models.PaymentProvider>}
      */
     paymentsProvidersUpdate(params: {
         id: string;
+        credentials?: object;
+        enabled?: boolean;
+        name?: string;
+        options?: object;
+        provider?: string;
+        testMode?: boolean;
+        webhookSecret?: string;
     }): Promise<Models.PaymentProvider>;
     /**
      *
      * @param {string} id -
+     * @param {object} credentials - PSP credentials — the catalog's credential_fields say which keys the auth scheme expects.
+     * @param {boolean} enabled - Only enabled providers transact (default false).
+     * @param {string} name - Display name — defaults to the catalog label.
+     * @param {object} options - Free-form provider options.
+     * @param {string} provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).
+     * @param {boolean} testMode - Sandbox/test credentials (default true).
+     * @param {string} webhookSecret - Shared secret for PSP callback verification.
      * @throws {RevenexxException}
      * @returns {Promise<Models.PaymentProvider>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    paymentsProvidersUpdate(id: string): Promise<Models.PaymentProvider>;
+    paymentsProvidersUpdate(id: string, credentials?: object, enabled?: boolean, name?: string, options?: object, provider?: string, testMode?: boolean, webhookSecret?: string): Promise<Models.PaymentProvider>;
     /**
      * 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.
      *
      * @param {string} params.provider -
+     * @param {object} params.data - Request body
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     paymentsWebhooksIngest(params: {
         provider: string;
+        data: object;
     }): Promise<{}>;
     /**
      * 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.
      *
      * @param {string} provider -
+     * @param {object} data - Request body
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    paymentsWebhooksIngest(provider: string): Promise<{}>;
+    paymentsWebhooksIngest(provider: string, data: object): Promise<{}>;
     /**
      *
      * @param {string} params.id -