CaptableApi class

Constructors

CaptableApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

deleteCaptableConvertiblesById(String id) → Future<CaptableDeleted?>
Removes one of the caller org's convertible notes, taking its principal out of the cap table's unconverted-instrument totals.
deleteCaptableConvertiblesByIdWithHttpInfo(String id) → Future<Response>
Removes one of the caller org's convertible notes, taking its principal out of the cap table's unconverted-instrument totals.
deleteCaptableOptionsById(String id) → Future<CaptableDeleted?>
Removes one of the caller org's option grants, taking its shares out of the cap table's granted-options and fully-diluted counts.
deleteCaptableOptionsByIdWithHttpInfo(String id) → Future<Response>
Removes one of the caller org's option grants, taking its shares out of the cap table's granted-options and fully-diluted counts.
deleteCaptableSafesById(String id) → Future<CaptableDeleted?>
Removes one of the caller org's SAFEs, taking its capital out of the cap table's unconverted-instrument totals.
deleteCaptableSafesByIdWithHttpInfo(String id) → Future<Response>
Removes one of the caller org's SAFEs, taking its capital out of the cap table's unconverted-instrument totals.
deleteCaptableSharesById(String id) → Future<CaptableDeleted?>
Removes one of the caller org's share certificates, taking its shares out of the cap table's outstanding and fully-diluted counts.
deleteCaptableSharesByIdWithHttpInfo(String id) → Future<Response>
Removes one of the caller org's share certificates, taking its shares out of the cap table's outstanding and fully-diluted counts.
deleteCaptableStakeholdersById(String id) → Future<CaptableDeleted?>
Removes one of the caller org's stakeholders.
deleteCaptableStakeholdersByIdWithHttpInfo(String id) → Future<Response>
Removes one of the caller org's stakeholders.
getCaptableClasses() → Future<List<CaptableShareClass>?>
Returns the caller org's share classes, in creation order.
getCaptableClassesWithHttpInfo() → Future<Response>
Returns the caller org's share classes, in creation order.
getCaptableCompany() → Future<CaptableCompany?>
Returns the caller org's cap-table company record.
getCaptableCompanyWithHttpInfo() → Future<Response>
Returns the caller org's cap-table company record.
getCaptableConvertibles() → Future<CaptableNotes?>
Returns the caller org's convertible notes, newest first.
getCaptableConvertiblesWithHttpInfo() → Future<Response>
Returns the caller org's convertible notes, newest first.
getCaptableInvestments() → Future<CaptableInvestments?>
Returns the caller org's investments, newest first.
getCaptableInvestmentsWithHttpInfo() → Future<Response>
Returns the caller org's investments, newest first.
getCaptableOptions() → Future<CaptableOptions?>
Returns the caller org's option grants, newest first.
getCaptableOptionsWithHttpInfo() → Future<Response>
Returns the caller org's option grants, newest first.
getCaptablePlans() → Future<CaptableEquityPlans?>
Returns the caller org's equity plans, newest first.
getCaptablePlansWithHttpInfo() → Future<Response>
Returns the caller org's equity plans, newest first.
getCaptableRounds() → Future<CaptableRounds?>
Returns the caller org's fundraising rounds, newest first.
getCaptableRoundsById(String id) → Future<CaptableRoundDetail?>
Returns one of the caller org's fundraising rounds together with every investment written into it, oldest first.
getCaptableRoundsByIdWithHttpInfo(String id) → Future<Response>
Returns one of the caller org's fundraising rounds together with every investment written into it, oldest first.
getCaptableRoundsWithHttpInfo() → Future<Response>
Returns the caller org's fundraising rounds, newest first.
getCaptableSafes() → Future<CaptableSafes?>
Returns the caller org's SAFEs, newest first.
getCaptableSafesWithHttpInfo() → Future<Response>
Returns the caller org's SAFEs, newest first.
getCaptableShares() → Future<CaptableShares?>
Returns the caller org's share certificates, newest first.
getCaptableSharesWithHttpInfo() → Future<Response>
Returns the caller org's share certificates, newest first.
getCaptableStakeholders() → Future<List<CaptableStakeholder>?>
Returns the caller org's stakeholders, newest first.
getCaptableStakeholdersWithHttpInfo() → Future<Response>
Returns the caller org's stakeholders, newest first.
getCaptableSummary() → Future<CaptableSummary?>
Computes the caller org's cap table.
getCaptableSummaryWithHttpInfo() → Future<Response>
Computes the caller org's cap table.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patchCaptableClassesById(String id, CaptableShareClassAmend captableShareClassAmend) → Future<CaptableUpdated?>
Replaces one share class's terms.
patchCaptableClassesByIdWithHttpInfo(String id, CaptableShareClassAmend captableShareClassAmend) → Future<Response>
Replaces one share class's terms.
patchCaptableStakeholdersById(String id, CaptableStakeholderPatch captableStakeholderPatch) → Future<CaptableUpdated?>
Changes one of the caller org's stakeholders.
patchCaptableStakeholdersByIdWithHttpInfo(String id, CaptableStakeholderPatch captableStakeholderPatch) → Future<Response>
Changes one of the caller org's stakeholders.
postCaptableClasses(CaptableShareClassIn captableShareClassIn) → Future<CaptableCreated?>
Defines a new class of shares.
postCaptableClassesWithHttpInfo(CaptableShareClassIn captableShareClassIn) → Future<Response>
Defines a new class of shares.
postCaptableConvertibles(CaptableConvertibleIn captableConvertibleIn) → Future<CaptableCreated?>
Records a convertible note.
postCaptableConvertiblesWithHttpInfo(CaptableConvertibleIn captableConvertibleIn) → Future<Response>
Records a convertible note.
postCaptableOptions(CaptableOptionIn captableOptionIn) → Future<CaptableCreated?>
Grants options to a stakeholder from an equity plan.
postCaptableOptionsWithHttpInfo(CaptableOptionIn captableOptionIn) → Future<Response>
Grants options to a stakeholder from an equity plan.
postCaptablePlans(CaptableEquityPlanIn captableEquityPlanIn) → Future<CaptableCreated?>
Opens an equity plan that options are granted from.
postCaptablePlansWithHttpInfo(CaptableEquityPlanIn captableEquityPlanIn) → Future<Response>
Opens an equity plan that options are granted from.
postCaptableRounds(CaptableRoundIn captableRoundIn) → Future<CaptableCreated?>
Opens a priced round that investments can be added to.
postCaptableRoundsByIdClose(String id, CaptableRoundCloseRequest captableRoundCloseRequest) → Future<CaptableUpdated?>
Closes one of the caller org's fundraising rounds, recording the close date and moving its status to CLOSED.
postCaptableRoundsByIdCloseWithHttpInfo(String id, CaptableRoundCloseRequest captableRoundCloseRequest) → Future<Response>
Closes one of the caller org's fundraising rounds, recording the close date and moving its status to CLOSED.
postCaptableRoundsByIdInvestments(String id, CaptableInvestmentIn captableInvestmentIn) → Future<CaptableInvested?>
Records one investor's money into an open round.
postCaptableRoundsByIdInvestmentsWithHttpInfo(String id, CaptableInvestmentIn captableInvestmentIn) → Future<Response>
Records one investor's money into an open round.
postCaptableRoundsWithHttpInfo(CaptableRoundIn captableRoundIn) → Future<Response>
Opens a priced round that investments can be added to.
postCaptableSafes(CaptableSafeIn captableSafeIn) → Future<CaptableCreated?>
Records a SAFE — a simple agreement for future equity.
postCaptableSafesWithHttpInfo(CaptableSafeIn captableSafeIn) → Future<Response>
Records a SAFE — a simple agreement for future equity.
postCaptableShares(CaptableShareIn captableShareIn) → Future<CaptableCreated?>
Issues a share certificate to a stakeholder.
postCaptableSharesTransfer(CaptableShareTransfer captableShareTransfer) → Future<CaptableTransferred?>
Moves shares from one stakeholder to another.
postCaptableSharesTransferWithHttpInfo(CaptableShareTransfer captableShareTransfer) → Future<Response>
Moves shares from one stakeholder to another.
postCaptableSharesWithHttpInfo(CaptableShareIn captableShareIn) → Future<Response>
Issues a share certificate to a stakeholder.
postCaptableStakeholders() → Future<void>
Add stakeholders to the cap table
postCaptableStakeholdersWithHttpInfo() → Future<Response>
Add stakeholders to the cap table
putCaptableCompany(CaptableCompanyUpdate captableCompanyUpdate) → Future<CaptableUpdated?>
Sets the caller org's company name and incorporation details.
putCaptableCompanyWithHttpInfo(CaptableCompanyUpdate captableCompanyUpdate) → Future<Response>
Sets the caller org's company name and incorporation details.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited