/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import { retirementsListContributionSummaries } from "../funcs/retirementsListContributionSummaries.js";
import { retirementsListDistributionSummaries } from "../funcs/retirementsListDistributionSummaries.js";
import { retirementsRetrieveContributionConstraints } from "../funcs/retirementsRetrieveContributionConstraints.js";
import { retirementsRetrieveDistributionConstraints } from "../funcs/retirementsRetrieveDistributionConstraints.js";
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import * as operations from "../models/operations/index.js";
import { unwrapAsync } from "../types/fp.js";
import { PageIterator, unwrapResultIterator } from "../types/operations.js";

export class Retirements extends ClientSDK {
  /**
   * List Contribution Summaries
   *
   * @remarks
   * Lists the aggregated retirement contribution summaries by tax year
   */
  async listContributionSummaries(
    accountId: string,
    pageSize?: number | undefined,
    pageToken?: string | undefined,
    options?: RequestOptions,
  ): Promise<
    PageIterator<
      operations.RetirementConstraintsListContributionSummariesResponse,
      { cursor: string }
    >
  > {
    return unwrapResultIterator(retirementsListContributionSummaries(
      this,
      accountId,
      pageSize,
      pageToken,
      options,
    ));
  }

  /**
   * Retrieve Contribution Constraints
   *
   * @remarks
   * Retrieves retirement contribution constraints for an account
   */
  async retrieveContributionConstraints(
    retrieveContributionConstraintsRequestCreate:
      components.RetrieveContributionConstraintsRequestCreate,
    accountId: string,
    options?: RequestOptions,
  ): Promise<
    operations.RetirementConstraintsRetrieveContributionConstraintsResponse
  > {
    return unwrapAsync(retirementsRetrieveContributionConstraints(
      this,
      retrieveContributionConstraintsRequestCreate,
      accountId,
      options,
    ));
  }

  /**
   * List Distribution Summaries
   *
   * @remarks
   * Lists the aggregated retirement distribution summaries by tax year
   */
  async listDistributionSummaries(
    accountId: string,
    pageSize?: number | undefined,
    pageToken?: string | undefined,
    options?: RequestOptions,
  ): Promise<
    PageIterator<
      operations.RetirementConstraintsListDistributionSummariesResponse,
      { cursor: string }
    >
  > {
    return unwrapResultIterator(retirementsListDistributionSummaries(
      this,
      accountId,
      pageSize,
      pageToken,
      options,
    ));
  }

  /**
   * Retrieve Distribution Constraints
   *
   * @remarks
   * Retrieves retirement distribution constraints for an account
   */
  async retrieveDistributionConstraints(
    retrieveDistributionConstraintsRequestCreate:
      components.RetrieveDistributionConstraintsRequestCreate,
    accountId: string,
    options?: RequestOptions,
  ): Promise<
    operations.RetirementConstraintsRetrieveDistributionConstraintsResponse
  > {
    return unwrapAsync(retirementsRetrieveDistributionConstraints(
      this,
      retrieveDistributionConstraintsRequestCreate,
      accountId,
      options,
    ));
  }
}