@heyama/pay-react-native 0.0.0-stage → 1.0.1

package/dist/checkout-core/models/checkout.enum.d.ts

@@ -0,0 +1,133 @@
+export declare enum CheckoutScreenEnum {
+    LOADING = "loading",
+    FORM = "form",
+    SUBMITTING = "submitting",
+    WAITING = "waiting",
+    /** The last attempt failed: why, a retry and another method. */
+    FAILED = "failed",
+    SUCCESS = "success",
+    EXPIRED = "expired",
+    CANCELLED = "cancelled",
+    LOCKED = "locked",
+    INVALID = "invalid",
+    /** Every method went off since the link was made: nothing to pay with. */
+    NO_METHOD = "no_method",
+    REDIRECT = "redirect"
+}
+/** Values are the `preferredTab` an app may send. */
+export declare enum CheckoutTabEnum {
+    MOBILE_MONEY = "mobile_money",
+    CARD = "card"
+}
+/** GLOSSARY: Payment. Values are the API's. */
+export declare enum CheckoutPaymentStatusEnum {
+    PENDING = "pending",
+    PAID = "paid",
+    EXPIRED = "expired",
+    LOCKED = "locked",
+    CANCELLED = "cancelled"
+}
+/** Where a method stands on this payment: payable, greyed with a note, or not built yet. */
+export declare enum MethodStateEnum {
+    AVAILABLE = "available",
+    MAINTENANCE = "maintenance",
+    SOON = "soon"
+}
+export declare enum MethodKindEnum {
+    MOBILE_MONEY = "mobile_money",
+    CARD = "card"
+}
+/** How the payer approves: a prompt on the phone, a one-time code, or card fields. Values are the backend's. */
+export declare enum MethodFlowEnum {
+    USSD_PUSH = "ussd_push",
+    OTP = "otp",
+    CARD_FIELDS = "card_fields"
+}
+/** The network a Mobile Money number belongs to, from its first digits. Values are logo names. */
+export declare enum MethodBrandEnum {
+    ORANGE = "orange",
+    MTN = "mtn",
+    MOOV = "moov"
+}
+/** Why Pay was refused. Values are the backend's. */
+export declare enum PayRefusalEnum {
+    CLOSED = "closed",
+    METHOD = "method",
+    PHONE = "phone",
+    /** An OTP method came without a valid code. */
+    CODE = "code",
+    /** Earlier attempts still pending could use up the payment's tries. */
+    BUSY = "busy"
+}
+/**
+ * What a provider's card fields page and the checkout tell each other through
+ * `postMessage`. The card itself never crosses: only whether it is complete,
+ * the page's height, and how a Pay went.
+ */
+export declare enum CardFieldsMessageEnum {
+    /** Page → checkout: `complete` says whether Pay can go. */
+    STATE = "card-fields:state",
+    /** Page → checkout: its content height, so the frame never scrolls. */
+    HEIGHT = "card-fields:height",
+    /** Checkout → page: Pay was pressed. */
+    SUBMIT = "card-fields:submit",
+    /** Page → checkout: the card is with the provider; the checkout waits for the status checks. */
+    DONE = "card-fields:done",
+    /** Page → checkout: Pay was refused (`reason`), or could not reach us (none). */
+    REFUSED = "card-fields:refused"
+}
+export declare enum CardFieldEnum {
+    NUMBER = "number",
+    EXPIRY = "expiry",
+    CVC = "cvc"
+}
+/** What a tester makes the Simulator answer. Values are the backend's. */
+export declare enum SimulatorOutcomeEnum {
+    APPROVED = "approved",
+    DECLINED = "declined",
+    INSUFFICIENT_FUNDS = "insufficient_funds",
+    NO_ACCOUNT = "no_account",
+    WRONG_PIN = "wrong_pin",
+    WRONG_CODE = "wrong_code",
+    PROVIDER_ERROR = "provider_error",
+    WRONG_AMOUNT = "wrong_amount",
+    APPROVED_LATE = "approved_late",
+    REVERSED = "reversed"
+}
+export declare enum PhoneErrorEnum {
+    START = "start",
+    SHORT = "short",
+    INVALID = "invalid",
+    EMPTY = "empty",
+    OPERATOR = "operator",
+    /** An international number of a country the payment is not offered in. */
+    COUNTRY = "country"
+}
+export declare enum SupportChannelEnum {
+    WHATSAPP = "whatsapp",
+    EMAIL = "email"
+}
+/** Values are the keys of `faqs` in the checkout catalog. */
+export declare enum FaqEnum {
+    NOT_RECEIVED = "not_received",
+    DEBITED = "debited"
+}
+/** Screens the payer cannot act on, each with its copy. Values are catalog keys. */
+export declare enum TerminalKindEnum {
+    EXPIRED = "expired",
+    CANCELLED = "cancelled",
+    LOCKED = "locked",
+    INVALID = "invalid",
+    NO_METHOD = "no_method"
+}
+export declare enum CheckoutButtonVariantEnum {
+    PRIMARY = "primary",
+    SECONDARY = "secondary",
+    /** Gives something up: cancelling the payment. */
+    DANGER = "danger"
+}
+/** Values are the `theme` an app may send. */
+export declare enum CheckoutThemeEnum {
+    LIGHT = "light",
+    DARK = "dark"
+}

package/dist/checkout-core/models/checkout.enum.js

@@ -0,0 +1,150 @@
+export var CheckoutScreenEnum;
+(function (CheckoutScreenEnum) {
+    CheckoutScreenEnum["LOADING"] = "loading";
+    CheckoutScreenEnum["FORM"] = "form";
+    CheckoutScreenEnum["SUBMITTING"] = "submitting";
+    CheckoutScreenEnum["WAITING"] = "waiting";
+    /** The last attempt failed: why, a retry and another method. */
+    CheckoutScreenEnum["FAILED"] = "failed";
+    CheckoutScreenEnum["SUCCESS"] = "success";
+    CheckoutScreenEnum["EXPIRED"] = "expired";
+    CheckoutScreenEnum["CANCELLED"] = "cancelled";
+    CheckoutScreenEnum["LOCKED"] = "locked";
+    CheckoutScreenEnum["INVALID"] = "invalid";
+    /** Every method went off since the link was made: nothing to pay with. */
+    CheckoutScreenEnum["NO_METHOD"] = "no_method";
+    CheckoutScreenEnum["REDIRECT"] = "redirect";
+})(CheckoutScreenEnum || (CheckoutScreenEnum = {}));
+/** Values are the `preferredTab` an app may send. */
+export var CheckoutTabEnum;
+(function (CheckoutTabEnum) {
+    CheckoutTabEnum["MOBILE_MONEY"] = "mobile_money";
+    CheckoutTabEnum["CARD"] = "card";
+})(CheckoutTabEnum || (CheckoutTabEnum = {}));
+/** GLOSSARY: Payment. Values are the API's. */
+export var CheckoutPaymentStatusEnum;
+(function (CheckoutPaymentStatusEnum) {
+    CheckoutPaymentStatusEnum["PENDING"] = "pending";
+    CheckoutPaymentStatusEnum["PAID"] = "paid";
+    CheckoutPaymentStatusEnum["EXPIRED"] = "expired";
+    CheckoutPaymentStatusEnum["LOCKED"] = "locked";
+    CheckoutPaymentStatusEnum["CANCELLED"] = "cancelled";
+})(CheckoutPaymentStatusEnum || (CheckoutPaymentStatusEnum = {}));
+/** Where a method stands on this payment: payable, greyed with a note, or not built yet. */
+export var MethodStateEnum;
+(function (MethodStateEnum) {
+    MethodStateEnum["AVAILABLE"] = "available";
+    MethodStateEnum["MAINTENANCE"] = "maintenance";
+    MethodStateEnum["SOON"] = "soon";
+})(MethodStateEnum || (MethodStateEnum = {}));
+export var MethodKindEnum;
+(function (MethodKindEnum) {
+    MethodKindEnum["MOBILE_MONEY"] = "mobile_money";
+    MethodKindEnum["CARD"] = "card";
+})(MethodKindEnum || (MethodKindEnum = {}));
+/** How the payer approves: a prompt on the phone, a one-time code, or card fields. Values are the backend's. */
+export var MethodFlowEnum;
+(function (MethodFlowEnum) {
+    MethodFlowEnum["USSD_PUSH"] = "ussd_push";
+    MethodFlowEnum["OTP"] = "otp";
+    MethodFlowEnum["CARD_FIELDS"] = "card_fields";
+})(MethodFlowEnum || (MethodFlowEnum = {}));
+/** The network a Mobile Money number belongs to, from its first digits. Values are logo names. */
+export var MethodBrandEnum;
+(function (MethodBrandEnum) {
+    MethodBrandEnum["ORANGE"] = "orange";
+    MethodBrandEnum["MTN"] = "mtn";
+    MethodBrandEnum["MOOV"] = "moov";
+})(MethodBrandEnum || (MethodBrandEnum = {}));
+/** Why Pay was refused. Values are the backend's. */
+export var PayRefusalEnum;
+(function (PayRefusalEnum) {
+    PayRefusalEnum["CLOSED"] = "closed";
+    PayRefusalEnum["METHOD"] = "method";
+    PayRefusalEnum["PHONE"] = "phone";
+    /** An OTP method came without a valid code. */
+    PayRefusalEnum["CODE"] = "code";
+    /** Earlier attempts still pending could use up the payment's tries. */
+    PayRefusalEnum["BUSY"] = "busy";
+})(PayRefusalEnum || (PayRefusalEnum = {}));
+/**
+ * What a provider's card fields page and the checkout tell each other through
+ * `postMessage`. The card itself never crosses: only whether it is complete,
+ * the page's height, and how a Pay went.
+ */
+export var CardFieldsMessageEnum;
+(function (CardFieldsMessageEnum) {
+    /** Page → checkout: `complete` says whether Pay can go. */
+    CardFieldsMessageEnum["STATE"] = "card-fields:state";
+    /** Page → checkout: its content height, so the frame never scrolls. */
+    CardFieldsMessageEnum["HEIGHT"] = "card-fields:height";
+    /** Checkout → page: Pay was pressed. */
+    CardFieldsMessageEnum["SUBMIT"] = "card-fields:submit";
+    /** Page → checkout: the card is with the provider; the checkout waits for the status checks. */
+    CardFieldsMessageEnum["DONE"] = "card-fields:done";
+    /** Page → checkout: Pay was refused (`reason`), or could not reach us (none). */
+    CardFieldsMessageEnum["REFUSED"] = "card-fields:refused";
+})(CardFieldsMessageEnum || (CardFieldsMessageEnum = {}));
+export var CardFieldEnum;
+(function (CardFieldEnum) {
+    CardFieldEnum["NUMBER"] = "number";
+    CardFieldEnum["EXPIRY"] = "expiry";
+    CardFieldEnum["CVC"] = "cvc";
+})(CardFieldEnum || (CardFieldEnum = {}));
+/** What a tester makes the Simulator answer. Values are the backend's. */
+export var SimulatorOutcomeEnum;
+(function (SimulatorOutcomeEnum) {
+    SimulatorOutcomeEnum["APPROVED"] = "approved";
+    SimulatorOutcomeEnum["DECLINED"] = "declined";
+    SimulatorOutcomeEnum["INSUFFICIENT_FUNDS"] = "insufficient_funds";
+    SimulatorOutcomeEnum["NO_ACCOUNT"] = "no_account";
+    SimulatorOutcomeEnum["WRONG_PIN"] = "wrong_pin";
+    SimulatorOutcomeEnum["WRONG_CODE"] = "wrong_code";
+    SimulatorOutcomeEnum["PROVIDER_ERROR"] = "provider_error";
+    SimulatorOutcomeEnum["WRONG_AMOUNT"] = "wrong_amount";
+    SimulatorOutcomeEnum["APPROVED_LATE"] = "approved_late";
+    SimulatorOutcomeEnum["REVERSED"] = "reversed";
+})(SimulatorOutcomeEnum || (SimulatorOutcomeEnum = {}));
+export var PhoneErrorEnum;
+(function (PhoneErrorEnum) {
+    PhoneErrorEnum["START"] = "start";
+    PhoneErrorEnum["SHORT"] = "short";
+    PhoneErrorEnum["INVALID"] = "invalid";
+    PhoneErrorEnum["EMPTY"] = "empty";
+    PhoneErrorEnum["OPERATOR"] = "operator";
+    /** An international number of a country the payment is not offered in. */
+    PhoneErrorEnum["COUNTRY"] = "country";
+})(PhoneErrorEnum || (PhoneErrorEnum = {}));
+export var SupportChannelEnum;
+(function (SupportChannelEnum) {
+    SupportChannelEnum["WHATSAPP"] = "whatsapp";
+    SupportChannelEnum["EMAIL"] = "email";
+})(SupportChannelEnum || (SupportChannelEnum = {}));
+/** Values are the keys of `faqs` in the checkout catalog. */
+export var FaqEnum;
+(function (FaqEnum) {
+    FaqEnum["NOT_RECEIVED"] = "not_received";
+    FaqEnum["DEBITED"] = "debited";
+})(FaqEnum || (FaqEnum = {}));
+/** Screens the payer cannot act on, each with its copy. Values are catalog keys. */
+export var TerminalKindEnum;
+(function (TerminalKindEnum) {
+    TerminalKindEnum["EXPIRED"] = "expired";
+    TerminalKindEnum["CANCELLED"] = "cancelled";
+    TerminalKindEnum["LOCKED"] = "locked";
+    TerminalKindEnum["INVALID"] = "invalid";
+    TerminalKindEnum["NO_METHOD"] = "no_method";
+})(TerminalKindEnum || (TerminalKindEnum = {}));
+export var CheckoutButtonVariantEnum;
+(function (CheckoutButtonVariantEnum) {
+    CheckoutButtonVariantEnum["PRIMARY"] = "primary";
+    CheckoutButtonVariantEnum["SECONDARY"] = "secondary";
+    /** Gives something up: cancelling the payment. */
+    CheckoutButtonVariantEnum["DANGER"] = "danger";
+})(CheckoutButtonVariantEnum || (CheckoutButtonVariantEnum = {}));
+/** Values are the `theme` an app may send. */
+export var CheckoutThemeEnum;
+(function (CheckoutThemeEnum) {
+    CheckoutThemeEnum["LIGHT"] = "light";
+    CheckoutThemeEnum["DARK"] = "dark";
+})(CheckoutThemeEnum || (CheckoutThemeEnum = {}));