@simpleapps-com/augur-api 0.1.0

package/dist/types/services/payments/client.d.ts

@@ -0,0 +1,174 @@
+import { HTTPClient } from '../../core/client';
+import { BaseServiceClient } from '../../core/base-client';
+import { type TransactionSetupParams, type AccountQueryParams, type BillingUpdateParams, type CardInfoParams, type SurchargeParams, type ValidateParams, type ElementPaymentParams } from './schemas';
+/**
+ * Client for the Payments API service
+ *
+ * Provides access to payment processing operations through Element Express integration,
+ * including transaction setup, account management, and billing operations.
+ *
+ * @example
+ * ```typescript
+ * const api = new AugurAPI({ bearerToken: 'token', siteId: 'site' });
+ *
+ * // Create transaction setup
+ * const setup = await api.payments.unified.transactionSetup({ customerId: '123' });
+ *
+ * // Query account information
+ * const account = await api.payments.unified.accountQuery({
+ *   customerId: '123',
+ *   transactionSetupId: setup.data.transactionSetupId
+ * });
+ * ```
+ */
+export declare class PaymentsClient extends BaseServiceClient {
+    constructor(http: HTTPClient, baseUrl?: string);
+    /**
+     * Unified payment operations through Element Express
+     */
+    unified: {
+        /**
+         * Creates a new payment transaction session with customer and account information
+         */
+        transactionSetup: (params: TransactionSetupParams) => Promise<{
+            data: {
+                uiEndpoint: string;
+                transactionSetupId: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Retrieves payment account information using a transaction setup ID
+         */
+        accountQuery: (params: AccountQueryParams) => Promise<{
+            data: false | {
+                ExpressResponseCode: string;
+                ExpressResponseMessage: string;
+                ExpressTransactionDate: string;
+                ExpressTransactionTime: string;
+                ExpressTransactionTimezone: string;
+                ExpirationMonth: string;
+                ExpirationYear: string;
+                PaymentAccountID: string;
+                PaymentAccountType: string;
+                PaymentAccountReferenceNumber: string;
+                PaymentBrand: string;
+                PASSUpdaterBatchStatus: string;
+                PASSUpdaterStatus: string;
+                TransactionSetupID: string;
+                TruncatedCardNumber: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Updates billing information for an existing transaction
+         */
+        billingUpdate: (params: BillingUpdateParams) => Promise<{
+            data: boolean;
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Retrieves formatted card information for a transaction
+         */
+        cardInfo: (params: CardInfoParams) => Promise<{
+            data: Record<string, never> | {
+                cardNumber: string;
+                transactionSetupId: string;
+                expMonth: string;
+                expYear: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Calculates payment processing surcharges based on location and payment details
+         */
+        surcharge: (params: SurchargeParams) => Promise<{
+            data: Record<string, never> | {
+                message: string;
+                success: boolean;
+                expressResponseCode: string;
+                surchargeAllowed: boolean;
+                surchargePercent: string;
+                surchargeDescription: string;
+                lumpSumTotalSurchargeAmount: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Validates an existing transaction setup
+         */
+        validate: (params: ValidateParams) => Promise<{
+            data: boolean;
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Legacy Element Express payment processing
+     *
+     * @deprecated This endpoint appears to be a legacy Element Express integration
+     * and may be deprecated in favor of the unified endpoints.
+     */
+    element: {
+        /**
+         * Process payment through legacy Element Express integration
+         */
+        payment: (params: ElementPaymentParams) => Promise<{
+            status: number;
+            data?: unknown;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Comprehensive health check that validates site configuration and triggers seeding jobs
+     */
+    getHealthCheck: () => Promise<{
+        data: {
+            siteHash: string;
+            siteId: string;
+        };
+        status: number;
+        options?: Record<string, unknown>[] | undefined;
+        message?: string | undefined;
+        totalResults?: number | undefined;
+        count?: number | undefined;
+    }>;
+    /**
+     * Simple availability check endpoint
+     */
+    getPing: () => Promise<{
+        data: "pong";
+        status: number;
+        options?: Record<string, unknown>[] | undefined;
+        message?: string | undefined;
+        totalResults?: number | undefined;
+        count?: number | undefined;
+    }>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/types/services/payments/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/payments/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAwBL,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAC1B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,cAAe,SAAQ,iBAAiB;gBACvC,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAyC;IAIhF;;OAEG;IACH,OAAO;QACL;;WAEG;mCAC8B,sBAAsB;;;;;;;;;;;QAYvD;;WAEG;+BAC0B,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;QAY/C;;WAEG;gCAC2B,mBAAmB;;;;;;;;QAYjD;;WAEG;2BACsB,cAAc;;;;;;;;;;;;;QAYvC;;WAEG;4BACuB,eAAe;;;;;;;;;;;;;;;;QAYzC;;WAEG;2BACsB,cAAc;;;;;;;;MAWvC;IAEF;;;;;OAKG;IACH,OAAO;QACL;;WAEG;0BACqB,oBAAoB;;;;;;;;MAW5C;IAEF;;OAEG;IACH,cAAc;;;;;;;;;;OAA2D;IAEzE;;OAEG;IACH,OAAO;;;;;;;OAOL;CACH"}

package/dist/types/services/payments/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './schemas';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/services/payments/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/payments/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}

package/dist/types/services/payments/schemas/element.d.ts

@@ -0,0 +1,101 @@
+import { z } from 'zod';
+export declare const ElementPaymentParamsSchema: z.ZodObject<{
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+} & {
+    edgeCache: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<8>]>>;
+} & {
+    billingAddress1: z.ZodString;
+    billingAddress2: z.ZodOptional<z.ZodString>;
+    billingCity: z.ZodString;
+    billingCountry: z.ZodString;
+    billingFirstName: z.ZodString;
+    billingLastName: z.ZodString;
+    billingPostalCode: z.ZodString;
+    billingState: z.ZodString;
+    ccNumber: z.ZodString;
+    cvv: z.ZodString;
+    expMonth: z.ZodString;
+    expYear: z.ZodString;
+    shippingAddress1: z.ZodString;
+    shippingAddress2: z.ZodOptional<z.ZodString>;
+    shippingCity: z.ZodString;
+    shippingCountry: z.ZodString;
+    shippingFirstName: z.ZodString;
+    shippingLastName: z.ZodString;
+    shippingPostalCode: z.ZodString;
+    shippingState: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    cvv: string;
+    expMonth: string;
+    expYear: string;
+    billingAddress1: string;
+    billingCity: string;
+    billingCountry: string;
+    billingFirstName: string;
+    billingLastName: string;
+    billingPostalCode: string;
+    billingState: string;
+    ccNumber: string;
+    shippingAddress1: string;
+    shippingCity: string;
+    shippingCountry: string;
+    shippingFirstName: string;
+    shippingLastName: string;
+    shippingPostalCode: string;
+    shippingState: string;
+    edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+    billingAddress2?: string | undefined;
+    shippingAddress2?: string | undefined;
+}, {
+    cvv: string;
+    expMonth: string;
+    expYear: string;
+    billingAddress1: string;
+    billingCity: string;
+    billingCountry: string;
+    billingFirstName: string;
+    billingLastName: string;
+    billingPostalCode: string;
+    billingState: string;
+    ccNumber: string;
+    shippingAddress1: string;
+    shippingCity: string;
+    shippingCountry: string;
+    shippingFirstName: string;
+    shippingLastName: string;
+    shippingPostalCode: string;
+    shippingState: string;
+    edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+    billingAddress2?: string | undefined;
+    shippingAddress2?: string | undefined;
+}>;
+export declare const ElementPaymentResponseSchema: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    data: z.ZodUnknown;
+    totalResults: z.ZodOptional<z.ZodNumber>;
+    count: z.ZodOptional<z.ZodNumber>;
+    options: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    status: number;
+    data?: unknown;
+    options?: Record<string, unknown>[] | undefined;
+    message?: string | undefined;
+    totalResults?: number | undefined;
+    count?: number | undefined;
+}, {
+    status: number;
+    data?: unknown;
+    options?: Record<string, unknown>[] | undefined;
+    message?: string | undefined;
+    totalResults?: number | undefined;
+    count?: number | undefined;
+}>;
+export type ElementPaymentParams = z.infer<typeof ElementPaymentParamsSchema>;
+export type ElementPaymentResponse = z.infer<typeof ElementPaymentResponseSchema>;
+//# sourceMappingURL=element.d.ts.map

package/dist/types/services/payments/schemas/element.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../../../../src/services/payments/schemas/element.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0BrC,CAAC;AAGH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;EAAkC,CAAC;AAG5E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC"}

package/dist/types/services/payments/schemas/health.d.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod';
+export declare const HealthCheckResponseSchema: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    data: z.ZodObject<{
+        siteHash: z.ZodString;
+        siteId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        siteHash: string;
+        siteId: string;
+    }, {
+        siteHash: string;
+        siteId: string;
+    }>;
+    totalResults: z.ZodOptional<z.ZodNumber>;
+    count: z.ZodOptional<z.ZodNumber>;
+    options: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    data: {
+        siteHash: string;
+        siteId: string;
+    };
+    status: number;
+    options?: Record<string, unknown>[] | undefined;
+    message?: string | undefined;
+    totalResults?: number | undefined;
+    count?: number | undefined;
+}, {
+    data: {
+        siteHash: string;
+        siteId: string;
+    };
+    status: number;
+    options?: Record<string, unknown>[] | undefined;
+    message?: string | undefined;
+    totalResults?: number | undefined;
+    count?: number | undefined;
+}>;
+export declare const PingResponseSchema: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    data: z.ZodLiteral<"pong">;
+    totalResults: z.ZodOptional<z.ZodNumber>;
+    count: z.ZodOptional<z.ZodNumber>;
+    options: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    data: "pong";
+    status: number;
+    options?: Record<string, unknown>[] | undefined;
+    message?: string | undefined;
+    totalResults?: number | undefined;
+    count?: number | undefined;
+}, {
+    data: "pong";
+    status: number;
+    options?: Record<string, unknown>[] | undefined;
+    message?: string | undefined;
+    totalResults?: number | undefined;
+    count?: number | undefined;
+}>;
+export type HealthCheckResponse = z.infer<typeof HealthCheckResponseSchema>;
+export type PingResponse = z.infer<typeof PingResponseSchema>;
+//# sourceMappingURL=health.d.ts.map

package/dist/types/services/payments/schemas/health.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../../../../src/services/payments/schemas/health.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAkC,CAAC;AAGzE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;EAA2B,CAAC;AAG3D,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/dist/types/services/payments/schemas/index.d.ts

@@ -0,0 +1,4 @@
+export * from './health';
+export * from './unified';
+export * from './element';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/services/payments/schemas/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/services/payments/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC"}