@paykit-sdk/paypal 1.0.2 → 1.0.4

package/dist/schema.d.mts

@@ -0,0 +1,138 @@
+import { Schema } from '@paypal/paypal-server-sdk/dist/types/schema';
+
+interface ShippingAmount {
+    /**
+     * The currency code.
+     */
+    currency_code: string;
+    /**
+     * The value which might be an integer for currencies like JPY that are not typically fractional.
+     */
+    value: string;
+}
+declare const shippingAmountSchema: Schema<ShippingAmount>;
+interface CreateSubscriptionSchema {
+    /**
+     * The ID of the plan, maps to `item_id` in the Paykit SDK.
+     */
+    plan_id: string;
+    /**
+     * The quantity of the plan.
+     */
+    quantity: number;
+    /**
+     * The custom ID of the subscription.
+     */
+    custom_id: string;
+    /**
+     * The start time of the subscription.
+     */
+    start_time: string;
+    /**
+     * The subscriber of the subscription.
+     */
+    subscriber: {
+        email_address: string;
+        name: {
+            given_name: string;
+            surname: string;
+        };
+        phone: {
+            phone_number: string;
+        };
+    };
+}
+declare const createSubscriptionApticSchema: Schema<CreateSubscriptionSchema>;
+declare enum SubscriptionStatus {
+    APPROVAL_PENDING = "APPROVAL_PENDING",
+    APPROVED = "APPROVED",
+    ACTIVE = "ACTIVE",
+    SUSPENDED = "SUSPENDED",
+    CANCELLED = "CANCELLED",
+    EXPIRED = "EXPIRED"
+}
+interface Subscription {
+    /**
+     * The ID of the subscription.
+     */
+    id: string;
+    /**
+     * The ID of the plan.
+     */
+    plan_id: string;
+    /**
+     * The quantity of the subscription.
+     */
+    quantity: number;
+    /**
+     * The status of the subscription.
+     */
+    status: SubscriptionStatus;
+    /**
+     * The time the status was updated.
+     */
+    status_update_time: string;
+    /**
+     * The note for the status change.
+     */
+    status_change_note: string;
+    /**
+     * The time the subscription started.
+     */
+    start_time: string;
+    /**
+     * The subscriber of the subscription.
+     */
+    subscriber: {
+        /**
+         * The email address of the subscriber.
+         */
+        email_address: string;
+        /**
+         * The name of the subscriber.
+         */
+        name: {
+            /**
+             * The given name of the subscriber.
+             */
+            given_name: string;
+            /**
+             * The surname of the subscriber.
+             */
+            surname: string;
+        };
+        /**
+         * The ID of the payer.
+         */
+        payer_id: string;
+    };
+    /**
+     * Whether the plan was overridden.
+     */
+    plan_overridden: boolean;
+    /**
+     * The custom ID of the subscription.
+     */
+    custom_id: string;
+}
+declare const subscriptionApticSchema: Schema<Subscription>;
+interface ResumeSubscriptionSchema {
+    /**
+     * The reason for resuming the subscription.
+     */
+    reason: string;
+}
+declare const resumeSubscriptionApticSchemaRequest: Schema<ResumeSubscriptionSchema>;
+declare enum VerifyWebhookStatus {
+    SUCCESS = "SUCCESS",
+    FAILURE = "FAILURE"
+}
+interface VerifyWebhookSchema {
+    /**
+     * The status of the verification.
+     */
+    verification_status: VerifyWebhookStatus;
+}
+declare const verifyWebhookSchema: Schema<VerifyWebhookSchema>;
+
+export { type CreateSubscriptionSchema, type ShippingAmount, type Subscription, type VerifyWebhookSchema, VerifyWebhookStatus, createSubscriptionApticSchema, resumeSubscriptionApticSchemaRequest, shippingAmountSchema, subscriptionApticSchema, verifyWebhookSchema };

package/dist/schema.d.ts

@@ -0,0 +1,138 @@
+import { Schema } from '@paypal/paypal-server-sdk/dist/types/schema';
+
+interface ShippingAmount {
+    /**
+     * The currency code.
+     */
+    currency_code: string;
+    /**
+     * The value which might be an integer for currencies like JPY that are not typically fractional.
+     */
+    value: string;
+}
+declare const shippingAmountSchema: Schema<ShippingAmount>;
+interface CreateSubscriptionSchema {
+    /**
+     * The ID of the plan, maps to `item_id` in the Paykit SDK.
+     */
+    plan_id: string;
+    /**
+     * The quantity of the plan.
+     */
+    quantity: number;
+    /**
+     * The custom ID of the subscription.
+     */
+    custom_id: string;
+    /**
+     * The start time of the subscription.
+     */
+    start_time: string;
+    /**
+     * The subscriber of the subscription.
+     */
+    subscriber: {
+        email_address: string;
+        name: {
+            given_name: string;
+            surname: string;
+        };
+        phone: {
+            phone_number: string;
+        };
+    };
+}
+declare const createSubscriptionApticSchema: Schema<CreateSubscriptionSchema>;
+declare enum SubscriptionStatus {
+    APPROVAL_PENDING = "APPROVAL_PENDING",
+    APPROVED = "APPROVED",
+    ACTIVE = "ACTIVE",
+    SUSPENDED = "SUSPENDED",
+    CANCELLED = "CANCELLED",
+    EXPIRED = "EXPIRED"
+}
+interface Subscription {
+    /**
+     * The ID of the subscription.
+     */
+    id: string;
+    /**
+     * The ID of the plan.
+     */
+    plan_id: string;
+    /**
+     * The quantity of the subscription.
+     */
+    quantity: number;
+    /**
+     * The status of the subscription.
+     */
+    status: SubscriptionStatus;
+    /**
+     * The time the status was updated.
+     */
+    status_update_time: string;
+    /**
+     * The note for the status change.
+     */
+    status_change_note: string;
+    /**
+     * The time the subscription started.
+     */
+    start_time: string;
+    /**
+     * The subscriber of the subscription.
+     */
+    subscriber: {
+        /**
+         * The email address of the subscriber.
+         */
+        email_address: string;
+        /**
+         * The name of the subscriber.
+         */
+        name: {
+            /**
+             * The given name of the subscriber.
+             */
+            given_name: string;
+            /**
+             * The surname of the subscriber.
+             */
+            surname: string;
+        };
+        /**
+         * The ID of the payer.
+         */
+        payer_id: string;
+    };
+    /**
+     * Whether the plan was overridden.
+     */
+    plan_overridden: boolean;
+    /**
+     * The custom ID of the subscription.
+     */
+    custom_id: string;
+}
+declare const subscriptionApticSchema: Schema<Subscription>;
+interface ResumeSubscriptionSchema {
+    /**
+     * The reason for resuming the subscription.
+     */
+    reason: string;
+}
+declare const resumeSubscriptionApticSchemaRequest: Schema<ResumeSubscriptionSchema>;
+declare enum VerifyWebhookStatus {
+    SUCCESS = "SUCCESS",
+    FAILURE = "FAILURE"
+}
+interface VerifyWebhookSchema {
+    /**
+     * The status of the verification.
+     */
+    verification_status: VerifyWebhookStatus;
+}
+declare const verifyWebhookSchema: Schema<VerifyWebhookSchema>;
+
+export { type CreateSubscriptionSchema, type ShippingAmount, type Subscription, type VerifyWebhookSchema, VerifyWebhookStatus, createSubscriptionApticSchema, resumeSubscriptionApticSchemaRequest, shippingAmountSchema, subscriptionApticSchema, verifyWebhookSchema };

package/dist/schema.js

@@ -0,0 +1,92 @@
+'use strict';
+
+var schema = require('@paypal/paypal-server-sdk/dist/types/schema');
+
+// src/schema.ts
+var shippingAmountSchema = schema.object({
+  currency_code: ["currency_code", schema.string()],
+  value: ["value", schema.string()]
+});
+var createSubscriptionApticSchema = schema.object({
+  plan_id: ["plan_id", schema.string()],
+  quantity: ["quantity", schema.number()],
+  custom_id: ["custom_id", schema.string()],
+  start_time: ["start_time", schema.string()],
+  subscriber: [
+    "subscriber",
+    schema.lazy(
+      () => schema.object({
+        email_address: ["email_address", schema.string()],
+        name: [
+          "name",
+          schema.lazy(
+            () => schema.object({
+              given_name: ["given_name", schema.string()],
+              surname: ["surname", schema.string()]
+            })
+          )
+        ],
+        phone: [
+          "phone",
+          schema.lazy(() => schema.object({ phone_number: ["phone_number", schema.string()] }))
+        ]
+      })
+    )
+  ]
+});
+var SubscriptionStatus = /* @__PURE__ */ ((SubscriptionStatus2) => {
+  SubscriptionStatus2["APPROVAL_PENDING"] = "APPROVAL_PENDING";
+  SubscriptionStatus2["APPROVED"] = "APPROVED";
+  SubscriptionStatus2["ACTIVE"] = "ACTIVE";
+  SubscriptionStatus2["SUSPENDED"] = "SUSPENDED";
+  SubscriptionStatus2["CANCELLED"] = "CANCELLED";
+  SubscriptionStatus2["EXPIRED"] = "EXPIRED";
+  return SubscriptionStatus2;
+})(SubscriptionStatus || {});
+var subscriptionApticSchema = schema.object({
+  id: ["id", schema.string()],
+  plan_id: ["plan_id", schema.string()],
+  quantity: ["quantity", schema.number()],
+  custom_id: ["custom_id", schema.string()],
+  plan_overridden: ["plan_overridden", schema.boolean()],
+  start_time: ["start_time", schema.string()],
+  subscriber: [
+    "subscriber",
+    schema.lazy(
+      () => schema.object({
+        email_address: ["email_address", schema.string()],
+        name: [
+          "name",
+          schema.lazy(
+            () => schema.object({
+              given_name: ["given_name", schema.string()],
+              surname: ["surname", schema.string()]
+            })
+          )
+        ],
+        payer_id: ["payer_id", schema.string()]
+      })
+    )
+  ],
+  status: ["status", schema.stringEnum(SubscriptionStatus)],
+  status_change_note: ["status_change_note", schema.string()],
+  status_update_time: ["status_update_time", schema.string()]
+});
+var resumeSubscriptionApticSchemaRequest = schema.object({
+  reason: ["reason", schema.string()]
+});
+var VerifyWebhookStatus = /* @__PURE__ */ ((VerifyWebhookStatus2) => {
+  VerifyWebhookStatus2["SUCCESS"] = "SUCCESS";
+  VerifyWebhookStatus2["FAILURE"] = "FAILURE";
+  return VerifyWebhookStatus2;
+})(VerifyWebhookStatus || {});
+var verifyWebhookSchema = schema.object({
+  verification_status: ["verification_status", schema.stringEnum(VerifyWebhookStatus)]
+});
+
+exports.VerifyWebhookStatus = VerifyWebhookStatus;
+exports.createSubscriptionApticSchema = createSubscriptionApticSchema;
+exports.resumeSubscriptionApticSchemaRequest = resumeSubscriptionApticSchemaRequest;
+exports.shippingAmountSchema = shippingAmountSchema;
+exports.subscriptionApticSchema = subscriptionApticSchema;
+exports.verifyWebhookSchema = verifyWebhookSchema;

package/dist/schema.mjs

@@ -0,0 +1,85 @@
+import { object, string, lazy, number, stringEnum, boolean } from '@paypal/paypal-server-sdk/dist/types/schema';
+
+// src/schema.ts
+var shippingAmountSchema = object({
+  currency_code: ["currency_code", string()],
+  value: ["value", string()]
+});
+var createSubscriptionApticSchema = object({
+  plan_id: ["plan_id", string()],
+  quantity: ["quantity", number()],
+  custom_id: ["custom_id", string()],
+  start_time: ["start_time", string()],
+  subscriber: [
+    "subscriber",
+    lazy(
+      () => object({
+        email_address: ["email_address", string()],
+        name: [
+          "name",
+          lazy(
+            () => object({
+              given_name: ["given_name", string()],
+              surname: ["surname", string()]
+            })
+          )
+        ],
+        phone: [
+          "phone",
+          lazy(() => object({ phone_number: ["phone_number", string()] }))
+        ]
+      })
+    )
+  ]
+});
+var SubscriptionStatus = /* @__PURE__ */ ((SubscriptionStatus2) => {
+  SubscriptionStatus2["APPROVAL_PENDING"] = "APPROVAL_PENDING";
+  SubscriptionStatus2["APPROVED"] = "APPROVED";
+  SubscriptionStatus2["ACTIVE"] = "ACTIVE";
+  SubscriptionStatus2["SUSPENDED"] = "SUSPENDED";
+  SubscriptionStatus2["CANCELLED"] = "CANCELLED";
+  SubscriptionStatus2["EXPIRED"] = "EXPIRED";
+  return SubscriptionStatus2;
+})(SubscriptionStatus || {});
+var subscriptionApticSchema = object({
+  id: ["id", string()],
+  plan_id: ["plan_id", string()],
+  quantity: ["quantity", number()],
+  custom_id: ["custom_id", string()],
+  plan_overridden: ["plan_overridden", boolean()],
+  start_time: ["start_time", string()],
+  subscriber: [
+    "subscriber",
+    lazy(
+      () => object({
+        email_address: ["email_address", string()],
+        name: [
+          "name",
+          lazy(
+            () => object({
+              given_name: ["given_name", string()],
+              surname: ["surname", string()]
+            })
+          )
+        ],
+        payer_id: ["payer_id", string()]
+      })
+    )
+  ],
+  status: ["status", stringEnum(SubscriptionStatus)],
+  status_change_note: ["status_change_note", string()],
+  status_update_time: ["status_update_time", string()]
+});
+var resumeSubscriptionApticSchemaRequest = object({
+  reason: ["reason", string()]
+});
+var VerifyWebhookStatus = /* @__PURE__ */ ((VerifyWebhookStatus2) => {
+  VerifyWebhookStatus2["SUCCESS"] = "SUCCESS";
+  VerifyWebhookStatus2["FAILURE"] = "FAILURE";
+  return VerifyWebhookStatus2;
+})(VerifyWebhookStatus || {});
+var verifyWebhookSchema = object({
+  verification_status: ["verification_status", stringEnum(VerifyWebhookStatus)]
+});
+
+export { VerifyWebhookStatus, createSubscriptionApticSchema, resumeSubscriptionApticSchemaRequest, shippingAmountSchema, subscriptionApticSchema, verifyWebhookSchema };

package/dist/types.d.mts

@@ -0,0 +1,108 @@
+type SubscriptionStatus = 'APPROVAL_PENDING' | 'APPROVED' | 'ACTIVE' | 'SUSPENDED' | 'CANCELLED' | 'EXPIRED';
+interface PayPalSubscription {
+    /**
+     * The ID of the subscription.
+     */
+    id: string;
+    /**
+     * The ID of the plan.
+     */
+    plan_id: string;
+    /**
+     * The status of the subscription.
+     */
+    status: SubscriptionStatus;
+    /**
+     * The time the status was updated.
+     */
+    status_update_time?: string;
+    /**
+     * The time the subscription started.
+     */
+    start_time?: string;
+    /**
+     * The time the subscription was created.
+     */
+    create_time?: string;
+    /**
+     * The subscriber of the subscription.
+     */
+    subscriber?: {
+        /**
+         * The email of the subscriber.
+         */
+        email_address?: string;
+        /**
+         * The name of the subscriber.
+         */
+        name?: {
+            /**
+             * The given name of the subscriber.
+             */
+            given_name?: string;
+            /**
+             * The surname of the subscriber.
+             */
+            surname?: string;
+        };
+    };
+    /**
+     * The billing info of the subscription.
+     */
+    billing_info?: {
+        /**
+         * The outstanding balance of the subscription.
+         */
+        outstanding_balance?: {
+            /**
+             * The currency code of the outstanding balance.
+             */
+            currency_code?: string;
+            /**
+             * The value of the outstanding balance.
+             */
+            value?: string;
+        };
+        cycle_executions?: Array<{
+            /**
+             * The tenure type of the cycle execution.
+             */
+            tenure_type?: string;
+            /**
+             * The sequence of the cycle execution.
+             */
+            sequence?: number;
+            /**
+             * The number of cycles completed.
+             */
+            cycles_completed?: number;
+            /**
+             * The total number of cycles.
+             */
+            total_cycles?: number;
+        }>;
+    };
+    /**
+     * The links of the subscription.
+     */
+    links?: Array<{
+        /**
+         * The href of the link.
+         */
+        href?: string;
+        /**
+         * The rel of the link.
+         */
+        rel?: string;
+        /**
+         * The method of the link.
+         */
+        method?: string;
+    }>;
+    /**
+     * The custom ID of the subscription, i.e metadata
+     */
+    customId?: string;
+}
+
+export type { PayPalSubscription, SubscriptionStatus };

package/dist/types.d.ts

@@ -0,0 +1,108 @@
+type SubscriptionStatus = 'APPROVAL_PENDING' | 'APPROVED' | 'ACTIVE' | 'SUSPENDED' | 'CANCELLED' | 'EXPIRED';
+interface PayPalSubscription {
+    /**
+     * The ID of the subscription.
+     */
+    id: string;
+    /**
+     * The ID of the plan.
+     */
+    plan_id: string;
+    /**
+     * The status of the subscription.
+     */
+    status: SubscriptionStatus;
+    /**
+     * The time the status was updated.
+     */
+    status_update_time?: string;
+    /**
+     * The time the subscription started.
+     */
+    start_time?: string;
+    /**
+     * The time the subscription was created.
+     */
+    create_time?: string;
+    /**
+     * The subscriber of the subscription.
+     */
+    subscriber?: {
+        /**
+         * The email of the subscriber.
+         */
+        email_address?: string;
+        /**
+         * The name of the subscriber.
+         */
+        name?: {
+            /**
+             * The given name of the subscriber.
+             */
+            given_name?: string;
+            /**
+             * The surname of the subscriber.
+             */
+            surname?: string;
+        };
+    };
+    /**
+     * The billing info of the subscription.
+     */
+    billing_info?: {
+        /**
+         * The outstanding balance of the subscription.
+         */
+        outstanding_balance?: {
+            /**
+             * The currency code of the outstanding balance.
+             */
+            currency_code?: string;
+            /**
+             * The value of the outstanding balance.
+             */
+            value?: string;
+        };
+        cycle_executions?: Array<{
+            /**
+             * The tenure type of the cycle execution.
+             */
+            tenure_type?: string;
+            /**
+             * The sequence of the cycle execution.
+             */
+            sequence?: number;
+            /**
+             * The number of cycles completed.
+             */
+            cycles_completed?: number;
+            /**
+             * The total number of cycles.
+             */
+            total_cycles?: number;
+        }>;
+    };
+    /**
+     * The links of the subscription.
+     */
+    links?: Array<{
+        /**
+         * The href of the link.
+         */
+        href?: string;
+        /**
+         * The rel of the link.
+         */
+        rel?: string;
+        /**
+         * The method of the link.
+         */
+        method?: string;
+    }>;
+    /**
+     * The custom ID of the subscription, i.e metadata
+     */
+    customId?: string;
+}
+
+export type { PayPalSubscription, SubscriptionStatus };

package/dist/types.js

@@ -0,0 +1,2 @@
+'use strict';
+

package/dist/types.mjs

@@ -0,0 +1 @@
+

package/dist/utils/mapper.d.mts

@@ -0,0 +1,22 @@
+import { Refund as Refund$1, Checkout, Payment, Subscription } from '@paykit-sdk/core';
+import { Refund, Order } from '@paypal/paypal-server-sdk';
+import { PayPalSubscription } from '../types.mjs';
+
+/**
+ * Refund
+ */
+declare const paykitRefund$InboundSchema: (refund: Refund) => Refund$1;
+/**
+ * Checkout
+ */
+declare const paykitCheckout$InboundSchema: (order: Order) => Checkout;
+/**
+ * Payment
+ */
+declare const paykitPayment$InboundSchema: (order: Order) => Payment;
+/**
+ * Subscription
+ */
+declare const paykitSubscription$InboundSchema: (subscription: PayPalSubscription) => Subscription;
+
+export { paykitCheckout$InboundSchema, paykitPayment$InboundSchema, paykitRefund$InboundSchema, paykitSubscription$InboundSchema };