@inkress/admin-sdk 1.1.46 → 1.1.47

package/dist/resources/checkout-sessions.d.ts

@@ -0,0 +1,201 @@
+import { HttpClient } from '../client';
+import { ApiResponse, CreateOrderData } from '../types';
+/**
+ * Fee mapping details for checkout session
+ */
+export interface CheckoutSessionFeeMapping {
+    charged_party: number;
+    computed_value: number;
+    currency: string;
+    fee_id: number;
+    group: number;
+    is_compounded: boolean;
+    recipient_merchant_id: number;
+    sequence: number;
+    unit: number;
+    value: number;
+}
+/**
+ * Fee breakdown for checkout session
+ */
+export interface CheckoutSessionFees {
+    after_tax_fee_total: number;
+    before_tax_fee_total: number;
+    customer_total: number;
+    discount_total: number;
+    fee_ids: number[];
+    fee_mappings: CheckoutSessionFeeMapping[];
+    merchant_total: number;
+    platform_total: number;
+    provider_total: number;
+    shipping_total: number;
+    sub_total: number;
+    tax_total: number;
+}
+/**
+ * Totals breakdown for checkout session
+ */
+export interface CheckoutSessionTotals {
+    sub_total: number;
+    customer_total: number;
+    merchant_total: number;
+    platform_total: number;
+    provider_total: number;
+    shipping_total: number;
+    tax_total: number;
+    discount_total: number;
+    before_tax_fee_total: number;
+    after_tax_fee_total: number;
+}
+/**
+ * Response data from creating a checkout session
+ */
+export interface CreateCheckoutSessionResponseData {
+    session_id: string;
+    reference_id: string;
+    status: string;
+    order_id: string;
+    currency: string;
+    currency_code: string;
+    created_at: string;
+    payment_initiated_at: string;
+    completed_at: string | null;
+    expires: number;
+    totals: CheckoutSessionTotals;
+    customer: CheckoutSessionCustomer;
+    title: string;
+    products: any[];
+    frame_url: string;
+    redirect_data: string;
+    spi_token: string;
+    transaction_id: string;
+    amount: number;
+    transaction_type: string | null;
+    three_d_secure: any | null;
+    is_subscription: boolean;
+}
+/**
+ * Currency info for checkout session
+ */
+export interface CheckoutSessionCurrency {
+    code: string;
+    id: number;
+}
+/**
+ * Customer info for checkout session
+ */
+export interface CheckoutSessionCustomer {
+    id: number | null;
+    email: string;
+    first_name: string;
+    last_name: string;
+    phone: string;
+}
+/**
+ * Checkout session status
+ */
+export type CheckoutSessionStatus = 'pending' | 'awaiting_payment' | 'completed' | 'cancelled' | 'expired';
+/**
+ * Response data from getting a checkout session
+ */
+export interface CheckoutSession {
+    status: CheckoutSessionStatus;
+    title: string;
+    currency: CheckoutSessionCurrency;
+    customer: CheckoutSessionCustomer;
+    session_id: string;
+    order_id: number | null;
+    reference_id: string;
+    fees: CheckoutSessionFees;
+    products: any[];
+    created_at: string;
+    completed_at: string | null;
+    payment_initiated_at: string | null;
+}
+/**
+ * Response data from deleting a checkout session
+ */
+export interface DeleteCheckoutSessionResponseData {
+    status: 'cancelled';
+    session_id: string;
+}
+/**
+ * Checkout Sessions Resource
+ *
+ * Handles creation and management of checkout sessions for payments.
+ * Checkout sessions provide a way to create temporary payment sessions
+ * with pre-calculated fees and payment URLs.
+ */
+export declare class CheckoutSessionsResource {
+    private client;
+    constructor(client: HttpClient);
+    /**
+     * Create a new checkout session
+     *
+     * Creates a checkout session with pre-calculated fees and returns
+     * payment URLs for processing the payment.
+     *
+     * Requires Client-Id header to be set in the configuration.
+     *
+     * @param data - Order data for the checkout session (same as order creation)
+     * @returns The created checkout session with payment URLs and fee breakdown
+     *
+     * @example
+     * ```typescript
+     * const session = await sdk.checkoutSessions.create({
+     *   reference_id: 'order-123',
+     *   total: 100.00,
+     *   kind: 'online',
+     *   currency_code: 'JMD',
+     *   customer: {
+     *     email: 'customer@example.com',
+     *     first_name: 'John',
+     *     last_name: 'Doe',
+     *     phone: '+1234567890'
+     *   },
+     *   title: 'My Order'
+     * });
+     *
+     * // Redirect customer to payment URL
+     * console.log(session.result.payment_url);
+     * ```
+     */
+    create(data: CreateOrderData): Promise<ApiResponse<CreateCheckoutSessionResponseData>>;
+    /**
+     * Get checkout session details by session ID
+     *
+     * Retrieves the current state of a checkout session including
+     * payment status, customer info, and fee breakdown.
+     *
+     * Requires Client-Id header to be set in the configuration.
+     *
+     * @param sessionId - The session ID (e.g., 'S.75a29ad32e52')
+     * @returns The checkout session details
+     *
+     * @example
+     * ```typescript
+     * const session = await sdk.checkoutSessions.get('S.75a29ad32e52');
+     * console.log(session.result.status); // 'awaiting_payment'
+     * ```
+     */
+    get(sessionId: string): Promise<ApiResponse<CheckoutSession>>;
+    /**
+     * Delete (cancel) a checkout session
+     *
+     * Cancels an active checkout session. Once cancelled, the session
+     * can no longer be used for payment.
+     *
+     * Requires Client-Id header to be set in the configuration.
+     *
+     * @param sessionId - The session ID to cancel (e.g., 'S.75a29ad32e52')
+     * @returns Confirmation of the cancellation
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.checkoutSessions.delete('S.75a29ad32e52');
+     * console.log(result.result); // 'Session cancelled'
+     * ```
+     */
+    delete(sessionId: string): Promise<ApiResponse<string>>;
+}
+//# sourceMappingURL=checkout-sessions.d.ts.map

package/dist/resources/checkout-sessions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkout-sessions.d.ts","sourceRoot":"","sources":["../../src/resources/checkout-sessions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EACL,WAAW,EACX,eAAe,EAChB,MAAM,UAAU,CAAC;AAMlB;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,OAAO,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,EAAE,yBAAyB,EAAE,CAAC;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IAEtB,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,EAAE,qBAAqB,CAAC;IAE9B,QAAQ,EAAE,uBAAuB,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,GAAG,EAAE,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IAEf,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,cAAc,EAAE,GAAG,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,kBAAkB,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC;AAE3G;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,uBAAuB,CAAC;IAClC,QAAQ,EAAE,uBAAuB,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,mBAAmB,CAAC;IAC1B,QAAQ,EAAE,GAAG,EAAE,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,WAAW,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,qBAAa,wBAAwB;IACvB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,UAAU;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;IAI5F;;;;;;;;;;;;;;;;OAgBG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAInE;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;CAG9D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkress/admin-sdk",
-  "version": "1.1.46",
+  "version": "1.1.47",
   "description": "Official Inkress Commerce API SDK for JavaScript/TypeScript",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",