# OptionInstructions (*optionInstructions*) ## Overview ### Available Operations * [createOptionInstruction](#createoptioninstruction) - Create Option Instruction * [listOptionInstructions](#listoptioninstructions) - List Option Instructions * [getOptionInstruction](#getoptioninstruction) - Get Option Instruction * [cancelOptionInstruction](#canceloptioninstruction) - Cancel Option Instruction ## createOptionInstruction CreateOptionInstruction creates a new option instruction for trading actions ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; import { OptionInstructionCreateIdentifierType, OptionInstructionCreateType } 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.optionInstructions.createOptionInstruction({ accountId: "01JTNGZM8PWRR6MHBCC6TEG9HE", identifier: "AAPL250620P00090000", identifierType: OptionInstructionCreateIdentifierType.Osi, quantity: {}, type: OptionInstructionCreateType.DoNotExercise, }, "ACC123456", "12345"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { optionInstructionsCreateOptionInstruction } from "@apexfintechsolutions/ascend-sdk/funcs/optionInstructionsCreateOptionInstruction.js"; import { OptionInstructionCreateIdentifierType, OptionInstructionCreateType } 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 optionInstructionsCreateOptionInstruction(apexascend, { accountId: "01JTNGZM8PWRR6MHBCC6TEG9HE", identifier: "AAPL250620P00090000", identifierType: OptionInstructionCreateIdentifierType.Osi, quantity: {}, type: OptionInstructionCreateType.DoNotExercise, }, "ACC123456", "12345"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("optionInstructionsCreateOptionInstruction failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `assetId` | *string* | :heavy_check_mark: | The asset id. | [object Object] | | `optionInstructionCreate` | [components.OptionInstructionCreate](../../models/components/optioninstructioncreate.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.ExerciseServiceCreateOptionInstructionResponse](../../models/operations/exerciseservicecreateoptioninstructionresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4XX, 5XX | \*/\* | ## listOptionInstructions ListOptionInstructions lists option instructions with optional filtering and pagination ### 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.optionInstructions.listOptionInstructions({ accountId: "ACC123456", assetId: "12345", pageSize: 50, pageToken: "eyJvZmZzZXQiOjUwfQ==", filter: "type == 'DO_NOT_EXERCISE' && account_id == '12345'", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { optionInstructionsListOptionInstructions } from "@apexfintechsolutions/ascend-sdk/funcs/optionInstructionsListOptionInstructions.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 optionInstructionsListOptionInstructions(apexascend, { accountId: "ACC123456", assetId: "12345", pageSize: 50, pageToken: "eyJvZmZzZXQiOjUwfQ==", filter: "type == 'DO_NOT_EXERCISE' && account_id == '12345'", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("optionInstructionsListOptionInstructions failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.ExerciseServiceListOptionInstructionsRequest](../../models/operations/exerciseservicelistoptioninstructionsrequest.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.ExerciseServiceListOptionInstructionsResponse](../../models/operations/exerciseservicelistoptioninstructionsresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4XX, 5XX | \*/\* | ## getOptionInstruction GetOptionInstruction retrieves an existing instruction by name ### 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.optionInstructions.getOptionInstruction("ACC123456", "12345", "abc12345"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { optionInstructionsGetOptionInstruction } from "@apexfintechsolutions/ascend-sdk/funcs/optionInstructionsGetOptionInstruction.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 optionInstructionsGetOptionInstruction(apexascend, "ACC123456", "12345", "abc12345"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("optionInstructionsGetOptionInstruction failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `assetId` | *string* | :heavy_check_mark: | The asset id. | [object Object] | | `instructionId` | *string* | :heavy_check_mark: | The instruction 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.ExerciseServiceGetOptionInstructionResponse](../../models/operations/exerciseservicegetoptioninstructionresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4XX, 5XX | \*/\* | ## cancelOptionInstruction CancelOptionInstruction cancels an existing instruction by name ### 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.optionInstructions.cancelOptionInstruction({ name: "accounts/ACC123456/assets/12345/instructions/abc12345", }, "ACC123456", "12345", "abc12345"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { optionInstructionsCancelOptionInstruction } from "@apexfintechsolutions/ascend-sdk/funcs/optionInstructionsCancelOptionInstruction.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 optionInstructionsCancelOptionInstruction(apexascend, { name: "accounts/ACC123456/assets/12345/instructions/abc12345", }, "ACC123456", "12345", "abc12345"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("optionInstructionsCancelOptionInstruction failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `assetId` | *string* | :heavy_check_mark: | The asset id. | [object Object] | | `instructionId` | *string* | :heavy_check_mark: | The instruction id. | [object Object] | | `cancelOptionInstructionRequestCreate` | [components.CancelOptionInstructionRequestCreate](../../models/components/canceloptioninstructionrequestcreate.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.ExerciseServiceCancelOptionInstructionResponse](../../models/operations/exerciseservicecanceloptioninstructionresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4XX, 5XX | \*/\* |