# PositionJournals (*positionJournals*) ## Overview ### Available Operations * [createPositionJournal](#createpositionjournal) - Create Position Journal * [getPositionJournal](#getpositionjournal) - Get Position Journal * [cancelPositionJournal](#cancelpositionjournal) - Cancel Position Journal ## createPositionJournal Creates a position journal ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; import { IdentifierType, PositionJournalCreateType } 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.positionJournals.createPositionJournal({ clientTransferId: "113bw03-49f8-4525-934c-560fb39dg2kd", destinationAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y", identifier: "AAPL", identifierType: IdentifierType.Symbol, quantity: {}, sourceAccount: "accounts/01H8FM6EXVH77SAW3TC8KAWMES", type: PositionJournalCreateType.Reward, }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { positionJournalsCreatePositionJournal } from "@apexfintechsolutions/ascend-sdk/funcs/positionJournalsCreatePositionJournal.js"; import { IdentifierType, PositionJournalCreateType } 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 positionJournalsCreatePositionJournal(apexascend, { clientTransferId: "113bw03-49f8-4525-934c-560fb39dg2kd", destinationAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y", identifier: "AAPL", identifierType: IdentifierType.Symbol, quantity: {}, sourceAccount: "accounts/01H8FM6EXVH77SAW3TC8KAWMES", type: PositionJournalCreateType.Reward, }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("positionJournalsCreatePositionJournal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [components.PositionJournalCreate](../../models/components/positionjournalcreate.md) | :heavy_check_mark: | The request object to use for the request. | | `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.PositionJournalsCreatePositionJournalResponse](../../models/operations/positionjournalscreatepositionjournalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 409 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## getPositionJournal Gets an existing position journal ### 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.positionJournals.getPositionJournal("20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { positionJournalsGetPositionJournal } from "@apexfintechsolutions/ascend-sdk/funcs/positionJournalsGetPositionJournal.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 positionJournalsGetPositionJournal(apexascend, "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("positionJournalsGetPositionJournal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `positionJournalId` | *string* | :heavy_check_mark: | The positionJournal id. | [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.PositionJournalsGetPositionJournalResponse](../../models/operations/positionjournalsgetpositionjournalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## cancelPositionJournal Cancels an existing position journal ### 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.positionJournals.cancelPositionJournal({ name: "positionJournals/20240717000319", }, "20240717000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { positionJournalsCancelPositionJournal } from "@apexfintechsolutions/ascend-sdk/funcs/positionJournalsCancelPositionJournal.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 positionJournalsCancelPositionJournal(apexascend, { name: "positionJournals/20240717000319", }, "20240717000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("positionJournalsCancelPositionJournal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `positionJournalId` | *string* | :heavy_check_mark: | The positionJournal id. | [object Object] | | `cancelPositionJournalRequestCreate` | [components.CancelPositionJournalRequestCreate](../../models/components/cancelpositionjournalrequestcreate.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.PositionJournalsCancelPositionJournalResponse](../../models/operations/positionjournalscancelpositionjournalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* |