Open Cap Table Protocol Canton SDK - v0.2.84
Preparing search index...
OcpClient
Class OcpClient
Index
Constructors
constructor
Properties
build
Create
Ocf
Object
Command
client
company
Valuation
Report
convertible
Issuance
document
issuer
issuer
Authorization
issuer
Authorized
Shares
Adjustment
stakeholder
stock
Cancellation
stock
Class
stock
Class
Authorized
Shares
Adjustment
stock
Issuance
stock
Legend
Template
stock
Plan
stock
Plan
Pool
Adjustment
vesting
Terms
warrant
Issuance
Methods
create
Batch
Constructors
constructor
new
OcpClient
(
config
?:
ClientConfig
)
:
OcpClient
Parameters
Optional
config
:
ClientConfig
Returns
OcpClient
Properties
build
Create
Ocf
Object
Command
buildCreateOcfObjectCommand
:
(
params
:
CreateOcfObjectParams
,
)
=>
CommandWithDisclosedContracts
[]
Readonly
client
client
:
LedgerJsonApiClient
company
Valuation
Report
companyValuationReport
:
{
addObserversToCompanyValuationReport
:
(
params
:
{
added
:
string
[]
;
companyValuationReportContractId
:
string
}
,
)
=>
Promise
<
{
contractId
:
string
;
updateId
:
string
}
>
;
buildCreateCompanyValuationReportCommand
:
(
params
:
CreateCompanyValuationReportParams
,
)
=>
CommandWithDisclosedContracts
;
createCompanyValuationReport
:
(
params
:
CreateCompanyValuationReportParams
,
)
=>
Promise
<
CreateCompanyValuationReportResult
>
;
updateCompanyValuationReport
:
(
params
:
UpdateCompanyValuationParams
,
)
=>
Promise
<
UpdateCompanyValuationResult
>
;
}
convertible
Issuance
convertibleIssuance
:
{
buildArchiveConvertibleIssuanceByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateConvertibleIssuanceCommand
:
(
params
:
CreateConvertibleIssuanceParams
,
)
=>
CommandWithDisclosedContracts
;
getConvertibleIssuanceAsOcf
:
(
params
:
GetConvertibleIssuanceAsOcfParams
,
)
=>
Promise
<
GetConvertibleIssuanceAsOcfResult
>
;
}
document
document
:
{
buildArchiveDocumentByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateDocumentCommand
:
(
params
:
CreateDocumentParams
,
)
=>
CommandWithDisclosedContracts
;
getDocumentAsOcf
:
(
params
:
GetDocumentAsOcfParams
,
)
=>
Promise
<
GetDocumentAsOcfResult
>
;
}
issuer
issuer
:
{
buildArchiveIssuerByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateIssuerCommand
:
(
params
:
CreateIssuerParams
,
)
=>
CommandWithDisclosedContracts
;
getIssuerAsOcf
:
(
params
:
GetIssuerAsOcfParams
,
)
=>
Promise
<
GetIssuerAsOcfResult
>
;
}
issuer
Authorization
issuerAuthorization
:
{
authorizeIssuer
:
(
params
:
AuthorizeIssuerParams
,
)
=>
Promise
<
AuthorizeIssuerResult
>
;
withdrawAuthorization
:
(
params
:
WithdrawAuthorizationParams
,
)
=>
Promise
<
WithdrawAuthorizationResult
>
;
}
issuer
Authorized
Shares
Adjustment
issuerAuthorizedSharesAdjustment
:
{
buildArchiveIssuerAuthorizedSharesAdjustmentByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateIssuerAuthorizedSharesAdjustmentCommand
:
(
params
:
CreateIssuerAuthorizedSharesAdjustmentParams
,
)
=>
CommandWithDisclosedContracts
;
getIssuerAuthorizedSharesAdjustmentEventAsOcf
:
(
params
:
GetIssuerAuthorizedSharesAdjustmentEventAsOcfParams
,
)
=>
Promise
<
GetIssuerAuthorizedSharesAdjustmentEventAsOcfResult
>
;
}
stakeholder
stakeholder
:
{
buildArchiveStakeholderByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateStakeholderCommand
:
(
params
:
CreateStakeholderParams
,
)
=>
CommandWithDisclosedContracts
;
getStakeholderAsOcf
:
(
params
:
GetStakeholderAsOcfParams
,
)
=>
Promise
<
GetStakeholderAsOcfResult
>
;
}
stock
Cancellation
stockCancellation
:
{
buildArchiveStockCancellationByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateStockCancellationCommand
:
(
params
:
CreateStockCancellationParams
,
)
=>
CommandWithDisclosedContracts
;
getStockCancellationEventAsOcf
:
(
params
:
GetStockCancellationEventAsOcfParams
,
)
=>
Promise
<
GetStockCancellationEventAsOcfResult
>
;
}
stock
Class
stockClass
:
{
buildArchiveStockClassByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateStockClassCommand
:
(
params
:
CreateStockClassParams
,
)
=>
CommandWithDisclosedContracts
;
getStockClassAsOcf
:
(
params
:
GetStockClassAsOcfParams
,
)
=>
Promise
<
GetStockClassAsOcfResult
>
;
}
stock
Class
Authorized
Shares
Adjustment
stockClassAuthorizedSharesAdjustment
:
{
buildArchiveStockClassAuthorizedSharesAdjustmentByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateStockClassAuthorizedSharesAdjustmentCommand
:
(
params
:
CreateStockClassAuthorizedSharesAdjustmentParams
,
)
=>
CommandWithDisclosedContracts
;
getStockClassAuthorizedSharesAdjustmentEventAsOcf
:
(
params
:
GetStockClassAuthorizedSharesAdjustmentEventAsOcfParams
,
)
=>
Promise
<
GetStockClassAuthorizedSharesAdjustmentEventAsOcfResult
>
;
}
stock
Issuance
stockIssuance
:
{
buildArchiveStockIssuanceByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateStockIssuanceCommand
:
(
params
:
CreateStockIssuanceParams
,
)
=>
CommandWithDisclosedContracts
;
getStockIssuanceAsOcf
:
(
params
:
GetStockIssuanceAsOcfParams
,
)
=>
Promise
<
GetStockIssuanceAsOcfResult
>
;
}
stock
Legend
Template
stockLegendTemplate
:
{
buildArchiveStockLegendTemplateByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateStockLegendTemplateCommand
:
(
params
:
CreateStockLegendTemplateParams
,
)
=>
CommandWithDisclosedContracts
;
getStockLegendTemplateAsOcf
:
(
params
:
GetStockLegendTemplateAsOcfParams
,
)
=>
Promise
<
GetStockLegendTemplateAsOcfResult
>
;
}
stock
Plan
stockPlan
:
{
buildArchiveStockPlanByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateEquityCompensationExerciseCommand
:
(
params
:
CreateEquityCompensationExerciseParams
,
)
=>
CommandWithDisclosedContracts
;
buildCreateEquityCompensationIssuanceCommand
:
(
params
:
CreateEquityCompensationIssuanceParams
,
)
=>
CommandWithDisclosedContracts
;
buildCreateStockPlanCommand
:
(
params
:
CreateStockPlanParams
,
)
=>
CommandWithDisclosedContracts
;
getEquityCompensationExerciseEventAsOcf
:
(
params
:
GetEquityCompensationExerciseEventAsOcfParams
,
)
=>
Promise
<
GetEquityCompensationExerciseEventAsOcfResult
>
;
getEquityCompensationIssuanceEventAsOcf
:
(
params
:
GetEquityCompensationIssuanceEventAsOcfParams
,
)
=>
Promise
<
GetEquityCompensationIssuanceEventAsOcfResult
>
;
getStockPlanAsOcf
:
(
params
:
GetStockPlanAsOcfParams
,
)
=>
Promise
<
GetStockPlanAsOcfResult
>
;
}
stock
Plan
Pool
Adjustment
stockPlanPoolAdjustment
:
{
buildArchiveStockPlanPoolAdjustmentByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateStockPlanPoolAdjustmentCommand
:
(
params
:
CreateStockPlanPoolAdjustmentParams
,
)
=>
CommandWithDisclosedContracts
;
getStockPlanPoolAdjustmentEventAsOcf
:
(
params
:
GetStockPlanPoolAdjustmentEventAsOcfParams
,
)
=>
Promise
<
GetStockPlanPoolAdjustmentEventAsOcfResult
>
;
}
vesting
Terms
vestingTerms
:
{
buildArchiveVestingTermsByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateVestingTermsCommand
:
(
params
:
CreateVestingTermsParams
,
)
=>
CommandWithDisclosedContracts
;
getVestingTermsAsOcf
:
(
params
:
GetVestingTermsAsOcfParams
,
)
=>
Promise
<
GetVestingTermsAsOcfResult
>
;
}
warrant
Issuance
warrantIssuance
:
{
buildArchiveWarrantIssuanceByIssuerCommand
:
(
params
:
{
contractId
:
string
}
,
)
=>
|
{
CreateCommand
:
{
createArguments
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
templateId
:
string
;
}
;
}
|
{
ExerciseCommand
:
{
choice
:
string
;
choiceArgument
:
z.ZodRecord
<
z.ZodString
,
z.ZodUnion
<
readonly
[
z.ZodString
,
z.ZodNumber
,
z.ZodBoolean
,
z.ZodNull
,
z.ZodRecord
<
z.ZodString
,
z.ZodAny
>
,
z.ZodArray
<
z.ZodAny
>
,
]
,
>
,
>
;
contractId
:
string
;
templateId
:
string
;
}
;
}
;
buildCreateWarrantIssuanceCommand
:
(
params
:
CreateWarrantIssuanceParams
,
)
=>
CommandWithDisclosedContracts
;
getWarrantIssuanceAsOcf
:
(
params
:
GetWarrantIssuanceAsOcfParams
,
)
=>
Promise
<
GetWarrantIssuanceAsOcfResult
>
;
}
Methods
create
Batch
createBatch
(
params
:
{
actAs
:
string
[]
;
readAs
?:
string
[]
}
)
:
TransactionBatch
Parameters
params
:
{
actAs
:
string
[]
;
readAs
?:
string
[]
}
Returns
TransactionBatch
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
build
Create
Ocf
Object
Command
client
company
Valuation
Report
convertible
Issuance
document
issuer
issuer
Authorization
issuer
Authorized
Shares
Adjustment
stakeholder
stock
Cancellation
stock
Class
stock
Class
Authorized
Shares
Adjustment
stock
Issuance
stock
Legend
Template
stock
Plan
stock
Plan
Pool
Adjustment
vesting
Terms
warrant
Issuance
Methods
create
Batch
Open Cap Table Protocol Canton SDK - v0.2.84
Loading...