# Retirements (*retirements*) ## Overview ### Available Operations * [listContributionSummaries](#listcontributionsummaries) - List Contribution Summaries * [retrieveContributionConstraints](#retrievecontributionconstraints) - Retrieve Contribution Constraints * [listDistributionSummaries](#listdistributionsummaries) - List Distribution Summaries * [retrieveDistributionConstraints](#retrievedistributionconstraints) - Retrieve Distribution Constraints ## listContributionSummaries Lists the aggregated retirement contribution summaries by tax year ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.retirements.listContributionSummaries("01H8FB90ZRRFWXB4XC2JPJ1D4Y"); for await (const page of result) { console.log(page); } } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { retirementsListContributionSummaries } from "@apexfintechsolutions/ascend-sdk/funcs/retirementsListContributionSummaries.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await retirementsListContributionSummaries(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y"); if (res.ok) { const { value: result } = res; for await (const page of result) { console.log(page); } } else { console.log("retirementsListContributionSummaries failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `pageSize` | *number* | :heavy_minus_sign: | Number of contribution summaries to get (partitioned by tax year) Default = 2 (current year and prior year), maximum = 10 | [object Object] | | `pageToken` | *string* | :heavy_minus_sign: | When paginating, this is used to retrieve a specific page from the overall response | [object Object] | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.RetirementConstraintsListContributionSummariesResponse](../../models/operations/retirementconstraintslistcontributionsummariesresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## retrieveContributionConstraints Retrieves retirement contribution constraints for an account ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; import { Mechanism } from "@apexfintechsolutions/ascend-sdk/models/components"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.retirements.retrieveContributionConstraints({ mechanism: Mechanism.Ach, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { retirementsRetrieveContributionConstraints } from "@apexfintechsolutions/ascend-sdk/funcs/retirementsRetrieveContributionConstraints.js"; import { Mechanism } from "@apexfintechsolutions/ascend-sdk/models/components"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await retirementsRetrieveContributionConstraints(apexascend, { mechanism: Mechanism.Ach, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("retirementsRetrieveContributionConstraints failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `retrieveContributionConstraintsRequestCreate` | [components.RetrieveContributionConstraintsRequestCreate](../../models/components/retrievecontributionconstraintsrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.RetirementConstraintsRetrieveContributionConstraintsResponse](../../models/operations/retirementconstraintsretrievecontributionconstraintsresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## listDistributionSummaries Lists the aggregated retirement distribution summaries by tax year ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.retirements.listDistributionSummaries("01H8FB90ZRRFWXB4XC2JPJ1D4Y"); for await (const page of result) { console.log(page); } } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { retirementsListDistributionSummaries } from "@apexfintechsolutions/ascend-sdk/funcs/retirementsListDistributionSummaries.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await retirementsListDistributionSummaries(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y"); if (res.ok) { const { value: result } = res; for await (const page of result) { console.log(page); } } else { console.log("retirementsListDistributionSummaries failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `pageSize` | *number* | :heavy_minus_sign: | Number of distribution summaries to get (partitioned by tax year) Default = 2 (current year and prior year), maximum = 10 | [object Object] | | `pageToken` | *string* | :heavy_minus_sign: | When paginating, this is used to retrieve a specific page from the overall response | [object Object] | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.RetirementConstraintsListDistributionSummariesResponse](../../models/operations/retirementconstraintslistdistributionsummariesresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## retrieveDistributionConstraints Retrieves retirement distribution constraints for an account ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; import { RetrieveDistributionConstraintsRequestCreateMechanism } from "@apexfintechsolutions/ascend-sdk/models/components"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.retirements.retrieveDistributionConstraints({ mechanism: RetrieveDistributionConstraintsRequestCreateMechanism.Ach, name: "accounts/01H8FM6EXVH77SAW3TC8KAWMES", }, "01H8FM6EXVH77SAW3TC8KAWMES"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { retirementsRetrieveDistributionConstraints } from "@apexfintechsolutions/ascend-sdk/funcs/retirementsRetrieveDistributionConstraints.js"; import { RetrieveDistributionConstraintsRequestCreateMechanism } from "@apexfintechsolutions/ascend-sdk/models/components"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await retirementsRetrieveDistributionConstraints(apexascend, { mechanism: RetrieveDistributionConstraintsRequestCreateMechanism.Ach, name: "accounts/01H8FM6EXVH77SAW3TC8KAWMES", }, "01H8FM6EXVH77SAW3TC8KAWMES"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("retirementsRetrieveDistributionConstraints failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `retrieveDistributionConstraintsRequestCreate` | [components.RetrieveDistributionConstraintsRequestCreate](../../models/components/retrievedistributionconstraintsrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.RetirementConstraintsRetrieveDistributionConstraintsResponse](../../models/operations/retirementconstraintsretrievedistributionconstraintsresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* |