@verma-consulting/common-library 0.1.15 → 0.1.16

package/dist/index.d.mts

@@ -103,7 +103,7 @@ interface UserInterface {
     usagesCreated?: UsageInterface[];
     productsCreated?: ProductInterface[];
     subscriptionsCreated?: SubscriptionInterface[];
-    paymentsCreated?: ChargeInterface[];
+    paymentsCreated?: PaymentInterface[];
     permissions?: PermissionInterface[];
     notifications?: NotificationInterface[];
     avatar?: FileInterface;
@@ -240,7 +240,7 @@ interface ProductInterface {
     price?: PriceInterface;
     client?: ClientInterface;
     subscriptions?: SubscriptionInterface[];
-    payments?: ChargeInterface[];
+    payments?: PaymentInterface[];
     poolId?: string;
     pool?: PoolInterface;
     organizationId?: string;
@@ -338,7 +338,7 @@ interface PauseCollectionInterface {
     behavior?: string;
     resumesAt?: Date;
 }
-interface ChargeInterface {
+interface PaymentInterface {
     id?: string;
     createdAt?: Date;
     updatedAt?: Date;
@@ -582,7 +582,7 @@ interface ClientInterface {
     tasks?: TaskInterface[];
     products?: ProductInterface[];
     subscriptions?: SubscriptionInterface[];
-    payments?: ChargeInterface[];
+    payments?: PaymentInterface[];
     contactIds?: string[];
     dealIds?: string[];
     invoiceIds?: string[];
@@ -758,7 +758,7 @@ interface InvoiceInterface {
     poolId?: string | null;
     accountOwnerId?: string;
     dealId?: string;
-    payment?: ChargeInterface;
+    payment?: PaymentInterface;
     contents?: ContentInterface[];
     inventories?: InventoryInterface[];
     inventoryIds?: string[];
@@ -885,7 +885,7 @@ interface PoolInterface {
     lead?: LeadInterface;
     product?: ProductInterface;
     subscription?: SubscriptionInterface;
-    payment?: ChargeInterface;
+    payment?: PaymentInterface;
     campaign?: CampaignInterface;
     invoice?: InvoiceInterface;
     engagement?: EngagementInterface;
@@ -1168,7 +1168,7 @@ declare enum userStatus {
     Active = "Active",
     Inactive = "Inactive"
 }
-declare enum subscriptionCancellationReason {
+declare enum cancellationReason {
     CustomerService = "customer_service",
     LowQuality = "low_quality",
     MissingFeatures = "missing_features",
@@ -1193,13 +1193,151 @@ declare enum captureMethod {
     manual = "manual"
 }
 declare enum paymentStatus {
-    canceled = "canceled",
-    processing = "processing",
+    pending = "pending",
+    succeeded = "succeeded",
+    failed = "failed",
     requiresAction = "requires_action",
     requiresCapture = "requires_capture",
     requiresConfirmation = "requires_confirmation",
-    requiresPaymentMethod = "requires_payment_method",
-    succeeded = "succeeded"
+    requiresPaymentMethod = "requires_payment_method"
+}
+declare enum paymentAllowRedirect {
+    always = "always",
+    never = "never"
+}
+declare enum paymentFutureUsage {
+    off_session = "off_session",
+    on_session = "on_session"
+}
+declare enum taxBehavior {
+    exclusive = "exclusive",
+    inclusive = "inclusive",
+    unspecified = "unspecified"
+}
+declare enum priceType {
+    one_time = "one_time",
+    recurring = "recurring"
+}
+declare enum billingScheme {
+    per_unit = "per_unit",
+    tiered = "tiered"
+}
+declare enum tiersMode {
+    graduated = "graduated",
+    volume = "volume"
+}
+declare enum disputeReason {
+    bankCannotProcess = "bank_cannot_process",
+    checkReturned = "check_returned",
+    creditNotProcessed = "credit_not_processed",
+    customerInitiated = "customer_initiated",
+    debitNotAuthorized = "debit_not_authorized",
+    duplicate = "duplicate",
+    fraudulent = "fraudulent",
+    general = "general",
+    incorrectAccountDetails = "incorrect_account_details",
+    insufficientFunds = "insufficient_funds",
+    noncompliant = "noncompliant",
+    productNotReceived = "product_not_received",
+    productUnacceptable = "product_unacceptable",
+    subscriptionCanceled = "subscription_canceled",
+    unrecognized = "unrecognized"
+}
+declare enum disputeStatus {
+    warningNeedsResponse = "warning_needs_response",
+    warningUnderReview = "warning_under_review",
+    warningClosed = "warning_closed",
+    needsResponse = "needs_response",
+    underReview = "under_review",
+    won = "won",
+    lost = "lost",
+    prevented = "prevented"
+}
+declare enum refundStatus {
+    pending = "pending",
+    requiresAction = "requires_action",
+    succeeded = "succeeded",
+    failed = "failed",
+    canceled = "canceled"
+}
+declare enum refundReason {
+    duplicate = "duplicate",
+    fraudulent = "fraudulent",
+    requestedByCustomer = "requested_by_customer",
+    expiredUncapturedCharge = "expired_uncaptured_charge"
+}
+declare enum refundFailureReason {
+    lostOrStolenCard = "lost_or_stolen_card",
+    expiredOrCanceledCard = "expired_or_canceled_card",
+    chargeForPendingRefundDisputed = "charge_for_pending_refund_disputed",
+    insufficientFunds = "insufficient_funds",
+    declined = "declined",
+    merchantRequest = "merchant_request",
+    unknown = "unknown"
+}
+declare enum refundPendingReason {
+    processing = "processing",
+    insufficientFunds = "insufficient_funds",
+    chargePending = "charge_pending"
+}
+declare enum paymentMethodAllowReDisplay {
+    always = "always",
+    limited = "limited",
+    unspecified = "unspecified"
+}
+declare enum paymentMethodType {
+    AcssDebit = "acss_debit",
+    Affirm = "affirm",
+    AfterpayClearpay = "afterpay_clearpay",
+    Alipay = "alipay",
+    Alma = "alma",
+    AmazonPay = "amazon_pay",
+    AuBecsDebit = "au_becs_debit",
+    BacsDebit = "bacs_debit",
+    Bancontact = "bancontact",
+    Billie = "billie",
+    Blik = "blik",
+    Boleto = "boleto",
+    Card = "card",
+    CardPresent = "card_present",
+    CashApp = "cashapp",
+    Crypto = "crypto",
+    CustomerBalance = "customer_balance",
+    Eps = "eps",
+    Fpx = "fpx",
+    Giropay = "giropay",
+    GrabPay = "grabpay",
+    Ideal = "ideal",
+    InteracPresent = "interac_present",
+    KakaoPay = "kakao_pay",
+    Klarna = "klarna",
+    Konbini = "konbini",
+    KrCard = "kr_card",
+    Link = "link",
+    MbWay = "mb_way",
+    MobilePay = "mobilepay",
+    Multibanco = "multibanco",
+    NaverPay = "naver_pay",
+    NzBankAccount = "nz_bank_account",
+    Oxxo = "oxxo",
+    P24 = "p24",
+    PayByBank = "pay_by_bank",
+    Payco = "payco",
+    PayNow = "paynow",
+    Paypal = "paypal",
+    PayPay = "paypay",
+    Pix = "pix",
+    PromptPay = "promptpay",
+    RevolutPay = "revolut_pay",
+    SamsungPay = "samsung_pay",
+    Satispay = "satispay",
+    SepaDebit = "sepa_debit",
+    Sofort = "sofort",
+    Swish = "swish",
+    Twint = "twint",
+    UsBankAccount = "us_bank_account",
+    WechatPay = "wechat_pay",
+    Zip = "zip"
 }
 declare enum OrganizationFeatures {
     clients = "clients",
@@ -1213,8 +1351,9 @@ declare enum OrganizationFeatures {
     engagements = "engagements",
     campaigns = "campaigns",
     subscriptions = "subscriptions",
-    charges = "charges",
+    payments = "payments",
     paymentMethods = "paymentMethods",
+    refunds = "refunds",
     disputes = "disputes",
     dataPools = "dataPools",
     lists = "lists",
@@ -1648,25 +1787,46 @@ declare const constants: {
     DEFAULT_CURRENCY_FIELDS: string[];
     MODEL_APP_MAPPING: {
         clients: string;
-        inventories: string;
+        tasks: string;
         products: string;
+        inventories: string;
         invoices: string;
-        tasks: string;
-        campaigns: string;
         contacts: string;
+        engagements: string;
+        campaigns: string;
+        leads: string;
         deals: string;
+        subscriptions: string;
+        payments: string;
+        paymentMethods: string;
+        refunds: string;
+        disputes: string;
+    };
+    MODEL_CATEGORY_MAP: {
+        clients: string;
+        tasks: string;
+        products: string;
+        inventories: string;
+        invoices: string;
+        contacts: string;
         engagements: string;
+        campaigns: string;
         leads: string;
-        charges: string;
+        deals: string;
         subscriptions: string;
+        payments: string;
         paymentMethods: string;
+        refunds: string;
         disputes: string;
+        content: string[];
+        relations: string[];
+        financials: string[];
     };
     NOT_INCLUDED_FIELDS: string[];
     GQL_FIELD_TYPE: {
         LIST: string;
         OBJECT: string;
-        ENUM: string;
+        Enum: string;
         String: string;
         Float: string;
         Int: string;
@@ -1688,25 +1848,6 @@ declare const constants: {
         assignees: string;
         Team: string;
     };
-    MODEL_CATEGORY_MAP: {
-        leads: string;
-        campaigns: string;
-        tasks: string;
-        clients: string;
-        products: string;
-        inventories: string;
-        deals: string;
-        invoices: string;
-        contacts: string;
-        engagements: string;
-        subscriptions: string;
-        charges: string;
-        paymentMethods: string;
-        disputes: string;
-        content: string[];
-        relations: string[];
-        financials: string[];
-    };
     SETTING_TABS: {
         Personal: string;
         Notifications: string;
@@ -1720,17 +1861,7 @@ declare const constants: {
     };
     POPULAR_EMAILS: string[];
     STATES: string[];
-    COUNTRIES: ({
-        code: string;
-        label: string;
-        phone: string;
-        suggested: boolean;
-    } | {
-        code: string;
-        label: string;
-        phone: string;
-        suggested?: undefined;
-    })[];
+    COUNTRIES: string[];
     CURRENCIES: {
         aed: string;
         afn: string;
@@ -2092,6 +2223,17 @@ declare const constants: {
 };
 
 declare const defaults: {
+    organizations: {
+        name: string;
+        website: string;
+        industry: string;
+        currency: string;
+        linkedinUrl: string;
+        facebookUrl: string;
+        twitterUrl: string;
+        angelUrl: string;
+        crunchbaseUrl: string;
+    };
     users: {
         firstName: string;
         lastName: string;
@@ -2151,88 +2293,65 @@ declare const defaults: {
         engagements: string;
         tasks: string;
     };
-    contacts: {
+    tasks: {
         name: string;
         description: string;
         status: string;
-        email: string;
-        phone: string;
-        role: string;
-        linkedinUrl: string;
-        twitterUrl: string;
+        priority: string;
+        dueDate: null;
+        reminder: boolean;
+        reminderDate: null;
+        reminderTime: string;
+        repeat: boolean;
+        repeatDate: null;
+        repeatTime: string;
         client: string;
-        engagements: string;
+        assignee: string;
     };
-    inventories: {
+    products: {
         name: string;
-        description: string;
+        description: null;
         status: string;
-        amount: number;
-        quantity: number;
-    };
-    organizations: {
-        name: string;
-        website: string;
-        industry: string;
-        currency: string;
-        linkedinUrl: string;
-        facebookUrl: string;
-        twitterUrl: string;
-        angelUrl: string;
-        crunchbaseUrl: string;
+        productType: string;
+        client: string;
+        inventory: string;
+        accountOwner: string;
+        active: boolean;
+        shippable: boolean;
+        statementDescriptor: string;
+        taxCode: null;
+        unitLabel: null;
+        url: string;
     };
-    activties: {
-        label: string;
-        value: string;
-        modelName: string;
-        path: string;
+    packageDimensions: {
+        height: number;
+        length: number;
+        weight: number;
+        width: number;
     };
-    leads: {
-        name: string;
-        description: string;
-        status: string;
-        leadType: string;
-        source: string;
-        amount: number;
-        projectedClosingDate: null;
-        expectedRevenue: number;
-        probability: number;
-        nextStep: string;
-        accountOwner: string;
-        client: string;
-        campaign: string;
+    prices: {
+        active: boolean;
+        unitAmount: number;
+        unitAmountDecimal: null;
+        lookupKey: string;
+        type: string;
+        taxBehavior: string;
+        currency: string;
+        billingScheme: string;
+        recurring: {
+            intervalCount: number;
+            interval: string;
+            aggregateUsage: string;
+            usageType: string;
+            trialPeriodDays: number;
+        };
     };
-    deals: {
+    inventories: {
         name: string;
         description: string;
         status: string;
-        dealType: string;
-        source: string;
         amount: number;
-        closingDate: null;
-        expectedRevenue: number;
-        probability: number;
-        nextStep: string;
-        accountOwner: string;
-        client: string;
-        campaign: string;
-    };
-    campaigns: {
-        name: string;
-        description: string;
-        status: string;
-        priority: string;
-        startDate: null;
-        endDate: null;
-        campaignType: string;
-        budgetedCost: number;
-        expectedRevenue: number;
-        actualCost: number;
-        numbersSent: number;
-        expectedResponse: string;
-        accountOwner: string;
-        leads: string;
-        deals: string;
+        quantity: number;
     };
     invoices: {
         name: string;
@@ -2277,9 +2396,17 @@ declare const defaults: {
         accountOwner: string;
         deal: string;
     };
-    issuer: {
-        account: string;
-        type: string;
+    contacts: {
+        name: string;
+        description: string;
+        status: string;
+        email: string;
+        phone: string;
+        role: string;
+        linkedinUrl: string;
+        twitterUrl: string;
+        client: string;
+        engagements: string;
     };
     engagements: {
         name: string;
@@ -2289,48 +2416,52 @@ declare const defaults: {
         client: string;
         contact: string;
     };
-    pools: {
+    campaigns: {
         name: string;
         description: string;
         status: string;
+        priority: string;
+        startDate: null;
+        endDate: null;
+        campaignType: string;
+        budgetedCost: number;
+        expectedRevenue: number;
+        actualCost: number;
+        numbersSent: number;
+        expectedResponse: string;
+        accountOwner: string;
+        leads: string;
+        deals: string;
     };
-    products: {
+    leads: {
         name: string;
-        description: null;
+        description: string;
         status: string;
-        productType: string;
-        client: string;
-        inventory: string;
+        leadType: string;
+        source: string;
+        amount: number;
+        projectedClosingDate: null;
+        expectedRevenue: number;
+        probability: number;
+        nextStep: string;
         accountOwner: string;
-        active: boolean;
-        shippable: boolean;
-        statementDescriptor: string;
-        taxCode: null;
-        unitLabel: null;
-        url: string;
-    };
-    prices: {
-        active: boolean;
-        unitAmount: number;
-        unitAmountDecimal: null;
-        lookupKey: string;
-        type: string;
-        taxBehavior: string;
-        currency: string;
-        billingScheme: string;
-        recurring: {
-            intervalCount: number;
-            interval: string;
-            aggregateUsage: string;
-            usageType: string;
-            trialPeriodDays: number;
-        };
+        client: string;
+        campaign: string;
     };
-    packageDimensions: {
-        height: number;
-        length: number;
-        weight: number;
-        width: number;
+    deals: {
+        name: string;
+        description: string;
+        status: string;
+        dealType: string;
+        source: string;
+        amount: number;
+        closingDate: null;
+        expectedRevenue: number;
+        probability: number;
+        nextStep: string;
+        accountOwner: string;
+        client: string;
+        campaign: string;
     };
     subscriptions: {
         name: string;
@@ -2380,7 +2511,7 @@ declare const defaults: {
             missingPaymentMethod: string;
         };
     };
-    charges: {
+    payments: {
         name: string;
         description: string;
         status: string;
@@ -2397,6 +2528,124 @@ declare const defaults: {
         client: string;
         subscription: string;
         invoice: string;
+        automaticPaymentMethods: {
+            allowRedirects: string;
+            enabled: boolean;
+        };
+        amountDetails: {
+            discountAmount: null;
+            shipping: {
+                amount: null;
+                fromPostalCode: null;
+                toPostalCode: null;
+            };
+            tax: {
+                totalTaxAmount: null;
+            };
+            tip: {
+                amount: null;
+            };
+        };
+    };
+    paymentMethods: {
+        name: string;
+        description: string;
+        status: string;
+        livemode: boolean;
+    };
+    billingDetails: {
+        address: {
+            city: null;
+            country: null;
+            line1: null;
+            line2: null;
+            postalCode: null;
+            state: null;
+        };
+        email: null;
+        name: string;
+        phone: null;
+    };
+    shipping: {
+        address: {
+            city: null;
+            country: null;
+            line1: null;
+            line2: null;
+            postalCode: null;
+            state: null;
+        };
+        carrier: string;
+        name: string;
+        phone: string;
+        trackingNumber: string;
+    };
+    disputes: {
+        name: string;
+        description: string;
+        status: string;
+        evidence: {
+            accessActivityLog: null;
+            billingAddress: null;
+            cancellationPolicy: null;
+            cancellationPolicyDisclosure: null;
+            cancellationRebuttal: null;
+            customerCommunication: null;
+            customerEmailAddress: null;
+            customerName: null;
+            customerPurchaseIp: null;
+            customerSignature: null;
+            duplicateChargeDocumentation: null;
+            duplicateChargeExplanation: null;
+            duplicateChargeId: null;
+            productDescription: null;
+            receipt: null;
+            refundPolicy: null;
+            refundPolicyDisclosure: null;
+            refundRefusalExplanation: null;
+            serviceDate: null;
+            serviceDocumentation: null;
+            shippingAddress: null;
+            shippingCarrier: null;
+            shippingDate: null;
+            shippingDocumentation: null;
+            shippingTrackingNumber: null;
+            uncategorizedFile: null;
+            uncategorizedText: null;
+        };
+        evidenceDetails: {
+            dueBy: null;
+            hasEvidence: boolean;
+            pastDue: boolean;
+            submissionCount: number;
+        };
+    };
+    refunds: {
+        name: string;
+        description: string;
+        status: string;
+    };
+    pools: {
+        name: string;
+        description: string;
+        status: string;
+    };
+    issuer: {
+        account: string;
+        type: string;
+    };
+    activties: {
+        label: string;
+        value: string;
+        modelName: string;
+        path: string;
+    };
+    schema: {
+        deleted: boolean;
+        selected: boolean;
+        key: string;
+        type: string;
+        options: never[];
     };
     reports: {
         label: string;
@@ -2442,31 +2691,9 @@ declare const defaults: {
         latitude: number;
         longitude: number;
     };
-    schema: {
-        deleted: boolean;
-        selected: boolean;
-        key: string;
-        type: string;
-        options: never[];
-    };
     comments: {
         label: string;
     };
-    tasks: {
-        name: string;
-        description: string;
-        status: string;
-        priority: string;
-        dueDate: null;
-        reminder: boolean;
-        reminderDate: null;
-        reminderTime: string;
-        repeat: boolean;
-        repeatDate: null;
-        repeatTime: string;
-        client: string;
-        assignee: string;
-    };
     integrations: {
         name: string;
         title: string;
@@ -3496,7 +3723,7 @@ declare const defaultsWithTypes: {
             };
         };
     };
-    charges: {
+    payments: {
         name: {
             default: string;
             type: string;
@@ -3872,4 +4099,4 @@ declare const defaultsWithTypes: {
     };
 };
 
-export { type ActivityInterface, type AddressInterface, type AnalyticsQueryInterface, AppMode, type AutomaticTaxInterface, CalculationType, type CampaignInterface, CampaignType, type CancellationDetailsInterface, type CardInterface, CategoryType, type ChargeInterface, ChartType, type ChatInterface, type ClientInterface, type CommentInterface, type ContactInterface, type ContentInterface, ContentType, type CurrentRateInterface, type DealInterface, DealType, DeviceNotification, type EmailInterface, type EngagementInterface, FeatureType, type FileInterface, type FilterInterface, FilterType, FormFieldOrder, FormFieldType, FrequencyType, Gender, type GenericPayload, type IntegrationInterface, type InventoryInterface, type InvoiceInterface, LandingPath, LandingView, type LeadInterface, LeadType, type ListInterface, type MarketingFeatureInterface, type ModelInterface, ModelType, type Notation, type NotificationInterface, type OperationInterface, OrganizationFeatures, type OrganizationInterface, type OrganizationModelInterface, type PackageDimensionsInterface, type PauseCollectionInterface, type PaymentMethodInterface, type PermissionInterface, PermissionType, PlatformLanguage, type PoolInterface, type PriceInterface, type PriceRecurringInterface, Priority, type ProductInterface, type PromptInterface, type QueryFilterInterface, type RegisterInterface, type ReportInterface, type SchemaInterface, type SentEmailInterface, SourceType, type StatisticInterface, type StripeAccountInterface, type StripeCustomer, type StripePaymentIntent, type SubscriptionInterface, type TagInterface, type TaskInterface, type TokenInterface, type UsageInterface, UsageType, type UserInterface, UserSettingType, type WaitlistInterface, accountType, action, automaticTaxStatus, billingReason, camelCaseToWords, capitalizeSentence, captureMethod, chatType, clientType, collectionMethod, commentRole, constants, currency, customerType, defaults, defaultsWithTypes, formatPhoneNumber, getRandomArbitrary, grabAge, integrationType, isNumber, largeNumberLabel, missingPaymentMethod, normalizeKey, openInNewTab, operationType, organizationFilterType, paymentCancellationReason, paymentStatus, prettifyString, productType, snakeToPretty, status, stripHtmlTags, subscriptionCancellationReason, taxExempt, toCurrencyValue, userRole, userSource, userStatus, validEmail };
+export { type ActivityInterface, type AddressInterface, type AnalyticsQueryInterface, AppMode, type AutomaticTaxInterface, CalculationType, type CampaignInterface, CampaignType, type CancellationDetailsInterface, type CardInterface, CategoryType, ChartType, type ChatInterface, type ClientInterface, type CommentInterface, type ContactInterface, type ContentInterface, ContentType, type CurrentRateInterface, type DealInterface, DealType, DeviceNotification, type EmailInterface, type EngagementInterface, FeatureType, type FileInterface, type FilterInterface, FilterType, FormFieldOrder, FormFieldType, FrequencyType, Gender, type GenericPayload, type IntegrationInterface, type InventoryInterface, type InvoiceInterface, LandingPath, LandingView, type LeadInterface, LeadType, type ListInterface, type MarketingFeatureInterface, type ModelInterface, ModelType, type Notation, type NotificationInterface, type OperationInterface, OrganizationFeatures, type OrganizationInterface, type OrganizationModelInterface, type PackageDimensionsInterface, type PauseCollectionInterface, type PaymentInterface, type PaymentMethodInterface, type PermissionInterface, PermissionType, PlatformLanguage, type PoolInterface, type PriceInterface, type PriceRecurringInterface, Priority, type ProductInterface, type PromptInterface, type QueryFilterInterface, type RegisterInterface, type ReportInterface, type SchemaInterface, type SentEmailInterface, SourceType, type StatisticInterface, type StripeAccountInterface, type StripeCustomer, type StripePaymentIntent, type SubscriptionInterface, type TagInterface, type TaskInterface, type TokenInterface, type UsageInterface, UsageType, type UserInterface, UserSettingType, type WaitlistInterface, accountType, action, automaticTaxStatus, billingReason, billingScheme, camelCaseToWords, cancellationReason, capitalizeSentence, captureMethod, chatType, clientType, collectionMethod, commentRole, constants, currency, customerType, defaults, defaultsWithTypes, disputeReason, disputeStatus, formatPhoneNumber, getRandomArbitrary, grabAge, integrationType, isNumber, largeNumberLabel, missingPaymentMethod, normalizeKey, openInNewTab, operationType, organizationFilterType, paymentAllowRedirect, paymentCancellationReason, paymentFutureUsage, paymentMethodAllowReDisplay, paymentMethodType, paymentStatus, prettifyString, priceType, productType, refundFailureReason, refundPendingReason, refundReason, refundStatus, snakeToPretty, status, stripHtmlTags, taxBehavior, taxExempt, tiersMode, toCurrencyValue, userRole, userSource, userStatus, validEmail };