@gopaycz/gopay-js-sdk 1.6.6

package/dist/index.d.ts

@@ -0,0 +1,303 @@
+import { CoreConfig, AwaitChargeOptions as AwaitChargeOptions$1 } from '@gopay-internal/core';
+export { BrowserData, GoPayEnvironment, GoPayErrorCode, GoPayErrorCodes, GoPayHTTPError, GoPaySDKError } from '@gopay-internal/core';
+import * as _gopay_internal_core_types_generated_js from '@gopay-internal/core/types/generated.js';
+import { components } from '@gopay-internal/core/types/generated.js';
+
+/** Server SDK configuration. All fields are optional. */
+type GoPayConfig = CoreConfig;
+
+/**
+ * Create a GoPay server-side SDK instance.
+ *
+ * ESM / CommonJS:
+ * ```ts
+ * import { createGoPaySDK } from '@gopaycz/gopay-js-sdk';
+ * const sdk = createGoPaySDK({ environment: 'sandbox' });
+ * await sdk.authenticate({ grant_type: 'client_credentials', client_id: '...', client_secret: '...', scope: '...' });
+ * ```
+ */
+declare function createGoPaySDK(config?: GoPayConfig): {
+    createPaymentLink(goid: string, params: {
+        payment: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-From-Link-Request"];
+        expires_at?: string;
+        reusable: boolean;
+    }): Promise<{
+        expires_at?: string;
+        reusable: boolean;
+        id: string;
+        url: string;
+        active: boolean;
+        payment?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-From-Link-Request"];
+        stop_reason?: "FROM_API" | "ALREADY_PAID" | "EXPIRED";
+    }>;
+    linkStatus(linkId: string): Promise<{
+        expires_at?: string;
+        reusable: boolean;
+        id: string;
+        url: string;
+        active: boolean;
+        payment?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-From-Link-Request"];
+        stop_reason?: "FROM_API" | "ALREADY_PAID" | "EXPIRED";
+    }>;
+    disableLink(linkId: string): Promise<void>;
+    refundPayment(paymentId: string, params: {
+        amount: number;
+    }): Promise<{
+        id: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Refund-State"];
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        created_at: string;
+        updated_at?: string;
+    }>;
+    listRefunds(paymentId: string): Promise<{
+        id: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Refund-State"];
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        created_at: string;
+        updated_at?: string;
+    }[]>;
+    getRefund(refundId: string): Promise<{
+        id: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Refund-State"];
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        created_at: string;
+        updated_at?: string;
+    }>;
+    createRecurrence(goid: string, params: {
+        type: "AUTO" | "ON_DEMAND";
+        schedule?: _gopay_internal_core_types_generated_js.components["schemas"]["Recurrence-Schedule"];
+        payment: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Create-Request"];
+    }): Promise<{
+        type: "AUTO" | "ON_DEMAND";
+        schedule?: _gopay_internal_core_types_generated_js.components["schemas"]["Recurrence-Schedule"];
+        id: string;
+        state?: "NEW" | "REQUESTED" | "STARTED" | "STOPPED";
+        stop_reason?: "RECURRENCE_EXPIRED" | "CARD_EXPIRED" | "CANCELLED_VIA_API" | "CANCELLED_VIA_BACKOFFICE" | "CANCELLED_BY_GOPAY" | "UNKNOWN";
+        payment: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Details"];
+    }>;
+    recurrenceStatus(recId: string): Promise<{
+        type: "AUTO" | "ON_DEMAND";
+        schedule?: _gopay_internal_core_types_generated_js.components["schemas"]["Recurrence-Schedule"];
+        id: string;
+        state?: "NEW" | "REQUESTED" | "STARTED" | "STOPPED";
+        stop_reason?: "RECURRENCE_EXPIRED" | "CARD_EXPIRED" | "CANCELLED_VIA_API" | "CANCELLED_VIA_BACKOFFICE" | "CANCELLED_BY_GOPAY" | "UNKNOWN";
+        payment: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Details"];
+    }>;
+    stopRecurrence(recId: string): Promise<void>;
+    startRecurrence(recId: string, params?: {
+        amount?: number;
+        order_number?: string;
+        order_description?: string;
+        additional_params?: _gopay_internal_core_types_generated_js.components["schemas"]["Additional-Param"][];
+        customer?: _gopay_internal_core_types_generated_js.components["schemas"]["Customer"];
+        callback?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Callback"];
+    }): Promise<{
+        id: string;
+        order_number: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-State"];
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        customer: _gopay_internal_core_types_generated_js.components["schemas"]["Customer"];
+        gw_url: string;
+        charge?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Charge-Status-Response"];
+        payment_secret: string;
+    }>;
+    recurrenceNext(recId: string, params?: {
+        amount?: number;
+        order_number?: string;
+        order_description?: string;
+        additional_params?: _gopay_internal_core_types_generated_js.components["schemas"]["Additional-Param"][];
+        customer?: _gopay_internal_core_types_generated_js.components["schemas"]["Customer"];
+        callback?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Callback"];
+    }): Promise<{
+        id: string;
+        order_number: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-State"];
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        customer: _gopay_internal_core_types_generated_js.components["schemas"]["Customer"];
+        gw_url: string;
+        charge?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Charge-Status-Response"];
+        payment_secret: string;
+    }>;
+    getCardDetails(cardId: string): Promise<{
+        card_id: string;
+        masked_pan: string;
+        masked_virtual_pan: string;
+        expiration_month: string;
+        expiration_year: string;
+        scheme: _gopay_internal_core_types_generated_js.components["schemas"]["Card-scheme"];
+        corporate: boolean;
+        fingerprint: string;
+        token: string;
+        card_art_url: string;
+        brand?: string;
+        service_type?: _gopay_internal_core_types_generated_js.components["schemas"]["Card-Service-Type"];
+        status?: _gopay_internal_core_types_generated_js.components["schemas"]["Card-Token-Status"];
+    }>;
+    deleteCard(cardId: string): Promise<void>;
+    tokenizeEncryptedCard(payload: string): Promise<{
+        card_id: string;
+        masked_pan: string;
+        masked_virtual_pan: string;
+        expiration_month: string;
+        expiration_year: string;
+        scheme: _gopay_internal_core_types_generated_js.components["schemas"]["Card-scheme"];
+        corporate: boolean;
+        fingerprint: string;
+        token: string;
+        card_art_url: string;
+        brand?: string;
+        service_type?: _gopay_internal_core_types_generated_js.components["schemas"]["Card-Service-Type"];
+        status?: _gopay_internal_core_types_generated_js.components["schemas"]["Card-Token-Status"];
+    }>;
+    getPaymentStatus(paymentId: string): Promise<{
+        id: string;
+        order_number: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-State"];
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        customer: _gopay_internal_core_types_generated_js.components["schemas"]["Customer"];
+        gw_url: string;
+        charge?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Charge-Status-Response"];
+        payment_secret: string;
+    }>;
+    createPayment(goid: string, params: {
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        order_number: string;
+        order_description?: string;
+        additional_params?: _gopay_internal_core_types_generated_js.components["schemas"]["Additional-Param"][];
+        customer: _gopay_internal_core_types_generated_js.components["schemas"]["Customer"];
+        callback: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Callback"];
+    }): Promise<{
+        id: string;
+        order_number: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-State"];
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        customer: _gopay_internal_core_types_generated_js.components["schemas"]["Customer"];
+        gw_url: string;
+        charge?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Charge-Status-Response"];
+        payment_secret: string;
+    }>;
+    chargePayment(paymentId: string, params: {
+        payment_instrument: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Charge-Data"];
+    }): Promise<{
+        id: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Charge-State"];
+        payment_instrument: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Instrument-Data"];
+        return_url: string;
+        action?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Charge-Action"];
+    }>;
+    getChargeState(paymentId: string): Promise<{
+        id: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Charge-State"];
+        payment_instrument?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Instrument-Data"];
+        return_url: string;
+        action?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Charge-Action"];
+        fail_reason?: string;
+    }>;
+    getGooglePayInfo(paymentId: string): Promise<{
+        environment?: "TEST" | "PRODUCTION";
+        paymentDataRequest?: {
+            apiVersion?: number;
+            apiVersionMinor?: number;
+            allowedPaymentMethods?: {
+                type?: string;
+                parameters?: {
+                    allowedAuthMethods?: ("PAN_ONLY" | "CRYPTOGRAM_3DS")[];
+                    allowedCardNetworks?: ("VISA" | "MASTERCARD")[];
+                };
+                tokenizationSpecification?: {
+                    type?: string;
+                    parameters?: {
+                        gateway?: string;
+                        gatewayMerchantId?: string;
+                    };
+                };
+            }[];
+            transactionInfo?: {
+                currencyCode?: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+                countryCode?: string;
+                totalPriceStatus?: string;
+                totalPrice?: string;
+            };
+            merchantInfo?: {
+                merchantName?: string;
+                merchantId?: string;
+            };
+            emailRequired?: boolean;
+        };
+    }>;
+    getApplePayInfo(paymentId: string): Promise<{
+        applepayVersion?: number;
+        merchantIdentifier?: string;
+        applePayPaymentRequest?: {
+            merchantCapabilities?: string[];
+            supportedNetworks?: ("maestro" | "masterCard" | "electron" | "visa" | "vPay")[];
+            countryCode?: string;
+            currencyCode?: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+            requiredBillingContactFields?: string[];
+            requiredShippingContactFields?: string[];
+            applicationData?: string;
+            total?: {
+                label?: string;
+                amount?: string;
+                type?: string;
+            };
+        };
+    }>;
+    startApplePaySession(paymentId: string, session: {
+        onvalidatemerchant: ((event: unknown) => void) | null;
+        oncancel: ((event: unknown) => void) | null;
+        completeMerchantValidation(merchantSession: unknown): void;
+        abort(): void;
+        begin(): void;
+    }, origin?: string, callbacks?: {
+        oncancel?: (event: unknown) => void;
+    }): void;
+    getQRPaymentInfo(paymentId: string, format?: "png" | "svg"): Promise<{
+        amount: number;
+        currency: _gopay_internal_core_types_generated_js.components["schemas"]["Currency"];
+        recipient: _gopay_internal_core_types_generated_js.components["schemas"]["Bank-Transfer-Recipient"];
+        qr_code: _gopay_internal_core_types_generated_js.components["schemas"]["QR-Code-List"];
+    }>;
+    awaitChargeState(paymentId: string, options?: AwaitChargeOptions): Promise<{
+        id: string;
+        state: _gopay_internal_core_types_generated_js.components["schemas"]["Charge-State"];
+        payment_instrument?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Instrument-Data"];
+        return_url: string;
+        action?: _gopay_internal_core_types_generated_js.components["schemas"]["Payment-Charge-Action"];
+        fail_reason?: string;
+    }>;
+    authenticate(params: AuthenticateRequest): Promise<void>;
+    isAuthenticated(): boolean;
+    logout(): void;
+    setShareableKey(key: string): void;
+    getBrowserKeys(): {
+        shareable_key: string;
+        client_id: string;
+    };
+    version: string;
+};
+type GoPaySDK = ReturnType<typeof createGoPaySDK>;
+
+type PaymentChargeStatusResponse = components['schemas']['Payment-Charge-Status-Response'];
+/** Options for {@link awaitChargeState}. */
+type AwaitChargeOptions = AwaitChargeOptions$1<PaymentChargeStatusResponse>;
+
+interface ClientCredentialsRequest {
+    grant_type: 'client_credentials';
+    client_id: string;
+    client_secret: string;
+    scope: string;
+}
+type AuthenticateRequest = ClientCredentialsRequest;
+
+declare const SDK_VERSION: string;
+
+export { type AuthenticateRequest, type AwaitChargeOptions, type ClientCredentialsRequest, type GoPayConfig, type GoPaySDK, SDK_VERSION, createGoPaySDK };