60 KiB
\CaptableAPI
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| DeleteCaptableConvertiblesById | Delete /v1/captable/convertibles/{id} | Removes one of the caller org's convertible notes, taking its principal out of the cap table's unconverted-instrument totals. |
| DeleteCaptableOptionsById | Delete /v1/captable/options/{id} | 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 | Delete /v1/captable/safes/{id} | Removes one of the caller org's SAFEs, taking its capital out of the cap table's unconverted-instrument totals. |
| DeleteCaptableSharesById | Delete /v1/captable/shares/{id} | Removes one of the caller org's share certificates, taking its shares out of the cap table's outstanding and fully-diluted counts. |
| DeleteCaptableStakeholdersById | Delete /v1/captable/stakeholders/{id} | Removes one of the caller org's stakeholders. |
| GetCaptableClasses | Get /v1/captable/classes | Returns the caller org's share classes, in creation order. |
| GetCaptableCompany | Get /v1/captable/company | Returns the caller org's cap-table company record. |
| GetCaptableConvertibles | Get /v1/captable/convertibles | Returns the caller org's convertible notes, newest first. |
| GetCaptableInvestments | Get /v1/captable/investments | Returns the caller org's investments, newest first. |
| GetCaptableOptions | Get /v1/captable/options | Returns the caller org's option grants, newest first. |
| GetCaptablePlans | Get /v1/captable/plans | Returns the caller org's equity plans, newest first. |
| GetCaptableRounds | Get /v1/captable/rounds | Returns the caller org's fundraising rounds, newest first. |
| GetCaptableRoundsById | Get /v1/captable/rounds/{id} | Returns one of the caller org's fundraising rounds together with every investment written into it, oldest first. |
| GetCaptableSafes | Get /v1/captable/safes | Returns the caller org's SAFEs, newest first. |
| GetCaptableShares | Get /v1/captable/shares | Returns the caller org's share certificates, newest first. |
| GetCaptableStakeholders | Get /v1/captable/stakeholders | Returns the caller org's stakeholders, newest first. |
| GetCaptableSummary | Get /v1/captable/summary | Computes the caller org's cap table. |
| PatchCaptableClassesById | Patch /v1/captable/classes/{id} | Replaces one share class's terms. |
| PatchCaptableStakeholdersById | Patch /v1/captable/stakeholders/{id} | Changes one of the caller org's stakeholders. |
| PostCaptableClasses | Post /v1/captable/classes | Defines a new class of shares. |
| PostCaptableConvertibles | Post /v1/captable/convertibles | Records a convertible note. |
| PostCaptableOptions | Post /v1/captable/options | Grants options to a stakeholder from an equity plan. |
| PostCaptablePlans | Post /v1/captable/plans | Opens an equity plan that options are granted from. |
| PostCaptableRounds | Post /v1/captable/rounds | Opens a priced round that investments can be added to. |
| PostCaptableRoundsByIdClose | Post /v1/captable/rounds/{id}/close | Closes one of the caller org's fundraising rounds, recording the close date and moving its status to CLOSED. |
| PostCaptableRoundsByIdInvestments | Post /v1/captable/rounds/{id}/investments | Records one investor's money into an open round. |
| PostCaptableSafes | Post /v1/captable/safes | Records a SAFE — a simple agreement for future equity. |
| PostCaptableShares | Post /v1/captable/shares | Issues a share certificate to a stakeholder. |
| PostCaptableSharesTransfer | Post /v1/captable/shares/transfer | Moves shares from one stakeholder to another. |
| PostCaptableStakeholders | Post /v1/captable/stakeholders | Add stakeholders to the cap table |
| PutCaptableCompany | Put /v1/captable/company | Sets the caller org's company name and incorporation details. |
DeleteCaptableConvertiblesById
CaptableCaptableDeleted DeleteCaptableConvertiblesById(ctx, id).Execute()
Removes one of the caller org's convertible notes, taking its principal out of the cap table's unconverted-instrument totals.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the convertible note to delete.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.DeleteCaptableConvertiblesById(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.DeleteCaptableConvertiblesById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteCaptableConvertiblesById`: CaptableCaptableDeleted
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.DeleteCaptableConvertiblesById`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the convertible note to delete. |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteCaptableConvertiblesByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteCaptableOptionsById
CaptableCaptableDeleted DeleteCaptableOptionsById(ctx, id).Execute()
Removes one of the caller org's option grants, taking its shares out of the cap table's granted-options and fully-diluted counts.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the option grant to delete.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.DeleteCaptableOptionsById(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.DeleteCaptableOptionsById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteCaptableOptionsById`: CaptableCaptableDeleted
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.DeleteCaptableOptionsById`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the option grant to delete. |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteCaptableOptionsByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteCaptableSafesById
CaptableCaptableDeleted DeleteCaptableSafesById(ctx, id).Execute()
Removes one of the caller org's SAFEs, taking its capital out of the cap table's unconverted-instrument totals.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the SAFE to delete.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.DeleteCaptableSafesById(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.DeleteCaptableSafesById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteCaptableSafesById`: CaptableCaptableDeleted
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.DeleteCaptableSafesById`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the SAFE to delete. |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteCaptableSafesByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteCaptableSharesById
CaptableCaptableDeleted DeleteCaptableSharesById(ctx, id).Execute()
Removes one of the caller org's share certificates, taking its shares out of the cap table's outstanding and fully-diluted counts.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the share certificate to delete.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.DeleteCaptableSharesById(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.DeleteCaptableSharesById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteCaptableSharesById`: CaptableCaptableDeleted
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.DeleteCaptableSharesById`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the share certificate to delete. |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteCaptableSharesByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteCaptableStakeholdersById
CaptableCaptableDeleted DeleteCaptableStakeholdersById(ctx, id).Execute()
Removes one of the caller org's stakeholders.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the stakeholder to delete.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.DeleteCaptableStakeholdersById(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.DeleteCaptableStakeholdersById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteCaptableStakeholdersById`: CaptableCaptableDeleted
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.DeleteCaptableStakeholdersById`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the stakeholder to delete. |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteCaptableStakeholdersByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableClasses
[]CaptableCaptableShareClass GetCaptableClasses(ctx).Execute()
Returns the caller org's share classes, in creation order.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableClasses(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableClasses``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableClasses`: []CaptableCaptableShareClass
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableClasses`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableClassesRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableCompany
CaptableCaptableCompany GetCaptableCompany(ctx).Execute()
Returns the caller org's cap-table company record.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableCompany(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableCompany``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableCompany`: CaptableCaptableCompany
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableCompany`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableCompanyRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableConvertibles
CaptableCaptableNotes GetCaptableConvertibles(ctx).Execute()
Returns the caller org's convertible notes, newest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableConvertibles(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableConvertibles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableConvertibles`: CaptableCaptableNotes
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableConvertibles`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableConvertiblesRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableInvestments
CaptableCaptableInvestments GetCaptableInvestments(ctx).Execute()
Returns the caller org's investments, newest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableInvestments(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableInvestments``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableInvestments`: CaptableCaptableInvestments
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableInvestments`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableInvestmentsRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableOptions
CaptableCaptableOptions GetCaptableOptions(ctx).Execute()
Returns the caller org's option grants, newest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableOptions(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableOptions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableOptions`: CaptableCaptableOptions
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableOptions`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableOptionsRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptablePlans
CaptableCaptableEquityPlans GetCaptablePlans(ctx).Execute()
Returns the caller org's equity plans, newest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptablePlans(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptablePlans``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptablePlans`: CaptableCaptableEquityPlans
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptablePlans`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptablePlansRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableRounds
CaptableCaptableRounds GetCaptableRounds(ctx).Execute()
Returns the caller org's fundraising rounds, newest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableRounds(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableRounds``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableRounds`: CaptableCaptableRounds
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableRounds`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableRoundsRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableRoundsById
CaptableCaptableRoundDetail GetCaptableRoundsById(ctx, id).Execute()
Returns one of the caller org's fundraising rounds together with every investment written into it, oldest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the round to read. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id from another tenant is simply not found.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableRoundsById(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableRoundsById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableRoundsById`: CaptableCaptableRoundDetail
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableRoundsById`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the round to read. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id from another tenant is simply not found. |
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableRoundsByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableSafes
CaptableCaptableSafes GetCaptableSafes(ctx).Execute()
Returns the caller org's SAFEs, newest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableSafes(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableSafes``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableSafes`: CaptableCaptableSafes
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableSafes`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableSafesRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableShares
CaptableCaptableShares GetCaptableShares(ctx).Execute()
Returns the caller org's share certificates, newest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableShares(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableShares``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableShares`: CaptableCaptableShares
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableShares`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableSharesRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableStakeholders
[]CaptableCaptableStakeholder GetCaptableStakeholders(ctx).Execute()
Returns the caller org's stakeholders, newest first.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableStakeholders(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableStakeholders``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableStakeholders`: []CaptableCaptableStakeholder
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableStakeholders`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableStakeholdersRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCaptableSummary
CaptableCaptableSummary GetCaptableSummary(ctx).Execute()
Computes the caller org's cap table.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.GetCaptableSummary(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.GetCaptableSummary``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCaptableSummary`: CaptableCaptableSummary
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.GetCaptableSummary`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetCaptableSummaryRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PatchCaptableClassesById
CaptableCaptableUpdated PatchCaptableClassesById(ctx, id).CaptableCaptableShareClassAmend(captableCaptableShareClassAmend).Execute()
Replaces one share class's terms.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID addresses the resource. The URL is the addressing authority — a path segment binds after the body and after the query — so the address decides which row is written whatever a body claims.
captableCaptableShareClassAmend := *openapiclient.NewCaptableCaptableShareClassAmend() // CaptableCaptableShareClassAmend |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PatchCaptableClassesById(context.Background(), id).CaptableCaptableShareClassAmend(captableCaptableShareClassAmend).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PatchCaptableClassesById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PatchCaptableClassesById`: CaptableCaptableUpdated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PatchCaptableClassesById`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID addresses the resource. The URL is the addressing authority — a path segment binds after the body and after the query — so the address decides which row is written whatever a body claims. |
Other Parameters
Other parameters are passed through a pointer to a apiPatchCaptableClassesByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
captableCaptableShareClassAmend | CaptableCaptableShareClassAmend | |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PatchCaptableStakeholdersById
CaptableCaptableUpdated PatchCaptableStakeholdersById(ctx, id).CaptableCaptableStakeholderPatch(captableCaptableStakeholderPatch).Execute()
Changes one of the caller org's stakeholders.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the stakeholder to update. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id from another tenant is simply not found.
captableCaptableStakeholderPatch := *openapiclient.NewCaptableCaptableStakeholderPatch() // CaptableCaptableStakeholderPatch |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PatchCaptableStakeholdersById(context.Background(), id).CaptableCaptableStakeholderPatch(captableCaptableStakeholderPatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PatchCaptableStakeholdersById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PatchCaptableStakeholdersById`: CaptableCaptableUpdated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PatchCaptableStakeholdersById`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the stakeholder to update. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id from another tenant is simply not found. |
Other Parameters
Other parameters are passed through a pointer to a apiPatchCaptableStakeholdersByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
captableCaptableStakeholderPatch | CaptableCaptableStakeholderPatch | |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableClasses
CaptableCaptableCreated PostCaptableClasses(ctx).CaptableCaptableShareClassIn(captableCaptableShareClassIn).Execute()
Defines a new class of shares.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableShareClassIn := *openapiclient.NewCaptableCaptableShareClassIn() // CaptableCaptableShareClassIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableClasses(context.Background()).CaptableCaptableShareClassIn(captableCaptableShareClassIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableClasses``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableClasses`: CaptableCaptableCreated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableClasses`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableClassesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableShareClassIn | CaptableCaptableShareClassIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableConvertibles
CaptableCaptableCreated PostCaptableConvertibles(ctx).CaptableCaptableConvertibleIn(captableCaptableConvertibleIn).Execute()
Records a convertible note.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableConvertibleIn := *openapiclient.NewCaptableCaptableConvertibleIn() // CaptableCaptableConvertibleIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableConvertibles(context.Background()).CaptableCaptableConvertibleIn(captableCaptableConvertibleIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableConvertibles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableConvertibles`: CaptableCaptableCreated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableConvertibles`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableConvertiblesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableConvertibleIn | CaptableCaptableConvertibleIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableOptions
CaptableCaptableCreated PostCaptableOptions(ctx).CaptableCaptableOptionIn(captableCaptableOptionIn).Execute()
Grants options to a stakeholder from an equity plan.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableOptionIn := *openapiclient.NewCaptableCaptableOptionIn() // CaptableCaptableOptionIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableOptions(context.Background()).CaptableCaptableOptionIn(captableCaptableOptionIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableOptions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableOptions`: CaptableCaptableCreated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableOptions`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableOptionsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableOptionIn | CaptableCaptableOptionIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptablePlans
CaptableCaptableCreated PostCaptablePlans(ctx).CaptableCaptableEquityPlanIn(captableCaptableEquityPlanIn).Execute()
Opens an equity plan that options are granted from.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableEquityPlanIn := *openapiclient.NewCaptableCaptableEquityPlanIn() // CaptableCaptableEquityPlanIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptablePlans(context.Background()).CaptableCaptableEquityPlanIn(captableCaptableEquityPlanIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptablePlans``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptablePlans`: CaptableCaptableCreated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptablePlans`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptablePlansRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableEquityPlanIn | CaptableCaptableEquityPlanIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableRounds
CaptableCaptableCreated PostCaptableRounds(ctx).CaptableCaptableRoundIn(captableCaptableRoundIn).Execute()
Opens a priced round that investments can be added to.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableRoundIn := *openapiclient.NewCaptableCaptableRoundIn() // CaptableCaptableRoundIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableRounds(context.Background()).CaptableCaptableRoundIn(captableCaptableRoundIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableRounds``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableRounds`: CaptableCaptableCreated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableRounds`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableRoundsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableRoundIn | CaptableCaptableRoundIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableRoundsByIdClose
CaptableCaptableUpdated PostCaptableRoundsByIdClose(ctx, id).CaptableCaptableRoundCloseRequest(captableCaptableRoundCloseRequest).Execute()
Closes one of the caller org's fundraising rounds, recording the close date and moving its status to CLOSED.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the round to close. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id from another tenant is simply not found.
captableCaptableRoundCloseRequest := *openapiclient.NewCaptableCaptableRoundCloseRequest() // CaptableCaptableRoundCloseRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableRoundsByIdClose(context.Background(), id).CaptableCaptableRoundCloseRequest(captableCaptableRoundCloseRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableRoundsByIdClose``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableRoundsByIdClose`: CaptableCaptableUpdated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableRoundsByIdClose`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the round to close. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id from another tenant is simply not found. |
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableRoundsByIdCloseRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
captableCaptableRoundCloseRequest | CaptableCaptableRoundCloseRequest | |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableRoundsByIdInvestments
CaptableCaptableInvested PostCaptableRoundsByIdInvestments(ctx, id).CaptableCaptableInvestmentIn(captableCaptableInvestmentIn).Execute()
Records one investor's money into an open round.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the round to invest in. The URL is the addressing authority — a path segment binds after the body and after the query — so the address decides which round is written whatever a body claims.
captableCaptableInvestmentIn := *openapiclient.NewCaptableCaptableInvestmentIn() // CaptableCaptableInvestmentIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableRoundsByIdInvestments(context.Background(), id).CaptableCaptableInvestmentIn(captableCaptableInvestmentIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableRoundsByIdInvestments``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableRoundsByIdInvestments`: CaptableCaptableInvested
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableRoundsByIdInvestments`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the round to invest in. The URL is the addressing authority — a path segment binds after the body and after the query — so the address decides which round is written whatever a body claims. |
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableRoundsByIdInvestmentsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
captableCaptableInvestmentIn | CaptableCaptableInvestmentIn | |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableSafes
CaptableCaptableCreated PostCaptableSafes(ctx).CaptableCaptableSafeIn(captableCaptableSafeIn).Execute()
Records a SAFE — a simple agreement for future equity.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableSafeIn := *openapiclient.NewCaptableCaptableSafeIn() // CaptableCaptableSafeIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableSafes(context.Background()).CaptableCaptableSafeIn(captableCaptableSafeIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableSafes``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableSafes`: CaptableCaptableCreated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableSafes`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableSafesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableSafeIn | CaptableCaptableSafeIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableShares
CaptableCaptableCreated PostCaptableShares(ctx).CaptableCaptableShareIn(captableCaptableShareIn).Execute()
Issues a share certificate to a stakeholder.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableShareIn := *openapiclient.NewCaptableCaptableShareIn() // CaptableCaptableShareIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableShares(context.Background()).CaptableCaptableShareIn(captableCaptableShareIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableShares``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableShares`: CaptableCaptableCreated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableShares`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableSharesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableShareIn | CaptableCaptableShareIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableSharesTransfer
CaptableCaptableTransferred PostCaptableSharesTransfer(ctx).CaptableCaptableShareTransfer(captableCaptableShareTransfer).Execute()
Moves shares from one stakeholder to another.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableShareTransfer := *openapiclient.NewCaptableCaptableShareTransfer() // CaptableCaptableShareTransfer |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PostCaptableSharesTransfer(context.Background()).CaptableCaptableShareTransfer(captableCaptableShareTransfer).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableSharesTransfer``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostCaptableSharesTransfer`: CaptableCaptableTransferred
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PostCaptableSharesTransfer`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableSharesTransferRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableShareTransfer | CaptableCaptableShareTransfer |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostCaptableStakeholders
PostCaptableStakeholders(ctx).Execute()
Add stakeholders to the cap table
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CaptableAPI.PostCaptableStakeholders(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PostCaptableStakeholders``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiPostCaptableStakeholdersRequest struct via the builder pattern
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PutCaptableCompany
CaptableCaptableUpdated PutCaptableCompany(ctx).CaptableCaptableCompanyUpdate(captableCaptableCompanyUpdate).Execute()
Sets the caller org's company name and incorporation details.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
captableCaptableCompanyUpdate := *openapiclient.NewCaptableCaptableCompanyUpdate() // CaptableCaptableCompanyUpdate |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CaptableAPI.PutCaptableCompany(context.Background()).CaptableCaptableCompanyUpdate(captableCaptableCompanyUpdate).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaptableAPI.PutCaptableCompany``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PutCaptableCompany`: CaptableCaptableUpdated
fmt.Fprintf(os.Stdout, "Response from `CaptableAPI.PutCaptableCompany`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPutCaptableCompanyRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| captableCaptableCompanyUpdate | CaptableCaptableCompanyUpdate |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]