feat: add typescript definitions for customer portal and embeddable sessions

Author: Justintime50

types/CustomerPortal/CustomerPortalAccountLink.d.ts

@@ -0,0 +1,38 @@
+import { ICustomerPortalAccountLinkCreateParameters } from './CustomerPortalAccountLinkCreateParameters';
+
+/**
+ * Class representing an EasyPost CustomerPortalAccountLink object.
+ *
+ */
+export declare interface ICustomerPortalAccountLink {
+  /** Always returns "CustomerPortalAccountLink". */
+  object: string;
+
+  /** One-time-use session URL for initiating the Customer Portal. */
+  link: string;
+
+  /** One-time-use session URL for initiating the Customer Portal. */
+  created_at: string;
+
+  /** ISO 8601 timestamp when the link will expire (5 minutes from creation). */
+  expires_at: string;
+}
+
+export declare class CustomerPortalAccountLink implements ICustomerPortalAccountLink {
+  public constructor(input: ICustomerPortalAccountLinkCreateParameters);
+
+  object: 'CustomerPortalAccountLink';
+  link: string;
+  created_at: string;
+  expires_at: string;
+
+  /**
+   * Create a Portal Session.
+   *
+   * @see https://docs.easypost.com/docs/customer-portals#creating-a-portal-session
+   *
+   * @param {Object} params The parameters to create a {@link CustomerPortalAccountLink} with.
+   * @returns {Promise<CustomerPortalAccountLink>} The {@link CustomerPortalAccountLink}.
+   */
+  static createAccountLink(params: Object): Promise<CustomerPortalAccountLink>;
+}

types/CustomerPortal/CustomerPortalAccountLinkCreateParameters.d.ts

@@ -0,0 +1,21 @@
+export declare interface ICustomerPortalAccountLinkCreateParameters {
+  /** Type of Customer Portal session. */
+  session_type: 'account_onboarding' | 'account_management';
+
+  /** The User ID of the sub account for which the portal session is being created. */
+  user_id: string;
+
+  /** The URL to which the sub account will be redirected if the session URL is expired, reused, or otherwise invalid. This should trigger a new session request. */
+  refresh_url: string;
+
+  /**
+   * The URL to which the sub account will be redirected after exiting the Customer Portal session.
+   * This does not confirm completion of the flow; webhook or API polling is recommended for confirmation.
+   */
+  return_url: string;
+
+  /**
+   * Used to configure the Customer Portal session.
+   */
+  metadata?: object;
+}

types/CustomerPortal/index.d.ts

@@ -0,0 +1,2 @@
+export * from './CustomerPortalAccountLink';
+export * from './CustomerPortalAccountLinkCreateParameters';

types/Embeddable/EmbeddablesSession.d.ts

@@ -0,0 +1,38 @@
+import { IEmbeddablesSessionCreateParameters } from './EmbeddablesSessionCreateParameters';
+
+/**
+ * Class representing an EasyPost EmbeddablesSession object.
+ *
+ */
+export declare interface IEmbeddablesSession {
+  /** Always returns "EmbeddablesSession". */
+  object: string;
+
+  /** Short-lived, one-time-use token that authorizes an Embeddables Components session. Must be provided to the client-side Embeddables script to initialize the component. */
+  session_id: string;
+
+  /** ISO 8601 timestamp indicating when the session was created. */
+  created_at: string;
+
+  /** ISO 8601 timestamp indicating when the session expires. */
+  expires_at: string;
+}
+
+export declare class EmbeddablesSession implements IEmbeddablesSession {
+  public constructor(input: IEmbeddablesSessionCreateParameters);
+
+  object: 'EmbeddablesSession';
+  session_id: string;
+  created_at: string;
+  expires_at: string;
+
+  /**
+   * Create a Portal Session.
+   *
+   * @see https://docs.easypost.com/docs/embeddables#create-an-embeddable-session
+   *
+   * @param {Object} params The parameters to create a {@link EmbeddablesSession} with.
+   * @returns {Promise<EmbeddablesSession>} The {@link EmbeddablesSession}.
+   */
+  static createSession(params: Object): Promise<EmbeddablesSession>;
+}

types/Embeddable/EmbeddablesSessionCreateParameters.d.ts

@@ -0,0 +1,7 @@
+export declare interface IEmbeddablesSessionCreateParameters {
+  /** The integrator’s domain in bare-host format (e.g., example.com), excluding protocol and subdomains. */
+  origin_host: string;
+
+  /** The User ID of the sub account for which the embeddable session is being created. */
+  user_id: string;
+}

types/Embeddable/index.d.ts

@@ -0,0 +1,2 @@
+export * from './EmbeddablesSession';
+export * from './EmbeddablesSessionCreateParameters';