@paykit-sdk/paypal 1.0.1 → 1.0.3

package/dist/controllers/subscription.d.mts

@@ -0,0 +1,37 @@
+import { Subscription } from '../schema.mjs';
+import { CreateSubscriptionSchema } from '@paykit-sdk/core';
+import { ApiResponse } from '@paypal/paypal-server-sdk';
+import { BaseController } from '@paypal/paypal-server-sdk/dist/types/controllers/baseController';
+import '@paypal/paypal-server-sdk/dist/types/schema';
+
+declare class SubscriptionsController extends BaseController {
+    private catchAllErrors;
+    /**
+     * @return Response from the API call
+     */
+    createSubscription({ body, }: {
+        body: CreateSubscriptionSchema;
+    }): Promise<ApiResponse<any>>;
+    /**
+     * @returns Response from the API call
+     */
+    resumeSubscription({ body, subscriptionId, }: {
+        body: {
+            reason: string;
+        };
+        subscriptionId: string;
+    }): Promise<void>;
+    retrieveSubscription({ subscriptionId }: {
+        subscriptionId: string;
+    }): Promise<ApiResponse<Subscription>>;
+    cancelSubscription({ subscriptionId, reason, }: {
+        subscriptionId: string;
+        reason: string;
+    }): Promise<ApiResponse<Subscription>>;
+    updateSubscription({ subscriptionId, metadata, }: {
+        subscriptionId: string;
+        metadata: Record<string, unknown>;
+    }): Promise<void>;
+}
+
+export { SubscriptionsController };

package/dist/controllers/subscription.d.ts

@@ -0,0 +1,37 @@
+import { Subscription } from '../schema.js';
+import { CreateSubscriptionSchema } from '@paykit-sdk/core';
+import { ApiResponse } from '@paypal/paypal-server-sdk';
+import { BaseController } from '@paypal/paypal-server-sdk/dist/types/controllers/baseController';
+import '@paypal/paypal-server-sdk/dist/types/schema';
+
+declare class SubscriptionsController extends BaseController {
+    private catchAllErrors;
+    /**
+     * @return Response from the API call
+     */
+    createSubscription({ body, }: {
+        body: CreateSubscriptionSchema;
+    }): Promise<ApiResponse<any>>;
+    /**
+     * @returns Response from the API call
+     */
+    resumeSubscription({ body, subscriptionId, }: {
+        body: {
+            reason: string;
+        };
+        subscriptionId: string;
+    }): Promise<void>;
+    retrieveSubscription({ subscriptionId }: {
+        subscriptionId: string;
+    }): Promise<ApiResponse<Subscription>>;
+    cancelSubscription({ subscriptionId, reason, }: {
+        subscriptionId: string;
+        reason: string;
+    }): Promise<ApiResponse<Subscription>>;
+    updateSubscription({ subscriptionId, metadata, }: {
+        subscriptionId: string;
+        metadata: Record<string, unknown>;
+    }): Promise<void>;
+}
+
+export { SubscriptionsController };

package/dist/controllers/subscription.js

@@ -0,0 +1,179 @@
+'use strict';
+
+var paypalServerSdk = require('@paypal/paypal-server-sdk');
+var baseController = require('@paypal/paypal-server-sdk/dist/types/controllers/baseController');
+var schema = require('@paypal/paypal-server-sdk/dist/types/schema');
+
+// src/controllers/subscription.ts
+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 || {});
+schema.object({
+  verification_status: ["verification_status", schema.stringEnum(VerifyWebhookStatus)]
+});
+
+// src/controllers/subscription.ts
+var SubscriptionsController = class extends baseController.BaseController {
+  catchAllErrors(req) {
+    req.throwOn(
+      400,
+      paypalServerSdk.CustomError,
+      "Request is not well-formed, syntactically incorrect, or violates schema."
+    );
+    req.throwOn(
+      401,
+      paypalServerSdk.CustomError,
+      "Authentication failed due to missing authorization header, or invalid authentication credentials."
+    );
+    req.throwOn(
+      422,
+      paypalServerSdk.CustomError,
+      "The requested action could not be performed, semantically incorrect, or failed business validation."
+    );
+  }
+  /**
+   * @return Response from the API call
+   */
+  async createSubscription({
+    body
+  }) {
+    const req = this.createRequest("POST", "/v1/billing/subscriptions");
+    const mapped = req.prepareArgs({ body: [body, createSubscriptionApticSchema] });
+    req.header("Content-Type", "application/json");
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    req.json(mapped.body);
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+    return req.callAsJson(subscriptionApticSchema);
+  }
+  /**
+   * @returns Response from the API call
+   */
+  async resumeSubscription({
+    body,
+    subscriptionId
+  }) {
+    const req = this.createRequest(
+      "POST",
+      `v1/billing/subscriptions/${subscriptionId}/activate `
+    );
+    const mapped = req.prepareArgs({
+      body: [body, resumeSubscriptionApticSchemaRequest]
+    });
+    req.header("Content-Type", "application/json");
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    req.json(mapped.body);
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+  }
+  async retrieveSubscription({ subscriptionId }) {
+    const req = this.createRequest("GET", `v1/billing/subscriptions/${subscriptionId}`);
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+    return req.callAsJson(subscriptionApticSchema);
+  }
+  async cancelSubscription({
+    subscriptionId,
+    reason
+  }) {
+    const req = this.createRequest(
+      "POST",
+      `v1/billing/subscriptions/${subscriptionId}/cancel`
+    );
+    const mapped = req.prepareArgs({
+      body: [reason, resumeSubscriptionApticSchemaRequest]
+    });
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    req.json(mapped.body);
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+    return req.callAsJson(subscriptionApticSchema);
+  }
+  async updateSubscription({
+    subscriptionId,
+    metadata
+  }) {
+    const req = this.createRequest("PATCH", `v1/billing/subscriptions/${subscriptionId}`);
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    req.json({ op: "replace", path: "/custom_id", value: JSON.stringify(metadata) });
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+  }
+};
+
+exports.SubscriptionsController = SubscriptionsController;

package/dist/controllers/subscription.mjs

@@ -0,0 +1,177 @@
+import { CustomError } from '@paypal/paypal-server-sdk';
+import { BaseController } from '@paypal/paypal-server-sdk/dist/types/controllers/baseController';
+import { object, string, lazy, number, stringEnum, boolean } from '@paypal/paypal-server-sdk/dist/types/schema';
+
+// src/controllers/subscription.ts
+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 || {});
+object({
+  verification_status: ["verification_status", stringEnum(VerifyWebhookStatus)]
+});
+
+// src/controllers/subscription.ts
+var SubscriptionsController = class extends BaseController {
+  catchAllErrors(req) {
+    req.throwOn(
+      400,
+      CustomError,
+      "Request is not well-formed, syntactically incorrect, or violates schema."
+    );
+    req.throwOn(
+      401,
+      CustomError,
+      "Authentication failed due to missing authorization header, or invalid authentication credentials."
+    );
+    req.throwOn(
+      422,
+      CustomError,
+      "The requested action could not be performed, semantically incorrect, or failed business validation."
+    );
+  }
+  /**
+   * @return Response from the API call
+   */
+  async createSubscription({
+    body
+  }) {
+    const req = this.createRequest("POST", "/v1/billing/subscriptions");
+    const mapped = req.prepareArgs({ body: [body, createSubscriptionApticSchema] });
+    req.header("Content-Type", "application/json");
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    req.json(mapped.body);
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+    return req.callAsJson(subscriptionApticSchema);
+  }
+  /**
+   * @returns Response from the API call
+   */
+  async resumeSubscription({
+    body,
+    subscriptionId
+  }) {
+    const req = this.createRequest(
+      "POST",
+      `v1/billing/subscriptions/${subscriptionId}/activate `
+    );
+    const mapped = req.prepareArgs({
+      body: [body, resumeSubscriptionApticSchemaRequest]
+    });
+    req.header("Content-Type", "application/json");
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    req.json(mapped.body);
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+  }
+  async retrieveSubscription({ subscriptionId }) {
+    const req = this.createRequest("GET", `v1/billing/subscriptions/${subscriptionId}`);
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+    return req.callAsJson(subscriptionApticSchema);
+  }
+  async cancelSubscription({
+    subscriptionId,
+    reason
+  }) {
+    const req = this.createRequest(
+      "POST",
+      `v1/billing/subscriptions/${subscriptionId}/cancel`
+    );
+    const mapped = req.prepareArgs({
+      body: [reason, resumeSubscriptionApticSchemaRequest]
+    });
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    req.json(mapped.body);
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+    return req.callAsJson(subscriptionApticSchema);
+  }
+  async updateSubscription({
+    subscriptionId,
+    metadata
+  }) {
+    const req = this.createRequest("PATCH", `v1/billing/subscriptions/${subscriptionId}`);
+    req.header("PayPal-Request-Id", Math.random().toString(36).substring(2, 15));
+    req.json({ op: "replace", path: "/custom_id", value: JSON.stringify(metadata) });
+    this.catchAllErrors(req);
+    req.authenticate([{ oauth2: true }]);
+  }
+};
+
+export { SubscriptionsController };

package/dist/controllers/webhook.d.mts

@@ -0,0 +1,18 @@
+import { ApiResponse } from '@paypal/paypal-server-sdk';
+import { BaseController } from '@paypal/paypal-server-sdk/dist/types/controllers/baseController';
+import { VerifyWebhookSchema } from '../schema.mjs';
+import '@paypal/paypal-server-sdk/dist/types/schema';
+
+declare class WebhookController extends BaseController {
+    verifyWebhook(body: {
+        authAlgo: string;
+        certUrl: string;
+        transmissionId: string;
+        transmissionSig: string;
+        transmissionTime: string;
+        webhookId: string;
+        webhookEvent: string;
+    }): Promise<ApiResponse<VerifyWebhookSchema>>;
+}
+
+export { WebhookController };

package/dist/controllers/webhook.d.ts

@@ -0,0 +1,18 @@
+import { ApiResponse } from '@paypal/paypal-server-sdk';
+import { BaseController } from '@paypal/paypal-server-sdk/dist/types/controllers/baseController';
+import { VerifyWebhookSchema } from '../schema.js';
+import '@paypal/paypal-server-sdk/dist/types/schema';
+
+declare class WebhookController extends BaseController {
+    verifyWebhook(body: {
+        authAlgo: string;
+        certUrl: string;
+        transmissionId: string;
+        transmissionSig: string;
+        transmissionTime: string;
+        webhookId: string;
+        webhookEvent: string;
+    }): Promise<ApiResponse<VerifyWebhookSchema>>;
+}
+
+export { WebhookController };

package/dist/controllers/webhook.js

@@ -0,0 +1,122 @@
+'use strict';
+
+var paypalServerSdk = require('@paypal/paypal-server-sdk');
+var baseController = require('@paypal/paypal-server-sdk/dist/types/controllers/baseController');
+var schema = require('@paypal/paypal-server-sdk/dist/types/schema');
+
+// src/controllers/webhook.ts
+schema.object({
+  currency_code: ["currency_code", schema.string()],
+  value: ["value", schema.string()]
+});
+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 || {});
+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()]
+});
+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)]
+});
+
+// src/controllers/webhook.ts
+var WebhookController = class extends baseController.BaseController {
+  async verifyWebhook(body) {
+    const req = this.createRequest("POST", "/v1/notifications/verify-webhook-signature");
+    req.header("Content-Type", "application/json");
+    req.throwOn(
+      400,
+      paypalServerSdk.CustomError,
+      "Request is not well-formed, syntactically incorrect, or violates schema."
+    );
+    req.throwOn(
+      401,
+      paypalServerSdk.CustomError,
+      "Authentication failed due to missing authorization header, or invalid authentication credentials."
+    );
+    req.throwOn(
+      422,
+      paypalServerSdk.CustomError,
+      "The requested action could not be performed, semantically incorrect, or failed business validation."
+    );
+    req.json(
+      Object.fromEntries(
+        Object.entries(body).map(([key, value]) => [
+          key.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`),
+          value
+        ])
+      )
+    );
+    req.authenticate([{ oauth2: true }]);
+    return req.callAsJson(verifyWebhookSchema);
+  }
+};
+
+exports.WebhookController = WebhookController;