@learnorama/mozaik-sdk 0.12.3-staging.46.1 → 0.13.0-staging.48.1

package/dist/api/biblio-billing.d.ts

@@ -0,0 +1,192 @@
+
+import { Bm as BillingIdentityRead, Bt as PromotionPage, Cm as BillingProviderProductWrite, Dm as BillingProductPage, Em as BillingProductWrite, Fm as BillingListTransactionsParams, Ft as PromotionRevealWrite, Gm as BillingCheckoutSubmitWrite, Hm as BillingClientTokenWrite, Ht as PromotionWrite, Im as BillingListSubscriptionsParams, It as PromotionRedemptionRead, Jm as BillingCancelWrite, Jt as PromotionExportRead, Km as BillingCheckoutRead, Lm as BillingListPromotionsParams, Lt as PromotionRedemptionHistoryPage, Nm as BillingPaymentMethodWrite, Om as BillingProductRead, Rm as BillingListProductsParams, Sm as BillingQuoteWrite, Tm as BillingPromotionGeneratorsParams, Um as BillingClientTokenRead, Ut as PromotionGeneratorPage, Vt as PromotionGeneratorWrite, Wt as PromotionGeneratorRead, Xm as BillingCancellationFeedbackPage, Xt as PromotionCreatedRead, Ym as BillingCancellationFeedbackParams, _m as BillingSubscriptionHistoryPage, dm as BillingTransactionRead, en as PromotionCodeRead, gm as BillingSubscriptionHistoryParams, jm as BillingProductAvailabilityWrite, mm as BillingSubscriptionRead, nn as PromotionCapacityRead, pm as BillingSubscriptionPage, qt as PromotionExportWrite, tn as PromotionCodeListRead, um as BillingTransactionPage, wm as BillingPromotionRedemptionsParams, zm as BillingIdentityWrite, zt as PromotionRedeemWrite } from "../chunks/index.js";
+import { c as request } from "../chunks/client.js";
+//#region src/api/biblio-billing/biblio-billing.d.ts
+export declare const getBillingCreateProductUrl: (catalogueId: number) => string;
+/**
+ * A global commercial operator creates an offer and its server-owned net price/tax. New offers default to inactive. Fixed offers need accessMonths or an institutional template; recurring offers cannot use a template. Retention offers require the customer's dated agreement. Requires high-assurance authentication.
+ * @summary Create a catalogue billing offer
+ */
+export declare const billingCreateProduct: (catalogueId: number, billingProductWrite: BillingProductWrite, options?: Parameters<typeof request>[1]) => Promise<BillingProductRead>;
+export declare const getBillingGeneratePromotionsUrl: (catalogueId: number) => string;
+/**
+ * Create 1–500 independent rules and encrypted distribution codes atomically from one reviewed template. Each code is the optional prefix followed by 20 unambiguous characters; rule.code must be null. rule.quantity is stock per generated rule, not the number of codes. Requires global commercial authority. Requires high-assurance authentication.
+ * @summary Generate a bounded promotion-code batch
+ */
+export declare const billingGeneratePromotions: (catalogueId: number, promotionGeneratorWrite: PromotionGeneratorWrite, options?: Parameters<typeof request>[1]) => Promise<PromotionCodeListRead>;
+export declare const getBillingPromotionGeneratorsUrl: (catalogueId: number, params?: BillingPromotionGeneratorsParams) => string;
+/**
+ * Global commercial operators list safe generator definitions, newest first. Includes historical sourceMask and partial rule fields when known; codes and private source metadata require a separate audited export.
+ * @summary List catalogue promotion generators
+ */
+export declare const billingPromotionGenerators: (catalogueId: number, params?: BillingPromotionGeneratorsParams, options?: Parameters<typeof request>[1]) => Promise<PromotionGeneratorPage>;
+export declare const getBillingListPromotionsUrl: (catalogueId: number, params?: BillingListPromotionsParams) => string;
+/**
+ * Catalogue finance operators list rule metadata, including inactive rules, ordered by promotion ID. Codes are deliberately omitted; explicit audited reveal or export is required to distribute codes.
+ * @summary List catalogue promotion rules
+ */
+export declare const billingListPromotions: (catalogueId: number, params?: BillingListPromotionsParams, options?: Parameters<typeof request>[1]) => Promise<PromotionPage>;
+export declare const getBillingCreatePromotionUrl: (catalogueId: number) => string;
+/**
+ * A global commercial operator creates bounded promotion stock for a catalogue. Discounts apply to explicit checkouts; benefits without payment-method requirements can be redeemed directly. Null code generates three groups of six unambiguous characters. Explicit codes retain their display form; lookup uses NFKC, trim and casefold normalization. Targets must belong to the catalogue. Requires high-assurance authentication.
+ * @summary Create a discount or access benefit
+ */
+export declare const billingCreatePromotion: (catalogueId: number, promotionWrite: PromotionWrite, options?: Parameters<typeof request>[1]) => Promise<PromotionCreatedRead>;
+export declare const getBillingExportPromotionCodesUrl: (catalogueId: number) => string;
+/**
+ * Global commercial operators decrypt selected catalogue codes in one audited transaction. Supply unique promotionIds and a reason; all IDs must belong to the selected catalogue or the entire export is refused. The JSON data is ordered by promotion ID. Responses are private, no-store. Requires high-assurance authentication.
+ * @summary Export selected promotion codes with an audit reason
+ */
+export declare const billingExportPromotionCodes: (catalogueId: number, promotionExportWrite: PromotionExportWrite, options?: Parameters<typeof request>[1]) => Promise<PromotionExportRead>;
+export declare const getBillingQuoteCheckoutUrl: () => string;
+/**
+ * Freeze server-priced purchase and renewal terms for 15 minutes and reserve promotion stock. Reuse requestKey with the same product and normalized promotion set to retrieve the same checkout; changing either under the same key returns 409. No payment is submitted by quoting. Display recurring, renewalAmount and expiresAt before obtaining consent. A fully discounted offer without a required payment method can become fixed access without renewal. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Quote a personal checkout
+ */
+export declare const billingQuoteCheckout: (billingQuoteWrite: BillingQuoteWrite, options?: Parameters<typeof request>[1]) => Promise<BillingCheckoutRead>;
+export declare const getBillingReadCheckoutUrl: (checkoutId: number) => string;
+/**
+ * Return persisted quote and outcome without contacting the payment provider. A submitting or unknown checkout requires the explicit reconcile operation; reading it does not retry payment. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached.
+ * @summary Read the current profile's checkout
+ */
+export declare const billingReadCheckout: (checkoutId: number, options?: Parameters<typeof request>[1]) => Promise<BillingCheckoutRead>;
+export declare const getBillingReconcileCheckoutUrl: (checkoutId: number) => string;
+/**
+ * Look up provider evidence using the checkout's existing operation identity and complete the same purchase when a matching receipt is found. This never resubmits payment. An absent receipt leaves the checkout submitting or unknown; terminal and quoted states are returned unchanged. Environment and quote integrity must match before access can be granted. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Reconcile an uncertain checkout
+ */
+export declare const billingReconcileCheckout: (checkoutId: number, options?: Parameters<typeof request>[1]) => Promise<BillingCheckoutRead>;
+export declare const getBillingSubmitCheckoutUrl: (checkoutId: number) => string;
+/**
+ * Submit the owned quote with acceptedTerms=true and a single-use provider nonce when payment or renewal requires it. Completed, submitting and unknown checkouts are returned without another charge. HTTP 200 alone does not mean payment succeeded: complete confirms the receipt, failed records a refusal, and unknown preserves an ambiguous provider outcome. Reconcile the same checkout after uncertainty; do not create a replacement payment. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Submit an accepted checkout
+ */
+export declare const billingSubmitCheckout: (checkoutId: number, billingCheckoutSubmitWrite: BillingCheckoutSubmitWrite, options?: Parameters<typeof request>[1]) => Promise<BillingCheckoutRead>;
+export declare const getBillingCreateClientTokenUrl: () => string;
+/**
+ * Obtain a Braintree client token for an owned, unexpired quoted checkout in the current environment. Pass it to the provider SDK to collect a single-use paymentMethodNonce, then submit the checkout. The token is sensitive and must not be logged or persisted in client analytics. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Create a checkout payment client token
+ */
+export declare const billingCreateClientToken: (billingClientTokenWrite: BillingClientTokenWrite, options?: Parameters<typeof request>[1]) => Promise<BillingClientTokenRead>;
+export declare const getBillingPrepareIdentityUrl: () => string;
+/**
+ * Return or create the stable server-issued billing subject for the selected provider in the configured environment. Supply this subject to the mobile billing SDK; never substitute a profile ID or email. This explicit request does not grant course access or charge a payment method. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Prepare the current profile's billing identity
+ */
+export declare const billingPrepareIdentity: (billingIdentityWrite: BillingIdentityWrite, options?: Parameters<typeof request>[1]) => Promise<BillingIdentityRead>;
+export declare const getBillingListProductsUrl: (params?: BillingListProductsParams) => string;
+/**
+ * List active offers visible to the profile, with server-calculated tax-inclusive prices. Retention offers appear only within seven days of their exact institution agreement's end. checkoutAvailable reflects configured web payment capability; providerProducts identifies active mappings in the current billing environment. Listing never starts a purchase. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached.
+ * @summary List personal purchase offers
+ */
+export declare const billingListProducts: (params?: BillingListProductsParams, options?: Parameters<typeof request>[1]) => Promise<BillingProductPage>;
+export declare const getBillingSetOfferAvailabilityUrl: (productId: number) => string;
+/**
+ * Set offer availability after commercial review and record the reason in the audit trail. Requires catalogue finance and global commercial authority. Returns 204 with no response body. Requires high-assurance authentication.
+ * @summary Activate or withdraw an offer
+ */
+export declare const billingSetOfferAvailability: (productId: number, billingProductAvailabilityWrite: BillingProductAvailabilityWrite, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getBillingBindProviderProductUrl: (productId: number) => string;
+/**
+ * Catalogue finance operators associate an offer with an exact provider product and sandbox or production environment. A provider/environment/product identifier cannot be shared by different offers. Store products must be public recurring offers. Returns 204 with no response body. Requires high-assurance authentication.
+ * @summary Bind an offer to a provider product
+ */
+export declare const billingBindProviderProduct: (productId: number, billingProviderProductWrite: BillingProviderProductWrite, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getBillingPromotionGeneratorUrl: (generatorId: number) => string;
+/**
+ * Return a safe definition to a global commercial operator. batchSize counts generated codes while rule.quantity describes permitted uses of each code. Historical missing rule values stay null.
+ * @summary Read a promotion generator definition
+ */
+export declare const billingPromotionGenerator: (generatorId: number, options?: Parameters<typeof request>[1]) => Promise<PromotionGeneratorRead>;
+export declare const getBillingRedeemPromotionUrl: () => string;
+/**
+ * Redeem a usable benefit code that does not require a payment method, atomically consuming stock and creating personal access through shared contracts. Discounts use checkout instead. Reusing requestKey for the same promotion returns the previous redemption; reuse for another code returns 409. Case/Unicode-normalized lookup, per-user stock and access-window limits apply. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Redeem an access benefit for the current profile
+ */
+export declare const billingRedeemPromotion: (promotionRedeemWrite: PromotionRedeemWrite, options?: Parameters<typeof request>[1]) => Promise<PromotionRedemptionRead>;
+export declare const getBillingPromotionCapacityUrl: (promotionId: number) => string;
+/**
+ * Global commercial operators inspect total and per-user limits, redeemed stock and live reservations. Submitting or unknown checkouts keep reservations even after quote expiry. remaining is max(0, quantity - redeemed - reserved); a positive count alone does not prove a rule is active or usable.
+ * @summary Inspect promotion stock and payment reservations
+ */
+export declare const billingPromotionCapacity: (promotionId: number, options?: Parameters<typeof request>[1]) => Promise<PromotionCapacityRead>;
+export declare const getBillingRevealPromotionCodeUrl: (promotionId: number) => string;
+/**
+ * A catalogue finance operator decrypts one distribution code and records the supplied reason. The response is private, no-store; do not expose it in public reports. Requires high-assurance authentication.
+ * @summary Reveal one promotion code with an audit reason
+ */
+export declare const billingRevealPromotionCode: (promotionId: number, promotionRevealWrite: PromotionRevealWrite, options?: Parameters<typeof request>[1]) => Promise<PromotionCodeRead>;
+export declare const getBillingPromotionRedemptionsUrl: (promotionId: number, params?: BillingPromotionRedemptionsParams) => string;
+/**
+ * Global commercial operators list a promotion's native and imported redemptions, newest first. Historical beneficiary, contract, transaction, discount and time references can be null; do not infer a payment from a redemption. Codes and raw source identifiers are omitted.
+ * @summary List promotion redemption evidence
+ */
+export declare const billingPromotionRedemptions: (promotionId: number, params?: BillingPromotionRedemptionsParams, options?: Parameters<typeof request>[1]) => Promise<PromotionRedemptionHistoryPage>;
+export declare const getBillingRestoreStorePurchasesUrl: () => string;
+/**
+ * Fetch RevenueCat evidence for the server-issued billing subject and reconcile supported store receipts in the current environment with active provider mappings. Receipts belonging to another profile are refused. Unknown receipt price, tax or renewal values stay unknown. The returned page contains restored subscriptions and can be empty; there is no client-supplied receipt-owner ID. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Restore the current profile's mobile purchases
+ */
+export declare const billingRestoreStorePurchases: (billingIdentityWrite: BillingIdentityWrite, options?: Parameters<typeof request>[1]) => Promise<BillingSubscriptionPage>;
+export declare const getBillingListSubscriptionsUrl: (params?: BillingListSubscriptionsParams) => string;
+/**
+ * List local subscription projections, newest first. No provider refresh occurs. autoRenew=null means renewal is unknown, and unknown historical price/currency remain null; use explicit reconciliation or store restoration to obtain current evidence. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached.
+ * @summary List the current profile's subscriptions
+ */
+export declare const billingListSubscriptions: (params?: BillingListSubscriptionsParams, options?: Parameters<typeof request>[1]) => Promise<BillingSubscriptionPage>;
+export declare const getBillingReadSubscriptionUrl: (subscriptionId: number) => string;
+/**
+ * Read the local subscription and its known access, price and renewal terms. managementUrl is provided for mobile store subscriptions. This GET neither refreshes receipts nor changes renewal. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached.
+ * @summary Read the current profile's subscription
+ */
+export declare const billingReadSubscription: (subscriptionId: number, options?: Parameters<typeof request>[1]) => Promise<BillingSubscriptionRead>;
+export declare const getBillingCancelSubscriptionUrl: (subscriptionId: number) => string;
+/**
+ * Cancel Braintree renewal and project the provider-confirmed access end, or cancel a local fixed subscription. Existing paid access follows the confirmed period. Optional feedback is stored separately. Mobile store renewal must be managed through managementUrl; this operation returns 409 for stores. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Cancel a personal subscription's renewal
+ */
+export declare const billingCancelSubscription: (subscriptionId: number, billingCancelWrite: BillingCancelWrite, options?: Parameters<typeof request>[1]) => Promise<BillingSubscriptionRead>;
+export declare const getBillingCancellationFeedbackUrl: (subscriptionId: number, params?: BillingCancellationFeedbackParams) => string;
+/**
+ * List only this profile's recorded cancellation feedback for the owned subscription, newest first. Missing historical answers and dates stay null. Feedback is not evidence of current provider renewal state. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached.
+ * @summary List an owned subscription's cancellation feedback
+ */
+export declare const billingCancellationFeedback: (subscriptionId: number, params?: BillingCancellationFeedbackParams, options?: Parameters<typeof request>[1]) => Promise<BillingCancellationFeedbackPage>;
+export declare const getBillingSubscriptionClientTokenUrl: (subscriptionId: number) => string;
+/**
+ * Initialize payment-method collection for an owned Braintree subscription whose renewal is confirmed active. Unknown renewal must be reconciled first; store and nonrenewing subscriptions are not editable here. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Create a subscription payment-method token
+ */
+export declare const billingSubscriptionClientToken: (subscriptionId: number, options?: Parameters<typeof request>[1]) => Promise<BillingClientTokenRead>;
+export declare const getBillingSubscriptionHistoryUrl: (subscriptionId: number, params?: BillingSubscriptionHistoryParams) => string;
+/**
+ * List preserved subscription events, newest local identifier first. Source status and transactionType are evidence labels, not current renewal guarantees. Unknown source times remain null with clockBasis; amount may also be null and this projection does not supply a currency. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached.
+ * @summary List an owned subscription's source events
+ */
+export declare const billingSubscriptionHistory: (subscriptionId: number, params?: BillingSubscriptionHistoryParams, options?: Parameters<typeof request>[1]) => Promise<BillingSubscriptionHistoryPage>;
+export declare const getBillingUpdatePaymentMethodUrl: (subscriptionId: number) => string;
+/**
+ * Use a new provider SDK nonce to update the current profile's renewing Braintree subscription and apply the returned receipt. acceptedOutstandingBalance explicitly allows collection of an outstanding balance; it defaults to false. Store subscriptions use their original provider. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Update a renewing subscription's payment method
+ */
+export declare const billingUpdatePaymentMethod: (subscriptionId: number, billingPaymentMethodWrite: BillingPaymentMethodWrite, options?: Parameters<typeof request>[1]) => Promise<BillingSubscriptionRead>;
+export declare const getBillingReconcileSubscriptionUrl: (subscriptionId: number) => string;
+/**
+ * Read the existing Braintree subscription, refresh authoritative renewal/access terms and project shared contract access. The existing provider identity and current billing environment must match. Use store restoration for App Store and Play Store subscriptions. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached. Requires high-assurance authentication.
+ * @summary Refresh a Braintree subscription from its receipt
+ */
+export declare const billingReconcileSubscription: (subscriptionId: number, options?: Parameters<typeof request>[1]) => Promise<BillingSubscriptionRead>;
+export declare const getBillingListTransactionsUrl: (params?: BillingListTransactionsParams) => string;
+/**
+ * List private native and imported transactions, newest local identifier first. Historical timestamps, money and currency remain null when unverified. amountBasis distinguishes verified_receipt, historical_provider_evidence and unknown. listedAmountBeforeDiscount and calculatedAmountAfterDiscount preserve source arithmetic; they must not be presented as confirmed paid amounts. clockBasis describes time evidence. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached.
+ * @summary List the current profile's payment history
+ */
+export declare const billingListTransactions: (params?: BillingListTransactionsParams, options?: Parameters<typeof request>[1]) => Promise<BillingTransactionPage>;
+export declare const getBillingReadTransactionUrl: (transactionId: number) => string;
+/**
+ * Return one transaction belonging to the authenticated profile. Historical timestamps, money and currency remain null when unverified. amountBasis distinguishes verified_receipt, historical_provider_evidence and unknown. listedAmountBeforeDiscount and calculatedAmountAfterDiscount preserve source arithmetic; they must not be presented as confirmed paid amounts. clockBasis describes time evidence. Uses the authenticated independent profile in the Biblio product context; support impersonation is refused. Responses are private and must not be cached.
+ * @summary Read an owned transaction's payment evidence
+ */
+export declare const billingReadTransaction: (transactionId: number, options?: Parameters<typeof request>[1]) => Promise<BillingTransactionRead>;
+//#endregion
+//# sourceMappingURL=biblio-billing.d.ts.map