Files
sdk/api_captable.go

3715 lines
132 KiB
Go

/*
Hanzo Cloud API
The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
API version: v1
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package hanzoai
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// CaptableAPIService CaptableAPI service
type CaptableAPIService service
type CaptableAPIDeleteCaptableConvertiblesByIdRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
}
func (r CaptableAPIDeleteCaptableConvertiblesByIdRequest) Execute() (*CaptableCaptableDeleted, *http.Response, error) {
return r.ApiService.DeleteCaptableConvertiblesByIdExecute(r)
}
/*
DeleteCaptableConvertiblesById Removes one of the caller org's convertible notes, taking its principal out of the cap table's unconverted-instrument totals.
Removes one of the caller org's convertible notes, taking its
principal out of the cap table's unconverted-instrument totals. An id this org
does not hold is not found.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the convertible note to delete.
@return CaptableAPIDeleteCaptableConvertiblesByIdRequest
*/
func (a *CaptableAPIService) DeleteCaptableConvertiblesById(ctx context.Context, id string) CaptableAPIDeleteCaptableConvertiblesByIdRequest {
return CaptableAPIDeleteCaptableConvertiblesByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableDeleted
func (a *CaptableAPIService) DeleteCaptableConvertiblesByIdExecute(r CaptableAPIDeleteCaptableConvertiblesByIdRequest) (*CaptableCaptableDeleted, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableDeleted
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.DeleteCaptableConvertiblesById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/convertibles/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIDeleteCaptableOptionsByIdRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
}
func (r CaptableAPIDeleteCaptableOptionsByIdRequest) Execute() (*CaptableCaptableDeleted, *http.Response, error) {
return r.ApiService.DeleteCaptableOptionsByIdExecute(r)
}
/*
DeleteCaptableOptionsById Removes one of the caller org's option grants, taking its shares out of the cap table's granted-options and fully-diluted counts.
Removes one of the caller org's option grants, taking its shares
out of the cap table's granted-options and fully-diluted counts. An id this org
does not hold is not found.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the option grant to delete.
@return CaptableAPIDeleteCaptableOptionsByIdRequest
*/
func (a *CaptableAPIService) DeleteCaptableOptionsById(ctx context.Context, id string) CaptableAPIDeleteCaptableOptionsByIdRequest {
return CaptableAPIDeleteCaptableOptionsByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableDeleted
func (a *CaptableAPIService) DeleteCaptableOptionsByIdExecute(r CaptableAPIDeleteCaptableOptionsByIdRequest) (*CaptableCaptableDeleted, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableDeleted
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.DeleteCaptableOptionsById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/options/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIDeleteCaptableSafesByIdRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
}
func (r CaptableAPIDeleteCaptableSafesByIdRequest) Execute() (*CaptableCaptableDeleted, *http.Response, error) {
return r.ApiService.DeleteCaptableSafesByIdExecute(r)
}
/*
DeleteCaptableSafesById Removes one of the caller org's SAFEs, taking its capital out of the cap table's unconverted-instrument totals.
Removes one of the caller org's SAFEs, taking its capital out of the
cap table's unconverted-instrument totals. An id this org does not hold is not
found.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the SAFE to delete.
@return CaptableAPIDeleteCaptableSafesByIdRequest
*/
func (a *CaptableAPIService) DeleteCaptableSafesById(ctx context.Context, id string) CaptableAPIDeleteCaptableSafesByIdRequest {
return CaptableAPIDeleteCaptableSafesByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableDeleted
func (a *CaptableAPIService) DeleteCaptableSafesByIdExecute(r CaptableAPIDeleteCaptableSafesByIdRequest) (*CaptableCaptableDeleted, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableDeleted
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.DeleteCaptableSafesById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/safes/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIDeleteCaptableSharesByIdRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
}
func (r CaptableAPIDeleteCaptableSharesByIdRequest) Execute() (*CaptableCaptableDeleted, *http.Response, error) {
return r.ApiService.DeleteCaptableSharesByIdExecute(r)
}
/*
DeleteCaptableSharesById Removes one of the caller org's share certificates, taking its shares out of the cap table's outstanding and fully-diluted counts.
Removes one of the caller org's share certificates, taking its
shares out of the cap table's outstanding and fully-diluted counts. An id this
org does not hold is not found.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the share certificate to delete.
@return CaptableAPIDeleteCaptableSharesByIdRequest
*/
func (a *CaptableAPIService) DeleteCaptableSharesById(ctx context.Context, id string) CaptableAPIDeleteCaptableSharesByIdRequest {
return CaptableAPIDeleteCaptableSharesByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableDeleted
func (a *CaptableAPIService) DeleteCaptableSharesByIdExecute(r CaptableAPIDeleteCaptableSharesByIdRequest) (*CaptableCaptableDeleted, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableDeleted
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.DeleteCaptableSharesById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/shares/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIDeleteCaptableStakeholdersByIdRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
}
func (r CaptableAPIDeleteCaptableStakeholdersByIdRequest) Execute() (*CaptableCaptableDeleted, *http.Response, error) {
return r.ApiService.DeleteCaptableStakeholdersByIdExecute(r)
}
/*
DeleteCaptableStakeholdersById Removes one of the caller org's stakeholders.
Removes one of the caller org's stakeholders. It REFUSES to
orphan issued equity: a holder that still holds share certificates or option
grants cannot be deleted, and answers 400 saying so — release or transfer the
holdings first. An id this org does not hold is not found.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the stakeholder to delete.
@return CaptableAPIDeleteCaptableStakeholdersByIdRequest
*/
func (a *CaptableAPIService) DeleteCaptableStakeholdersById(ctx context.Context, id string) CaptableAPIDeleteCaptableStakeholdersByIdRequest {
return CaptableAPIDeleteCaptableStakeholdersByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableDeleted
func (a *CaptableAPIService) DeleteCaptableStakeholdersByIdExecute(r CaptableAPIDeleteCaptableStakeholdersByIdRequest) (*CaptableCaptableDeleted, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableDeleted
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.DeleteCaptableStakeholdersById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/stakeholders/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableClassesRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableClassesRequest) Execute() ([]CaptableCaptableShareClass, *http.Response, error) {
return r.ApiService.GetCaptableClassesExecute(r)
}
/*
GetCaptableClasses Returns the caller org's share classes, in creation order.
Returns the caller org's share classes, in creation order. A
share class is what a certificate is issued in, and every class the company
has authorized appears. The response is a bare JSON array, not an envelope.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableClassesRequest
*/
func (a *CaptableAPIService) GetCaptableClasses(ctx context.Context) CaptableAPIGetCaptableClassesRequest {
return CaptableAPIGetCaptableClassesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return []CaptableCaptableShareClass
func (a *CaptableAPIService) GetCaptableClassesExecute(r CaptableAPIGetCaptableClassesRequest) ([]CaptableCaptableShareClass, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue []CaptableCaptableShareClass
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableClasses")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/classes"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableCompanyRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableCompanyRequest) Execute() (*CaptableCaptableCompany, *http.Response, error) {
return r.ApiService.GetCaptableCompanyExecute(r)
}
/*
GetCaptableCompany Returns the caller org's cap-table company record.
Returns the caller org's cap-table company record. The row is
seeded when the tenant's store first opens, so it always exists; its name and
incorporation details are set with PUT /v1/captable/company.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableCompanyRequest
*/
func (a *CaptableAPIService) GetCaptableCompany(ctx context.Context) CaptableAPIGetCaptableCompanyRequest {
return CaptableAPIGetCaptableCompanyRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableCompany
func (a *CaptableAPIService) GetCaptableCompanyExecute(r CaptableAPIGetCaptableCompanyRequest) (*CaptableCaptableCompany, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableCompany
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableCompany")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/company"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableConvertiblesRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableConvertiblesRequest) Execute() (*CaptableCaptableNotes, *http.Response, error) {
return r.ApiService.GetCaptableConvertiblesExecute(r)
}
/*
GetCaptableConvertibles Returns the caller org's convertible notes, newest first.
Returns the caller org's convertible notes, newest first. A
note's principal sits OUTSIDE issued equity until it converts, so it is not
part of the share counts.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableConvertiblesRequest
*/
func (a *CaptableAPIService) GetCaptableConvertibles(ctx context.Context) CaptableAPIGetCaptableConvertiblesRequest {
return CaptableAPIGetCaptableConvertiblesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableNotes
func (a *CaptableAPIService) GetCaptableConvertiblesExecute(r CaptableAPIGetCaptableConvertiblesRequest) (*CaptableCaptableNotes, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableNotes
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableConvertibles")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/convertibles"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableInvestmentsRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableInvestmentsRequest) Execute() (*CaptableCaptableInvestments, *http.Response, error) {
return r.ApiService.GetCaptableInvestmentsExecute(r)
}
/*
GetCaptableInvestments Returns the caller org's investments, newest first.
Returns the caller org's investments, newest first. It spans
every round, so it is the flat ledger of cheques written into the company,
each naming its investor and the round it went into.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableInvestmentsRequest
*/
func (a *CaptableAPIService) GetCaptableInvestments(ctx context.Context) CaptableAPIGetCaptableInvestmentsRequest {
return CaptableAPIGetCaptableInvestmentsRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableInvestments
func (a *CaptableAPIService) GetCaptableInvestmentsExecute(r CaptableAPIGetCaptableInvestmentsRequest) (*CaptableCaptableInvestments, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableInvestments
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableInvestments")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/investments"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableOptionsRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableOptionsRequest) Execute() (*CaptableCaptableOptions, *http.Response, error) {
return r.ApiService.GetCaptableOptionsExecute(r)
}
/*
GetCaptableOptions Returns the caller org's option grants, newest first.
Returns the caller org's option grants, newest first. Each row is
joined to its grantee and its equity plan. Grants that are EXERCISED, EXPIRED
or CANCELLED are listed here but do not dilute the cap table.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableOptionsRequest
*/
func (a *CaptableAPIService) GetCaptableOptions(ctx context.Context) CaptableAPIGetCaptableOptionsRequest {
return CaptableAPIGetCaptableOptionsRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableOptions
func (a *CaptableAPIService) GetCaptableOptionsExecute(r CaptableAPIGetCaptableOptionsRequest) (*CaptableCaptableOptions, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableOptions
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableOptions")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/options"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptablePlansRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptablePlansRequest) Execute() (*CaptableCaptableEquityPlans, *http.Response, error) {
return r.ApiService.GetCaptablePlansExecute(r)
}
/*
GetCaptablePlans Returns the caller org's equity plans, newest first.
Returns the caller org's equity plans, newest first. An equity
plan is an option pool: a reserve of shares, drawn from one share class, that
option grants are written against.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptablePlansRequest
*/
func (a *CaptableAPIService) GetCaptablePlans(ctx context.Context) CaptableAPIGetCaptablePlansRequest {
return CaptableAPIGetCaptablePlansRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableEquityPlans
func (a *CaptableAPIService) GetCaptablePlansExecute(r CaptableAPIGetCaptablePlansRequest) (*CaptableCaptableEquityPlans, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableEquityPlans
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptablePlans")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/plans"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableRoundsRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableRoundsRequest) Execute() (*CaptableCaptableRounds, *http.Response, error) {
return r.ApiService.GetCaptableRoundsExecute(r)
}
/*
GetCaptableRounds Returns the caller org's fundraising rounds, newest first.
Returns the caller org's fundraising rounds, newest first. A round
groups a fundraising event; a PRICED round also carries the share class and
price per share it issues at.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableRoundsRequest
*/
func (a *CaptableAPIService) GetCaptableRounds(ctx context.Context) CaptableAPIGetCaptableRoundsRequest {
return CaptableAPIGetCaptableRoundsRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableRounds
func (a *CaptableAPIService) GetCaptableRoundsExecute(r CaptableAPIGetCaptableRoundsRequest) (*CaptableCaptableRounds, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableRounds
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableRounds")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/rounds"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableRoundsByIdRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
}
func (r CaptableAPIGetCaptableRoundsByIdRequest) Execute() (*CaptableCaptableRoundDetail, *http.Response, error) {
return r.ApiService.GetCaptableRoundsByIdExecute(r)
}
/*
GetCaptableRoundsById Returns one of the caller org's fundraising rounds together with every investment written into it, oldest first.
Returns one of the caller org's fundraising rounds together with every
investment written into it, oldest first. A round id that does not exist in the
caller's org is not found — including one that exists in another tenant, since
the org comes from the caller's principal and is part of the lookup.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id 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.
@return CaptableAPIGetCaptableRoundsByIdRequest
*/
func (a *CaptableAPIService) GetCaptableRoundsById(ctx context.Context, id string) CaptableAPIGetCaptableRoundsByIdRequest {
return CaptableAPIGetCaptableRoundsByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableRoundDetail
func (a *CaptableAPIService) GetCaptableRoundsByIdExecute(r CaptableAPIGetCaptableRoundsByIdRequest) (*CaptableCaptableRoundDetail, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableRoundDetail
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableRoundsById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/rounds/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableSafesRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableSafesRequest) Execute() (*CaptableCaptableSafes, *http.Response, error) {
return r.ApiService.GetCaptableSafesExecute(r)
}
/*
GetCaptableSafes Returns the caller org's SAFEs, newest first.
Returns the caller org's SAFEs, newest first. A SAFE is a simple
agreement for future equity: its capital sits OUTSIDE issued equity until it
converts, so it is not part of the share counts.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableSafesRequest
*/
func (a *CaptableAPIService) GetCaptableSafes(ctx context.Context) CaptableAPIGetCaptableSafesRequest {
return CaptableAPIGetCaptableSafesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableSafes
func (a *CaptableAPIService) GetCaptableSafesExecute(r CaptableAPIGetCaptableSafesRequest) (*CaptableCaptableSafes, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableSafes
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableSafes")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/safes"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableSharesRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableSharesRequest) Execute() (*CaptableCaptableShares, *http.Response, error) {
return r.ApiService.GetCaptableSharesExecute(r)
}
/*
GetCaptableShares Returns the caller org's share certificates, newest first.
Returns the caller org's share certificates, newest first. Each row
is joined to its holder and its share class, so a certificate names who holds
it and what class it is in without a second call.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableSharesRequest
*/
func (a *CaptableAPIService) GetCaptableShares(ctx context.Context) CaptableAPIGetCaptableSharesRequest {
return CaptableAPIGetCaptableSharesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableShares
func (a *CaptableAPIService) GetCaptableSharesExecute(r CaptableAPIGetCaptableSharesRequest) (*CaptableCaptableShares, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableShares
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableShares")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/shares"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableStakeholdersRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableStakeholdersRequest) Execute() ([]CaptableCaptableStakeholder, *http.Response, error) {
return r.ApiService.GetCaptableStakeholdersExecute(r)
}
/*
GetCaptableStakeholders Returns the caller org's stakeholders, newest first.
Returns the caller org's stakeholders, newest first. The
response is a bare JSON array, not an envelope. Each row carries the holder's
contact and address fields alongside the company's name.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableStakeholdersRequest
*/
func (a *CaptableAPIService) GetCaptableStakeholders(ctx context.Context) CaptableAPIGetCaptableStakeholdersRequest {
return CaptableAPIGetCaptableStakeholdersRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return []CaptableCaptableStakeholder
func (a *CaptableAPIService) GetCaptableStakeholdersExecute(r CaptableAPIGetCaptableStakeholdersRequest) ([]CaptableCaptableStakeholder, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue []CaptableCaptableStakeholder
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableStakeholders")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/stakeholders"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIGetCaptableSummaryRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIGetCaptableSummaryRequest) Execute() (*CaptableCaptableSummary, *http.Response, error) {
return r.ApiService.GetCaptableSummaryExecute(r)
}
/*
GetCaptableSummary Computes the caller org's cap table.
Computes the caller org's cap table. It answers who owns what on a
fully-diluted basis: outstanding shares, granted options, per-stakeholder
ownership percentages, each share class's authorized versus issued position,
and the capital sitting on SAFEs and convertible notes that have not yet
converted. Only non-terminal option grants dilute — EXERCISED, EXPIRED and
CANCELLED grants are excluded, so equity issued through an exercised option is
never counted twice.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIGetCaptableSummaryRequest
*/
func (a *CaptableAPIService) GetCaptableSummary(ctx context.Context) CaptableAPIGetCaptableSummaryRequest {
return CaptableAPIGetCaptableSummaryRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableSummary
func (a *CaptableAPIService) GetCaptableSummaryExecute(r CaptableAPIGetCaptableSummaryRequest) (*CaptableCaptableSummary, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableSummary
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.GetCaptableSummary")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/summary"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPatchCaptableClassesByIdRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
captableCaptableShareClassAmend *CaptableCaptableShareClassAmend
}
func (r CaptableAPIPatchCaptableClassesByIdRequest) CaptableCaptableShareClassAmend(captableCaptableShareClassAmend CaptableCaptableShareClassAmend) CaptableAPIPatchCaptableClassesByIdRequest {
r.captableCaptableShareClassAmend = &captableCaptableShareClassAmend
return r
}
func (r CaptableAPIPatchCaptableClassesByIdRequest) Execute() (*CaptableCaptableUpdated, *http.Response, error) {
return r.ApiService.PatchCaptableClassesByIdExecute(r)
}
/*
PatchCaptableClassesById Replaces one share class's terms.
Replaces one share class's terms.
It is a full REPLACE and not a merge, despite the PATCH: every field is written
as sent, so a field omitted is written empty rather than left alone. Send the
whole class. The method is PATCH because the resource is addressed by id, not
because the body is partial — and getting that backwards silently blanks terms
every later issuance prices against.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id 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.
@return CaptableAPIPatchCaptableClassesByIdRequest
*/
func (a *CaptableAPIService) PatchCaptableClassesById(ctx context.Context, id string) CaptableAPIPatchCaptableClassesByIdRequest {
return CaptableAPIPatchCaptableClassesByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableUpdated
func (a *CaptableAPIService) PatchCaptableClassesByIdExecute(r CaptableAPIPatchCaptableClassesByIdRequest) (*CaptableCaptableUpdated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPatch
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableUpdated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PatchCaptableClassesById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/classes/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableShareClassAmend == nil {
return localVarReturnValue, nil, reportError("captableCaptableShareClassAmend is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableShareClassAmend
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPatchCaptableStakeholdersByIdRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
captableCaptableStakeholderPatch *CaptableCaptableStakeholderPatch
}
func (r CaptableAPIPatchCaptableStakeholdersByIdRequest) CaptableCaptableStakeholderPatch(captableCaptableStakeholderPatch CaptableCaptableStakeholderPatch) CaptableAPIPatchCaptableStakeholdersByIdRequest {
r.captableCaptableStakeholderPatch = &captableCaptableStakeholderPatch
return r
}
func (r CaptableAPIPatchCaptableStakeholdersByIdRequest) Execute() (*CaptableCaptableUpdated, *http.Response, error) {
return r.ApiService.PatchCaptableStakeholdersByIdExecute(r)
}
/*
PatchCaptableStakeholdersById Changes one of the caller org's stakeholders.
Changes one of the caller org's stakeholders. It is a
PARTIAL update: only the fields the request names are written, and a field
sent as null clears that column. A request that names no updatable field is
refused, and an id this org does not hold is not found.
The values are stored as sent. Unlike adding a stakeholder, this route does
not check the email's shape or the type and relationship vocabularies, so it
can record a value that adding one would have rejected.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id 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.
@return CaptableAPIPatchCaptableStakeholdersByIdRequest
*/
func (a *CaptableAPIService) PatchCaptableStakeholdersById(ctx context.Context, id string) CaptableAPIPatchCaptableStakeholdersByIdRequest {
return CaptableAPIPatchCaptableStakeholdersByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableUpdated
func (a *CaptableAPIService) PatchCaptableStakeholdersByIdExecute(r CaptableAPIPatchCaptableStakeholdersByIdRequest) (*CaptableCaptableUpdated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPatch
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableUpdated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PatchCaptableStakeholdersById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/stakeholders/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableStakeholderPatch == nil {
return localVarReturnValue, nil, reportError("captableCaptableStakeholderPatch is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableStakeholderPatch
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableClassesRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableShareClassIn *CaptableCaptableShareClassIn
}
func (r CaptableAPIPostCaptableClassesRequest) CaptableCaptableShareClassIn(captableCaptableShareClassIn CaptableCaptableShareClassIn) CaptableAPIPostCaptableClassesRequest {
r.captableCaptableShareClassIn = &captableCaptableShareClassIn
return r
}
func (r CaptableAPIPostCaptableClassesRequest) Execute() (*CaptableCaptableCreated, *http.Response, error) {
return r.ApiService.PostCaptableClassesExecute(r)
}
/*
PostCaptableClasses Defines a new class of shares.
Defines a new class of shares.
Every field but convertsToShareClassId is required — a class is the instrument
every later issuance prices against, so a partially-specified one would silently
mis-value every share issued into it. `seniority` orders liquidation preference
with LOWER first.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptableClassesRequest
*/
func (a *CaptableAPIService) PostCaptableClasses(ctx context.Context) CaptableAPIPostCaptableClassesRequest {
return CaptableAPIPostCaptableClassesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableCreated
func (a *CaptableAPIService) PostCaptableClassesExecute(r CaptableAPIPostCaptableClassesRequest) (*CaptableCaptableCreated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableCreated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableClasses")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/classes"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableShareClassIn == nil {
return localVarReturnValue, nil, reportError("captableCaptableShareClassIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableShareClassIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableConvertiblesRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableConvertibleIn *CaptableCaptableConvertibleIn
}
func (r CaptableAPIPostCaptableConvertiblesRequest) CaptableCaptableConvertibleIn(captableCaptableConvertibleIn CaptableCaptableConvertibleIn) CaptableAPIPostCaptableConvertiblesRequest {
r.captableCaptableConvertibleIn = &captableCaptableConvertibleIn
return r
}
func (r CaptableAPIPostCaptableConvertiblesRequest) Execute() (*CaptableCaptableCreated, *http.Response, error) {
return r.ApiService.PostCaptableConvertiblesExecute(r)
}
/*
PostCaptableConvertibles Records a convertible note.
Records a convertible note.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptableConvertiblesRequest
*/
func (a *CaptableAPIService) PostCaptableConvertibles(ctx context.Context) CaptableAPIPostCaptableConvertiblesRequest {
return CaptableAPIPostCaptableConvertiblesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableCreated
func (a *CaptableAPIService) PostCaptableConvertiblesExecute(r CaptableAPIPostCaptableConvertiblesRequest) (*CaptableCaptableCreated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableCreated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableConvertibles")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/convertibles"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableConvertibleIn == nil {
return localVarReturnValue, nil, reportError("captableCaptableConvertibleIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableConvertibleIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableOptionsRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableOptionIn *CaptableCaptableOptionIn
}
func (r CaptableAPIPostCaptableOptionsRequest) CaptableCaptableOptionIn(captableCaptableOptionIn CaptableCaptableOptionIn) CaptableAPIPostCaptableOptionsRequest {
r.captableCaptableOptionIn = &captableCaptableOptionIn
return r
}
func (r CaptableAPIPostCaptableOptionsRequest) Execute() (*CaptableCaptableCreated, *http.Response, error) {
return r.ApiService.PostCaptableOptionsExecute(r)
}
/*
PostCaptableOptions Grants options to a stakeholder from an equity plan.
Grants options to a stakeholder from an equity plan.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptableOptionsRequest
*/
func (a *CaptableAPIService) PostCaptableOptions(ctx context.Context) CaptableAPIPostCaptableOptionsRequest {
return CaptableAPIPostCaptableOptionsRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableCreated
func (a *CaptableAPIService) PostCaptableOptionsExecute(r CaptableAPIPostCaptableOptionsRequest) (*CaptableCaptableCreated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableCreated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableOptions")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/options"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableOptionIn == nil {
return localVarReturnValue, nil, reportError("captableCaptableOptionIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableOptionIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptablePlansRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableEquityPlanIn *CaptableCaptableEquityPlanIn
}
func (r CaptableAPIPostCaptablePlansRequest) CaptableCaptableEquityPlanIn(captableCaptableEquityPlanIn CaptableCaptableEquityPlanIn) CaptableAPIPostCaptablePlansRequest {
r.captableCaptableEquityPlanIn = &captableCaptableEquityPlanIn
return r
}
func (r CaptableAPIPostCaptablePlansRequest) Execute() (*CaptableCaptableCreated, *http.Response, error) {
return r.ApiService.PostCaptablePlansExecute(r)
}
/*
PostCaptablePlans Opens an equity plan that options are granted from.
Opens an equity plan that options are granted from.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptablePlansRequest
*/
func (a *CaptableAPIService) PostCaptablePlans(ctx context.Context) CaptableAPIPostCaptablePlansRequest {
return CaptableAPIPostCaptablePlansRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableCreated
func (a *CaptableAPIService) PostCaptablePlansExecute(r CaptableAPIPostCaptablePlansRequest) (*CaptableCaptableCreated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableCreated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptablePlans")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/plans"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableEquityPlanIn == nil {
return localVarReturnValue, nil, reportError("captableCaptableEquityPlanIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableEquityPlanIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableRoundsRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableRoundIn *CaptableCaptableRoundIn
}
func (r CaptableAPIPostCaptableRoundsRequest) CaptableCaptableRoundIn(captableCaptableRoundIn CaptableCaptableRoundIn) CaptableAPIPostCaptableRoundsRequest {
r.captableCaptableRoundIn = &captableCaptableRoundIn
return r
}
func (r CaptableAPIPostCaptableRoundsRequest) Execute() (*CaptableCaptableCreated, *http.Response, error) {
return r.ApiService.PostCaptableRoundsExecute(r)
}
/*
PostCaptableRounds Opens a priced round that investments can be added to.
Opens a priced round that investments can be added to.
The round opens OPEN; investing into a closed one is refused.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptableRoundsRequest
*/
func (a *CaptableAPIService) PostCaptableRounds(ctx context.Context) CaptableAPIPostCaptableRoundsRequest {
return CaptableAPIPostCaptableRoundsRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableCreated
func (a *CaptableAPIService) PostCaptableRoundsExecute(r CaptableAPIPostCaptableRoundsRequest) (*CaptableCaptableCreated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableCreated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableRounds")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/rounds"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableRoundIn == nil {
return localVarReturnValue, nil, reportError("captableCaptableRoundIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableRoundIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableRoundsByIdCloseRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
captableCaptableRoundCloseRequest *CaptableCaptableRoundCloseRequest
}
func (r CaptableAPIPostCaptableRoundsByIdCloseRequest) CaptableCaptableRoundCloseRequest(captableCaptableRoundCloseRequest CaptableCaptableRoundCloseRequest) CaptableAPIPostCaptableRoundsByIdCloseRequest {
r.captableCaptableRoundCloseRequest = &captableCaptableRoundCloseRequest
return r
}
func (r CaptableAPIPostCaptableRoundsByIdCloseRequest) Execute() (*CaptableCaptableUpdated, *http.Response, error) {
return r.ApiService.PostCaptableRoundsByIdCloseExecute(r)
}
/*
PostCaptableRoundsByIdClose Closes one of the caller org's fundraising rounds, recording the close date and moving its status to CLOSED.
Closes one of the caller org's fundraising rounds, recording the
close date and moving its status to CLOSED. Only an OPEN round can be closed:
a round that is already closed — like an id this org does not hold — is not
found. Closing a round does not change what was invested in it.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id 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.
@return CaptableAPIPostCaptableRoundsByIdCloseRequest
*/
func (a *CaptableAPIService) PostCaptableRoundsByIdClose(ctx context.Context, id string) CaptableAPIPostCaptableRoundsByIdCloseRequest {
return CaptableAPIPostCaptableRoundsByIdCloseRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableUpdated
func (a *CaptableAPIService) PostCaptableRoundsByIdCloseExecute(r CaptableAPIPostCaptableRoundsByIdCloseRequest) (*CaptableCaptableUpdated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableUpdated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableRoundsByIdClose")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/rounds/{id}/close"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableRoundCloseRequest == nil {
return localVarReturnValue, nil, reportError("captableCaptableRoundCloseRequest is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableRoundCloseRequest
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableRoundsByIdInvestmentsRequest struct {
ctx context.Context
ApiService *CaptableAPIService
id string
captableCaptableInvestmentIn *CaptableCaptableInvestmentIn
}
func (r CaptableAPIPostCaptableRoundsByIdInvestmentsRequest) CaptableCaptableInvestmentIn(captableCaptableInvestmentIn CaptableCaptableInvestmentIn) CaptableAPIPostCaptableRoundsByIdInvestmentsRequest {
r.captableCaptableInvestmentIn = &captableCaptableInvestmentIn
return r
}
func (r CaptableAPIPostCaptableRoundsByIdInvestmentsRequest) Execute() (*CaptableCaptableInvested, *http.Response, error) {
return r.ApiService.PostCaptableRoundsByIdInvestmentsExecute(r)
}
/*
PostCaptableRoundsByIdInvestments Records one investor's money into an open round.
Records one investor's money into an open round.
The round must be OPEN; investing into a closed one is refused. Where the round
carries a price per share, the investment also issues the shares it buys and the
answer names them.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id 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.
@return CaptableAPIPostCaptableRoundsByIdInvestmentsRequest
*/
func (a *CaptableAPIService) PostCaptableRoundsByIdInvestments(ctx context.Context, id string) CaptableAPIPostCaptableRoundsByIdInvestmentsRequest {
return CaptableAPIPostCaptableRoundsByIdInvestmentsRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return CaptableCaptableInvested
func (a *CaptableAPIService) PostCaptableRoundsByIdInvestmentsExecute(r CaptableAPIPostCaptableRoundsByIdInvestmentsRequest) (*CaptableCaptableInvested, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableInvested
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableRoundsByIdInvestments")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/rounds/{id}/investments"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableInvestmentIn == nil {
return localVarReturnValue, nil, reportError("captableCaptableInvestmentIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableInvestmentIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableSafesRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableSafeIn *CaptableCaptableSafeIn
}
func (r CaptableAPIPostCaptableSafesRequest) CaptableCaptableSafeIn(captableCaptableSafeIn CaptableCaptableSafeIn) CaptableAPIPostCaptableSafesRequest {
r.captableCaptableSafeIn = &captableCaptableSafeIn
return r
}
func (r CaptableAPIPostCaptableSafesRequest) Execute() (*CaptableCaptableCreated, *http.Response, error) {
return r.ApiService.PostCaptableSafesExecute(r)
}
/*
PostCaptableSafes Records a SAFE — a simple agreement for future equity.
Records a SAFE — a simple agreement for future equity.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptableSafesRequest
*/
func (a *CaptableAPIService) PostCaptableSafes(ctx context.Context) CaptableAPIPostCaptableSafesRequest {
return CaptableAPIPostCaptableSafesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableCreated
func (a *CaptableAPIService) PostCaptableSafesExecute(r CaptableAPIPostCaptableSafesRequest) (*CaptableCaptableCreated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableCreated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableSafes")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/safes"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableSafeIn == nil {
return localVarReturnValue, nil, reportError("captableCaptableSafeIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableSafeIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableSharesRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableShareIn *CaptableCaptableShareIn
}
func (r CaptableAPIPostCaptableSharesRequest) CaptableCaptableShareIn(captableCaptableShareIn CaptableCaptableShareIn) CaptableAPIPostCaptableSharesRequest {
r.captableCaptableShareIn = &captableCaptableShareIn
return r
}
func (r CaptableAPIPostCaptableSharesRequest) Execute() (*CaptableCaptableCreated, *http.Response, error) {
return r.ApiService.PostCaptableSharesExecute(r)
}
/*
PostCaptableShares Issues a share certificate to a stakeholder.
Issues a share certificate to a stakeholder.
The certificate id must be UNIQUE within the company — a duplicate is refused
409, not silently merged — and both the stakeholder and the share class must
belong to this company, so an id from another tenant is a 400 rather than a
cross-company issuance.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptableSharesRequest
*/
func (a *CaptableAPIService) PostCaptableShares(ctx context.Context) CaptableAPIPostCaptableSharesRequest {
return CaptableAPIPostCaptableSharesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableCreated
func (a *CaptableAPIService) PostCaptableSharesExecute(r CaptableAPIPostCaptableSharesRequest) (*CaptableCaptableCreated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableCreated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableShares")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/shares"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableShareIn == nil {
return localVarReturnValue, nil, reportError("captableCaptableShareIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableShareIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableSharesTransferRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableShareTransfer *CaptableCaptableShareTransfer
}
func (r CaptableAPIPostCaptableSharesTransferRequest) CaptableCaptableShareTransfer(captableCaptableShareTransfer CaptableCaptableShareTransfer) CaptableAPIPostCaptableSharesTransferRequest {
r.captableCaptableShareTransfer = &captableCaptableShareTransfer
return r
}
func (r CaptableAPIPostCaptableSharesTransferRequest) Execute() (*CaptableCaptableTransferred, *http.Response, error) {
return r.ApiService.PostCaptableSharesTransferExecute(r)
}
/*
PostCaptableSharesTransfer Moves shares from one stakeholder to another.
Moves shares from one stakeholder to another.
Omit `quantity` to transfer the whole certificate, which REASSIGNS it and mints
no new share. Send a quantity below the amount held to SPLIT it — the source
certificate keeps the remainder, and a split additionally requires
`certificateId` for the new certificate, which must be unique in the company.
A quantity outside 1..held is refused, so a transfer can never over-issue.
Both outcomes answer 200: a transfer records a movement between holders and
mints no security of its own, which is why this is not a 201 the way an
investment is.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptableSharesTransferRequest
*/
func (a *CaptableAPIService) PostCaptableSharesTransfer(ctx context.Context) CaptableAPIPostCaptableSharesTransferRequest {
return CaptableAPIPostCaptableSharesTransferRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableTransferred
func (a *CaptableAPIService) PostCaptableSharesTransferExecute(r CaptableAPIPostCaptableSharesTransferRequest) (*CaptableCaptableTransferred, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableTransferred
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableSharesTransfer")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/shares/transfer"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableShareTransfer == nil {
return localVarReturnValue, nil, reportError("captableCaptableShareTransfer is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableShareTransfer
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type CaptableAPIPostCaptableStakeholdersRequest struct {
ctx context.Context
ApiService *CaptableAPIService
}
func (r CaptableAPIPostCaptableStakeholdersRequest) Execute() (*http.Response, error) {
return r.ApiService.PostCaptableStakeholdersExecute(r)
}
/*
PostCaptableStakeholders Add stakeholders to the cap table
Records the people and institutions that can hold equity — the rows every share, option, SAFE, note and investment is issued to.
The body is ONE stakeholder object or an ARRAY of them, and the array is the point: a whole roster loads in a single call. Email is the identity within the company, so a stakeholder whose email is already on the table is SKIPPED rather than duplicated or rejected — the 201 reports how many rows were actually inserted, which is what makes re-running an import safe. Validation is all-or-nothing across the batch: one bad entry refuses the whole array.
Writes the caller's OWN cap table: the org resolved from the validated principal selects the tenant's store and scopes every row, so there is no field by which a caller can write into another company's table; a request with no validated org is refused 401, and one from a member who is neither a SuperAdmin nor an admin of the org is refused 403. The whole write runs in one transaction, so a refusal leaves nothing behind. Validation is the cap-table bundle's and so is its refusal: a bad body comes back as {success:false, message, errors:[…]} with the failing fields listed, and numeric fields accept a number OR a numeric string. Bodies are capped at 1 MiB.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPostCaptableStakeholdersRequest
*/
func (a *CaptableAPIService) PostCaptableStakeholders(ctx context.Context) CaptableAPIPostCaptableStakeholdersRequest {
return CaptableAPIPostCaptableStakeholdersRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
func (a *CaptableAPIService) PostCaptableStakeholdersExecute(r CaptableAPIPostCaptableStakeholdersRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PostCaptableStakeholders")
if err != nil {
return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/stakeholders"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarHTTPResponse, newErr
}
return localVarHTTPResponse, nil
}
type CaptableAPIPutCaptableCompanyRequest struct {
ctx context.Context
ApiService *CaptableAPIService
captableCaptableCompanyUpdate *CaptableCaptableCompanyUpdate
}
func (r CaptableAPIPutCaptableCompanyRequest) CaptableCaptableCompanyUpdate(captableCaptableCompanyUpdate CaptableCaptableCompanyUpdate) CaptableAPIPutCaptableCompanyRequest {
r.captableCaptableCompanyUpdate = &captableCaptableCompanyUpdate
return r
}
func (r CaptableAPIPutCaptableCompanyRequest) Execute() (*CaptableCaptableUpdated, *http.Response, error) {
return r.ApiService.PutCaptableCompanyExecute(r)
}
/*
PutCaptableCompany Sets the caller org's company name and incorporation details.
Sets the caller org's company name and incorporation details.
The name is required; the three incorporation fields are optional and each is
stored as empty when omitted, so a call that sends only a name CLEARS them.
The company row itself is seeded when the tenant's store first opens, so this
never creates one.
Only a SuperAdmin or an admin of the org may call it; a member who is neither is
refused 403.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return CaptableAPIPutCaptableCompanyRequest
*/
func (a *CaptableAPIService) PutCaptableCompany(ctx context.Context) CaptableAPIPutCaptableCompanyRequest {
return CaptableAPIPutCaptableCompanyRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return CaptableCaptableUpdated
func (a *CaptableAPIService) PutCaptableCompanyExecute(r CaptableAPIPutCaptableCompanyRequest) (*CaptableCaptableUpdated, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPut
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *CaptableCaptableUpdated
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CaptableAPIService.PutCaptableCompany")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/captable/company"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.captableCaptableCompanyUpdate == nil {
return localVarReturnValue, nil, reportError("captableCaptableCompanyUpdate is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.captableCaptableCompanyUpdate
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}