@payrails/web-sdk 5.26.0-RC.0 → 5.27.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payrails/web-sdk",
-  "version": "5.26.0-RC.0",
+  "version": "5.27.0",
   "description": "SDK providing tokenization options on the client for merchants",
   "main": "index.js",
   "types": "payrails.d.ts",

package/payrails.d.ts

@@ -7,7 +7,9 @@ declare enum PAYMENT_METHOD_CODES {
     'GOOGLE_PAY' = "googlePay",
     'PAYPAL' = "payPal",
     'APPLE_PAY' = "applePay",
-    'GENERIC_REDIRECT' = "genericRedirect"
+    'GENERIC_REDIRECT' = "genericRedirect",
+    'MERCADO_PAGO' = "mercadoPago",
+    'PIX' = "pix"
 }
 declare enum PAYMENT_INSTRUMENT_STATUS {
     'ENABLED' = "enabled",
@@ -76,7 +78,7 @@ declare class WorkflowExecution {
     static isAddressSelectorEnabled(paymentMethod: PAYMENT_METHOD_CODES): boolean | undefined;
     static isPaymentInstallmentsEnabled(paymentMethod: PAYMENT_METHOD_CODES): boolean | undefined;
     static getPaymentInstallmentOptions(paymentMethod: PAYMENT_METHOD_CODES): PaymentInstallmentsConfig;
-    private static getStoredInstrumentForPaymentMethod;
+    static getStoredInstrumentForPaymentMethod<T = CardMetadata | PayPalMetadata>(paymentMethod: PAYMENT_METHOD_CODES): Array<StoredPaymentInstrument<T>>;
     static getPaymentMethodForStoredInstrument<T extends CardMetadata | PayPalMetadata>(instrument: StoredPaymentInstrument<T>): {
         id: string;
         description?: string;
@@ -305,7 +307,7 @@ declare enum RedactionType {
     MASKED = "MASKED",
     REDACTED = "REDACTED"
 }
-declare enum RequestMethod {
+declare enum RequestMethod$1 {
     GET = "GET",
     POST = "POST",
     PUT = "PUT",
@@ -503,7 +505,7 @@ declare class Skyflow {
     static get ContainerType(): typeof ContainerType;
     static get ElementType(): typeof ElementType$1;
     static get RedactionType(): typeof RedactionType;
-    static get RequestMethod(): typeof RequestMethod;
+    static get RequestMethod(): typeof RequestMethod$1;
     static get LogLevel(): typeof LogLevel;
     static get EventName(): typeof EventName;
     static get Env(): typeof Env;
@@ -871,14 +873,40 @@ declare class CardList extends PayrailsElement {
     reset(): void;
 }
 
-interface InitOptions {
-    version: string;
-    data: string;
+interface SdkConfiguration {
+    token: string;
+    amount: PayrailsAmount;
+    holderReference: string;
+    links?: {
+        binLookup?: Links;
+        instrumentDelete?: Links;
+        instrumentUpdate?: Links;
+    };
+    vaultConfiguration: {
+        cardTableName: string;
+        token: string;
+        vaultId: string;
+        vaultUrl: string;
+        providerId: string;
+        providerConfigId: string;
+        vaultType: 'Payrails' | 'Test';
+        encryptionPublicKey?: string;
+        links: {
+            saveInstrument: {
+                href: string;
+            };
+        };
+    };
+    execution?: WorkflowExecutionResponse;
 }
 interface PayrailsAmount {
     value: string;
     currency: string;
 }
+interface Links {
+    method: 'GET' | 'POST';
+    href: string;
+}
 
 interface ReturnInfo {
     success?: string;
@@ -1257,6 +1285,74 @@ interface ContainerStyles {
     styles?: Partial<CSSStyleDeclaration>;
 }
 
+declare enum RequestMethod {
+    GET = "GET",
+    POST = "POST",
+    DELETE = "DELETE",
+    PATCH = "PATCH"
+}
+
+type Operations = {
+    deleteInstrument: OperationConfig<void, DeleteInstrumentResponse>;
+    updateInstrument: OperationConfig<UpdateInstrumentBody, UpdateInstrumentResponse>;
+};
+interface UpdateInstrumentBody {
+    status?: 'enabled' | 'disabled';
+    networkTransactionReference?: string;
+    merchantReference?: string;
+    paymentMethod?: 'applepay' | 'card' | 'googlepay' | 'paypal';
+    default?: boolean;
+}
+interface UpdateInstrumentResponse {
+    id: string;
+    createdAt: string;
+    holderId: string;
+    paymentMethod: PAYMENT_METHOD_CODES;
+    status: PAYMENT_INSTRUMENT_STATUS;
+    data: {
+        bin?: string;
+        binLookup?: {
+            bin?: string;
+            network?: string;
+            issuer?: string;
+            issuerCountry?: {
+                code?: string;
+                name?: string;
+                iso3?: string;
+            };
+            type?: string;
+        };
+        holderName?: string;
+        network?: string;
+        suffix?: string;
+        expiryMonth?: string;
+        expiryYear?: string;
+    };
+    fingerprint?: string;
+    futureUsage?: string;
+}
+interface DeleteInstrumentResponse {
+    success: boolean;
+}
+type RequestCreator<TReq, TOperation extends keyof Operations> = (config: ApiConfig<TReq> & {
+    operation: TOperation;
+}) => {
+    url: string;
+    body?: TReq;
+};
+interface OperationConfig<TReq, TRes> {
+    linkKey: keyof NonNullable<SdkConfiguration['links']>;
+    method: RequestMethod;
+    createRequest: RequestCreator<TReq, keyof Operations>;
+    requestType: TReq;
+    responseType: TRes;
+}
+interface ApiConfig<TReq> {
+    operation: keyof Operations;
+    resourceId?: string;
+    body?: TReq;
+}
+
 declare class SdkLoader {
     private static readonly scriptMap;
     static load<T = void>(sdk: ThirdPartySDK, params?: PayPalScriptConfig): Promise<T>;
@@ -1279,6 +1375,27 @@ declare enum ThirdPartySDK {
     PayPal = "paypal-sdk"
 }
 
+interface QueryDefinition<T> {
+    path: string[];
+    returnType: T;
+}
+
+interface ConfigurationQueryTypes {
+    holderReference: QueryDefinition<string>;
+    amount: QueryDefinition<PayrailsAmount>;
+    binLookup: QueryDefinition<Links | undefined>;
+    instrumentDelete: QueryDefinition<Links | undefined>;
+    instrumentUpdate: QueryDefinition<Links | undefined>;
+    executionId: QueryDefinition<string | undefined>;
+    paymentMethodConfig: QueryDefinition<StorablePaymentCompositionOption | undefined>;
+    paymentMethodInstruments: QueryDefinition<StoredPaymentInstrument<CardMetadata | PayPalMetadata>[] | undefined>;
+}
+
+interface InitOptions {
+    version: string;
+    data: string;
+}
+
 interface PayrailsClientOptions {
     environment?: PayrailsEnvironment;
     events?: ClientEvents;
@@ -1313,6 +1430,10 @@ declare class Payrails {
     getSavedCreditCards(): StoredPaymentInstrument<CardMetadata>[];
     getSavedGooglePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
     getSavedApplePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
+    query<K extends keyof ConfigurationQueryTypes>(key: K, params?: Record<string, any>): ConfigurationQueryTypes[K]['returnType'] | null;
+    api<TOperation extends keyof Operations>(config: ApiConfig<Operations[TOperation]['requestType']> & {
+        operation: TOperation;
+    }): Promise<Operations[TOperation]['responseType']>;
     getStoredInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
     getAvailablePaymentMethods(): PAYMENT_METHOD_CODES[];
     paymentButton(options: CardPaymentButtonOptions): CardPaymentButton;