monax

package module
v1.5.23 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 5, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

README

monax-go go-doc

This is the Golang client library for the Monax API. This SDK is generated via after being tested thoroughly against our API. A version of this library is tagged and pushed with each version release of our API.

Our API should be considered BETA level until we reach v2.0.

We currently maintain one linear master branch with strongly tagged versions of the library. You should use these tagged versions via go modules and not worry about branches.

Installation

The package can be simply installed via go get. The packages are modules ready. Simply import it in your cody and allow the tooling to pull it into your vendor directory.

Alternatively, to install it manually:

go get https://github.com/monax/monax-go

Documentation

The links bellow should provide all the documentation needed to make the best use of the library and our API:

Usage Example

A brief example of how to use the library is outlined below. See our documentation site for additional information.

package main

import (
	"os"

  "github.com/go-openapi/strfmt"
	"github.com/go-openapi/spec"
	httptransport "github.com/go-openapi/runtime/client"

	monax "github.com/monax/monax-go/client"
)

func main() {

  // create the transport
  transport := httptransport.New(os.Getenv("MONAX_HOST"), "", nil)

  // create the API client, with the transport
  client := monax.New(transport, strfmt.Default)

  // to override the host for the default client
  // monax.Default.SetTransport(transport)

  // make the request to get all items
  resp, err := client.Operations.All()
  if err != nil {
    log.Fatal(err)
  }
  fmt.Printf("%#v\n", resp.Payload)
}

License

The library is released under the Apache v2.0 License.

Documentation

Overview

Package monax provides primitives to interact the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewAcceptConnectionRequestRequest

func NewAcceptConnectionRequestRequest(server string, id int) (*http.Request, error)

NewAcceptConnectionRequestRequest generates requests for AcceptConnectionRequest

func NewActivateTemplatePackageRequest

func NewActivateTemplatePackageRequest(server string, id int32) (*http.Request, error)

NewActivateTemplatePackageRequest generates requests for ActivateTemplatePackage

func NewActivateTemplateRequest

func NewActivateTemplateRequest(server string, address string) (*http.Request, error)

NewActivateTemplateRequest generates requests for ActivateTemplate

func NewAddApproversToOrganizationRequest

func NewAddApproversToOrganizationRequest(server string, address string, body AddApproversToOrganizationJSONRequestBody) (*http.Request, error)

NewAddApproversToOrganizationRequest calls the generic AddApproversToOrganization builder with application/json body

func NewAddApproversToOrganizationRequestWithBody

func NewAddApproversToOrganizationRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewAddApproversToOrganizationRequestWithBody generates requests for AddApproversToOrganization with any type of body

func NewAddDepartmentToOrganizationRequest

func NewAddDepartmentToOrganizationRequest(server string, address string, body AddDepartmentToOrganizationJSONRequestBody) (*http.Request, error)

NewAddDepartmentToOrganizationRequest calls the generic AddDepartmentToOrganization builder with application/json body

func NewAddDepartmentToOrganizationRequestWithBody

func NewAddDepartmentToOrganizationRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewAddDepartmentToOrganizationRequestWithBody generates requests for AddDepartmentToOrganization with any type of body

func NewAddTemplateToPackageRequest

func NewAddTemplateToPackageRequest(server string, id int32, address string) (*http.Request, error)

NewAddTemplateToPackageRequest generates requests for AddTemplateToPackage

func NewAddUserToDepartmentRequest

func NewAddUserToDepartmentRequest(server string, address string, departmentId string, body AddUserToDepartmentJSONRequestBody) (*http.Request, error)

NewAddUserToDepartmentRequest calls the generic AddUserToDepartment builder with application/json body

func NewAddUserToDepartmentRequestWithBody

func NewAddUserToDepartmentRequestWithBody(server string, address string, departmentId string, contentType string, body io.Reader) (*http.Request, error)

NewAddUserToDepartmentRequestWithBody generates requests for AddUserToDepartment with any type of body

func NewAddUserToOrganizationRequest

func NewAddUserToOrganizationRequest(server string, address string, body AddUserToOrganizationJSONRequestBody) (*http.Request, error)

NewAddUserToOrganizationRequest calls the generic AddUserToOrganization builder with application/json body

func NewAddUserToOrganizationRequestWithBody

func NewAddUserToOrganizationRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewAddUserToOrganizationRequestWithBody generates requests for AddUserToOrganization with any type of body

func NewAssembleDocumentRequest

func NewAssembleDocumentRequest(server string, params *AssembleDocumentParams) (*http.Request, error)

NewAssembleDocumentRequest generates requests for AssembleDocument

func NewAssembleDocumentsForAgreementExternalRequest

func NewAssembleDocumentsForAgreementExternalRequest(server string, address string) (*http.Request, error)

NewAssembleDocumentsForAgreementExternalRequest generates requests for AssembleDocumentsForAgreementExternal

func NewAssembleDocumentsForAgreementRequest

func NewAssembleDocumentsForAgreementRequest(server string, address string) (*http.Request, error)

NewAssembleDocumentsForAgreementRequest generates requests for AssembleDocumentsForAgreement

func NewAssembleDocumentsForTemplateRequest

func NewAssembleDocumentsForTemplateRequest(server string, address string, params *AssembleDocumentsForTemplateParams) (*http.Request, error)

NewAssembleDocumentsForTemplateRequest generates requests for AssembleDocumentsForTemplate

func NewCompleteSigningTaskExternalRequestWithBody added in v1.5.21

func NewCompleteSigningTaskExternalRequestWithBody(server string, id string, agreementAddress string, contentType string, body io.Reader) (*http.Request, error)

NewCompleteSigningTaskExternalRequestWithBody generates requests for CompleteSigningTaskExternal with any type of body

func NewCompleteSigningTaskRequestWithBody added in v1.5.8

func NewCompleteSigningTaskRequestWithBody(server string, id string, agreementAddress string, contentType string, body io.Reader) (*http.Request, error)

NewCompleteSigningTaskRequestWithBody generates requests for CompleteSigningTask with any type of body

func NewCompleteTaskExternalRequest

func NewCompleteTaskExternalRequest(server string, id string) (*http.Request, error)

NewCompleteTaskExternalRequest generates requests for CompleteTaskExternal

func NewCompleteTaskRequest

func NewCompleteTaskRequest(server string, id string) (*http.Request, error)

NewCompleteTaskRequest generates requests for CompleteTask

func NewCreateAgreementAttachmentExternalRequest

func NewCreateAgreementAttachmentExternalRequest(server string, address string, body CreateAgreementAttachmentExternalJSONRequestBody) (*http.Request, error)

NewCreateAgreementAttachmentExternalRequest calls the generic CreateAgreementAttachmentExternal builder with application/json body

func NewCreateAgreementAttachmentExternalRequestWithBody

func NewCreateAgreementAttachmentExternalRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewCreateAgreementAttachmentExternalRequestWithBody generates requests for CreateAgreementAttachmentExternal with any type of body

func NewCreateAgreementQuicklyRequest

func NewCreateAgreementQuicklyRequest(server string, body CreateAgreementQuicklyJSONRequestBody) (*http.Request, error)

NewCreateAgreementQuicklyRequest calls the generic CreateAgreementQuickly builder with application/json body

func NewCreateAgreementQuicklyRequestWithBody

func NewCreateAgreementQuicklyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateAgreementQuicklyRequestWithBody generates requests for CreateAgreementQuickly with any type of body

func NewCreateAgreementRequest

func NewCreateAgreementRequest(server string, body CreateAgreementJSONRequestBody) (*http.Request, error)

NewCreateAgreementRequest calls the generic CreateAgreement builder with application/json body

func NewCreateAgreementRequestWithBody

func NewCreateAgreementRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateAgreementRequestWithBody generates requests for CreateAgreement with any type of body

func NewCreateAgreementTagRequest

func NewCreateAgreementTagRequest(server string, body CreateAgreementTagJSONRequestBody) (*http.Request, error)

NewCreateAgreementTagRequest calls the generic CreateAgreementTag builder with application/json body

func NewCreateAgreementTagRequestWithBody

func NewCreateAgreementTagRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateAgreementTagRequestWithBody generates requests for CreateAgreementTag with any type of body

func NewCreateCollectionRequest

func NewCreateCollectionRequest(server string, body CreateCollectionJSONRequestBody) (*http.Request, error)

NewCreateCollectionRequest calls the generic CreateCollection builder with application/json body

func NewCreateCollectionRequestWithBody

func NewCreateCollectionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateCollectionRequestWithBody generates requests for CreateCollection with any type of body

func NewCreateConnectionRequestRequest

func NewCreateConnectionRequestRequest(server string, body CreateConnectionRequestJSONRequestBody) (*http.Request, error)

NewCreateConnectionRequestRequest calls the generic CreateConnectionRequest builder with application/json body

func NewCreateConnectionRequestRequestWithBody

func NewCreateConnectionRequestRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateConnectionRequestRequestWithBody generates requests for CreateConnectionRequest with any type of body

func NewCreateDocumentRequest

func NewCreateDocumentRequest(server string, params *CreateDocumentParams) (*http.Request, error)

NewCreateDocumentRequest generates requests for CreateDocument

func NewCreateModelRequestWithBody

func NewCreateModelRequestWithBody(server string, params *CreateModelParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateModelRequestWithBody generates requests for CreateModel with any type of body

func NewCreateOrganizationRequest

func NewCreateOrganizationRequest(server string, body CreateOrganizationJSONRequestBody) (*http.Request, error)

NewCreateOrganizationRequest calls the generic CreateOrganization builder with application/json body

func NewCreateOrganizationRequestWithBody

func NewCreateOrganizationRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateOrganizationRequestWithBody generates requests for CreateOrganization with any type of body

func NewCreateTOSForUserRequest

func NewCreateTOSForUserRequest(server string) (*http.Request, error)

NewCreateTOSForUserRequest generates requests for CreateTOSForUser

func NewCreateTemplateDraftRequest

func NewCreateTemplateDraftRequest(server string, body CreateTemplateDraftJSONRequestBody) (*http.Request, error)

NewCreateTemplateDraftRequest calls the generic CreateTemplateDraft builder with application/json body

func NewCreateTemplateDraftRequestWithBody

func NewCreateTemplateDraftRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateTemplateDraftRequestWithBody generates requests for CreateTemplateDraft with any type of body

func NewCreateTemplatePackageRequest

func NewCreateTemplatePackageRequest(server string, body CreateTemplatePackageJSONRequestBody) (*http.Request, error)

NewCreateTemplatePackageRequest calls the generic CreateTemplatePackage builder with application/json body

func NewCreateTemplatePackageRequestWithBody

func NewCreateTemplatePackageRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateTemplatePackageRequestWithBody generates requests for CreateTemplatePackage with any type of body

func NewCreateTemplateRequest

func NewCreateTemplateRequest(server string, body CreateTemplateJSONRequestBody) (*http.Request, error)

NewCreateTemplateRequest calls the generic CreateTemplate builder with application/json body

func NewCreateTemplateRequestWithBody

func NewCreateTemplateRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateTemplateRequestWithBody generates requests for CreateTemplate with any type of body

func NewCreateUserWithinAccountRequest

func NewCreateUserWithinAccountRequest(server string, code string, body CreateUserWithinAccountJSONRequestBody) (*http.Request, error)

NewCreateUserWithinAccountRequest calls the generic CreateUserWithinAccount builder with application/json body

func NewCreateUserWithinAccountRequestWithBody

func NewCreateUserWithinAccountRequestWithBody(server string, code string, contentType string, body io.Reader) (*http.Request, error)

NewCreateUserWithinAccountRequestWithBody generates requests for CreateUserWithinAccount with any type of body

func NewDeactivateTemplatePackageRequest

func NewDeactivateTemplatePackageRequest(server string, id int32) (*http.Request, error)

NewDeactivateTemplatePackageRequest generates requests for DeactivateTemplatePackage

func NewDeactivateTemplateRequest

func NewDeactivateTemplateRequest(server string, address string) (*http.Request, error)

NewDeactivateTemplateRequest generates requests for DeactivateTemplate

func NewDeleteAgreementRequest added in v1.5.8

func NewDeleteAgreementRequest(server string, address string) (*http.Request, error)

NewDeleteAgreementRequest generates requests for DeleteAgreement

func NewDeleteInvitationRequest

func NewDeleteInvitationRequest(server string, code string) (*http.Request, error)

NewDeleteInvitationRequest generates requests for DeleteInvitation

func NewDeleteTagRequest

func NewDeleteTagRequest(server string, id int) (*http.Request, error)

NewDeleteTagRequest generates requests for DeleteTag

func NewDeleteTemplateDraftLockRequest

func NewDeleteTemplateDraftLockRequest(server string, id int32) (*http.Request, error)

NewDeleteTemplateDraftLockRequest generates requests for DeleteTemplateDraftLock

func NewDeleteTemplateDraftRequest

func NewDeleteTemplateDraftRequest(server string, id int32) (*http.Request, error)

NewDeleteTemplateDraftRequest generates requests for DeleteTemplateDraft

func NewDeleteUserFromAccountRequest

func NewDeleteUserFromAccountRequest(server string, address string) (*http.Request, error)

NewDeleteUserFromAccountRequest generates requests for DeleteUserFromAccount

func NewExportAgreementExternalRequest

func NewExportAgreementExternalRequest(server string, address string) (*http.Request, error)

NewExportAgreementExternalRequest generates requests for ExportAgreementExternal

func NewExportAgreementRequest

func NewExportAgreementRequest(server string, address string) (*http.Request, error)

NewExportAgreementRequest generates requests for ExportAgreement

func NewGetAccountInfoRequest

func NewGetAccountInfoRequest(server string) (*http.Request, error)

NewGetAccountInfoRequest generates requests for GetAccountInfo

func NewGetAgreementAttachmentsExternalRequest

func NewGetAgreementAttachmentsExternalRequest(server string, address string) (*http.Request, error)

NewGetAgreementAttachmentsExternalRequest generates requests for GetAgreementAttachmentsExternal

func NewGetAgreementAttachmentsRequest

func NewGetAgreementAttachmentsRequest(server string, address string) (*http.Request, error)

NewGetAgreementAttachmentsRequest generates requests for GetAgreementAttachments

func NewGetAgreementExternalRequest

func NewGetAgreementExternalRequest(server string, params *GetAgreementExternalParams) (*http.Request, error)

NewGetAgreementExternalRequest generates requests for GetAgreementExternal

func NewGetAgreementRequest

func NewGetAgreementRequest(server string, address string, params *GetAgreementParams) (*http.Request, error)

NewGetAgreementRequest generates requests for GetAgreement

func NewGetCollectionRequest

func NewGetCollectionRequest(server string, id string) (*http.Request, error)

NewGetCollectionRequest generates requests for GetCollection

func NewGetCollectionsRequest

func NewGetCollectionsRequest(server string) (*http.Request, error)

NewGetCollectionsRequest generates requests for GetCollections

func NewGetConnectionsRequest

func NewGetConnectionsRequest(server string) (*http.Request, error)

NewGetConnectionsRequest generates requests for GetConnections

func NewGetCountryRequest

func NewGetCountryRequest(server string, alpha2 string) (*http.Request, error)

NewGetCountryRequest generates requests for GetCountry

func NewGetCurrencyRequest

func NewGetCurrencyRequest(server string, alpha3 string) (*http.Request, error)

NewGetCurrencyRequest generates requests for GetCurrency

func NewGetDocumentRequest

func NewGetDocumentRequest(server string, params *GetDocumentParams) (*http.Request, error)

NewGetDocumentRequest generates requests for GetDocument

func NewGetDraftsRequest added in v1.5.18

func NewGetDraftsRequest(server string) (*http.Request, error)

NewGetDraftsRequest generates requests for GetDrafts

func NewGetModelApplicationsRequest

func NewGetModelApplicationsRequest(server string) (*http.Request, error)

NewGetModelApplicationsRequest generates requests for GetModelApplications

func NewGetModelDiagramRequest

func NewGetModelDiagramRequest(server string, address string) (*http.Request, error)

NewGetModelDiagramRequest generates requests for GetModelDiagram

func NewGetModelsRequest

func NewGetModelsRequest(server string) (*http.Request, error)

NewGetModelsRequest generates requests for GetModels

func NewGetOrganizationRequest

func NewGetOrganizationRequest(server string, address string) (*http.Request, error)

NewGetOrganizationRequest generates requests for GetOrganization

func NewGetParameterTypeRequest

func NewGetParameterTypeRequest(server string, id int) (*http.Request, error)

NewGetParameterTypeRequest generates requests for GetParameterType

func NewGetProcessDefinitionRequest

func NewGetProcessDefinitionRequest(server string, address string) (*http.Request, error)

NewGetProcessDefinitionRequest generates requests for GetProcessDefinition

func NewGetProcessDefinitionsRequest

func NewGetProcessDefinitionsRequest(server string, params *GetProcessDefinitionsParams) (*http.Request, error)

NewGetProcessDefinitionsRequest generates requests for GetProcessDefinitions

func NewGetRegionsRequest

func NewGetRegionsRequest(server string, alpha2 string) (*http.Request, error)

NewGetRegionsRequest generates requests for GetRegions

func NewGetTaskDataMappingRequest

func NewGetTaskDataMappingRequest(server string, id string, dataMappingId int) (*http.Request, error)

NewGetTaskDataMappingRequest generates requests for GetTaskDataMapping

func NewGetTaskDataMappingsRequest

func NewGetTaskDataMappingsRequest(server string, id string) (*http.Request, error)

NewGetTaskDataMappingsRequest generates requests for GetTaskDataMappings

func NewGetTaskRequest

func NewGetTaskRequest(server string, id string) (*http.Request, error)

NewGetTaskRequest generates requests for GetTask

func NewGetTasksRequest

func NewGetTasksRequest(server string, params *GetTasksParams) (*http.Request, error)

NewGetTasksRequest generates requests for GetTasks

func NewGetTemplateDraftRequest

func NewGetTemplateDraftRequest(server string, id int32) (*http.Request, error)

NewGetTemplateDraftRequest generates requests for GetTemplateDraft

func NewGetTemplateDraftsRequest

func NewGetTemplateDraftsRequest(server string) (*http.Request, error)

NewGetTemplateDraftsRequest generates requests for GetTemplateDrafts

func NewGetTemplatePackageRequest

func NewGetTemplatePackageRequest(server string, id int32) (*http.Request, error)

NewGetTemplatePackageRequest generates requests for GetTemplatePackage

func NewGetTemplatePackagesRequest

func NewGetTemplatePackagesRequest(server string) (*http.Request, error)

NewGetTemplatePackagesRequest generates requests for GetTemplatePackages

func NewGetTemplateRequest

func NewGetTemplateRequest(server string, address string, params *GetTemplateParams) (*http.Request, error)

NewGetTemplateRequest generates requests for GetTemplate

func NewGetTemplateRestrictionsRequest

func NewGetTemplateRestrictionsRequest(server string, address string, organizationAddress string) (*http.Request, error)

NewGetTemplateRestrictionsRequest generates requests for GetTemplateRestrictions

func NewGetTemplatesRequest

func NewGetTemplatesRequest(server string) (*http.Request, error)

NewGetTemplatesRequest generates requests for GetTemplates

func NewGetUserProfileRequest

func NewGetUserProfileRequest(server string) (*http.Request, error)

NewGetUserProfileRequest generates requests for GetUserProfile

func NewInviteNewUserRequest

func NewInviteNewUserRequest(server string, body InviteNewUserJSONRequestBody) (*http.Request, error)

NewInviteNewUserRequest calls the generic InviteNewUser builder with application/json body

func NewInviteNewUserRequestWithBody

func NewInviteNewUserRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewInviteNewUserRequestWithBody generates requests for InviteNewUser with any type of body

func NewListAgreementTagsRequest

func NewListAgreementTagsRequest(server string, params *ListAgreementTagsParams) (*http.Request, error)

NewListAgreementTagsRequest generates requests for ListAgreementTags

func NewListAgreementsByCollaboratorRequest

func NewListAgreementsByCollaboratorRequest(server string, params *ListAgreementsByCollaboratorParams) (*http.Request, error)

NewListAgreementsByCollaboratorRequest generates requests for ListAgreementsByCollaborator

func NewListAgreementsByStateRequest

func NewListAgreementsByStateRequest(server string) (*http.Request, error)

NewListAgreementsByStateRequest generates requests for ListAgreementsByState

func NewListAgreementsRequest added in v1.4.4

func NewListAgreementsRequest(server string) (*http.Request, error)

NewListAgreementsRequest generates requests for ListAgreements

func NewListCollectionTypesRequest

func NewListCollectionTypesRequest(server string) (*http.Request, error)

NewListCollectionTypesRequest generates requests for ListCollectionTypes

func NewListCountriesRequest

func NewListCountriesRequest(server string) (*http.Request, error)

NewListCountriesRequest generates requests for ListCountries

func NewListCurrenciesRequest

func NewListCurrenciesRequest(server string) (*http.Request, error)

NewListCurrenciesRequest generates requests for ListCurrencies

func NewListInvitationsRequest

func NewListInvitationsRequest(server string) (*http.Request, error)

NewListInvitationsRequest generates requests for ListInvitations

func NewListKnownUsersRequest

func NewListKnownUsersRequest(server string) (*http.Request, error)

NewListKnownUsersRequest generates requests for ListKnownUsers

func NewListMyTasksRequest

func NewListMyTasksRequest(server string) (*http.Request, error)

NewListMyTasksRequest generates requests for ListMyTasks

func NewListOrganizationalAssetsRequest

func NewListOrganizationalAssetsRequest(server string, address string) (*http.Request, error)

NewListOrganizationalAssetsRequest generates requests for ListOrganizationalAssets

func NewListOrganizationsRequest

func NewListOrganizationsRequest(server string, params *ListOrganizationsParams) (*http.Request, error)

NewListOrganizationsRequest generates requests for ListOrganizations

func NewListParameterTypesRequest

func NewListParameterTypesRequest(server string) (*http.Request, error)

NewListParameterTypesRequest generates requests for ListParameterTypes

func NewListTopTemplatesRequest

func NewListTopTemplatesRequest(server string, params *ListTopTemplatesParams) (*http.Request, error)

NewListTopTemplatesRequest generates requests for ListTopTemplates

func NewLogoutRequest

func NewLogoutRequest(server string) (*http.Request, error)

NewLogoutRequest generates requests for Logout

func NewRegisterUserRequest

func NewRegisterUserRequest(server string, body RegisterUserJSONRequestBody) (*http.Request, error)

NewRegisterUserRequest calls the generic RegisterUser builder with application/json body

func NewRegisterUserRequestWithBody

func NewRegisterUserRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewRegisterUserRequestWithBody generates requests for RegisterUser with any type of body

func NewRemoveApproversFromOrganizationRequest

func NewRemoveApproversFromOrganizationRequest(server string, address string, userAddress string) (*http.Request, error)

NewRemoveApproversFromOrganizationRequest generates requests for RemoveApproversFromOrganization

func NewRemoveConnectionRequest

func NewRemoveConnectionRequest(server string, id int) (*http.Request, error)

NewRemoveConnectionRequest generates requests for RemoveConnection

func NewRemoveDepartmentFromOrganizationRequest

func NewRemoveDepartmentFromOrganizationRequest(server string, address string, departmentId string) (*http.Request, error)

NewRemoveDepartmentFromOrganizationRequest generates requests for RemoveDepartmentFromOrganization

func NewRemoveUserFromDepartmentRequest

func NewRemoveUserFromDepartmentRequest(server string, address string, departmentId string, userAddress string) (*http.Request, error)

NewRemoveUserFromDepartmentRequest generates requests for RemoveUserFromDepartment

func NewRemoveUserFromOrganizationRequest

func NewRemoveUserFromOrganizationRequest(server string, address string, userAddress string) (*http.Request, error)

NewRemoveUserFromOrganizationRequest generates requests for RemoveUserFromOrganization

func NewRequestPasswordResetRequest

func NewRequestPasswordResetRequest(server string) (*http.Request, error)

NewRequestPasswordResetRequest generates requests for RequestPasswordReset

func NewResendTaskEmailRequest

func NewResendTaskEmailRequest(server string, id string) (*http.Request, error)

NewResendTaskEmailRequest generates requests for ResendTaskEmail

func NewSupersedeTemplateRequest

func NewSupersedeTemplateRequest(server string, address string, successor string) (*http.Request, error)

NewSupersedeTemplateRequest generates requests for SupersedeTemplate

func NewUpdateAgreementRequest

func NewUpdateAgreementRequest(server string, address string, body UpdateAgreementJSONRequestBody) (*http.Request, error)

NewUpdateAgreementRequest calls the generic UpdateAgreement builder with application/json body

func NewUpdateAgreementRequestWithBody

func NewUpdateAgreementRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAgreementRequestWithBody generates requests for UpdateAgreement with any type of body

func NewUpdateAgreementWithAttachmentRequest

func NewUpdateAgreementWithAttachmentRequest(server string, address string, body UpdateAgreementWithAttachmentJSONRequestBody) (*http.Request, error)

NewUpdateAgreementWithAttachmentRequest calls the generic UpdateAgreementWithAttachment builder with application/json body

func NewUpdateAgreementWithAttachmentRequestWithBody

func NewUpdateAgreementWithAttachmentRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAgreementWithAttachmentRequestWithBody generates requests for UpdateAgreementWithAttachment with any type of body

func NewUpdateAgreementWithCancellationExternalRequest

func NewUpdateAgreementWithCancellationExternalRequest(server string, address string) (*http.Request, error)

NewUpdateAgreementWithCancellationExternalRequest generates requests for UpdateAgreementWithCancellationExternal

func NewUpdateAgreementWithCancellationRequest

func NewUpdateAgreementWithCancellationRequest(server string, address string) (*http.Request, error)

NewUpdateAgreementWithCancellationRequest generates requests for UpdateAgreementWithCancellation

func NewUpdateAgreementWithSignatureRequestWithBody

func NewUpdateAgreementWithSignatureRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAgreementWithSignatureRequestWithBody generates requests for UpdateAgreementWithSignature with any type of body

func NewUpdateCollectionRequest

func NewUpdateCollectionRequest(server string, body UpdateCollectionJSONRequestBody) (*http.Request, error)

NewUpdateCollectionRequest calls the generic UpdateCollection builder with application/json body

func NewUpdateCollectionRequestWithBody

func NewUpdateCollectionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateCollectionRequestWithBody generates requests for UpdateCollection with any type of body

func NewUpdateDepartmentNameRequest added in v1.5.0

func NewUpdateDepartmentNameRequest(server string, address string, departmentId string, body UpdateDepartmentNameJSONRequestBody) (*http.Request, error)

NewUpdateDepartmentNameRequest calls the generic UpdateDepartmentName builder with application/json body

func NewUpdateDepartmentNameRequestWithBody added in v1.5.0

func NewUpdateDepartmentNameRequestWithBody(server string, address string, departmentId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDepartmentNameRequestWithBody generates requests for UpdateDepartmentName with any type of body

func NewUpdateOrganizationRequest

func NewUpdateOrganizationRequest(server string, address string, body UpdateOrganizationJSONRequestBody) (*http.Request, error)

NewUpdateOrganizationRequest calls the generic UpdateOrganization builder with application/json body

func NewUpdateOrganizationRequestWithBody

func NewUpdateOrganizationRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateOrganizationRequestWithBody generates requests for UpdateOrganization with any type of body

func NewUpdateTagRequest

func NewUpdateTagRequest(server string, id int, body UpdateTagJSONRequestBody) (*http.Request, error)

NewUpdateTagRequest calls the generic UpdateTag builder with application/json body

func NewUpdateTagRequestWithBody

func NewUpdateTagRequestWithBody(server string, id int, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTagRequestWithBody generates requests for UpdateTag with any type of body

func NewUpdateTaskDataMappingRequest

func NewUpdateTaskDataMappingRequest(server string, id string, dataMappingId int, body UpdateTaskDataMappingJSONRequestBody) (*http.Request, error)

NewUpdateTaskDataMappingRequest calls the generic UpdateTaskDataMapping builder with application/json body

func NewUpdateTaskDataMappingRequestWithBody

func NewUpdateTaskDataMappingRequestWithBody(server string, id string, dataMappingId int, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTaskDataMappingRequestWithBody generates requests for UpdateTaskDataMapping with any type of body

func NewUpdateTaskDataMappingsRequest

func NewUpdateTaskDataMappingsRequest(server string, id string, body UpdateTaskDataMappingsJSONRequestBody) (*http.Request, error)

NewUpdateTaskDataMappingsRequest calls the generic UpdateTaskDataMappings builder with application/json body

func NewUpdateTaskDataMappingsRequestWithBody

func NewUpdateTaskDataMappingsRequestWithBody(server string, id string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTaskDataMappingsRequestWithBody generates requests for UpdateTaskDataMappings with any type of body

func NewUpdateTemplateDraftRequest

func NewUpdateTemplateDraftRequest(server string, id int32, body UpdateTemplateDraftJSONRequestBody) (*http.Request, error)

NewUpdateTemplateDraftRequest calls the generic UpdateTemplateDraft builder with application/json body

func NewUpdateTemplateDraftRequestWithBody

func NewUpdateTemplateDraftRequestWithBody(server string, id int32, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTemplateDraftRequestWithBody generates requests for UpdateTemplateDraft with any type of body

func NewUpdateTemplatePriceRequest

func NewUpdateTemplatePriceRequest(server string, address string, body UpdateTemplatePriceJSONRequestBody) (*http.Request, error)

NewUpdateTemplatePriceRequest calls the generic UpdateTemplatePrice builder with application/json body

func NewUpdateTemplatePriceRequestWithBody

func NewUpdateTemplatePriceRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTemplatePriceRequestWithBody generates requests for UpdateTemplatePrice with any type of body

func NewUpdateTemplateRequest

func NewUpdateTemplateRequest(server string, address string, body UpdateTemplateJSONRequestBody) (*http.Request, error)

NewUpdateTemplateRequest calls the generic UpdateTemplate builder with application/json body

func NewUpdateTemplateRequestWithBody

func NewUpdateTemplateRequestWithBody(server string, address string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTemplateRequestWithBody generates requests for UpdateTemplate with any type of body

func NewUpdateTemplateRestrictionsRequest

func NewUpdateTemplateRestrictionsRequest(server string, address string, organizationAddress string, body UpdateTemplateRestrictionsJSONRequestBody) (*http.Request, error)

NewUpdateTemplateRestrictionsRequest calls the generic UpdateTemplateRestrictions builder with application/json body

func NewUpdateTemplateRestrictionsRequestWithBody

func NewUpdateTemplateRestrictionsRequestWithBody(server string, address string, organizationAddress string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTemplateRestrictionsRequestWithBody generates requests for UpdateTemplateRestrictions with any type of body

func NewUpdateUserProfileRequest

func NewUpdateUserProfileRequest(server string, body UpdateUserProfileJSONRequestBody) (*http.Request, error)

NewUpdateUserProfileRequest calls the generic UpdateUserProfile builder with application/json body

func NewUpdateUserProfileRequestWithBody

func NewUpdateUserProfileRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateUserProfileRequestWithBody generates requests for UpdateUserProfile with any type of body

func ParseAcceptConnectionRequestResponse added in v1.5.21

func ParseAcceptConnectionRequestResponse(rsp *http.Response) (*acceptConnectionRequestResponse, error)

ParseAcceptConnectionRequestResponse parses an HTTP response from a AcceptConnectionRequestWithResponse call

func ParseActivateTemplatePackageResponse added in v1.5.21

func ParseActivateTemplatePackageResponse(rsp *http.Response) (*activateTemplatePackageResponse, error)

ParseActivateTemplatePackageResponse parses an HTTP response from a ActivateTemplatePackageWithResponse call

func ParseActivateTemplateResponse added in v1.5.21

func ParseActivateTemplateResponse(rsp *http.Response) (*activateTemplateResponse, error)

ParseActivateTemplateResponse parses an HTTP response from a ActivateTemplateWithResponse call

func ParseAddApproversToOrganizationResponse added in v1.5.21

func ParseAddApproversToOrganizationResponse(rsp *http.Response) (*addApproversToOrganizationResponse, error)

ParseAddApproversToOrganizationResponse parses an HTTP response from a AddApproversToOrganizationWithResponse call

func ParseAddDepartmentToOrganizationResponse added in v1.5.21

func ParseAddDepartmentToOrganizationResponse(rsp *http.Response) (*addDepartmentToOrganizationResponse, error)

ParseAddDepartmentToOrganizationResponse parses an HTTP response from a AddDepartmentToOrganizationWithResponse call

func ParseAddTemplateToPackageResponse added in v1.5.21

func ParseAddTemplateToPackageResponse(rsp *http.Response) (*addTemplateToPackageResponse, error)

ParseAddTemplateToPackageResponse parses an HTTP response from a AddTemplateToPackageWithResponse call

func ParseAddUserToDepartmentResponse added in v1.5.21

func ParseAddUserToDepartmentResponse(rsp *http.Response) (*addUserToDepartmentResponse, error)

ParseAddUserToDepartmentResponse parses an HTTP response from a AddUserToDepartmentWithResponse call

func ParseAddUserToOrganizationResponse added in v1.5.21

func ParseAddUserToOrganizationResponse(rsp *http.Response) (*addUserToOrganizationResponse, error)

ParseAddUserToOrganizationResponse parses an HTTP response from a AddUserToOrganizationWithResponse call

func ParseAssembleDocumentResponse added in v1.5.21

func ParseAssembleDocumentResponse(rsp *http.Response) (*assembleDocumentResponse, error)

ParseAssembleDocumentResponse parses an HTTP response from a AssembleDocumentWithResponse call

func ParseAssembleDocumentsForAgreementExternalResponse added in v1.5.21

func ParseAssembleDocumentsForAgreementExternalResponse(rsp *http.Response) (*assembleDocumentsForAgreementExternalResponse, error)

ParseAssembleDocumentsForAgreementExternalResponse parses an HTTP response from a AssembleDocumentsForAgreementExternalWithResponse call

func ParseAssembleDocumentsForAgreementResponse added in v1.5.21

func ParseAssembleDocumentsForAgreementResponse(rsp *http.Response) (*assembleDocumentsForAgreementResponse, error)

ParseAssembleDocumentsForAgreementResponse parses an HTTP response from a AssembleDocumentsForAgreementWithResponse call

func ParseAssembleDocumentsForTemplateResponse added in v1.5.21

func ParseAssembleDocumentsForTemplateResponse(rsp *http.Response) (*assembleDocumentsForTemplateResponse, error)

ParseAssembleDocumentsForTemplateResponse parses an HTTP response from a AssembleDocumentsForTemplateWithResponse call

func ParseCompleteSigningTaskExternalResponse added in v1.5.21

func ParseCompleteSigningTaskExternalResponse(rsp *http.Response) (*completeSigningTaskExternalResponse, error)

ParseCompleteSigningTaskExternalResponse parses an HTTP response from a CompleteSigningTaskExternalWithResponse call

func ParseCompleteSigningTaskResponse added in v1.5.21

func ParseCompleteSigningTaskResponse(rsp *http.Response) (*completeSigningTaskResponse, error)

ParseCompleteSigningTaskResponse parses an HTTP response from a CompleteSigningTaskWithResponse call

func ParseCompleteTaskExternalResponse added in v1.5.21

func ParseCompleteTaskExternalResponse(rsp *http.Response) (*completeTaskExternalResponse, error)

ParseCompleteTaskExternalResponse parses an HTTP response from a CompleteTaskExternalWithResponse call

func ParseCompleteTaskResponse added in v1.5.21

func ParseCompleteTaskResponse(rsp *http.Response) (*completeTaskResponse, error)

ParseCompleteTaskResponse parses an HTTP response from a CompleteTaskWithResponse call

func ParseCreateAgreementAttachmentExternalResponse added in v1.5.21

func ParseCreateAgreementAttachmentExternalResponse(rsp *http.Response) (*createAgreementAttachmentExternalResponse, error)

ParseCreateAgreementAttachmentExternalResponse parses an HTTP response from a CreateAgreementAttachmentExternalWithResponse call

func ParseCreateAgreementQuicklyResponse added in v1.5.21

func ParseCreateAgreementQuicklyResponse(rsp *http.Response) (*createAgreementQuicklyResponse, error)

ParseCreateAgreementQuicklyResponse parses an HTTP response from a CreateAgreementQuicklyWithResponse call

func ParseCreateAgreementResponse added in v1.5.21

func ParseCreateAgreementResponse(rsp *http.Response) (*createAgreementResponse, error)

ParseCreateAgreementResponse parses an HTTP response from a CreateAgreementWithResponse call

func ParseCreateAgreementTagResponse added in v1.5.21

func ParseCreateAgreementTagResponse(rsp *http.Response) (*createAgreementTagResponse, error)

ParseCreateAgreementTagResponse parses an HTTP response from a CreateAgreementTagWithResponse call

func ParseCreateCollectionResponse added in v1.5.21

func ParseCreateCollectionResponse(rsp *http.Response) (*createCollectionResponse, error)

ParseCreateCollectionResponse parses an HTTP response from a CreateCollectionWithResponse call

func ParseCreateConnectionRequestResponse added in v1.5.21

func ParseCreateConnectionRequestResponse(rsp *http.Response) (*createConnectionRequestResponse, error)

ParseCreateConnectionRequestResponse parses an HTTP response from a CreateConnectionRequestWithResponse call

func ParseCreateDocumentResponse added in v1.5.21

func ParseCreateDocumentResponse(rsp *http.Response) (*createDocumentResponse, error)

ParseCreateDocumentResponse parses an HTTP response from a CreateDocumentWithResponse call

func ParseCreateModelResponse added in v1.5.21

func ParseCreateModelResponse(rsp *http.Response) (*createModelResponse, error)

ParseCreateModelResponse parses an HTTP response from a CreateModelWithResponse call

func ParseCreateOrganizationResponse added in v1.5.21

func ParseCreateOrganizationResponse(rsp *http.Response) (*createOrganizationResponse, error)

ParseCreateOrganizationResponse parses an HTTP response from a CreateOrganizationWithResponse call

func ParseCreateTOSForUserResponse added in v1.5.21

func ParseCreateTOSForUserResponse(rsp *http.Response) (*createTOSForUserResponse, error)

ParseCreateTOSForUserResponse parses an HTTP response from a CreateTOSForUserWithResponse call

func ParseCreateTemplateDraftResponse added in v1.5.21

func ParseCreateTemplateDraftResponse(rsp *http.Response) (*createTemplateDraftResponse, error)

ParseCreateTemplateDraftResponse parses an HTTP response from a CreateTemplateDraftWithResponse call

func ParseCreateTemplatePackageResponse added in v1.5.21

func ParseCreateTemplatePackageResponse(rsp *http.Response) (*createTemplatePackageResponse, error)

ParseCreateTemplatePackageResponse parses an HTTP response from a CreateTemplatePackageWithResponse call

func ParseCreateTemplateResponse added in v1.5.21

func ParseCreateTemplateResponse(rsp *http.Response) (*createTemplateResponse, error)

ParseCreateTemplateResponse parses an HTTP response from a CreateTemplateWithResponse call

func ParseCreateUserWithinAccountResponse added in v1.5.21

func ParseCreateUserWithinAccountResponse(rsp *http.Response) (*createUserWithinAccountResponse, error)

ParseCreateUserWithinAccountResponse parses an HTTP response from a CreateUserWithinAccountWithResponse call

func ParseDeactivateTemplatePackageResponse added in v1.5.21

func ParseDeactivateTemplatePackageResponse(rsp *http.Response) (*deactivateTemplatePackageResponse, error)

ParseDeactivateTemplatePackageResponse parses an HTTP response from a DeactivateTemplatePackageWithResponse call

func ParseDeactivateTemplateResponse added in v1.5.21

func ParseDeactivateTemplateResponse(rsp *http.Response) (*deactivateTemplateResponse, error)

ParseDeactivateTemplateResponse parses an HTTP response from a DeactivateTemplateWithResponse call

func ParseDeleteAgreementResponse added in v1.5.21

func ParseDeleteAgreementResponse(rsp *http.Response) (*deleteAgreementResponse, error)

ParseDeleteAgreementResponse parses an HTTP response from a DeleteAgreementWithResponse call

func ParseDeleteInvitationResponse added in v1.5.21

func ParseDeleteInvitationResponse(rsp *http.Response) (*deleteInvitationResponse, error)

ParseDeleteInvitationResponse parses an HTTP response from a DeleteInvitationWithResponse call

func ParseDeleteTagResponse added in v1.5.21

func ParseDeleteTagResponse(rsp *http.Response) (*deleteTagResponse, error)

ParseDeleteTagResponse parses an HTTP response from a DeleteTagWithResponse call

func ParseDeleteTemplateDraftLockResponse added in v1.5.21

func ParseDeleteTemplateDraftLockResponse(rsp *http.Response) (*deleteTemplateDraftLockResponse, error)

ParseDeleteTemplateDraftLockResponse parses an HTTP response from a DeleteTemplateDraftLockWithResponse call

func ParseDeleteTemplateDraftResponse added in v1.5.21

func ParseDeleteTemplateDraftResponse(rsp *http.Response) (*deleteTemplateDraftResponse, error)

ParseDeleteTemplateDraftResponse parses an HTTP response from a DeleteTemplateDraftWithResponse call

func ParseDeleteUserFromAccountResponse added in v1.5.21

func ParseDeleteUserFromAccountResponse(rsp *http.Response) (*deleteUserFromAccountResponse, error)

ParseDeleteUserFromAccountResponse parses an HTTP response from a DeleteUserFromAccountWithResponse call

func ParseExportAgreementExternalResponse added in v1.5.21

func ParseExportAgreementExternalResponse(rsp *http.Response) (*exportAgreementExternalResponse, error)

ParseExportAgreementExternalResponse parses an HTTP response from a ExportAgreementExternalWithResponse call

func ParseExportAgreementResponse added in v1.5.21

func ParseExportAgreementResponse(rsp *http.Response) (*exportAgreementResponse, error)

ParseExportAgreementResponse parses an HTTP response from a ExportAgreementWithResponse call

func ParseGetAccountInfoResponse added in v1.5.21

func ParseGetAccountInfoResponse(rsp *http.Response) (*getAccountInfoResponse, error)

ParseGetAccountInfoResponse parses an HTTP response from a GetAccountInfoWithResponse call

func ParseGetAgreementAttachmentsExternalResponse added in v1.5.21

func ParseGetAgreementAttachmentsExternalResponse(rsp *http.Response) (*getAgreementAttachmentsExternalResponse, error)

ParseGetAgreementAttachmentsExternalResponse parses an HTTP response from a GetAgreementAttachmentsExternalWithResponse call

func ParseGetAgreementAttachmentsResponse added in v1.5.21

func ParseGetAgreementAttachmentsResponse(rsp *http.Response) (*getAgreementAttachmentsResponse, error)

ParseGetAgreementAttachmentsResponse parses an HTTP response from a GetAgreementAttachmentsWithResponse call

func ParseGetAgreementExternalResponse added in v1.5.21

func ParseGetAgreementExternalResponse(rsp *http.Response) (*getAgreementExternalResponse, error)

ParseGetAgreementExternalResponse parses an HTTP response from a GetAgreementExternalWithResponse call

func ParseGetAgreementResponse added in v1.5.21

func ParseGetAgreementResponse(rsp *http.Response) (*getAgreementResponse, error)

ParseGetAgreementResponse parses an HTTP response from a GetAgreementWithResponse call

func ParseGetCollectionResponse added in v1.5.21

func ParseGetCollectionResponse(rsp *http.Response) (*getCollectionResponse, error)

ParseGetCollectionResponse parses an HTTP response from a GetCollectionWithResponse call

func ParseGetCollectionsResponse added in v1.5.21

func ParseGetCollectionsResponse(rsp *http.Response) (*getCollectionsResponse, error)

ParseGetCollectionsResponse parses an HTTP response from a GetCollectionsWithResponse call

func ParseGetConnectionsResponse added in v1.5.21

func ParseGetConnectionsResponse(rsp *http.Response) (*getConnectionsResponse, error)

ParseGetConnectionsResponse parses an HTTP response from a GetConnectionsWithResponse call

func ParseGetCountryResponse added in v1.5.21

func ParseGetCountryResponse(rsp *http.Response) (*getCountryResponse, error)

ParseGetCountryResponse parses an HTTP response from a GetCountryWithResponse call

func ParseGetCurrencyResponse added in v1.5.21

func ParseGetCurrencyResponse(rsp *http.Response) (*getCurrencyResponse, error)

ParseGetCurrencyResponse parses an HTTP response from a GetCurrencyWithResponse call

func ParseGetDocumentResponse added in v1.5.21

func ParseGetDocumentResponse(rsp *http.Response) (*getDocumentResponse, error)

ParseGetDocumentResponse parses an HTTP response from a GetDocumentWithResponse call

func ParseGetDraftsResponse added in v1.5.21

func ParseGetDraftsResponse(rsp *http.Response) (*getDraftsResponse, error)

ParseGetDraftsResponse parses an HTTP response from a GetDraftsWithResponse call

func ParseGetModelApplicationsResponse added in v1.5.21

func ParseGetModelApplicationsResponse(rsp *http.Response) (*getModelApplicationsResponse, error)

ParseGetModelApplicationsResponse parses an HTTP response from a GetModelApplicationsWithResponse call

func ParseGetModelDiagramResponse added in v1.5.21

func ParseGetModelDiagramResponse(rsp *http.Response) (*getModelDiagramResponse, error)

ParseGetModelDiagramResponse parses an HTTP response from a GetModelDiagramWithResponse call

func ParseGetModelsResponse added in v1.5.21

func ParseGetModelsResponse(rsp *http.Response) (*getModelsResponse, error)

ParseGetModelsResponse parses an HTTP response from a GetModelsWithResponse call

func ParseGetOrganizationResponse added in v1.5.21

func ParseGetOrganizationResponse(rsp *http.Response) (*getOrganizationResponse, error)

ParseGetOrganizationResponse parses an HTTP response from a GetOrganizationWithResponse call

func ParseGetParameterTypeResponse added in v1.5.21

func ParseGetParameterTypeResponse(rsp *http.Response) (*getParameterTypeResponse, error)

ParseGetParameterTypeResponse parses an HTTP response from a GetParameterTypeWithResponse call

func ParseGetProcessDefinitionResponse added in v1.5.21

func ParseGetProcessDefinitionResponse(rsp *http.Response) (*getProcessDefinitionResponse, error)

ParseGetProcessDefinitionResponse parses an HTTP response from a GetProcessDefinitionWithResponse call

func ParseGetProcessDefinitionsResponse added in v1.5.21

func ParseGetProcessDefinitionsResponse(rsp *http.Response) (*getProcessDefinitionsResponse, error)

ParseGetProcessDefinitionsResponse parses an HTTP response from a GetProcessDefinitionsWithResponse call

func ParseGetRegionsResponse added in v1.5.21

func ParseGetRegionsResponse(rsp *http.Response) (*getRegionsResponse, error)

ParseGetRegionsResponse parses an HTTP response from a GetRegionsWithResponse call

func ParseGetTaskDataMappingResponse added in v1.5.21

func ParseGetTaskDataMappingResponse(rsp *http.Response) (*getTaskDataMappingResponse, error)

ParseGetTaskDataMappingResponse parses an HTTP response from a GetTaskDataMappingWithResponse call

func ParseGetTaskDataMappingsResponse added in v1.5.21

func ParseGetTaskDataMappingsResponse(rsp *http.Response) (*getTaskDataMappingsResponse, error)

ParseGetTaskDataMappingsResponse parses an HTTP response from a GetTaskDataMappingsWithResponse call

func ParseGetTaskResponse added in v1.5.21

func ParseGetTaskResponse(rsp *http.Response) (*getTaskResponse, error)

ParseGetTaskResponse parses an HTTP response from a GetTaskWithResponse call

func ParseGetTasksResponse added in v1.5.21

func ParseGetTasksResponse(rsp *http.Response) (*getTasksResponse, error)

ParseGetTasksResponse parses an HTTP response from a GetTasksWithResponse call

func ParseGetTemplateDraftResponse added in v1.5.21

func ParseGetTemplateDraftResponse(rsp *http.Response) (*getTemplateDraftResponse, error)

ParseGetTemplateDraftResponse parses an HTTP response from a GetTemplateDraftWithResponse call

func ParseGetTemplateDraftsResponse added in v1.5.21

func ParseGetTemplateDraftsResponse(rsp *http.Response) (*getTemplateDraftsResponse, error)

ParseGetTemplateDraftsResponse parses an HTTP response from a GetTemplateDraftsWithResponse call

func ParseGetTemplatePackageResponse added in v1.5.21

func ParseGetTemplatePackageResponse(rsp *http.Response) (*getTemplatePackageResponse, error)

ParseGetTemplatePackageResponse parses an HTTP response from a GetTemplatePackageWithResponse call

func ParseGetTemplatePackagesResponse added in v1.5.21

func ParseGetTemplatePackagesResponse(rsp *http.Response) (*getTemplatePackagesResponse, error)

ParseGetTemplatePackagesResponse parses an HTTP response from a GetTemplatePackagesWithResponse call

func ParseGetTemplateResponse added in v1.5.21

func ParseGetTemplateResponse(rsp *http.Response) (*getTemplateResponse, error)

ParseGetTemplateResponse parses an HTTP response from a GetTemplateWithResponse call

func ParseGetTemplateRestrictionsResponse added in v1.5.21

func ParseGetTemplateRestrictionsResponse(rsp *http.Response) (*getTemplateRestrictionsResponse, error)

ParseGetTemplateRestrictionsResponse parses an HTTP response from a GetTemplateRestrictionsWithResponse call

func ParseGetTemplatesResponse added in v1.5.21

func ParseGetTemplatesResponse(rsp *http.Response) (*getTemplatesResponse, error)

ParseGetTemplatesResponse parses an HTTP response from a GetTemplatesWithResponse call

func ParseGetUserProfileResponse added in v1.5.21

func ParseGetUserProfileResponse(rsp *http.Response) (*getUserProfileResponse, error)

ParseGetUserProfileResponse parses an HTTP response from a GetUserProfileWithResponse call

func ParseInviteNewUserResponse added in v1.5.21

func ParseInviteNewUserResponse(rsp *http.Response) (*inviteNewUserResponse, error)

ParseInviteNewUserResponse parses an HTTP response from a InviteNewUserWithResponse call

func ParseListAgreementTagsResponse added in v1.5.21

func ParseListAgreementTagsResponse(rsp *http.Response) (*listAgreementTagsResponse, error)

ParseListAgreementTagsResponse parses an HTTP response from a ListAgreementTagsWithResponse call

func ParseListAgreementsByCollaboratorResponse added in v1.5.21

func ParseListAgreementsByCollaboratorResponse(rsp *http.Response) (*listAgreementsByCollaboratorResponse, error)

ParseListAgreementsByCollaboratorResponse parses an HTTP response from a ListAgreementsByCollaboratorWithResponse call

func ParseListAgreementsByStateResponse added in v1.5.21

func ParseListAgreementsByStateResponse(rsp *http.Response) (*listAgreementsByStateResponse, error)

ParseListAgreementsByStateResponse parses an HTTP response from a ListAgreementsByStateWithResponse call

func ParseListAgreementsResponse added in v1.5.21

func ParseListAgreementsResponse(rsp *http.Response) (*listAgreementsResponse, error)

ParseListAgreementsResponse parses an HTTP response from a ListAgreementsWithResponse call

func ParseListCollectionTypesResponse added in v1.5.21

func ParseListCollectionTypesResponse(rsp *http.Response) (*listCollectionTypesResponse, error)

ParseListCollectionTypesResponse parses an HTTP response from a ListCollectionTypesWithResponse call

func ParseListCountriesResponse added in v1.5.21

func ParseListCountriesResponse(rsp *http.Response) (*listCountriesResponse, error)

ParseListCountriesResponse parses an HTTP response from a ListCountriesWithResponse call

func ParseListCurrenciesResponse added in v1.5.21

func ParseListCurrenciesResponse(rsp *http.Response) (*listCurrenciesResponse, error)

ParseListCurrenciesResponse parses an HTTP response from a ListCurrenciesWithResponse call

func ParseListInvitationsResponse added in v1.5.21

func ParseListInvitationsResponse(rsp *http.Response) (*listInvitationsResponse, error)

ParseListInvitationsResponse parses an HTTP response from a ListInvitationsWithResponse call

func ParseListKnownUsersResponse added in v1.5.21

func ParseListKnownUsersResponse(rsp *http.Response) (*listKnownUsersResponse, error)

ParseListKnownUsersResponse parses an HTTP response from a ListKnownUsersWithResponse call

func ParseListMyTasksResponse added in v1.5.21

func ParseListMyTasksResponse(rsp *http.Response) (*listMyTasksResponse, error)

ParseListMyTasksResponse parses an HTTP response from a ListMyTasksWithResponse call

func ParseListOrganizationalAssetsResponse added in v1.5.21

func ParseListOrganizationalAssetsResponse(rsp *http.Response) (*listOrganizationalAssetsResponse, error)

ParseListOrganizationalAssetsResponse parses an HTTP response from a ListOrganizationalAssetsWithResponse call

func ParseListOrganizationsResponse added in v1.5.21

func ParseListOrganizationsResponse(rsp *http.Response) (*listOrganizationsResponse, error)

ParseListOrganizationsResponse parses an HTTP response from a ListOrganizationsWithResponse call

func ParseListParameterTypesResponse added in v1.5.21

func ParseListParameterTypesResponse(rsp *http.Response) (*listParameterTypesResponse, error)

ParseListParameterTypesResponse parses an HTTP response from a ListParameterTypesWithResponse call

func ParseListTopTemplatesResponse added in v1.5.21

func ParseListTopTemplatesResponse(rsp *http.Response) (*listTopTemplatesResponse, error)

ParseListTopTemplatesResponse parses an HTTP response from a ListTopTemplatesWithResponse call

func ParseLogoutResponse added in v1.5.21

func ParseLogoutResponse(rsp *http.Response) (*logoutResponse, error)

ParseLogoutResponse parses an HTTP response from a LogoutWithResponse call

func ParseRegisterUserResponse added in v1.5.21

func ParseRegisterUserResponse(rsp *http.Response) (*registerUserResponse, error)

ParseRegisterUserResponse parses an HTTP response from a RegisterUserWithResponse call

func ParseRemoveApproversFromOrganizationResponse added in v1.5.21

func ParseRemoveApproversFromOrganizationResponse(rsp *http.Response) (*removeApproversFromOrganizationResponse, error)

ParseRemoveApproversFromOrganizationResponse parses an HTTP response from a RemoveApproversFromOrganizationWithResponse call

func ParseRemoveConnectionResponse added in v1.5.21

func ParseRemoveConnectionResponse(rsp *http.Response) (*removeConnectionResponse, error)

ParseRemoveConnectionResponse parses an HTTP response from a RemoveConnectionWithResponse call

func ParseRemoveDepartmentFromOrganizationResponse added in v1.5.21

func ParseRemoveDepartmentFromOrganizationResponse(rsp *http.Response) (*removeDepartmentFromOrganizationResponse, error)

ParseRemoveDepartmentFromOrganizationResponse parses an HTTP response from a RemoveDepartmentFromOrganizationWithResponse call

func ParseRemoveUserFromDepartmentResponse added in v1.5.21

func ParseRemoveUserFromDepartmentResponse(rsp *http.Response) (*removeUserFromDepartmentResponse, error)

ParseRemoveUserFromDepartmentResponse parses an HTTP response from a RemoveUserFromDepartmentWithResponse call

func ParseRemoveUserFromOrganizationResponse added in v1.5.21

func ParseRemoveUserFromOrganizationResponse(rsp *http.Response) (*removeUserFromOrganizationResponse, error)

ParseRemoveUserFromOrganizationResponse parses an HTTP response from a RemoveUserFromOrganizationWithResponse call

func ParseRequestPasswordResetResponse added in v1.5.21

func ParseRequestPasswordResetResponse(rsp *http.Response) (*requestPasswordResetResponse, error)

ParseRequestPasswordResetResponse parses an HTTP response from a RequestPasswordResetWithResponse call

func ParseResendTaskEmailResponse added in v1.5.21

func ParseResendTaskEmailResponse(rsp *http.Response) (*resendTaskEmailResponse, error)

ParseResendTaskEmailResponse parses an HTTP response from a ResendTaskEmailWithResponse call

func ParseSupersedeTemplateResponse added in v1.5.21

func ParseSupersedeTemplateResponse(rsp *http.Response) (*supersedeTemplateResponse, error)

ParseSupersedeTemplateResponse parses an HTTP response from a SupersedeTemplateWithResponse call

func ParseUpdateAgreementResponse added in v1.5.21

func ParseUpdateAgreementResponse(rsp *http.Response) (*updateAgreementResponse, error)

ParseUpdateAgreementResponse parses an HTTP response from a UpdateAgreementWithResponse call

func ParseUpdateAgreementWithAttachmentResponse added in v1.5.21

func ParseUpdateAgreementWithAttachmentResponse(rsp *http.Response) (*updateAgreementWithAttachmentResponse, error)

ParseUpdateAgreementWithAttachmentResponse parses an HTTP response from a UpdateAgreementWithAttachmentWithResponse call

func ParseUpdateAgreementWithCancellationExternalResponse added in v1.5.21

func ParseUpdateAgreementWithCancellationExternalResponse(rsp *http.Response) (*updateAgreementWithCancellationExternalResponse, error)

ParseUpdateAgreementWithCancellationExternalResponse parses an HTTP response from a UpdateAgreementWithCancellationExternalWithResponse call

func ParseUpdateAgreementWithCancellationResponse added in v1.5.21

func ParseUpdateAgreementWithCancellationResponse(rsp *http.Response) (*updateAgreementWithCancellationResponse, error)

ParseUpdateAgreementWithCancellationResponse parses an HTTP response from a UpdateAgreementWithCancellationWithResponse call

func ParseUpdateAgreementWithSignatureResponse added in v1.5.21

func ParseUpdateAgreementWithSignatureResponse(rsp *http.Response) (*updateAgreementWithSignatureResponse, error)

ParseUpdateAgreementWithSignatureResponse parses an HTTP response from a UpdateAgreementWithSignatureWithResponse call

func ParseUpdateCollectionResponse added in v1.5.21

func ParseUpdateCollectionResponse(rsp *http.Response) (*updateCollectionResponse, error)

ParseUpdateCollectionResponse parses an HTTP response from a UpdateCollectionWithResponse call

func ParseUpdateDepartmentNameResponse added in v1.5.21

func ParseUpdateDepartmentNameResponse(rsp *http.Response) (*updateDepartmentNameResponse, error)

ParseUpdateDepartmentNameResponse parses an HTTP response from a UpdateDepartmentNameWithResponse call

func ParseUpdateOrganizationResponse added in v1.5.21

func ParseUpdateOrganizationResponse(rsp *http.Response) (*updateOrganizationResponse, error)

ParseUpdateOrganizationResponse parses an HTTP response from a UpdateOrganizationWithResponse call

func ParseUpdateTagResponse added in v1.5.21

func ParseUpdateTagResponse(rsp *http.Response) (*updateTagResponse, error)

ParseUpdateTagResponse parses an HTTP response from a UpdateTagWithResponse call

func ParseUpdateTaskDataMappingResponse added in v1.5.21

func ParseUpdateTaskDataMappingResponse(rsp *http.Response) (*updateTaskDataMappingResponse, error)

ParseUpdateTaskDataMappingResponse parses an HTTP response from a UpdateTaskDataMappingWithResponse call

func ParseUpdateTaskDataMappingsResponse added in v1.5.21

func ParseUpdateTaskDataMappingsResponse(rsp *http.Response) (*updateTaskDataMappingsResponse, error)

ParseUpdateTaskDataMappingsResponse parses an HTTP response from a UpdateTaskDataMappingsWithResponse call

func ParseUpdateTemplateDraftResponse added in v1.5.21

func ParseUpdateTemplateDraftResponse(rsp *http.Response) (*updateTemplateDraftResponse, error)

ParseUpdateTemplateDraftResponse parses an HTTP response from a UpdateTemplateDraftWithResponse call

func ParseUpdateTemplatePriceResponse added in v1.5.21

func ParseUpdateTemplatePriceResponse(rsp *http.Response) (*updateTemplatePriceResponse, error)

ParseUpdateTemplatePriceResponse parses an HTTP response from a UpdateTemplatePriceWithResponse call

func ParseUpdateTemplateResponse added in v1.5.21

func ParseUpdateTemplateResponse(rsp *http.Response) (*updateTemplateResponse, error)

ParseUpdateTemplateResponse parses an HTTP response from a UpdateTemplateWithResponse call

func ParseUpdateTemplateRestrictionsResponse added in v1.5.21

func ParseUpdateTemplateRestrictionsResponse(rsp *http.Response) (*updateTemplateRestrictionsResponse, error)

ParseUpdateTemplateRestrictionsResponse parses an HTTP response from a UpdateTemplateRestrictionsWithResponse call

func ParseUpdateUserProfileResponse added in v1.5.21

func ParseUpdateUserProfileResponse(rsp *http.Response) (*updateUserProfileResponse, error)

ParseUpdateUserProfileResponse parses an HTTP response from a UpdateUserProfileWithResponse call

Types

type AccountUser

type AccountUser struct {

	// Whether user account is activated and the email has been verified
	Activated *bool `json:"activated,omitempty"`

	// Users's Controller Contract
	Address *string `json:"address,omitempty"`

	// Whether the user has been blocked by administrators
	Blocked *bool `json:"blocked,omitempty"`

	// User's company
	Company *string `json:"company,omitempty"`

	// User's country code
	Country *string `json:"country,omitempty"`

	// Timestamp of user account creation (non-Unix time)
	CreatedAt *string `json:"createdAt,omitempty"`

	// Customer id from billing system
	CustomerId *string `json:"customerId,omitempty"`

	// Users's email address
	Email *string `json:"email,omitempty"`

	// Boolean representing whether user is an external user with no profile on Monax Platform
	ExternalUser *bool `json:"externalUser,omitempty"`

	// User's first name
	FirstName *string `json:"firstName,omitempty"`

	// User's table ID
	Id *int `json:"id,omitempty"`

	// User's last name
	LastName *string `json:"lastName,omitempty"`

	// Identifies the plan the customer is subscribed to
	PlanId *string `json:"planId,omitempty"`

	// Status of the plan
	PlanStatus *string `json:"planStatus,omitempty"`

	// Contract address of user's region
	Region *string `json:"region,omitempty"`

	// Subscription id from billing system
	SubscriptionId *string `json:"subscriptionId,omitempty"`

	// User account address of the owner of the subscription
	SubscriptionOwnerAddress *string `json:"subscriptionOwnerAddress,omitempty"`

	// Subscription status from billing system
	SubscriptionStatus *string `json:"subscriptionStatus,omitempty"`

	// Username of the user
	Username *string `json:"username,omitempty"`
}

AccountUser defines model for AccountUser.

type AccountUsers

type AccountUsers []AccountUser

AccountUsers defines model for AccountUsers.

type ActivityInstance

type ActivityInstance struct {
	ActivityId               *string `json:"activityId,omitempty"`
	ActivityInstanceId       string  `json:"activityInstanceId"`
	AgreementAddress         *string `json:"agreementAddress,omitempty"`
	AgreementName            *string `json:"agreementName,omitempty"`
	Application              *string `json:"application,omitempty"`
	ApplicationType          *int    `json:"applicationType,omitempty"`
	AssignedToUser           *bool   `json:"assignedToUser,omitempty"`
	AttachmentsFileReference *string `json:"attachmentsFileReference,omitempty"`

	// Block number of when the task was completed -- as a string
	BlockNumber *string `json:"blockNumber,omitempty"`
	Completed   *bool   `json:"completed,omitempty"`

	// Blockchain based address of the entity that has completed the task, if the task is incomplete it will be the hex 0
	CompletedBy            *string `json:"completedBy,omitempty"`
	CompletedByDisplayName *string `json:"completedByDisplayName,omitempty"`

	// Unix timestamp of when the activity was created
	Created                *float32       `json:"created,omitempty"`
	Data                   *[]DataMapping `json:"data,omitempty"`
	InterfaceId            *string        `json:"interfaceId,omitempty"`
	IsModelPrivate         *bool          `json:"isModelPrivate,omitempty"`
	MaxNumberOfAttachments *int           `json:"maxNumberOfAttachments,omitempty"`
	ModelAddress           *string        `json:"modelAddress,omitempty"`
	ModelAuthor            *string        `json:"modelAuthor,omitempty"`
	ModelId                *string        `json:"modelId,omitempty"`
	Name                   *string        `json:"name,omitempty"`
	OrganizationKey        *string        `json:"organizationKey,omitempty"`

	// Blockchain based address of the entity tasked with performing the activity.
	Performer                *string `json:"performer,omitempty"`
	PerformerDisplayName     *string `json:"performerDisplayName,omitempty"`
	ProcessAddress           *string `json:"processAddress,omitempty"`
	ProcessDefinitionAddress *string `json:"processDefinitionAddress,omitempty"`
	ProcessDefinitionId      *string `json:"processDefinitionId,omitempty"`
	ProcessName              *string `json:"processName,omitempty"`
	Scope                    *string `json:"scope,omitempty"`
	ScopeDisplayName         *string `json:"scopeDisplayName,omitempty"`
	State                    int     `json:"state"`
	TaskType                 *int    `json:"taskType,omitempty"`
	TransactionHash          *string `json:"transactionHash,omitempty"`
	WebForm                  *string `json:"webForm,omitempty"`
}

ActivityInstance defines model for ActivityInstance.

type ActivityInstances

type ActivityInstances []ActivityInstance

ActivityInstances defines model for ActivityInstances.

type AddApproversToOrganizationJSONBody added in v1.5.21

type AddApproversToOrganizationJSONBody OrganizationCreation

AddApproversToOrganizationJSONBody defines parameters for AddApproversToOrganization.

type AddApproversToOrganizationJSONRequestBody

type AddApproversToOrganizationJSONRequestBody AddApproversToOrganizationJSONBody

AddApproversToOrganizationRequestBody defines body for AddApproversToOrganization for application/json ContentType.

type AddDepartmentToOrganizationJSONBody added in v1.5.21

type AddDepartmentToOrganizationJSONBody struct {

	// Department's human readable name
	Name *string `json:"name,omitempty"`

	// Addresses of the members to add to the Department
	// If not given, department will be created with no members and members can be added later
	Users *[]string `json:"users,omitempty"`
}

AddDepartmentToOrganizationJSONBody defines parameters for AddDepartmentToOrganization.

type AddDepartmentToOrganizationJSONRequestBody

type AddDepartmentToOrganizationJSONRequestBody AddDepartmentToOrganizationJSONBody

AddDepartmentToOrganizationRequestBody defines body for AddDepartmentToOrganization for application/json ContentType.

type AddUserToDepartmentJSONBody added in v1.5.21

type AddUserToDepartmentJSONBody struct {

	// Addresses of the members to add to the Department
	Users *[]string `json:"users,omitempty"`
}

AddUserToDepartmentJSONBody defines parameters for AddUserToDepartment.

type AddUserToDepartmentJSONRequestBody

type AddUserToDepartmentJSONRequestBody AddUserToDepartmentJSONBody

AddUserToDepartmentRequestBody defines body for AddUserToDepartment for application/json ContentType.

type AddUserToOrganizationJSONBody added in v1.5.21

type AddUserToOrganizationJSONBody struct {

	// List of the blockchain based addresses for users to add
	Users *[]string `json:"users,omitempty"`
}

AddUserToOrganizationJSONBody defines parameters for AddUserToOrganization.

type AddUserToOrganizationJSONRequestBody

type AddUserToOrganizationJSONRequestBody AddUserToOrganizationJSONBody

AddUserToOrganizationRequestBody defines body for AddUserToOrganization for application/json ContentType.

type Agreement

type Agreement struct {

	// An array of the activities which are attached to the agreement and controlled by its process model
	ActivityInstances *[]AgreementActivityInstance `json:"activityInstances,omitempty"`

	// Agreement's address on the blockchain
	Address *string `json:"address,omitempty"`

	// Address of the parent of the agreement
	Archetype *string `json:"archetype,omitempty"`

	// Unique reference to the file wrapping up all of the attachments
	AttachmentsFileReference *string `json:"attachmentsFileReference,omitempty"`

	// If the agreement is part of a collection, the unique
	// identifier of that collection is returned here
	CollectionId *string `json:"collectionId,omitempty"`

	// Unix timestamp object creation
	CreatedAt *float32 `json:"createdAt,omitempty"`

	// The entity who originally created the agreement
	Creator *string `json:"creator,omitempty"`

	// Human readable name of the creator of the agreement
	CreatorDisplayName *string `json:"creatorDisplayName,omitempty"`

	// Array of the prose template documents that provide the basis
	// for the human-readable (traditional) contract.
	//
	// N.B. these documents when displayed for a user are "assembled" in
	// that they are ran through our documentary assembly processing system
	// before they are displayed to the user in our webApp. This field
	// only returns the "raw" document which needs to be ran through
	// the Monax assembler if one wants to have the "full" contract
	// equivalent to what is displayed in the webApp.
	Documents *[]AgreementDocument `json:"documents,omitempty"`

	// Address of the agreement's execution process definition
	ExecutionProcessDefinition *string `json:"executionProcessDefinition,omitempty"`

	// Address of the agreement's execution process instance
	ExecutionProcessInstance *string `json:"executionProcessInstance,omitempty"`

	// Address of the agreement's formation process definition
	FormationProcessDefinition *string `json:"formationProcessDefinition,omitempty"`

	// Address of the agreement's formation process instance
	FormationProcessInstance *string `json:"formationProcessInstance,omitempty"`

	// An array of any agreements which are "parents" and as such "govern" the agreement in question. This array is not returned as a hierarchical order. Any entries in this array will be deemed as parents.
	// For more information see [here](https://media.giphy.com/media/l2SpMzL4mUMAGkHbG/giphy.gif).
	GoverningAgreements *[]AgreementGoverning `json:"governingAgreements,omitempty"`

	// Understand if the entity retrieving the information has a currently
	// pending task to be completed
	IsAssignedTask *bool `json:"isAssignedTask,omitempty"`

	// Understand if the entity retrieving the information is also the
	// creator of the agreement
	IsCreator *bool `json:"isCreator,omitempty"`

	// Understand if the entity retrieving the information is a legal
	// party to the agreement
	IsParty *bool `json:"isParty,omitempty"`

	// Whether the encryption framework of the agreement
	// is operational or not
	IsPrivate *bool `json:"isPrivate,omitempty"`

	// Every agreement contains a state machine which can only go one way
	// through it's life-cycle. This state machine is very helpful for understanding
	// at a "macro" level where are we within the contract's life-cycle.
	//
	// This state machine is controlled by logic which exists on the blockchain
	// and as such is very reliable and visible to all of the parties to the
	// agreement (assuming they have the correct address of the contract).
	//
	// The state machine encompasses the following states:
	//
	// - `Legal State: 1` -> Formulation
	// - `Legal State: 2` -> Execution
	// - `Legal State: 3` -> Fulfilled
	// - `Legal State: 4` -> Cancelled
	// - `Legal State: 5` -> Defaulted
	LegalState *int `json:"legalState,omitempty"`

	// (Currently not used) The maximum number of attachments which
	// may be placed onto an agreement
	MaxNumberOfAttachments *int `json:"maxNumberOfAttachments,omitempty"`

	// Human readable name of the agreement. Note that this field is limited to a maximum of 32 ASCII characters.
	Name *string `json:"name,omitempty"`

	// The entity who controls the visibility of the agreement
	Owner *string `json:"owner,omitempty"`

	// Human readable name of the owner of the agreement
	OwnerDisplayName *string `json:"ownerDisplayName,omitempty"`

	// An array of objects with each parameter's name, value, and data type. See the AgreementParameter object definition for more information on the data types.
	// Note - If a parameter with type 8 (Signing Party) is given, the corresponding value will be added to the agreement's parties.
	Parameters *[]AgreementParameter `json:"parameters,omitempty"`

	// An array of objects with each party member's address, user id or organization name, signature timestamp, and address of the user that has signed for the party
	Parties *[]AgreementParty `json:"parties,omitempty"`

	// Unique reference to the file wrapping all of the parameters which
	// are not used by process models, and therefore not put onto the
	// blockchain underlying Monax
	PrivateParametersFileReference *string `json:"privateParametersFileReference,omitempty"`

	// An array of the processes which are attached to the agreement
	Processes *[]AgreementProcess `json:"processes,omitempty"`

	// Unique reference to the file wrapping all of the data surrounding
	// the signatures placed onto the agreement by the parties
	SignaturesFileReference *string `json:"signaturesFileReference,omitempty"`
}

Agreement defines model for Agreement.

type AgreementActivityInstance

type AgreementActivityInstance struct {

	// The identifier of this activity whenever it is used by this model
	ActivityId *string `json:"activityId,omitempty"`

	// The unique identifier of this particular activity
	ActivityInstanceId *string `json:"activityInstanceId,omitempty"`

	// Blockchain based address of the contract which defines and controls the agreement this activity instance is a part of.
	AgreementAddress *string `json:"agreementAddress,omitempty"`

	// Human readable name of the agreement this activity instance is attached to
	AgreementName *string `json:"agreementName,omitempty"`

	// Application within the process engine which has raised and controls completion of the activity
	Application *string `json:"application,omitempty"`

	// Has the task been placed into a user's task list
	AssignedToUser *bool `json:"assignedToUser,omitempty"`

	// Blockchain based block number in which the activity was completed. If the activity has not been completed (`state` == `4`) then the blockNumber will return the current block height. If the activity has been completed then the blockNumber will be populated by the blockNumber in which the activity was completed. # TODO - the above is really weird. Why do we return the current block # height here rather than a 0?
	BlockNumber *string `json:"blockNumber,omitempty"`

	// Unix timestamp of when the activity instance was completed by the actor assigned to complete this instance of the activity
	Completed *float32 `json:"completed,omitempty"`

	// Blockchain based address of the entity that is performed the activity.
	// This field will always return the `0000000000000000000000000000000000000000` address when the activity **has not been completed** and will return the address of the performer when the activity **has been** completed.
	// This field operates the same as (but on the opposite cycle) as the `performer` field within this object schema.
	CompletedBy *string `json:"completedBy,omitempty"`

	// Human readable name of the user who completed the activity
	CompletedByDisplayName *string `json:"completedByDisplayName,omitempty"`

	// Unix timestamp of when the activity instance was created by the process model
	Created *float32 `json:"created,omitempty"`

	// Indicates whether the performer user is an external (ie. fully registered) user
	ExternalPerformer *bool `json:"externalPerformer,omitempty"`

	// The TYPE of process this is formation or execution
	InterfaceId *string `json:"interfaceId,omitempty"`

	// Blockchain address of the process model contract
	ModelAddress *string `json:"modelAddress,omitempty"`

	// Unique ID of the process model
	ModelId *string `json:"modelId,omitempty"`

	// Human readable name of the activity
	Name *string `json:"name,omitempty"`

	// Blockchain-based key of the performer organization (if any). If the `scope` is equal to this key, this indicates the activity instance is assigned to all members of the performer organization.
	OrganizationKey *string `json:"organizationKey,omitempty"`

	// Blockchain based address of the entity that is assigned to perform the activity.
	// This field will always return the `0000000000000000000000000000000000000000` address when the activity **has been completed** and will return the address of the performer when the activity has **not** been completed.
	// This field operates the same as (but on the opposite cycle) as the `completedBy` field within this object schema.
	Performer *string `json:"performer,omitempty"`

	// Human readable name of the user who is to perform the activity
	PerformerDisplayName *string `json:"performerDisplayName,omitempty"`

	// The blockchain address of the process model contract
	ProcessAddress *string `json:"processAddress,omitempty"`

	// Blockchain address of the process definition contract
	ProcessDefinitionAddress *string `json:"processDefinitionAddress,omitempty"`

	// ID of the process definition
	ProcessDefinitionId *string `json:"processDefinitionId,omitempty"`

	// Human readable name of the process definition
	ProcessName *string `json:"processName,omitempty"`

	// Blockchain based id of the assigned department within the performer organization (if any)
	Scope *string `json:"scope,omitempty"`

	// Human readable name of the assigned department within the performer organization (if any)
	ScopeDisplayName *string `json:"scopeDisplayName,omitempty"`

	// The status of the activity.
	State *int `json:"state,omitempty"`

	// The type of activity.
	TaskType *int `json:"taskType,omitempty"`

	// Blockchain based transaction hash which completed the activity. If the activity has not been completed (`state` == 4) then the transactionHash will return the transaction hash which created the activity. If the activity has been completed then the field will be populated by the actual transaction hash which completed the activity. # TODO - the above is weird. We should revisit it.
	TransactionHash *string `json:"transactionHash,omitempty"`
	WebForm         *string `json:"webForm,omitempty"`
}

AgreementActivityInstance defines model for AgreementActivityInstance.

type AgreementActivityInstances

type AgreementActivityInstances []struct {

	// The unique identifier of this particular activity
	ActivityInstanceId *string `json:"activityInstanceId,omitempty"`
	Email              *string `json:"email,omitempty"`
	ExternalUser       *string `json:"externalUser,omitempty"`

	// Blockchain based address of the entity that is assigned to perform the activity.
	// This field will always return the `0000000000000000000000000000000000000000` address when the activity **has been completed** and will return the address of the performer when the activity has **not** been completed.
	// This field operates the same as (but on the opposite cycle) as the `completedBy` field within this object schema.
	Performer *string `json:"performer,omitempty"`

	// The status of the activity.
	State *int `json:"state,omitempty"`
}

AgreementActivityInstances defines model for AgreementActivityInstances.

type AgreementAttachmentDetail

type AgreementAttachmentDetail struct {

	// If the attachment was uploaded via a JSON Post in plain text
	// rather than as a file upload, then the content will be the
	// actual content of what was sent in.
	//
	// If the attachment was uploaded via a multipart form upload
	// as a file then the reference to the file will be provided
	// here.
	Content *string `json:"content,omitempty"`

	// The type of the content.
	ContentType *string `json:"contentType,omitempty"`

	// Human readable name of the submitter
	DisplayName *string `json:"displayName,omitempty"`

	// The name of the attachment
	Name *string `json:"name,omitempty"`

	// Blockchain based address of the identity of the entity who uploaded to the attachment to the agreement's data room.
	Submitter *string `json:"submitter,omitempty"`

	// Unix timestamp of when the attachment was uploaded
	Timestamp *int `json:"timestamp,omitempty"`
}

AgreementAttachmentDetail defines model for AgreementAttachmentDetail.

type AgreementAttachmentJSON

type AgreementAttachmentJSON struct {
	Content *string `json:"content,omitempty"`
	Name    *string `json:"name,omitempty"`
}

AgreementAttachmentJSON defines model for AgreementAttachmentJSON.

type AgreementAttachmentResponse

type AgreementAttachmentResponse struct {

	// The updated array of attachments
	Attachments *[]AgreementAttachmentDetail `json:"attachments,omitempty"`

	// Unique reference to the file wrapping up all of the attachments
	AttachmentsFileReference *string `json:"attachmentsFileReference,omitempty"`
}

AgreementAttachmentResponse defines model for AgreementAttachmentResponse.

type AgreementByGroup

type AgreementByGroup struct {

	// An array of the currently pending activities which are attached to the agreement and controlled by its process model
	ActivityInstances *[]AgreementActivityInstance `json:"activityInstances,omitempty"`

	// Agreement's address on the blockchain
	Address *string `json:"address,omitempty"`

	// Address of the parent of the agreement
	Archetype *string `json:"archetype,omitempty"`

	// Human readable name of the archetype
	ArchetypeName *string `json:"archetypeName,omitempty"`

	// Unique reference to the file wrapping up all of the attachments
	AttachmentsFileReference *string `json:"attachmentsFileReference,omitempty"`

	// Unix timestamp object creation
	CreatedAt *float32 `json:"createdAt,omitempty"`

	// The entity who originally created the agreement
	Creator *string `json:"creator,omitempty"`

	// Human readable name of the creator of the agreement
	CreatorDisplayName *string `json:"creatorDisplayName,omitempty"`

	// Whether the encryption framework of the agreement
	// is operational or not
	IsPrivate *bool `json:"isPrivate,omitempty"`

	// Every agreement contains a state machine which can only go one way
	// through it's life-cycle. This state machine is very helpful for understanding
	// at a "macro" level where are we within the contract's life-cycle.
	//
	// This state machine is controlled by logic which exists on the blockchain
	// and as such is very reliable and visible to all of the parties to the
	// agreement (assuming they have the correct address of the contract).
	//
	// The state machine encompasses the following states:
	//
	// - `Legal State: 1` -> Formulation
	// - `Legal State: 2` -> Execution
	// - `Legal State: 3` -> Fulfilled
	// - `Legal State: 4` -> Cancelled
	// - `Legal State: 5` -> Defaulted
	LegalState *int `json:"legalState,omitempty"`

	// (Currently not used) The maximum number of attachments which
	// may be placed onto an agreement
	MaxNumberOfAttachments *int `json:"maxNumberOfAttachments,omitempty"`

	// Human readable name of the agreement. Note that this field is limited to a maximum of 32 ASCII characters.
	Name *string `json:"name,omitempty"`

	// The entity who controls the visibility of the agreement
	Owner *string `json:"owner,omitempty"`

	// Human readable name of the owner of the agreement
	OwnerDisplayName *string         `json:"ownerDisplayName,omitempty"`
	Tags             *[]AgreementTag `json:"tags,omitempty"`
}

AgreementByGroup defines model for AgreementByGroup.

type AgreementCreationResponse

type AgreementCreationResponse struct {

	// Agreement's address on the blockchain
	Address *string `json:"address,omitempty"`

	// New users that have been created in line with the creation of this agreement.
	NewUsers *[]struct {

		// Blockchain based contract address of the new user
		Address *string `json:"address,omitempty"`

		// Email address of the new user created
		Email *string `json:"email,omitempty"`
	} `json:"newUsers,omitempty"`

	// An array of objects with each parameter's name, value, and data type. See the AgreementParameter object definition for more information on the data types.
	// Note - If a parameter with type 8 (Signing Party) is given, the corresponding value will be added to the agreement's parties.
	Parameters *[]AgreementParameter `json:"parameters,omitempty"`

	// Address of the agreement's formation process instance
	ProcessInstance *string `json:"processInstance,omitempty"`
}

AgreementCreationResponse defines model for AgreementCreationResponse.

type AgreementDocument

type AgreementDocument struct {

	// Unique reference to the document addressable via the hash
	// of the document's contents for clean and concise assurances
	// of legitimacy. This can be retrieved by uploading the document
	// via a `POST` request to `/documents`.
	Grant *string `json:"grant,omitempty"`

	// Human readable name of the document
	Name *string `json:"name,omitempty"`
}

AgreementDocument defines model for AgreementDocument.

type AgreementDraftBody

type AgreementDraftBody struct {
	Documents *[]struct {

		// Reference to the document addressable.
		Grant *string `json:"grant,omitempty"`

		// File name of the document
		Name *string `json:"name,omitempty"`
	} `json:"documents,omitempty"`

	// Blockchain based address of the process definition that should be used for the agreement's execution process
	ExecutionProcessDefinition *string `json:"executionProcessDefinition,omitempty"`

	// The date on which the agreement expires
	ExpirationDate *string `json:"expirationDate,omitempty"`

	// Blockchain based address of the process definition that should be used for the agreement's formation process
	FormationProcessDefinition *string `json:"formationProcessDefinition,omitempty"`
	Jurisdictions              *[]struct {

		// Two letter country code of the jurisdiction that this template is marked as valid for
		Country *string `json:"country,omitempty"`

		// Comma-separated string of the blockchain based addresses of the country's sub-national region
		Regions *string `json:"regions,omitempty"`
	} `json:"jurisdictions,omitempty"`

	// Human readable name of the agreement
	Name *string `json:"name,omitempty"`

	// A new signatory object to be added to the signatories array
	NewSignatory *struct {

		// If `value` is the blockchain based address of a user, and `addConnection` is true, a business connection will be made between them and the requesting user.
		AddConnection *bool `json:"addConnection,omitempty"`

		// The label/role of the signatory
		Label *string `json:"label,omitempty"`

		// If `value` is the blockchain based address of an organization, a department within the organization can be specified by setting the `scope` value to the blockchain based id of the department within
		Scope *string `json:"scope,omitempty"`

		// The blockchain based address of the user/organziation that is a signing party
		Value *string `json:"value,omitempty"`
	} `json:"newSignatory,omitempty"`

	// Blockchain based address of the user or organization who can control modifications, updates, and the visibility of the agreement
	Owner *string `json:"owner,omitempty"`

	// Comma-separated string of the blockchain based department ids within the owner organization to limit visibility of the agreement to
	OwnerScope *string `json:"ownerScope,omitempty"`
	Parameters *[]struct {

		// If `value` is the blockchain based address of a user, and `addConnection` is true, a business connection will be made between them and the requesting user.
		AddConnection *bool `json:"addConnection,omitempty"`

		// Indicates whether the parameter should be hidden when retrieving the agreement details
		Confidential *bool `json:"confidential,omitempty"`

		// Name of the parameter
		Name *string `json:"name,omitempty"`

		// Indicates whether the value for the parameter is required at agreement creation
		Required *bool `json:"required,omitempty"`

		// If `value` is the blockchain based address of an organization, a department within the organization can be specified by setting the `scope` value to the blockchain based id of the department within
		Scope *string `json:"scope,omitempty"`

		// Code indicating the data type of the parameter
		Type *float32 `json:"type,omitempty"`

		// The value of the parameters. Should be of type matching parameter `type`
		Value *string `json:"value,omitempty"`

		// Code used to indicate whom visibility of the parameter should be limited to
		Visibility *float32 `json:"visibility,omitempty"`
	} `json:"parameters,omitempty"`

	// Indicates whether parameters from the attached documents and workflows have been added to the draft body
	ParametersSet *bool `json:"parametersSet,omitempty"`

	// Indicates whether the new template created for this agreement should be kept as an active template.
	ReuseAsTemplate *bool `json:"reuseAsTemplate,omitempty"`
	Signatories     *[]struct {

		// If `value` is the blockchain based address of a user, and `addConnection` is true, a business connection will be made between them and the requesting user.
		AddConnection *bool `json:"addConnection,omitempty"`

		// Indicates whether the signatory was added via parameters
		CustomSignatory *bool `json:"customSignatory,omitempty"`

		// The label/role of the signatory
		Label *string `json:"label,omitempty"`

		// If `value` is the blockchain based address of an organization, a department within the organization can be specified by setting the `scope` value to the blockchain based id of the department within
		Scope *string `json:"scope,omitempty"`

		// The blockchain based address of the user/organziation that is a signing party
		Value *string `json:"value,omitempty"`
	} `json:"signatories,omitempty"`
	UploadDocuments *[]map[string]interface{} `json:"uploadDocuments,omitempty"`
}

AgreementDraftBody defines model for AgreementDraftBody.

type AgreementGoverning

type AgreementGoverning struct {

	// Address of the governing agreement
	Address *string `json:"address,omitempty"`

	// Human readable name of the governing agreement
	Name *string `json:"name,omitempty"`
}

AgreementGoverning defines model for AgreementGoverning.

type AgreementParameter

type AgreementParameter struct {

	// Is the parameter confidential and therefore only available to be seen by the `owner` of the Agreement? If a parameter is not confidential then the presence and value of that parameter are made known to all the `parties` to the agreement along with their organizations / departments. If a parameter is confidential then the presence and value of that parameter are made known **only** to the owner of the agreement.
	Confidential *bool `json:"confidential,omitempty"`

	// When the field in question refers to an identity within the Agreements Network underlying Monax then the displayValue field is returned with a human readable name.
	DisplayValue *string `json:"displayValue,omitempty"`

	// Human readable name of the parameter. This is field is leveraged by the document assembly system used by Monax as well as in the webApp.
	Name *string `json:"name,omitempty"`

	// The parameter type (as in a computer typing system). The following
	// types are currently allowed:
	//
	// - `0`: Boolean"
	// - `1`: String
	// - `2`: Number
	// - `3`: Date
	// - `4`: Datetime
	// - `5`: Monetary Amount
	// - `6`: User/Organization
	// - `7`: Contract Address
	// - `8`: Signing Party
	// - `11`: Large Text
	// - `12`: Positive Number
	Type *int `json:"type,omitempty"`

	// The value that should replace the `name` when it properly appears within a given document.
	Value *string `json:"value,omitempty"`

	// Code indicating how to restrict visibility of the parameter. - 0: Agreement creator only - 1: Agreement owner only - 2: Agreement signatories only
	Visibility *int `json:"visibility,omitempty"`
}

AgreementParameter defines model for AgreementParameter.

type AgreementParty

type AgreementParty struct {

	// Blockchain address (or identity) of the party to the agreement
	Address *string `json:"address,omitempty"`

	// Unix timestamp on which the party in question put their mark
	// electronically upon the agreement to cancel it.
	//
	// Cancellation is a bi- (or multi-)lateral activity which (as defined
	// by the [Agreements Network protocol](https://agreements.network))
	// must take place affirmatively by all of the parties to the agreement.
	CancelationTimestamp *int64 `json:"cancelationTimestamp,omitempty"`

	// Blockchain based address (or identity) of the human (or machine?)
	// which has cancelled an agreement on behalf of the party.
	//
	// Where the party is not a corporate or collective identity (such
	// as a company, team, department, etc.) then the `canceledBy` and
	// the `address` fields will be the same. Where the party is a
	// corporate or collective identity then these fields will not be
	// the same.
	//
	// Cancellation is a bi- (or multi-)lateral activity which (as defined
	// by the [Agreements Network protocol](https://agreements.network))
	// must take place affirmatively by all of the parties to the agreement.
	CanceledBy *string `json:"canceledBy,omitempty"`

	// Human readable name of the canceller.
	//
	//
	// Cancellation is a bi- (or multi-)lateral activity which (as defined
	// by the [Agreements Network protocol](https://agreements.network))
	// must take place affirmatively by all of the parties to the agreement.
	CanceledByDisplayName *string `json:"canceledByDisplayName,omitempty"`
	OrganizationKey       *string `json:"organizationKey,omitempty"`

	// Human readable name of the party
	PartyDisplayName *string `json:"partyDisplayName,omitempty"`
	Scope            *string `json:"scope,omitempty"`
	ScopeDisplayName *string `json:"scopeDisplayName,omitempty"`

	// Unix timestamp on which the actor placed their electronic
	// signature onto the agreement
	SignatureTimestamp *int64 `json:"signatureTimestamp,omitempty"`

	// Blockchain address (or identity) of the HUMAN (or machine?)
	// who signed on behalf of the party.
	//
	// Where the party is not a corporate or collective identity (such
	// as a company, team, department, etc.) then the `signedBy` and
	// the `address` fields will be the same. Where the party is a
	// corporate or collective identity then these fields will not be
	// the same.
	SignedBy *string `json:"signedBy,omitempty"`

	// Human readable name of the signer
	SignedByDisplayName *string `json:"signedByDisplayName,omitempty"`
}

AgreementParty defines model for AgreementParty.

type AgreementProcess

type AgreementProcess struct {

	// File providing the diagram of the process model in BPMN specification format
	Diagram *string `json:"diagram,omitempty"`

	// The TYPE of process this is formation or execution
	InterfaceId *string `json:"interfaceId,omitempty"`

	// Blockchain address of the process model contract
	ModelAddress *string `json:"modelAddress,omitempty"`

	// Blockchain address of the process definition contract
	ProcessDefinitionAddress *string `json:"processDefinitionAddress,omitempty"`

	// ID of the process definition
	ProcessDefinitionId *string `json:"processDefinitionId,omitempty"`

	// Blockchain address of the process instance contract
	ProcessInstanceAddress *string `json:"processInstanceAddress,omitempty"`

	// Human-readable name of the process definition
	ProcessName *string `json:"processName,omitempty"`
}

AgreementProcess defines model for AgreementProcess.

type AgreementQuick

type AgreementQuick struct {

	// Array of the prose template documents that provide the basis
	// for the human-readable (traditional) contract.
	//
	// N.B. these documents when displayed for a user are "assembled" in
	// that they are ran through our documentary assembly processing system
	// before they are displayed to the user in our webApp. This field
	// only returns the "raw" document which needs to be ran through
	// the Monax assembler if one wants to have the "full" contract
	// equivalent to what is displayed in the webApp.
	Documents *[]AgreementDocument `json:"documents,omitempty"`

	// Human readable name of the agreement. Note that this field is limited to a maximum of 32 ASCII characters.
	Name *string `json:"name,omitempty"`

	// The entity who controls the visibility of the agreement
	Owner *string `json:"owner,omitempty"`

	// An array of objects with each parameter's name, value, and data type. See the AgreementParameter object definition for more information on the data types.
	// Note - If a parameter with type 8 (Signing Party) is given, the corresponding value will be added to the agreement's parties.
	Parameters *[]AgreementParameter `json:"parameters,omitempty"`
}

AgreementQuick defines model for AgreementQuick.

type AgreementSignature

type AgreementSignature struct {

	// The mailing (or physical) address of the entity that is the party to the agreement
	Address *string `json:"address,omitempty"`

	// Name of the company (if applicable) who is becoming a party to the agreement by operation of the addition of this electronic signature.
	Company *string `json:"company,omitempty"`

	// Unix timestamp of when the signature is made
	Date *int `json:"date,omitempty"`

	// Email address of the human signing the agreement
	Email *string `json:"email,omitempty"`

	// The full name of the human signing the agreement
	Name         *string      `json:"name,omitempty"`
	Signature    *interface{} `json:"signature,omitempty"`
	SignatureRaw *string      `json:"signatureRaw,omitempty"`

	// The type of signature which provides consent
	SignatureType *string `json:"signatureType,omitempty"`

	// The job title of the human signing the agreement on behalf of a corporate entity.
	Title *string `json:"title,omitempty"`
}

AgreementSignature defines model for AgreementSignature.

type AgreementTag

type AgreementTag struct {

	// Unique identifier of the tag
	Id *int `json:"id,omitempty"`

	// Blockchain based contract address of the entity (user or
	// organization) that owns the tag.
	//
	// During a write operation, if this field is not specified,
	// the address of the authenticated user will be used.
	Owner *string `json:"owner,omitempty"`

	// Human readable text to display
	Text string `json:"text"`
}

AgreementTag defines model for AgreementTag.

type AgreementUpdateRequest

type AgreementUpdateRequest struct {

	// Array of tags that should be applied to the agreement
	Tags *[]int `json:"tags,omitempty"`
}

AgreementUpdateRequest defines model for AgreementUpdateRequest.

type AgreementsByCollaboratorReport

type AgreementsByCollaboratorReport []struct {

	// The blockchain based address of the entity that is the counterparty.
	Address *string `json:"address,omitempty"`

	// The number of agreements between the current logged in user and the counterparty in question
	Total *int `json:"total,omitempty"`

	// The username of the entity that is the counterparty.
	Username *string `json:"username,omitempty"`
}

AgreementsByCollaboratorReport defines model for AgreementsByCollaboratorReport.

type AgreementsByStateReport

type AgreementsByStateReport struct {

	// The number of agreements in draft state
	N0 *int `json:"0,omitempty"`

	// The number of agreements in formulated state
	N1 *int `json:"1,omitempty"`

	// The number of agreements in executed state
	N2 *int `json:"2,omitempty"`

	// The number of agreements in fulfilled state
	N3 *int `json:"3,omitempty"`

	// The number of agreements in default state
	N4 *int `json:"4,omitempty"`

	// The number of agreements in canceled state
	N5 *int `json:"5,omitempty"`
}

AgreementsByStateReport defines model for AgreementsByStateReport.

type AssembleDocumentParams

type AssembleDocumentParams struct {

	// The reference grants of the documents to be assembled
	Grants []string `json:"grants"`

	// Array of parameters to overlay
	Params []AgreementParameter `json:"params"`
}

AssembleDocumentParams defines parameters for AssembleDocument.

type AssembleDocumentsForTemplateParams

type AssembleDocumentsForTemplateParams struct {

	// Array of parameters to overlay
	Params []AgreementParameter `json:"params"`
}

AssembleDocumentsForTemplateParams defines parameters for AssembleDocumentsForTemplate.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A callback for modifying requests which are generated before sending over
	// the network.
	RequestEditor RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient added in v1.4.8

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) AcceptConnectionRequest

func (c *Client) AcceptConnectionRequest(ctx context.Context, id int) (*http.Response, error)

func (*Client) ActivateTemplate

func (c *Client) ActivateTemplate(ctx context.Context, address string) (*http.Response, error)

func (*Client) ActivateTemplatePackage

func (c *Client) ActivateTemplatePackage(ctx context.Context, id int32) (*http.Response, error)

func (*Client) AddApproversToOrganization

func (c *Client) AddApproversToOrganization(ctx context.Context, address string, body AddApproversToOrganizationJSONRequestBody) (*http.Response, error)

func (*Client) AddApproversToOrganizationWithBody

func (c *Client) AddApproversToOrganizationWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) AddDepartmentToOrganization

func (c *Client) AddDepartmentToOrganization(ctx context.Context, address string, body AddDepartmentToOrganizationJSONRequestBody) (*http.Response, error)

func (*Client) AddDepartmentToOrganizationWithBody

func (c *Client) AddDepartmentToOrganizationWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) AddTemplateToPackage

func (c *Client) AddTemplateToPackage(ctx context.Context, id int32, address string) (*http.Response, error)

func (*Client) AddUserToDepartment

func (c *Client) AddUserToDepartment(ctx context.Context, address string, departmentId string, body AddUserToDepartmentJSONRequestBody) (*http.Response, error)

func (*Client) AddUserToDepartmentWithBody

func (c *Client) AddUserToDepartmentWithBody(ctx context.Context, address string, departmentId string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) AddUserToOrganization

func (c *Client) AddUserToOrganization(ctx context.Context, address string, body AddUserToOrganizationJSONRequestBody) (*http.Response, error)

func (*Client) AddUserToOrganizationWithBody

func (c *Client) AddUserToOrganizationWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) AssembleDocument

func (c *Client) AssembleDocument(ctx context.Context, params *AssembleDocumentParams) (*http.Response, error)

func (*Client) AssembleDocumentsForAgreement

func (c *Client) AssembleDocumentsForAgreement(ctx context.Context, address string) (*http.Response, error)

func (*Client) AssembleDocumentsForAgreementExternal

func (c *Client) AssembleDocumentsForAgreementExternal(ctx context.Context, address string) (*http.Response, error)

func (*Client) AssembleDocumentsForTemplate

func (c *Client) AssembleDocumentsForTemplate(ctx context.Context, address string, params *AssembleDocumentsForTemplateParams) (*http.Response, error)

func (*Client) CompleteSigningTaskExternalWithBody added in v1.5.21

func (c *Client) CompleteSigningTaskExternalWithBody(ctx context.Context, id string, agreementAddress string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CompleteSigningTaskWithBody added in v1.5.8

func (c *Client) CompleteSigningTaskWithBody(ctx context.Context, id string, agreementAddress string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CompleteTask

func (c *Client) CompleteTask(ctx context.Context, id string) (*http.Response, error)

func (*Client) CompleteTaskExternal

func (c *Client) CompleteTaskExternal(ctx context.Context, id string) (*http.Response, error)

func (*Client) CreateAgreement

func (c *Client) CreateAgreement(ctx context.Context, body CreateAgreementJSONRequestBody) (*http.Response, error)

func (*Client) CreateAgreementAttachmentExternal

func (c *Client) CreateAgreementAttachmentExternal(ctx context.Context, address string, body CreateAgreementAttachmentExternalJSONRequestBody) (*http.Response, error)

func (*Client) CreateAgreementAttachmentExternalWithBody

func (c *Client) CreateAgreementAttachmentExternalWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateAgreementQuickly

func (c *Client) CreateAgreementQuickly(ctx context.Context, body CreateAgreementQuicklyJSONRequestBody) (*http.Response, error)

func (*Client) CreateAgreementQuicklyWithBody

func (c *Client) CreateAgreementQuicklyWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateAgreementTag

func (c *Client) CreateAgreementTag(ctx context.Context, body CreateAgreementTagJSONRequestBody) (*http.Response, error)

func (*Client) CreateAgreementTagWithBody

func (c *Client) CreateAgreementTagWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateAgreementWithBody

func (c *Client) CreateAgreementWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateCollection

func (c *Client) CreateCollection(ctx context.Context, body CreateCollectionJSONRequestBody) (*http.Response, error)

func (*Client) CreateCollectionWithBody

func (c *Client) CreateCollectionWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateConnectionRequest

func (c *Client) CreateConnectionRequest(ctx context.Context, body CreateConnectionRequestJSONRequestBody) (*http.Response, error)

func (*Client) CreateConnectionRequestWithBody

func (c *Client) CreateConnectionRequestWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateDocument

func (c *Client) CreateDocument(ctx context.Context, params *CreateDocumentParams) (*http.Response, error)

func (*Client) CreateModelWithBody

func (c *Client) CreateModelWithBody(ctx context.Context, params *CreateModelParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateOrganization

func (c *Client) CreateOrganization(ctx context.Context, body CreateOrganizationJSONRequestBody) (*http.Response, error)

func (*Client) CreateOrganizationWithBody

func (c *Client) CreateOrganizationWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateTOSForUser

func (c *Client) CreateTOSForUser(ctx context.Context) (*http.Response, error)

func (*Client) CreateTemplate

func (c *Client) CreateTemplate(ctx context.Context, body CreateTemplateJSONRequestBody) (*http.Response, error)

func (*Client) CreateTemplateDraft

func (c *Client) CreateTemplateDraft(ctx context.Context, body CreateTemplateDraftJSONRequestBody) (*http.Response, error)

func (*Client) CreateTemplateDraftWithBody

func (c *Client) CreateTemplateDraftWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateTemplatePackage

func (c *Client) CreateTemplatePackage(ctx context.Context, body CreateTemplatePackageJSONRequestBody) (*http.Response, error)

func (*Client) CreateTemplatePackageWithBody

func (c *Client) CreateTemplatePackageWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateTemplateWithBody

func (c *Client) CreateTemplateWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateUserWithinAccount

func (c *Client) CreateUserWithinAccount(ctx context.Context, code string, body CreateUserWithinAccountJSONRequestBody) (*http.Response, error)

func (*Client) CreateUserWithinAccountWithBody

func (c *Client) CreateUserWithinAccountWithBody(ctx context.Context, code string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) DeactivateTemplate

func (c *Client) DeactivateTemplate(ctx context.Context, address string) (*http.Response, error)

func (*Client) DeactivateTemplatePackage

func (c *Client) DeactivateTemplatePackage(ctx context.Context, id int32) (*http.Response, error)

func (*Client) DeleteAgreement added in v1.5.8

func (c *Client) DeleteAgreement(ctx context.Context, address string) (*http.Response, error)

func (*Client) DeleteInvitation

func (c *Client) DeleteInvitation(ctx context.Context, code string) (*http.Response, error)

func (*Client) DeleteTag

func (c *Client) DeleteTag(ctx context.Context, id int) (*http.Response, error)

func (*Client) DeleteTemplateDraft

func (c *Client) DeleteTemplateDraft(ctx context.Context, id int32) (*http.Response, error)

func (*Client) DeleteTemplateDraftLock

func (c *Client) DeleteTemplateDraftLock(ctx context.Context, id int32) (*http.Response, error)

func (*Client) DeleteUserFromAccount

func (c *Client) DeleteUserFromAccount(ctx context.Context, address string) (*http.Response, error)

func (*Client) ExportAgreement

func (c *Client) ExportAgreement(ctx context.Context, address string) (*http.Response, error)

func (*Client) ExportAgreementExternal

func (c *Client) ExportAgreementExternal(ctx context.Context, address string) (*http.Response, error)

func (*Client) GetAccountInfo

func (c *Client) GetAccountInfo(ctx context.Context) (*http.Response, error)

func (*Client) GetAgreement

func (c *Client) GetAgreement(ctx context.Context, address string, params *GetAgreementParams) (*http.Response, error)

func (*Client) GetAgreementAttachments

func (c *Client) GetAgreementAttachments(ctx context.Context, address string) (*http.Response, error)

func (*Client) GetAgreementAttachmentsExternal

func (c *Client) GetAgreementAttachmentsExternal(ctx context.Context, address string) (*http.Response, error)

func (*Client) GetAgreementExternal

func (c *Client) GetAgreementExternal(ctx context.Context, params *GetAgreementExternalParams) (*http.Response, error)

func (*Client) GetCollection

func (c *Client) GetCollection(ctx context.Context, id string) (*http.Response, error)

func (*Client) GetCollections

func (c *Client) GetCollections(ctx context.Context) (*http.Response, error)

func (*Client) GetConnections

func (c *Client) GetConnections(ctx context.Context) (*http.Response, error)

func (*Client) GetCountry

func (c *Client) GetCountry(ctx context.Context, alpha2 string) (*http.Response, error)

func (*Client) GetCurrency

func (c *Client) GetCurrency(ctx context.Context, alpha3 string) (*http.Response, error)

func (*Client) GetDocument

func (c *Client) GetDocument(ctx context.Context, params *GetDocumentParams) (*http.Response, error)

func (*Client) GetDrafts added in v1.5.18

func (c *Client) GetDrafts(ctx context.Context) (*http.Response, error)

func (*Client) GetModelApplications

func (c *Client) GetModelApplications(ctx context.Context) (*http.Response, error)

func (*Client) GetModelDiagram

func (c *Client) GetModelDiagram(ctx context.Context, address string) (*http.Response, error)

func (*Client) GetModels

func (c *Client) GetModels(ctx context.Context) (*http.Response, error)

func (*Client) GetOrganization

func (c *Client) GetOrganization(ctx context.Context, address string) (*http.Response, error)

func (*Client) GetParameterType

func (c *Client) GetParameterType(ctx context.Context, id int) (*http.Response, error)

func (*Client) GetProcessDefinition

func (c *Client) GetProcessDefinition(ctx context.Context, address string) (*http.Response, error)

func (*Client) GetProcessDefinitions

func (c *Client) GetProcessDefinitions(ctx context.Context, params *GetProcessDefinitionsParams) (*http.Response, error)

func (*Client) GetRegions

func (c *Client) GetRegions(ctx context.Context, alpha2 string) (*http.Response, error)

func (*Client) GetTask

func (c *Client) GetTask(ctx context.Context, id string) (*http.Response, error)

func (*Client) GetTaskDataMapping

func (c *Client) GetTaskDataMapping(ctx context.Context, id string, dataMappingId int) (*http.Response, error)

func (*Client) GetTaskDataMappings

func (c *Client) GetTaskDataMappings(ctx context.Context, id string) (*http.Response, error)

func (*Client) GetTasks

func (c *Client) GetTasks(ctx context.Context, params *GetTasksParams) (*http.Response, error)

func (*Client) GetTemplate

func (c *Client) GetTemplate(ctx context.Context, address string, params *GetTemplateParams) (*http.Response, error)

func (*Client) GetTemplateDraft

func (c *Client) GetTemplateDraft(ctx context.Context, id int32) (*http.Response, error)

func (*Client) GetTemplateDrafts

func (c *Client) GetTemplateDrafts(ctx context.Context) (*http.Response, error)

func (*Client) GetTemplatePackage

func (c *Client) GetTemplatePackage(ctx context.Context, id int32) (*http.Response, error)

func (*Client) GetTemplatePackages

func (c *Client) GetTemplatePackages(ctx context.Context) (*http.Response, error)

func (*Client) GetTemplateRestrictions

func (c *Client) GetTemplateRestrictions(ctx context.Context, address string, organizationAddress string) (*http.Response, error)

func (*Client) GetTemplates

func (c *Client) GetTemplates(ctx context.Context) (*http.Response, error)

func (*Client) GetUserProfile

func (c *Client) GetUserProfile(ctx context.Context) (*http.Response, error)

func (*Client) InviteNewUser

func (c *Client) InviteNewUser(ctx context.Context, body InviteNewUserJSONRequestBody) (*http.Response, error)

func (*Client) InviteNewUserWithBody

func (c *Client) InviteNewUserWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) ListAgreementTags

func (c *Client) ListAgreementTags(ctx context.Context, params *ListAgreementTagsParams) (*http.Response, error)

func (*Client) ListAgreements added in v1.4.4

func (c *Client) ListAgreements(ctx context.Context) (*http.Response, error)

func (*Client) ListAgreementsByCollaborator

func (c *Client) ListAgreementsByCollaborator(ctx context.Context, params *ListAgreementsByCollaboratorParams) (*http.Response, error)

func (*Client) ListAgreementsByState

func (c *Client) ListAgreementsByState(ctx context.Context) (*http.Response, error)

func (*Client) ListCollectionTypes

func (c *Client) ListCollectionTypes(ctx context.Context) (*http.Response, error)

func (*Client) ListCountries

func (c *Client) ListCountries(ctx context.Context) (*http.Response, error)

func (*Client) ListCurrencies

func (c *Client) ListCurrencies(ctx context.Context) (*http.Response, error)

func (*Client) ListInvitations

func (c *Client) ListInvitations(ctx context.Context) (*http.Response, error)

func (*Client) ListKnownUsers

func (c *Client) ListKnownUsers(ctx context.Context) (*http.Response, error)

func (*Client) ListMyTasks

func (c *Client) ListMyTasks(ctx context.Context) (*http.Response, error)

func (*Client) ListOrganizationalAssets

func (c *Client) ListOrganizationalAssets(ctx context.Context, address string) (*http.Response, error)

func (*Client) ListOrganizations

func (c *Client) ListOrganizations(ctx context.Context, params *ListOrganizationsParams) (*http.Response, error)

func (*Client) ListParameterTypes

func (c *Client) ListParameterTypes(ctx context.Context) (*http.Response, error)

func (*Client) ListTopTemplates

func (c *Client) ListTopTemplates(ctx context.Context, params *ListTopTemplatesParams) (*http.Response, error)

func (*Client) Logout

func (c *Client) Logout(ctx context.Context) (*http.Response, error)

func (*Client) RegisterUser

func (c *Client) RegisterUser(ctx context.Context, body RegisterUserJSONRequestBody) (*http.Response, error)

func (*Client) RegisterUserWithBody

func (c *Client) RegisterUserWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) RemoveApproversFromOrganization

func (c *Client) RemoveApproversFromOrganization(ctx context.Context, address string, userAddress string) (*http.Response, error)

func (*Client) RemoveConnection

func (c *Client) RemoveConnection(ctx context.Context, id int) (*http.Response, error)

func (*Client) RemoveDepartmentFromOrganization

func (c *Client) RemoveDepartmentFromOrganization(ctx context.Context, address string, departmentId string) (*http.Response, error)

func (*Client) RemoveUserFromDepartment

func (c *Client) RemoveUserFromDepartment(ctx context.Context, address string, departmentId string, userAddress string) (*http.Response, error)

func (*Client) RemoveUserFromOrganization

func (c *Client) RemoveUserFromOrganization(ctx context.Context, address string, userAddress string) (*http.Response, error)

func (*Client) RequestPasswordReset

func (c *Client) RequestPasswordReset(ctx context.Context) (*http.Response, error)

func (*Client) ResendTaskEmail

func (c *Client) ResendTaskEmail(ctx context.Context, id string) (*http.Response, error)

func (*Client) SupersedeTemplate

func (c *Client) SupersedeTemplate(ctx context.Context, address string, successor string) (*http.Response, error)

func (*Client) UpdateAgreement

func (c *Client) UpdateAgreement(ctx context.Context, address string, body UpdateAgreementJSONRequestBody) (*http.Response, error)

func (*Client) UpdateAgreementWithAttachment

func (c *Client) UpdateAgreementWithAttachment(ctx context.Context, address string, body UpdateAgreementWithAttachmentJSONRequestBody) (*http.Response, error)

func (*Client) UpdateAgreementWithAttachmentWithBody

func (c *Client) UpdateAgreementWithAttachmentWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateAgreementWithBody

func (c *Client) UpdateAgreementWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateAgreementWithCancellation

func (c *Client) UpdateAgreementWithCancellation(ctx context.Context, address string) (*http.Response, error)

func (*Client) UpdateAgreementWithCancellationExternal

func (c *Client) UpdateAgreementWithCancellationExternal(ctx context.Context, address string) (*http.Response, error)

func (*Client) UpdateAgreementWithSignatureWithBody

func (c *Client) UpdateAgreementWithSignatureWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateCollection

func (c *Client) UpdateCollection(ctx context.Context, body UpdateCollectionJSONRequestBody) (*http.Response, error)

func (*Client) UpdateCollectionWithBody

func (c *Client) UpdateCollectionWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateDepartmentName added in v1.5.0

func (c *Client) UpdateDepartmentName(ctx context.Context, address string, departmentId string, body UpdateDepartmentNameJSONRequestBody) (*http.Response, error)

func (*Client) UpdateDepartmentNameWithBody added in v1.5.0

func (c *Client) UpdateDepartmentNameWithBody(ctx context.Context, address string, departmentId string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateOrganization

func (c *Client) UpdateOrganization(ctx context.Context, address string, body UpdateOrganizationJSONRequestBody) (*http.Response, error)

func (*Client) UpdateOrganizationWithBody

func (c *Client) UpdateOrganizationWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateTag

func (c *Client) UpdateTag(ctx context.Context, id int, body UpdateTagJSONRequestBody) (*http.Response, error)

func (*Client) UpdateTagWithBody

func (c *Client) UpdateTagWithBody(ctx context.Context, id int, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateTaskDataMapping

func (c *Client) UpdateTaskDataMapping(ctx context.Context, id string, dataMappingId int, body UpdateTaskDataMappingJSONRequestBody) (*http.Response, error)

func (*Client) UpdateTaskDataMappingWithBody

func (c *Client) UpdateTaskDataMappingWithBody(ctx context.Context, id string, dataMappingId int, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateTaskDataMappings

func (c *Client) UpdateTaskDataMappings(ctx context.Context, id string, body UpdateTaskDataMappingsJSONRequestBody) (*http.Response, error)

func (*Client) UpdateTaskDataMappingsWithBody

func (c *Client) UpdateTaskDataMappingsWithBody(ctx context.Context, id string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateTemplate

func (c *Client) UpdateTemplate(ctx context.Context, address string, body UpdateTemplateJSONRequestBody) (*http.Response, error)

func (*Client) UpdateTemplateDraft

func (c *Client) UpdateTemplateDraft(ctx context.Context, id int32, body UpdateTemplateDraftJSONRequestBody) (*http.Response, error)

func (*Client) UpdateTemplateDraftWithBody

func (c *Client) UpdateTemplateDraftWithBody(ctx context.Context, id int32, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateTemplatePrice

func (c *Client) UpdateTemplatePrice(ctx context.Context, address string, body UpdateTemplatePriceJSONRequestBody) (*http.Response, error)

func (*Client) UpdateTemplatePriceWithBody

func (c *Client) UpdateTemplatePriceWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateTemplateRestrictions

func (c *Client) UpdateTemplateRestrictions(ctx context.Context, address string, organizationAddress string, body UpdateTemplateRestrictionsJSONRequestBody) (*http.Response, error)

func (*Client) UpdateTemplateRestrictionsWithBody

func (c *Client) UpdateTemplateRestrictionsWithBody(ctx context.Context, address string, organizationAddress string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateTemplateWithBody

func (c *Client) UpdateTemplateWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateUserProfile

func (c *Client) UpdateUserProfile(ctx context.Context, body UpdateUserProfileJSONRequestBody) (*http.Response, error)

func (*Client) UpdateUserProfileWithBody

func (c *Client) UpdateUserProfileWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetCollections request
	GetCollections(ctx context.Context) (*http.Response, error)

	// CreateCollection request  with any body
	CreateCollectionWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateCollection(ctx context.Context, body CreateCollectionJSONRequestBody) (*http.Response, error)

	// UpdateCollection request  with any body
	UpdateCollectionWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	UpdateCollection(ctx context.Context, body UpdateCollectionJSONRequestBody) (*http.Response, error)

	// GetCollection request
	GetCollection(ctx context.Context, id string) (*http.Response, error)

	// ListAgreementTags request
	ListAgreementTags(ctx context.Context, params *ListAgreementTagsParams) (*http.Response, error)

	// CreateAgreementTag request  with any body
	CreateAgreementTagWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateAgreementTag(ctx context.Context, body CreateAgreementTagJSONRequestBody) (*http.Response, error)

	// DeleteTag request
	DeleteTag(ctx context.Context, id int) (*http.Response, error)

	// UpdateTag request  with any body
	UpdateTagWithBody(ctx context.Context, id int, contentType string, body io.Reader) (*http.Response, error)

	UpdateTag(ctx context.Context, id int, body UpdateTagJSONRequestBody) (*http.Response, error)

	// ListAgreements request
	ListAgreements(ctx context.Context) (*http.Response, error)

	// CreateAgreement request  with any body
	CreateAgreementWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateAgreement(ctx context.Context, body CreateAgreementJSONRequestBody) (*http.Response, error)

	// CreateAgreementQuickly request  with any body
	CreateAgreementQuicklyWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateAgreementQuickly(ctx context.Context, body CreateAgreementQuicklyJSONRequestBody) (*http.Response, error)

	// DeleteAgreement request
	DeleteAgreement(ctx context.Context, address string) (*http.Response, error)

	// GetAgreement request
	GetAgreement(ctx context.Context, address string, params *GetAgreementParams) (*http.Response, error)

	// UpdateAgreement request  with any body
	UpdateAgreementWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	UpdateAgreement(ctx context.Context, address string, body UpdateAgreementJSONRequestBody) (*http.Response, error)

	// GetAgreementAttachments request
	GetAgreementAttachments(ctx context.Context, address string) (*http.Response, error)

	// UpdateAgreementWithAttachment request  with any body
	UpdateAgreementWithAttachmentWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	UpdateAgreementWithAttachment(ctx context.Context, address string, body UpdateAgreementWithAttachmentJSONRequestBody) (*http.Response, error)

	// UpdateAgreementWithCancellation request
	UpdateAgreementWithCancellation(ctx context.Context, address string) (*http.Response, error)

	// UpdateAgreementWithSignature request  with any body
	UpdateAgreementWithSignatureWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	// ExportAgreement request
	ExportAgreement(ctx context.Context, address string) (*http.Response, error)

	// GetTemplateDrafts request
	GetTemplateDrafts(ctx context.Context) (*http.Response, error)

	// CreateTemplateDraft request  with any body
	CreateTemplateDraftWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateTemplateDraft(ctx context.Context, body CreateTemplateDraftJSONRequestBody) (*http.Response, error)

	// DeleteTemplateDraft request
	DeleteTemplateDraft(ctx context.Context, id int32) (*http.Response, error)

	// GetTemplateDraft request
	GetTemplateDraft(ctx context.Context, id int32) (*http.Response, error)

	// UpdateTemplateDraft request  with any body
	UpdateTemplateDraftWithBody(ctx context.Context, id int32, contentType string, body io.Reader) (*http.Response, error)

	UpdateTemplateDraft(ctx context.Context, id int32, body UpdateTemplateDraftJSONRequestBody) (*http.Response, error)

	// DeleteTemplateDraftLock request
	DeleteTemplateDraftLock(ctx context.Context, id int32) (*http.Response, error)

	// GetTemplatePackages request
	GetTemplatePackages(ctx context.Context) (*http.Response, error)

	// CreateTemplatePackage request  with any body
	CreateTemplatePackageWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateTemplatePackage(ctx context.Context, body CreateTemplatePackageJSONRequestBody) (*http.Response, error)

	// GetTemplatePackage request
	GetTemplatePackage(ctx context.Context, id int32) (*http.Response, error)

	// ActivateTemplatePackage request
	ActivateTemplatePackage(ctx context.Context, id int32) (*http.Response, error)

	// AddTemplateToPackage request
	AddTemplateToPackage(ctx context.Context, id int32, address string) (*http.Response, error)

	// DeactivateTemplatePackage request
	DeactivateTemplatePackage(ctx context.Context, id int32) (*http.Response, error)

	// GetTemplates request
	GetTemplates(ctx context.Context) (*http.Response, error)

	// CreateTemplate request  with any body
	CreateTemplateWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateTemplate(ctx context.Context, body CreateTemplateJSONRequestBody) (*http.Response, error)

	// GetTemplate request
	GetTemplate(ctx context.Context, address string, params *GetTemplateParams) (*http.Response, error)

	// UpdateTemplate request  with any body
	UpdateTemplateWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	UpdateTemplate(ctx context.Context, address string, body UpdateTemplateJSONRequestBody) (*http.Response, error)

	// ActivateTemplate request
	ActivateTemplate(ctx context.Context, address string) (*http.Response, error)

	// DeactivateTemplate request
	DeactivateTemplate(ctx context.Context, address string) (*http.Response, error)

	// UpdateTemplatePrice request  with any body
	UpdateTemplatePriceWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	UpdateTemplatePrice(ctx context.Context, address string, body UpdateTemplatePriceJSONRequestBody) (*http.Response, error)

	// GetTemplateRestrictions request
	GetTemplateRestrictions(ctx context.Context, address string, organizationAddress string) (*http.Response, error)

	// UpdateTemplateRestrictions request  with any body
	UpdateTemplateRestrictionsWithBody(ctx context.Context, address string, organizationAddress string, contentType string, body io.Reader) (*http.Response, error)

	UpdateTemplateRestrictions(ctx context.Context, address string, organizationAddress string, body UpdateTemplateRestrictionsJSONRequestBody) (*http.Response, error)

	// SupersedeTemplate request
	SupersedeTemplate(ctx context.Context, address string, successor string) (*http.Response, error)

	// GetTasks request
	GetTasks(ctx context.Context, params *GetTasksParams) (*http.Response, error)

	// GetTask request
	GetTask(ctx context.Context, id string) (*http.Response, error)

	// GetTaskDataMappings request
	GetTaskDataMappings(ctx context.Context, id string) (*http.Response, error)

	// UpdateTaskDataMappings request  with any body
	UpdateTaskDataMappingsWithBody(ctx context.Context, id string, contentType string, body io.Reader) (*http.Response, error)

	UpdateTaskDataMappings(ctx context.Context, id string, body UpdateTaskDataMappingsJSONRequestBody) (*http.Response, error)

	// GetTaskDataMapping request
	GetTaskDataMapping(ctx context.Context, id string, dataMappingId int) (*http.Response, error)

	// UpdateTaskDataMapping request  with any body
	UpdateTaskDataMappingWithBody(ctx context.Context, id string, dataMappingId int, contentType string, body io.Reader) (*http.Response, error)

	UpdateTaskDataMapping(ctx context.Context, id string, dataMappingId int, body UpdateTaskDataMappingJSONRequestBody) (*http.Response, error)

	// ResendTaskEmail request
	ResendTaskEmail(ctx context.Context, id string) (*http.Response, error)

	// GetModelApplications request
	GetModelApplications(ctx context.Context) (*http.Response, error)

	// GetProcessDefinitions request
	GetProcessDefinitions(ctx context.Context, params *GetProcessDefinitionsParams) (*http.Response, error)

	// GetProcessDefinition request
	GetProcessDefinition(ctx context.Context, address string) (*http.Response, error)

	// GetModels request
	GetModels(ctx context.Context) (*http.Response, error)

	// CreateModel request  with any body
	CreateModelWithBody(ctx context.Context, params *CreateModelParams, contentType string, body io.Reader) (*http.Response, error)

	// GetModelDiagram request
	GetModelDiagram(ctx context.Context, address string) (*http.Response, error)

	// GetConnections request
	GetConnections(ctx context.Context) (*http.Response, error)

	// CreateConnectionRequest request  with any body
	CreateConnectionRequestWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateConnectionRequest(ctx context.Context, body CreateConnectionRequestJSONRequestBody) (*http.Response, error)

	// RemoveConnection request
	RemoveConnection(ctx context.Context, id int) (*http.Response, error)

	// AcceptConnectionRequest request
	AcceptConnectionRequest(ctx context.Context, id int) (*http.Response, error)

	// ListAgreementsByCollaborator request
	ListAgreementsByCollaborator(ctx context.Context, params *ListAgreementsByCollaboratorParams) (*http.Response, error)

	// ListAgreementsByState request
	ListAgreementsByState(ctx context.Context) (*http.Response, error)

	// ListTopTemplates request
	ListTopTemplates(ctx context.Context, params *ListTopTemplatesParams) (*http.Response, error)

	// GetDocument request
	GetDocument(ctx context.Context, params *GetDocumentParams) (*http.Response, error)

	// CreateDocument request
	CreateDocument(ctx context.Context, params *CreateDocumentParams) (*http.Response, error)

	// AssembleDocumentsForTemplate request
	AssembleDocumentsForTemplate(ctx context.Context, address string, params *AssembleDocumentsForTemplateParams) (*http.Response, error)

	// AssembleDocument request
	AssembleDocument(ctx context.Context, params *AssembleDocumentParams) (*http.Response, error)

	// AssembleDocumentsForAgreementExternal request
	AssembleDocumentsForAgreementExternal(ctx context.Context, address string) (*http.Response, error)

	// AssembleDocumentsForAgreement request
	AssembleDocumentsForAgreement(ctx context.Context, address string) (*http.Response, error)

	// GetDrafts request
	GetDrafts(ctx context.Context) (*http.Response, error)

	// GetAgreementExternal request
	GetAgreementExternal(ctx context.Context, params *GetAgreementExternalParams) (*http.Response, error)

	// GetAgreementAttachmentsExternal request
	GetAgreementAttachmentsExternal(ctx context.Context, address string) (*http.Response, error)

	// CreateAgreementAttachmentExternal request  with any body
	CreateAgreementAttachmentExternalWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	CreateAgreementAttachmentExternal(ctx context.Context, address string, body CreateAgreementAttachmentExternalJSONRequestBody) (*http.Response, error)

	// UpdateAgreementWithCancellationExternal request
	UpdateAgreementWithCancellationExternal(ctx context.Context, address string) (*http.Response, error)

	// ExportAgreementExternal request
	ExportAgreementExternal(ctx context.Context, address string) (*http.Response, error)

	// ListOrganizations request
	ListOrganizations(ctx context.Context, params *ListOrganizationsParams) (*http.Response, error)

	// CreateOrganization request  with any body
	CreateOrganizationWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateOrganization(ctx context.Context, body CreateOrganizationJSONRequestBody) (*http.Response, error)

	// GetOrganization request
	GetOrganization(ctx context.Context, address string) (*http.Response, error)

	// UpdateOrganization request  with any body
	UpdateOrganizationWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	UpdateOrganization(ctx context.Context, address string, body UpdateOrganizationJSONRequestBody) (*http.Response, error)

	// AddApproversToOrganization request  with any body
	AddApproversToOrganizationWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	AddApproversToOrganization(ctx context.Context, address string, body AddApproversToOrganizationJSONRequestBody) (*http.Response, error)

	// RemoveApproversFromOrganization request
	RemoveApproversFromOrganization(ctx context.Context, address string, userAddress string) (*http.Response, error)

	// ListOrganizationalAssets request
	ListOrganizationalAssets(ctx context.Context, address string) (*http.Response, error)

	// AddDepartmentToOrganization request  with any body
	AddDepartmentToOrganizationWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	AddDepartmentToOrganization(ctx context.Context, address string, body AddDepartmentToOrganizationJSONRequestBody) (*http.Response, error)

	// RemoveDepartmentFromOrganization request
	RemoveDepartmentFromOrganization(ctx context.Context, address string, departmentId string) (*http.Response, error)

	// UpdateDepartmentName request  with any body
	UpdateDepartmentNameWithBody(ctx context.Context, address string, departmentId string, contentType string, body io.Reader) (*http.Response, error)

	UpdateDepartmentName(ctx context.Context, address string, departmentId string, body UpdateDepartmentNameJSONRequestBody) (*http.Response, error)

	// AddUserToDepartment request  with any body
	AddUserToDepartmentWithBody(ctx context.Context, address string, departmentId string, contentType string, body io.Reader) (*http.Response, error)

	AddUserToDepartment(ctx context.Context, address string, departmentId string, body AddUserToDepartmentJSONRequestBody) (*http.Response, error)

	// RemoveUserFromDepartment request
	RemoveUserFromDepartment(ctx context.Context, address string, departmentId string, userAddress string) (*http.Response, error)

	// AddUserToOrganization request  with any body
	AddUserToOrganizationWithBody(ctx context.Context, address string, contentType string, body io.Reader) (*http.Response, error)

	AddUserToOrganization(ctx context.Context, address string, body AddUserToOrganizationJSONRequestBody) (*http.Response, error)

	// RemoveUserFromOrganization request
	RemoveUserFromOrganization(ctx context.Context, address string, userAddress string) (*http.Response, error)

	// ListCollectionTypes request
	ListCollectionTypes(ctx context.Context) (*http.Response, error)

	// ListCountries request
	ListCountries(ctx context.Context) (*http.Response, error)

	// GetCountry request
	GetCountry(ctx context.Context, alpha2 string) (*http.Response, error)

	// GetRegions request
	GetRegions(ctx context.Context, alpha2 string) (*http.Response, error)

	// ListCurrencies request
	ListCurrencies(ctx context.Context) (*http.Response, error)

	// GetCurrency request
	GetCurrency(ctx context.Context, alpha3 string) (*http.Response, error)

	// ListParameterTypes request
	ListParameterTypes(ctx context.Context) (*http.Response, error)

	// GetParameterType request
	GetParameterType(ctx context.Context, id int) (*http.Response, error)

	// ListInvitations request
	ListInvitations(ctx context.Context) (*http.Response, error)

	// InviteNewUser request  with any body
	InviteNewUserWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	InviteNewUser(ctx context.Context, body InviteNewUserJSONRequestBody) (*http.Response, error)

	// DeleteInvitation request
	DeleteInvitation(ctx context.Context, code string) (*http.Response, error)

	// CreateUserWithinAccount request  with any body
	CreateUserWithinAccountWithBody(ctx context.Context, code string, contentType string, body io.Reader) (*http.Response, error)

	CreateUserWithinAccount(ctx context.Context, code string, body CreateUserWithinAccountJSONRequestBody) (*http.Response, error)

	// GetAccountInfo request
	GetAccountInfo(ctx context.Context) (*http.Response, error)

	// DeleteUserFromAccount request
	DeleteUserFromAccount(ctx context.Context, address string) (*http.Response, error)

	// ListMyTasks request
	ListMyTasks(ctx context.Context) (*http.Response, error)

	// CompleteTaskExternal request
	CompleteTaskExternal(ctx context.Context, id string) (*http.Response, error)

	// CompleteSigningTaskExternal request  with any body
	CompleteSigningTaskExternalWithBody(ctx context.Context, id string, agreementAddress string, contentType string, body io.Reader) (*http.Response, error)

	// CompleteTask request
	CompleteTask(ctx context.Context, id string) (*http.Response, error)

	// CompleteSigningTask request  with any body
	CompleteSigningTaskWithBody(ctx context.Context, id string, agreementAddress string, contentType string, body io.Reader) (*http.Response, error)

	// ListKnownUsers request
	ListKnownUsers(ctx context.Context) (*http.Response, error)

	// RegisterUser request  with any body
	RegisterUserWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	RegisterUser(ctx context.Context, body RegisterUserJSONRequestBody) (*http.Response, error)

	// Logout request
	Logout(ctx context.Context) (*http.Response, error)

	// RequestPasswordReset request
	RequestPasswordReset(ctx context.Context) (*http.Response, error)

	// GetUserProfile request
	GetUserProfile(ctx context.Context) (*http.Response, error)

	// UpdateUserProfile request  with any body
	UpdateUserProfileWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	UpdateUserProfile(ctx context.Context, body UpdateUserProfileJSONRequestBody) (*http.Response, error)

	// CreateTOSForUser request
	CreateTOSForUser(ctx context.Context) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption added in v1.4.8

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL added in v1.4.8

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient added in v1.4.8

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn added in v1.4.8

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) AcceptConnectionRequestWithResponse

func (c *ClientWithResponses) AcceptConnectionRequestWithResponse(ctx context.Context, id int) (*acceptConnectionRequestResponse, error)

AcceptConnectionRequestWithResponse request returning *AcceptConnectionRequestResponse

func (*ClientWithResponses) ActivateTemplatePackageWithResponse

func (c *ClientWithResponses) ActivateTemplatePackageWithResponse(ctx context.Context, id int32) (*activateTemplatePackageResponse, error)

ActivateTemplatePackageWithResponse request returning *ActivateTemplatePackageResponse

func (*ClientWithResponses) ActivateTemplateWithResponse

func (c *ClientWithResponses) ActivateTemplateWithResponse(ctx context.Context, address string) (*activateTemplateResponse, error)

ActivateTemplateWithResponse request returning *ActivateTemplateResponse

func (*ClientWithResponses) AddApproversToOrganizationWithBodyWithResponse

func (c *ClientWithResponses) AddApproversToOrganizationWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*addApproversToOrganizationResponse, error)

AddApproversToOrganizationWithBodyWithResponse request with arbitrary body returning *AddApproversToOrganizationResponse

func (*ClientWithResponses) AddApproversToOrganizationWithResponse

func (c *ClientWithResponses) AddApproversToOrganizationWithResponse(ctx context.Context, address string, body AddApproversToOrganizationJSONRequestBody) (*addApproversToOrganizationResponse, error)

func (*ClientWithResponses) AddDepartmentToOrganizationWithBodyWithResponse

func (c *ClientWithResponses) AddDepartmentToOrganizationWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*addDepartmentToOrganizationResponse, error)

AddDepartmentToOrganizationWithBodyWithResponse request with arbitrary body returning *AddDepartmentToOrganizationResponse

func (*ClientWithResponses) AddDepartmentToOrganizationWithResponse

func (c *ClientWithResponses) AddDepartmentToOrganizationWithResponse(ctx context.Context, address string, body AddDepartmentToOrganizationJSONRequestBody) (*addDepartmentToOrganizationResponse, error)

func (*ClientWithResponses) AddTemplateToPackageWithResponse

func (c *ClientWithResponses) AddTemplateToPackageWithResponse(ctx context.Context, id int32, address string) (*addTemplateToPackageResponse, error)

AddTemplateToPackageWithResponse request returning *AddTemplateToPackageResponse

func (*ClientWithResponses) AddUserToDepartmentWithBodyWithResponse

func (c *ClientWithResponses) AddUserToDepartmentWithBodyWithResponse(ctx context.Context, address string, departmentId string, contentType string, body io.Reader) (*addUserToDepartmentResponse, error)

AddUserToDepartmentWithBodyWithResponse request with arbitrary body returning *AddUserToDepartmentResponse

func (*ClientWithResponses) AddUserToDepartmentWithResponse

func (c *ClientWithResponses) AddUserToDepartmentWithResponse(ctx context.Context, address string, departmentId string, body AddUserToDepartmentJSONRequestBody) (*addUserToDepartmentResponse, error)

func (*ClientWithResponses) AddUserToOrganizationWithBodyWithResponse

func (c *ClientWithResponses) AddUserToOrganizationWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*addUserToOrganizationResponse, error)

AddUserToOrganizationWithBodyWithResponse request with arbitrary body returning *AddUserToOrganizationResponse

func (*ClientWithResponses) AddUserToOrganizationWithResponse

func (c *ClientWithResponses) AddUserToOrganizationWithResponse(ctx context.Context, address string, body AddUserToOrganizationJSONRequestBody) (*addUserToOrganizationResponse, error)

func (*ClientWithResponses) AssembleDocumentWithResponse

func (c *ClientWithResponses) AssembleDocumentWithResponse(ctx context.Context, params *AssembleDocumentParams) (*assembleDocumentResponse, error)

AssembleDocumentWithResponse request returning *AssembleDocumentResponse

func (*ClientWithResponses) AssembleDocumentsForAgreementExternalWithResponse

func (c *ClientWithResponses) AssembleDocumentsForAgreementExternalWithResponse(ctx context.Context, address string) (*assembleDocumentsForAgreementExternalResponse, error)

AssembleDocumentsForAgreementExternalWithResponse request returning *AssembleDocumentsForAgreementExternalResponse

func (*ClientWithResponses) AssembleDocumentsForAgreementWithResponse

func (c *ClientWithResponses) AssembleDocumentsForAgreementWithResponse(ctx context.Context, address string) (*assembleDocumentsForAgreementResponse, error)

AssembleDocumentsForAgreementWithResponse request returning *AssembleDocumentsForAgreementResponse

func (*ClientWithResponses) AssembleDocumentsForTemplateWithResponse

func (c *ClientWithResponses) AssembleDocumentsForTemplateWithResponse(ctx context.Context, address string, params *AssembleDocumentsForTemplateParams) (*assembleDocumentsForTemplateResponse, error)

AssembleDocumentsForTemplateWithResponse request returning *AssembleDocumentsForTemplateResponse

func (*ClientWithResponses) CompleteSigningTaskExternalWithBodyWithResponse added in v1.5.21

func (c *ClientWithResponses) CompleteSigningTaskExternalWithBodyWithResponse(ctx context.Context, id string, agreementAddress string, contentType string, body io.Reader) (*completeSigningTaskExternalResponse, error)

CompleteSigningTaskExternalWithBodyWithResponse request with arbitrary body returning *CompleteSigningTaskExternalResponse

func (*ClientWithResponses) CompleteSigningTaskWithBodyWithResponse added in v1.5.8

func (c *ClientWithResponses) CompleteSigningTaskWithBodyWithResponse(ctx context.Context, id string, agreementAddress string, contentType string, body io.Reader) (*completeSigningTaskResponse, error)

CompleteSigningTaskWithBodyWithResponse request with arbitrary body returning *CompleteSigningTaskResponse

func (*ClientWithResponses) CompleteTaskExternalWithResponse

func (c *ClientWithResponses) CompleteTaskExternalWithResponse(ctx context.Context, id string) (*completeTaskExternalResponse, error)

CompleteTaskExternalWithResponse request returning *CompleteTaskExternalResponse

func (*ClientWithResponses) CompleteTaskWithResponse

func (c *ClientWithResponses) CompleteTaskWithResponse(ctx context.Context, id string) (*completeTaskResponse, error)

CompleteTaskWithResponse request returning *CompleteTaskResponse

func (*ClientWithResponses) CreateAgreementAttachmentExternalWithBodyWithResponse

func (c *ClientWithResponses) CreateAgreementAttachmentExternalWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*createAgreementAttachmentExternalResponse, error)

CreateAgreementAttachmentExternalWithBodyWithResponse request with arbitrary body returning *CreateAgreementAttachmentExternalResponse

func (*ClientWithResponses) CreateAgreementAttachmentExternalWithResponse

func (c *ClientWithResponses) CreateAgreementAttachmentExternalWithResponse(ctx context.Context, address string, body CreateAgreementAttachmentExternalJSONRequestBody) (*createAgreementAttachmentExternalResponse, error)

func (*ClientWithResponses) CreateAgreementQuicklyWithBodyWithResponse

func (c *ClientWithResponses) CreateAgreementQuicklyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createAgreementQuicklyResponse, error)

CreateAgreementQuicklyWithBodyWithResponse request with arbitrary body returning *CreateAgreementQuicklyResponse

func (*ClientWithResponses) CreateAgreementQuicklyWithResponse

func (c *ClientWithResponses) CreateAgreementQuicklyWithResponse(ctx context.Context, body CreateAgreementQuicklyJSONRequestBody) (*createAgreementQuicklyResponse, error)

func (*ClientWithResponses) CreateAgreementTagWithBodyWithResponse

func (c *ClientWithResponses) CreateAgreementTagWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createAgreementTagResponse, error)

CreateAgreementTagWithBodyWithResponse request with arbitrary body returning *CreateAgreementTagResponse

func (*ClientWithResponses) CreateAgreementTagWithResponse

func (c *ClientWithResponses) CreateAgreementTagWithResponse(ctx context.Context, body CreateAgreementTagJSONRequestBody) (*createAgreementTagResponse, error)

func (*ClientWithResponses) CreateAgreementWithBodyWithResponse

func (c *ClientWithResponses) CreateAgreementWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createAgreementResponse, error)

CreateAgreementWithBodyWithResponse request with arbitrary body returning *CreateAgreementResponse

func (*ClientWithResponses) CreateAgreementWithResponse

func (c *ClientWithResponses) CreateAgreementWithResponse(ctx context.Context, body CreateAgreementJSONRequestBody) (*createAgreementResponse, error)

func (*ClientWithResponses) CreateCollectionWithBodyWithResponse

func (c *ClientWithResponses) CreateCollectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createCollectionResponse, error)

CreateCollectionWithBodyWithResponse request with arbitrary body returning *CreateCollectionResponse

func (*ClientWithResponses) CreateCollectionWithResponse

func (c *ClientWithResponses) CreateCollectionWithResponse(ctx context.Context, body CreateCollectionJSONRequestBody) (*createCollectionResponse, error)

func (*ClientWithResponses) CreateConnectionRequestWithBodyWithResponse

func (c *ClientWithResponses) CreateConnectionRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createConnectionRequestResponse, error)

CreateConnectionRequestWithBodyWithResponse request with arbitrary body returning *CreateConnectionRequestResponse

func (*ClientWithResponses) CreateConnectionRequestWithResponse

func (c *ClientWithResponses) CreateConnectionRequestWithResponse(ctx context.Context, body CreateConnectionRequestJSONRequestBody) (*createConnectionRequestResponse, error)

func (*ClientWithResponses) CreateDocumentWithResponse

func (c *ClientWithResponses) CreateDocumentWithResponse(ctx context.Context, params *CreateDocumentParams) (*createDocumentResponse, error)

CreateDocumentWithResponse request returning *CreateDocumentResponse

func (*ClientWithResponses) CreateModelWithBodyWithResponse

func (c *ClientWithResponses) CreateModelWithBodyWithResponse(ctx context.Context, params *CreateModelParams, contentType string, body io.Reader) (*createModelResponse, error)

CreateModelWithBodyWithResponse request with arbitrary body returning *CreateModelResponse

func (*ClientWithResponses) CreateOrganizationWithBodyWithResponse

func (c *ClientWithResponses) CreateOrganizationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createOrganizationResponse, error)

CreateOrganizationWithBodyWithResponse request with arbitrary body returning *CreateOrganizationResponse

func (*ClientWithResponses) CreateOrganizationWithResponse

func (c *ClientWithResponses) CreateOrganizationWithResponse(ctx context.Context, body CreateOrganizationJSONRequestBody) (*createOrganizationResponse, error)

func (*ClientWithResponses) CreateTOSForUserWithResponse

func (c *ClientWithResponses) CreateTOSForUserWithResponse(ctx context.Context) (*createTOSForUserResponse, error)

CreateTOSForUserWithResponse request returning *CreateTOSForUserResponse

func (*ClientWithResponses) CreateTemplateDraftWithBodyWithResponse

func (c *ClientWithResponses) CreateTemplateDraftWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createTemplateDraftResponse, error)

CreateTemplateDraftWithBodyWithResponse request with arbitrary body returning *CreateTemplateDraftResponse

func (*ClientWithResponses) CreateTemplateDraftWithResponse

func (c *ClientWithResponses) CreateTemplateDraftWithResponse(ctx context.Context, body CreateTemplateDraftJSONRequestBody) (*createTemplateDraftResponse, error)

func (*ClientWithResponses) CreateTemplatePackageWithBodyWithResponse

func (c *ClientWithResponses) CreateTemplatePackageWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createTemplatePackageResponse, error)

CreateTemplatePackageWithBodyWithResponse request with arbitrary body returning *CreateTemplatePackageResponse

func (*ClientWithResponses) CreateTemplatePackageWithResponse

func (c *ClientWithResponses) CreateTemplatePackageWithResponse(ctx context.Context, body CreateTemplatePackageJSONRequestBody) (*createTemplatePackageResponse, error)

func (*ClientWithResponses) CreateTemplateWithBodyWithResponse

func (c *ClientWithResponses) CreateTemplateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*createTemplateResponse, error)

CreateTemplateWithBodyWithResponse request with arbitrary body returning *CreateTemplateResponse

func (*ClientWithResponses) CreateTemplateWithResponse

func (c *ClientWithResponses) CreateTemplateWithResponse(ctx context.Context, body CreateTemplateJSONRequestBody) (*createTemplateResponse, error)

func (*ClientWithResponses) CreateUserWithinAccountWithBodyWithResponse

func (c *ClientWithResponses) CreateUserWithinAccountWithBodyWithResponse(ctx context.Context, code string, contentType string, body io.Reader) (*createUserWithinAccountResponse, error)

CreateUserWithinAccountWithBodyWithResponse request with arbitrary body returning *CreateUserWithinAccountResponse

func (*ClientWithResponses) CreateUserWithinAccountWithResponse

func (c *ClientWithResponses) CreateUserWithinAccountWithResponse(ctx context.Context, code string, body CreateUserWithinAccountJSONRequestBody) (*createUserWithinAccountResponse, error)

func (*ClientWithResponses) DeactivateTemplatePackageWithResponse

func (c *ClientWithResponses) DeactivateTemplatePackageWithResponse(ctx context.Context, id int32) (*deactivateTemplatePackageResponse, error)

DeactivateTemplatePackageWithResponse request returning *DeactivateTemplatePackageResponse

func (*ClientWithResponses) DeactivateTemplateWithResponse

func (c *ClientWithResponses) DeactivateTemplateWithResponse(ctx context.Context, address string) (*deactivateTemplateResponse, error)

DeactivateTemplateWithResponse request returning *DeactivateTemplateResponse

func (*ClientWithResponses) DeleteAgreementWithResponse added in v1.5.8

func (c *ClientWithResponses) DeleteAgreementWithResponse(ctx context.Context, address string) (*deleteAgreementResponse, error)

DeleteAgreementWithResponse request returning *DeleteAgreementResponse

func (*ClientWithResponses) DeleteInvitationWithResponse

func (c *ClientWithResponses) DeleteInvitationWithResponse(ctx context.Context, code string) (*deleteInvitationResponse, error)

DeleteInvitationWithResponse request returning *DeleteInvitationResponse

func (*ClientWithResponses) DeleteTagWithResponse

func (c *ClientWithResponses) DeleteTagWithResponse(ctx context.Context, id int) (*deleteTagResponse, error)

DeleteTagWithResponse request returning *DeleteTagResponse

func (*ClientWithResponses) DeleteTemplateDraftLockWithResponse

func (c *ClientWithResponses) DeleteTemplateDraftLockWithResponse(ctx context.Context, id int32) (*deleteTemplateDraftLockResponse, error)

DeleteTemplateDraftLockWithResponse request returning *DeleteTemplateDraftLockResponse

func (*ClientWithResponses) DeleteTemplateDraftWithResponse

func (c *ClientWithResponses) DeleteTemplateDraftWithResponse(ctx context.Context, id int32) (*deleteTemplateDraftResponse, error)

DeleteTemplateDraftWithResponse request returning *DeleteTemplateDraftResponse

func (*ClientWithResponses) DeleteUserFromAccountWithResponse

func (c *ClientWithResponses) DeleteUserFromAccountWithResponse(ctx context.Context, address string) (*deleteUserFromAccountResponse, error)

DeleteUserFromAccountWithResponse request returning *DeleteUserFromAccountResponse

func (*ClientWithResponses) ExportAgreementExternalWithResponse

func (c *ClientWithResponses) ExportAgreementExternalWithResponse(ctx context.Context, address string) (*exportAgreementExternalResponse, error)

ExportAgreementExternalWithResponse request returning *ExportAgreementExternalResponse

func (*ClientWithResponses) ExportAgreementWithResponse

func (c *ClientWithResponses) ExportAgreementWithResponse(ctx context.Context, address string) (*exportAgreementResponse, error)

ExportAgreementWithResponse request returning *ExportAgreementResponse

func (*ClientWithResponses) GetAccountInfoWithResponse

func (c *ClientWithResponses) GetAccountInfoWithResponse(ctx context.Context) (*getAccountInfoResponse, error)

GetAccountInfoWithResponse request returning *GetAccountInfoResponse

func (*ClientWithResponses) GetAgreementAttachmentsExternalWithResponse

func (c *ClientWithResponses) GetAgreementAttachmentsExternalWithResponse(ctx context.Context, address string) (*getAgreementAttachmentsExternalResponse, error)

GetAgreementAttachmentsExternalWithResponse request returning *GetAgreementAttachmentsExternalResponse

func (*ClientWithResponses) GetAgreementAttachmentsWithResponse

func (c *ClientWithResponses) GetAgreementAttachmentsWithResponse(ctx context.Context, address string) (*getAgreementAttachmentsResponse, error)

GetAgreementAttachmentsWithResponse request returning *GetAgreementAttachmentsResponse

func (*ClientWithResponses) GetAgreementExternalWithResponse

func (c *ClientWithResponses) GetAgreementExternalWithResponse(ctx context.Context, params *GetAgreementExternalParams) (*getAgreementExternalResponse, error)

GetAgreementExternalWithResponse request returning *GetAgreementExternalResponse

func (*ClientWithResponses) GetAgreementWithResponse

func (c *ClientWithResponses) GetAgreementWithResponse(ctx context.Context, address string, params *GetAgreementParams) (*getAgreementResponse, error)

GetAgreementWithResponse request returning *GetAgreementResponse

func (*ClientWithResponses) GetCollectionWithResponse

func (c *ClientWithResponses) GetCollectionWithResponse(ctx context.Context, id string) (*getCollectionResponse, error)

GetCollectionWithResponse request returning *GetCollectionResponse

func (*ClientWithResponses) GetCollectionsWithResponse

func (c *ClientWithResponses) GetCollectionsWithResponse(ctx context.Context) (*getCollectionsResponse, error)

GetCollectionsWithResponse request returning *GetCollectionsResponse

func (*ClientWithResponses) GetConnectionsWithResponse

func (c *ClientWithResponses) GetConnectionsWithResponse(ctx context.Context) (*getConnectionsResponse, error)

GetConnectionsWithResponse request returning *GetConnectionsResponse

func (*ClientWithResponses) GetCountryWithResponse

func (c *ClientWithResponses) GetCountryWithResponse(ctx context.Context, alpha2 string) (*getCountryResponse, error)

GetCountryWithResponse request returning *GetCountryResponse

func (*ClientWithResponses) GetCurrencyWithResponse

func (c *ClientWithResponses) GetCurrencyWithResponse(ctx context.Context, alpha3 string) (*getCurrencyResponse, error)

GetCurrencyWithResponse request returning *GetCurrencyResponse

func (*ClientWithResponses) GetDocumentWithResponse

func (c *ClientWithResponses) GetDocumentWithResponse(ctx context.Context, params *GetDocumentParams) (*getDocumentResponse, error)

GetDocumentWithResponse request returning *GetDocumentResponse

func (*ClientWithResponses) GetDraftsWithResponse added in v1.5.18

func (c *ClientWithResponses) GetDraftsWithResponse(ctx context.Context) (*getDraftsResponse, error)

GetDraftsWithResponse request returning *GetDraftsResponse

func (*ClientWithResponses) GetModelApplicationsWithResponse

func (c *ClientWithResponses) GetModelApplicationsWithResponse(ctx context.Context) (*getModelApplicationsResponse, error)

GetModelApplicationsWithResponse request returning *GetModelApplicationsResponse

func (*ClientWithResponses) GetModelDiagramWithResponse

func (c *ClientWithResponses) GetModelDiagramWithResponse(ctx context.Context, address string) (*getModelDiagramResponse, error)

GetModelDiagramWithResponse request returning *GetModelDiagramResponse

func (*ClientWithResponses) GetModelsWithResponse

func (c *ClientWithResponses) GetModelsWithResponse(ctx context.Context) (*getModelsResponse, error)

GetModelsWithResponse request returning *GetModelsResponse

func (*ClientWithResponses) GetOrganizationWithResponse

func (c *ClientWithResponses) GetOrganizationWithResponse(ctx context.Context, address string) (*getOrganizationResponse, error)

GetOrganizationWithResponse request returning *GetOrganizationResponse

func (*ClientWithResponses) GetParameterTypeWithResponse

func (c *ClientWithResponses) GetParameterTypeWithResponse(ctx context.Context, id int) (*getParameterTypeResponse, error)

GetParameterTypeWithResponse request returning *GetParameterTypeResponse

func (*ClientWithResponses) GetProcessDefinitionWithResponse

func (c *ClientWithResponses) GetProcessDefinitionWithResponse(ctx context.Context, address string) (*getProcessDefinitionResponse, error)

GetProcessDefinitionWithResponse request returning *GetProcessDefinitionResponse

func (*ClientWithResponses) GetProcessDefinitionsWithResponse

func (c *ClientWithResponses) GetProcessDefinitionsWithResponse(ctx context.Context, params *GetProcessDefinitionsParams) (*getProcessDefinitionsResponse, error)

GetProcessDefinitionsWithResponse request returning *GetProcessDefinitionsResponse

func (*ClientWithResponses) GetRegionsWithResponse

func (c *ClientWithResponses) GetRegionsWithResponse(ctx context.Context, alpha2 string) (*getRegionsResponse, error)

GetRegionsWithResponse request returning *GetRegionsResponse

func (*ClientWithResponses) GetTaskDataMappingWithResponse

func (c *ClientWithResponses) GetTaskDataMappingWithResponse(ctx context.Context, id string, dataMappingId int) (*getTaskDataMappingResponse, error)

GetTaskDataMappingWithResponse request returning *GetTaskDataMappingResponse

func (*ClientWithResponses) GetTaskDataMappingsWithResponse

func (c *ClientWithResponses) GetTaskDataMappingsWithResponse(ctx context.Context, id string) (*getTaskDataMappingsResponse, error)

GetTaskDataMappingsWithResponse request returning *GetTaskDataMappingsResponse

func (*ClientWithResponses) GetTaskWithResponse

func (c *ClientWithResponses) GetTaskWithResponse(ctx context.Context, id string) (*getTaskResponse, error)

GetTaskWithResponse request returning *GetTaskResponse

func (*ClientWithResponses) GetTasksWithResponse

func (c *ClientWithResponses) GetTasksWithResponse(ctx context.Context, params *GetTasksParams) (*getTasksResponse, error)

GetTasksWithResponse request returning *GetTasksResponse

func (*ClientWithResponses) GetTemplateDraftWithResponse

func (c *ClientWithResponses) GetTemplateDraftWithResponse(ctx context.Context, id int32) (*getTemplateDraftResponse, error)

GetTemplateDraftWithResponse request returning *GetTemplateDraftResponse

func (*ClientWithResponses) GetTemplateDraftsWithResponse

func (c *ClientWithResponses) GetTemplateDraftsWithResponse(ctx context.Context) (*getTemplateDraftsResponse, error)

GetTemplateDraftsWithResponse request returning *GetTemplateDraftsResponse

func (*ClientWithResponses) GetTemplatePackageWithResponse

func (c *ClientWithResponses) GetTemplatePackageWithResponse(ctx context.Context, id int32) (*getTemplatePackageResponse, error)

GetTemplatePackageWithResponse request returning *GetTemplatePackageResponse

func (*ClientWithResponses) GetTemplatePackagesWithResponse

func (c *ClientWithResponses) GetTemplatePackagesWithResponse(ctx context.Context) (*getTemplatePackagesResponse, error)

GetTemplatePackagesWithResponse request returning *GetTemplatePackagesResponse

func (*ClientWithResponses) GetTemplateRestrictionsWithResponse

func (c *ClientWithResponses) GetTemplateRestrictionsWithResponse(ctx context.Context, address string, organizationAddress string) (*getTemplateRestrictionsResponse, error)

GetTemplateRestrictionsWithResponse request returning *GetTemplateRestrictionsResponse

func (*ClientWithResponses) GetTemplateWithResponse

func (c *ClientWithResponses) GetTemplateWithResponse(ctx context.Context, address string, params *GetTemplateParams) (*getTemplateResponse, error)

GetTemplateWithResponse request returning *GetTemplateResponse

func (*ClientWithResponses) GetTemplatesWithResponse

func (c *ClientWithResponses) GetTemplatesWithResponse(ctx context.Context) (*getTemplatesResponse, error)

GetTemplatesWithResponse request returning *GetTemplatesResponse

func (*ClientWithResponses) GetUserProfileWithResponse

func (c *ClientWithResponses) GetUserProfileWithResponse(ctx context.Context) (*getUserProfileResponse, error)

GetUserProfileWithResponse request returning *GetUserProfileResponse

func (*ClientWithResponses) InviteNewUserWithBodyWithResponse

func (c *ClientWithResponses) InviteNewUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*inviteNewUserResponse, error)

InviteNewUserWithBodyWithResponse request with arbitrary body returning *InviteNewUserResponse

func (*ClientWithResponses) InviteNewUserWithResponse

func (c *ClientWithResponses) InviteNewUserWithResponse(ctx context.Context, body InviteNewUserJSONRequestBody) (*inviteNewUserResponse, error)

func (*ClientWithResponses) ListAgreementTagsWithResponse

func (c *ClientWithResponses) ListAgreementTagsWithResponse(ctx context.Context, params *ListAgreementTagsParams) (*listAgreementTagsResponse, error)

ListAgreementTagsWithResponse request returning *ListAgreementTagsResponse

func (*ClientWithResponses) ListAgreementsByCollaboratorWithResponse

func (c *ClientWithResponses) ListAgreementsByCollaboratorWithResponse(ctx context.Context, params *ListAgreementsByCollaboratorParams) (*listAgreementsByCollaboratorResponse, error)

ListAgreementsByCollaboratorWithResponse request returning *ListAgreementsByCollaboratorResponse

func (*ClientWithResponses) ListAgreementsByStateWithResponse

func (c *ClientWithResponses) ListAgreementsByStateWithResponse(ctx context.Context) (*listAgreementsByStateResponse, error)

ListAgreementsByStateWithResponse request returning *ListAgreementsByStateResponse

func (*ClientWithResponses) ListAgreementsWithResponse added in v1.4.4

func (c *ClientWithResponses) ListAgreementsWithResponse(ctx context.Context) (*listAgreementsResponse, error)

ListAgreementsWithResponse request returning *ListAgreementsResponse

func (*ClientWithResponses) ListCollectionTypesWithResponse

func (c *ClientWithResponses) ListCollectionTypesWithResponse(ctx context.Context) (*listCollectionTypesResponse, error)

ListCollectionTypesWithResponse request returning *ListCollectionTypesResponse

func (*ClientWithResponses) ListCountriesWithResponse

func (c *ClientWithResponses) ListCountriesWithResponse(ctx context.Context) (*listCountriesResponse, error)

ListCountriesWithResponse request returning *ListCountriesResponse

func (*ClientWithResponses) ListCurrenciesWithResponse

func (c *ClientWithResponses) ListCurrenciesWithResponse(ctx context.Context) (*listCurrenciesResponse, error)

ListCurrenciesWithResponse request returning *ListCurrenciesResponse

func (*ClientWithResponses) ListInvitationsWithResponse

func (c *ClientWithResponses) ListInvitationsWithResponse(ctx context.Context) (*listInvitationsResponse, error)

ListInvitationsWithResponse request returning *ListInvitationsResponse

func (*ClientWithResponses) ListKnownUsersWithResponse

func (c *ClientWithResponses) ListKnownUsersWithResponse(ctx context.Context) (*listKnownUsersResponse, error)

ListKnownUsersWithResponse request returning *ListKnownUsersResponse

func (*ClientWithResponses) ListMyTasksWithResponse

func (c *ClientWithResponses) ListMyTasksWithResponse(ctx context.Context) (*listMyTasksResponse, error)

ListMyTasksWithResponse request returning *ListMyTasksResponse

func (*ClientWithResponses) ListOrganizationalAssetsWithResponse

func (c *ClientWithResponses) ListOrganizationalAssetsWithResponse(ctx context.Context, address string) (*listOrganizationalAssetsResponse, error)

ListOrganizationalAssetsWithResponse request returning *ListOrganizationalAssetsResponse

func (*ClientWithResponses) ListOrganizationsWithResponse

func (c *ClientWithResponses) ListOrganizationsWithResponse(ctx context.Context, params *ListOrganizationsParams) (*listOrganizationsResponse, error)

ListOrganizationsWithResponse request returning *ListOrganizationsResponse

func (*ClientWithResponses) ListParameterTypesWithResponse

func (c *ClientWithResponses) ListParameterTypesWithResponse(ctx context.Context) (*listParameterTypesResponse, error)

ListParameterTypesWithResponse request returning *ListParameterTypesResponse

func (*ClientWithResponses) ListTopTemplatesWithResponse

func (c *ClientWithResponses) ListTopTemplatesWithResponse(ctx context.Context, params *ListTopTemplatesParams) (*listTopTemplatesResponse, error)

ListTopTemplatesWithResponse request returning *ListTopTemplatesResponse

func (*ClientWithResponses) LogoutWithResponse

func (c *ClientWithResponses) LogoutWithResponse(ctx context.Context) (*logoutResponse, error)

LogoutWithResponse request returning *LogoutResponse

func (*ClientWithResponses) RegisterUserWithBodyWithResponse

func (c *ClientWithResponses) RegisterUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*registerUserResponse, error)

RegisterUserWithBodyWithResponse request with arbitrary body returning *RegisterUserResponse

func (*ClientWithResponses) RegisterUserWithResponse

func (c *ClientWithResponses) RegisterUserWithResponse(ctx context.Context, body RegisterUserJSONRequestBody) (*registerUserResponse, error)

func (*ClientWithResponses) RemoveApproversFromOrganizationWithResponse

func (c *ClientWithResponses) RemoveApproversFromOrganizationWithResponse(ctx context.Context, address string, userAddress string) (*removeApproversFromOrganizationResponse, error)

RemoveApproversFromOrganizationWithResponse request returning *RemoveApproversFromOrganizationResponse

func (*ClientWithResponses) RemoveConnectionWithResponse

func (c *ClientWithResponses) RemoveConnectionWithResponse(ctx context.Context, id int) (*removeConnectionResponse, error)

RemoveConnectionWithResponse request returning *RemoveConnectionResponse

func (*ClientWithResponses) RemoveDepartmentFromOrganizationWithResponse

func (c *ClientWithResponses) RemoveDepartmentFromOrganizationWithResponse(ctx context.Context, address string, departmentId string) (*removeDepartmentFromOrganizationResponse, error)

RemoveDepartmentFromOrganizationWithResponse request returning *RemoveDepartmentFromOrganizationResponse

func (*ClientWithResponses) RemoveUserFromDepartmentWithResponse

func (c *ClientWithResponses) RemoveUserFromDepartmentWithResponse(ctx context.Context, address string, departmentId string, userAddress string) (*removeUserFromDepartmentResponse, error)

RemoveUserFromDepartmentWithResponse request returning *RemoveUserFromDepartmentResponse

func (*ClientWithResponses) RemoveUserFromOrganizationWithResponse

func (c *ClientWithResponses) RemoveUserFromOrganizationWithResponse(ctx context.Context, address string, userAddress string) (*removeUserFromOrganizationResponse, error)

RemoveUserFromOrganizationWithResponse request returning *RemoveUserFromOrganizationResponse

func (*ClientWithResponses) RequestPasswordResetWithResponse

func (c *ClientWithResponses) RequestPasswordResetWithResponse(ctx context.Context) (*requestPasswordResetResponse, error)

RequestPasswordResetWithResponse request returning *RequestPasswordResetResponse

func (*ClientWithResponses) ResendTaskEmailWithResponse

func (c *ClientWithResponses) ResendTaskEmailWithResponse(ctx context.Context, id string) (*resendTaskEmailResponse, error)

ResendTaskEmailWithResponse request returning *ResendTaskEmailResponse

func (*ClientWithResponses) SupersedeTemplateWithResponse

func (c *ClientWithResponses) SupersedeTemplateWithResponse(ctx context.Context, address string, successor string) (*supersedeTemplateResponse, error)

SupersedeTemplateWithResponse request returning *SupersedeTemplateResponse

func (*ClientWithResponses) UpdateAgreementWithAttachmentWithBodyWithResponse

func (c *ClientWithResponses) UpdateAgreementWithAttachmentWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*updateAgreementWithAttachmentResponse, error)

UpdateAgreementWithAttachmentWithBodyWithResponse request with arbitrary body returning *UpdateAgreementWithAttachmentResponse

func (*ClientWithResponses) UpdateAgreementWithAttachmentWithResponse

func (c *ClientWithResponses) UpdateAgreementWithAttachmentWithResponse(ctx context.Context, address string, body UpdateAgreementWithAttachmentJSONRequestBody) (*updateAgreementWithAttachmentResponse, error)

func (*ClientWithResponses) UpdateAgreementWithBodyWithResponse

func (c *ClientWithResponses) UpdateAgreementWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*updateAgreementResponse, error)

UpdateAgreementWithBodyWithResponse request with arbitrary body returning *UpdateAgreementResponse

func (*ClientWithResponses) UpdateAgreementWithCancellationExternalWithResponse

func (c *ClientWithResponses) UpdateAgreementWithCancellationExternalWithResponse(ctx context.Context, address string) (*updateAgreementWithCancellationExternalResponse, error)

UpdateAgreementWithCancellationExternalWithResponse request returning *UpdateAgreementWithCancellationExternalResponse

func (*ClientWithResponses) UpdateAgreementWithCancellationWithResponse

func (c *ClientWithResponses) UpdateAgreementWithCancellationWithResponse(ctx context.Context, address string) (*updateAgreementWithCancellationResponse, error)

UpdateAgreementWithCancellationWithResponse request returning *UpdateAgreementWithCancellationResponse

func (*ClientWithResponses) UpdateAgreementWithResponse

func (c *ClientWithResponses) UpdateAgreementWithResponse(ctx context.Context, address string, body UpdateAgreementJSONRequestBody) (*updateAgreementResponse, error)

func (*ClientWithResponses) UpdateAgreementWithSignatureWithBodyWithResponse

func (c *ClientWithResponses) UpdateAgreementWithSignatureWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*updateAgreementWithSignatureResponse, error)

UpdateAgreementWithSignatureWithBodyWithResponse request with arbitrary body returning *UpdateAgreementWithSignatureResponse

func (*ClientWithResponses) UpdateCollectionWithBodyWithResponse

func (c *ClientWithResponses) UpdateCollectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*updateCollectionResponse, error)

UpdateCollectionWithBodyWithResponse request with arbitrary body returning *UpdateCollectionResponse

func (*ClientWithResponses) UpdateCollectionWithResponse

func (c *ClientWithResponses) UpdateCollectionWithResponse(ctx context.Context, body UpdateCollectionJSONRequestBody) (*updateCollectionResponse, error)

func (*ClientWithResponses) UpdateDepartmentNameWithBodyWithResponse added in v1.5.0

func (c *ClientWithResponses) UpdateDepartmentNameWithBodyWithResponse(ctx context.Context, address string, departmentId string, contentType string, body io.Reader) (*updateDepartmentNameResponse, error)

UpdateDepartmentNameWithBodyWithResponse request with arbitrary body returning *UpdateDepartmentNameResponse

func (*ClientWithResponses) UpdateDepartmentNameWithResponse added in v1.5.0

func (c *ClientWithResponses) UpdateDepartmentNameWithResponse(ctx context.Context, address string, departmentId string, body UpdateDepartmentNameJSONRequestBody) (*updateDepartmentNameResponse, error)

func (*ClientWithResponses) UpdateOrganizationWithBodyWithResponse

func (c *ClientWithResponses) UpdateOrganizationWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*updateOrganizationResponse, error)

UpdateOrganizationWithBodyWithResponse request with arbitrary body returning *UpdateOrganizationResponse

func (*ClientWithResponses) UpdateOrganizationWithResponse

func (c *ClientWithResponses) UpdateOrganizationWithResponse(ctx context.Context, address string, body UpdateOrganizationJSONRequestBody) (*updateOrganizationResponse, error)

func (*ClientWithResponses) UpdateTagWithBodyWithResponse

func (c *ClientWithResponses) UpdateTagWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader) (*updateTagResponse, error)

UpdateTagWithBodyWithResponse request with arbitrary body returning *UpdateTagResponse

func (*ClientWithResponses) UpdateTagWithResponse

func (c *ClientWithResponses) UpdateTagWithResponse(ctx context.Context, id int, body UpdateTagJSONRequestBody) (*updateTagResponse, error)

func (*ClientWithResponses) UpdateTaskDataMappingWithBodyWithResponse

func (c *ClientWithResponses) UpdateTaskDataMappingWithBodyWithResponse(ctx context.Context, id string, dataMappingId int, contentType string, body io.Reader) (*updateTaskDataMappingResponse, error)

UpdateTaskDataMappingWithBodyWithResponse request with arbitrary body returning *UpdateTaskDataMappingResponse

func (*ClientWithResponses) UpdateTaskDataMappingWithResponse

func (c *ClientWithResponses) UpdateTaskDataMappingWithResponse(ctx context.Context, id string, dataMappingId int, body UpdateTaskDataMappingJSONRequestBody) (*updateTaskDataMappingResponse, error)

func (*ClientWithResponses) UpdateTaskDataMappingsWithBodyWithResponse

func (c *ClientWithResponses) UpdateTaskDataMappingsWithBodyWithResponse(ctx context.Context, id string, contentType string, body io.Reader) (*updateTaskDataMappingsResponse, error)

UpdateTaskDataMappingsWithBodyWithResponse request with arbitrary body returning *UpdateTaskDataMappingsResponse

func (*ClientWithResponses) UpdateTaskDataMappingsWithResponse

func (c *ClientWithResponses) UpdateTaskDataMappingsWithResponse(ctx context.Context, id string, body UpdateTaskDataMappingsJSONRequestBody) (*updateTaskDataMappingsResponse, error)

func (*ClientWithResponses) UpdateTemplateDraftWithBodyWithResponse

func (c *ClientWithResponses) UpdateTemplateDraftWithBodyWithResponse(ctx context.Context, id int32, contentType string, body io.Reader) (*updateTemplateDraftResponse, error)

UpdateTemplateDraftWithBodyWithResponse request with arbitrary body returning *UpdateTemplateDraftResponse

func (*ClientWithResponses) UpdateTemplateDraftWithResponse

func (c *ClientWithResponses) UpdateTemplateDraftWithResponse(ctx context.Context, id int32, body UpdateTemplateDraftJSONRequestBody) (*updateTemplateDraftResponse, error)

func (*ClientWithResponses) UpdateTemplatePriceWithBodyWithResponse

func (c *ClientWithResponses) UpdateTemplatePriceWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*updateTemplatePriceResponse, error)

UpdateTemplatePriceWithBodyWithResponse request with arbitrary body returning *UpdateTemplatePriceResponse

func (*ClientWithResponses) UpdateTemplatePriceWithResponse

func (c *ClientWithResponses) UpdateTemplatePriceWithResponse(ctx context.Context, address string, body UpdateTemplatePriceJSONRequestBody) (*updateTemplatePriceResponse, error)

func (*ClientWithResponses) UpdateTemplateRestrictionsWithBodyWithResponse

func (c *ClientWithResponses) UpdateTemplateRestrictionsWithBodyWithResponse(ctx context.Context, address string, organizationAddress string, contentType string, body io.Reader) (*updateTemplateRestrictionsResponse, error)

UpdateTemplateRestrictionsWithBodyWithResponse request with arbitrary body returning *UpdateTemplateRestrictionsResponse

func (*ClientWithResponses) UpdateTemplateRestrictionsWithResponse

func (c *ClientWithResponses) UpdateTemplateRestrictionsWithResponse(ctx context.Context, address string, organizationAddress string, body UpdateTemplateRestrictionsJSONRequestBody) (*updateTemplateRestrictionsResponse, error)

func (*ClientWithResponses) UpdateTemplateWithBodyWithResponse

func (c *ClientWithResponses) UpdateTemplateWithBodyWithResponse(ctx context.Context, address string, contentType string, body io.Reader) (*updateTemplateResponse, error)

UpdateTemplateWithBodyWithResponse request with arbitrary body returning *UpdateTemplateResponse

func (*ClientWithResponses) UpdateTemplateWithResponse

func (c *ClientWithResponses) UpdateTemplateWithResponse(ctx context.Context, address string, body UpdateTemplateJSONRequestBody) (*updateTemplateResponse, error)

func (*ClientWithResponses) UpdateUserProfileWithBodyWithResponse

func (c *ClientWithResponses) UpdateUserProfileWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*updateUserProfileResponse, error)

UpdateUserProfileWithBodyWithResponse request with arbitrary body returning *UpdateUserProfileResponse

func (*ClientWithResponses) UpdateUserProfileWithResponse

func (c *ClientWithResponses) UpdateUserProfileWithResponse(ctx context.Context, body UpdateUserProfileJSONRequestBody) (*updateUserProfileResponse, error)

type Collection

type Collection struct {
	Agreements *[]CollectionAgreement `json:"agreements,omitempty"`

	// Blockchain based contract address of the entity that created the collection
	Author string `json:"author"`

	// Determines what the collection is represented as in the application
	CollectionType int `json:"collectionType"`

	// The unique identification string of the collection
	Id *string `json:"id,omitempty"`

	// The human readable name of the collection
	Name string `json:"name"`

	// The unique identifier of the package
	PackageId string `json:"packageId"`
}

Collection defines model for Collection.

type CollectionAgreement

type CollectionAgreement struct {

	// The blockchain based address of the agreement contract
	Address *string `json:"address,omitempty"`

	// The blockchain based address of the agreement's template
	Archetype *string `json:"archetype,omitempty"`

	// The human readable name of the agreement
	Name *string `json:"name,omitempty"`
}

CollectionAgreement defines model for CollectionAgreement.

type CollectionByGroup

type CollectionByGroup struct {

	// Blockchain based contract address of the entity that created the collection
	Author *string `json:"author,omitempty"`

	// Human readable name of the entity which authored the collection
	AuthorDisplayName *string `json:"authorDisplayName,omitempty"`

	// Determines what the collection is represented as in the application
	CollectionType *int `json:"collectionType,omitempty"`

	// Unix timestamp of when the collection was created
	CreatedAt *float32 `json:"createdAt,omitempty"`

	// The unique identification string of the collection
	Id *string `json:"id,omitempty"`

	// The human readable name of the collection
	Name *string `json:"name,omitempty"`

	// The unique identifier of the package
	PackageId *string `json:"packageId,omitempty"`

	// The human readable name of the package
	PackageName *string `json:"packageName,omitempty"`
}

CollectionByGroup defines model for CollectionByGroup.

type Connection

type Connection struct {

	// Time that the connection was initiated (not unix time)
	CreatedAt string `json:"createdAt"`

	// Whether the description is OUT (meaning the current user can see the identity details of the connection) or IN ( meaning the connection can see the identity details of the current user).
	Direction string `json:"direction"`

	// The connection's human-readable name and username, or if no name is found, the connection's email
	DisplayName *string `json:"displayName,omitempty"`

	// The unique identifier of the business connection
	Id float32 `json:"id"`

	// The connection is to an organization. Thus giving the connected entity the identity information of all the members of that organization. This is especially useful in contracting when it is based upon a specific department.
	IsOrganization *bool `json:"isOrganization,omitempty"`

	// Blockchain based location of the entity who initiated the connection. Address of the user/organization to hold the right to see personal information about the target entity. Must be the address of the authenticated user or an organization they are an approver of.
	Source string `json:"source"`

	// Status of the connection:
	//
	// - `0` means not accepted.
	// - `1` means accepted.
	State float32 `json:"state"`

	// Blockchain based location of the entity who received the connection. Address of the user/organization whose information the source entity wishes to be visible.
	Target string `json:"target"`

	// Time that the connection was initiated (not unix time)
	UpdatedAt *string `json:"updatedAt,omitempty"`

	// Current user is an approver of the Source entity
	UserIsApprover bool `json:"userIsApprover"`

	// Current user is a member of the Source entity
	UserIsMember bool `json:"userIsMember"`
}

Connection defines model for Connection.

type ConnectionRequest

type ConnectionRequest struct {

	// Is the connection a bilateral connection where both parties will share their identities with one another (somewhat akin to a facebook or linkedin friend) or a unilateral connection where one party is simply disclosing it's identity to another for the purposes of contracting with them (somewhat akin to twitter following...?)
	Reciprocal bool `json:"reciprocal"`

	// Blockchain based location of the entity who initiated the connection. Address of the user/organization to hold the right to see personal information about the target entity. Must be the address of the authenticated user or an organization they are an approver of.
	Source string `json:"source"`

	// Blockchain based location of the entity who received the connection. Address of the user/organization whose information the source entity wishes to be visible.
	Target string `json:"target"`
}

ConnectionRequest defines model for ConnectionRequest.

type Connections

type Connections struct {

	// Business connections that been RECEIVED BY the authenticated user or an organization they are an approver or member of
	IN *struct {

		// The entities that are connected with the authenticated user or the organizations they are a member or approver of. Includes the name of the source entity.
		Accepted *[]Connection `json:"accepted,omitempty"`

		// The entities that have requested to be connected with the authenticated user or the organizations they are an approver of. Includes the name of the source entity.
		Pending *[]Connection `json:"pending,omitempty"`
	} `json:"IN,omitempty"`

	// Business connections that have been SENT FROM the authenticated user or an organization they are an approver or member of.
	OUT *struct {

		// The entities that the authenticated user or the organizations they are an approver or member of are connected with. Includes the name of the target entity.
		Accepted *[]Connection `json:"accepted,omitempty"`

		// The entities that the authenticated user or the organizations they are an approver have requested to be connected with. Includes no personal details of the target entity.
		Pending *[]Connection `json:"pending,omitempty"`
	} `json:"OUT,omitempty"`
}

Connections defines model for Connections.

type CreateAgreementAttachmentExternalJSONBody added in v1.5.21

type CreateAgreementAttachmentExternalJSONBody AgreementAttachmentJSON

CreateAgreementAttachmentExternalJSONBody defines parameters for CreateAgreementAttachmentExternal.

type CreateAgreementAttachmentExternalJSONRequestBody

type CreateAgreementAttachmentExternalJSONRequestBody CreateAgreementAttachmentExternalJSONBody

CreateAgreementAttachmentExternalRequestBody defines body for CreateAgreementAttachmentExternal for application/json ContentType.

type CreateAgreementJSONBody added in v1.5.21

type CreateAgreementJSONBody Agreement

CreateAgreementJSONBody defines parameters for CreateAgreement.

type CreateAgreementJSONRequestBody

type CreateAgreementJSONRequestBody CreateAgreementJSONBody

CreateAgreementRequestBody defines body for CreateAgreement for application/json ContentType.

type CreateAgreementQuicklyJSONBody added in v1.5.21

type CreateAgreementQuicklyJSONBody AgreementQuick

CreateAgreementQuicklyJSONBody defines parameters for CreateAgreementQuickly.

type CreateAgreementQuicklyJSONRequestBody

type CreateAgreementQuicklyJSONRequestBody CreateAgreementQuicklyJSONBody

CreateAgreementQuicklyRequestBody defines body for CreateAgreementQuickly for application/json ContentType.

type CreateAgreementTagJSONBody added in v1.5.21

type CreateAgreementTagJSONBody TagCreation

CreateAgreementTagJSONBody defines parameters for CreateAgreementTag.

type CreateAgreementTagJSONRequestBody

type CreateAgreementTagJSONRequestBody CreateAgreementTagJSONBody

CreateAgreementTagRequestBody defines body for CreateAgreementTag for application/json ContentType.

type CreateCollectionJSONBody added in v1.5.21

type CreateCollectionJSONBody Collection

CreateCollectionJSONBody defines parameters for CreateCollection.

type CreateCollectionJSONRequestBody

type CreateCollectionJSONRequestBody CreateCollectionJSONBody

CreateCollectionRequestBody defines body for CreateCollection for application/json ContentType.

type CreateConnectionRequestJSONBody added in v1.5.21

type CreateConnectionRequestJSONBody ConnectionRequest

CreateConnectionRequestJSONBody defines parameters for CreateConnectionRequest.

type CreateConnectionRequestJSONRequestBody

type CreateConnectionRequestJSONRequestBody CreateConnectionRequestJSONBody

CreateConnectionRequestRequestBody defines body for CreateConnectionRequest for application/json ContentType.

type CreateDocumentParams

type CreateDocumentParams struct {

	// Whether to extract the parameters from the document (treat it like a template).
	ExtractParams bool `json:"extractParams"`
}

CreateDocumentParams defines parameters for CreateDocument.

type CreateModelParams

type CreateModelParams struct {

	// Denote format of process model. Defaults to `bpmn` which is also the only format that is supported at this time.
	Format *string `json:"format,omitempty"`
}

CreateModelParams defines parameters for CreateModel.

type CreateOrganizationJSONBody added in v1.5.21

type CreateOrganizationJSONBody OrganizationCreation

CreateOrganizationJSONBody defines parameters for CreateOrganization.

type CreateOrganizationJSONRequestBody

type CreateOrganizationJSONRequestBody CreateOrganizationJSONBody

CreateOrganizationRequestBody defines body for CreateOrganization for application/json ContentType.

type CreateTemplateDraftJSONBody added in v1.5.21

type CreateTemplateDraftJSONBody TemplateDraft

CreateTemplateDraftJSONBody defines parameters for CreateTemplateDraft.

type CreateTemplateDraftJSONRequestBody

type CreateTemplateDraftJSONRequestBody CreateTemplateDraftJSONBody

CreateTemplateDraftRequestBody defines body for CreateTemplateDraft for application/json ContentType.

type CreateTemplateJSONBody added in v1.5.21

type CreateTemplateJSONBody Template

CreateTemplateJSONBody defines parameters for CreateTemplate.

type CreateTemplateJSONRequestBody

type CreateTemplateJSONRequestBody CreateTemplateJSONBody

CreateTemplateRequestBody defines body for CreateTemplate for application/json ContentType.

type CreateTemplatePackageJSONBody added in v1.5.21

type CreateTemplatePackageJSONBody TemplatePackage

CreateTemplatePackageJSONBody defines parameters for CreateTemplatePackage.

type CreateTemplatePackageJSONRequestBody

type CreateTemplatePackageJSONRequestBody CreateTemplatePackageJSONBody

CreateTemplatePackageRequestBody defines body for CreateTemplatePackage for application/json ContentType.

type CreateUserWithinAccountJSONBody added in v1.5.21

type CreateUserWithinAccountJSONBody struct {

	// The user's email address
	Email *string `json:"email,omitempty"`

	// Set to true to create a producer account instead of a consumer account (optional and not currently used.
	IsProducer *bool `json:"isProducer,omitempty"`

	// The user's password
	Password *string `json:"password,omitempty"`

	// The user's userName
	Username *string `json:"username,omitempty"`
}

CreateUserWithinAccountJSONBody defines parameters for CreateUserWithinAccount.

type CreateUserWithinAccountJSONRequestBody

type CreateUserWithinAccountJSONRequestBody CreateUserWithinAccountJSONBody

CreateUserWithinAccountRequestBody defines body for CreateUserWithinAccount for application/json ContentType.

type DataCollectionType

type DataCollectionType struct {

	// The code for the collection type
	CollectionType *int `json:"collectionType,omitempty"`

	// Human readable label for the collection type
	Label *string `json:"label,omitempty"`
}

DataCollectionType defines model for DataCollectionType.

type DataCollectionTypes

type DataCollectionTypes []DataCollectionType

DataCollectionTypes defines model for DataCollectionTypes.

type DataCountries

type DataCountries []DataCountry

DataCountries defines model for DataCountries.

type DataCountry

type DataCountry struct {

	// Two letter ISO country code.
	Alpha2 *string `json:"alpha2,omitempty"`

	// Three letter ISO country code.
	Alpha3 *string `json:"alpha3,omitempty"`

	// Two letter ISO country code.
	Country *string `json:"country,omitempty"`

	// UN M49 or the Standard Country or Area Codes for Statistical Use (Series M, No. 49) is a standard for area codes used by the United Nations for statistical purposes, developed and maintained by the United Nations Statistics Division.
	M49 *int `json:"m49,omitempty"`

	// Human readable name of the country
	Name *string `json:"name,omitempty"`
}

DataCountry defines model for DataCountry.

type DataCurrencies

type DataCurrencies []DataCurrency

DataCurrencies defines model for DataCurrencies.

type DataCurrency

type DataCurrency struct {

	// Three letter code for the currency
	Alpha3 *string `json:"alpha3,omitempty"`

	// UN M49 or the Standard Country or Area Codes for Statistical Use (Series M, No. 49) is a standard for area codes used by the United Nations for statistical purposes, developed and maintained by the United Nations Statistics Division.
	M49 *string `json:"m49,omitempty"`

	// Human readable name of the currency
	Name *string `json:"name,omitempty"`
}

DataCurrency defines model for DataCurrency.

type DataMapping

type DataMapping struct {
	DataMappingId *string `json:"dataMappingId,omitempty"`
	DataPath      *string `json:"dataPath,omitempty"`
	DataStorageId *string `json:"dataStorageId,omitempty"`
	DataType      *int    `json:"dataType,omitempty"`
	Direction     *int    `json:"direction,omitempty"`
	ParameterType *int    `json:"parameterType,omitempty"`
	Scope         *string `json:"scope,omitempty"`
	Value         *string `json:"value,omitempty"`
}

DataMapping defines model for DataMapping.

type DataParameterType

type DataParameterType struct {

	// Human readable label for the type
	Label *string `json:"label,omitempty"`

	// The parameter type code that is used throughout the platform
	ParameterType *int `json:"parameterType,omitempty"`
}

DataParameterType defines model for DataParameterType.

type DataParameterTypes

type DataParameterTypes []DataParameterType

DataParameterTypes defines model for DataParameterTypes.

type DataRegion

type DataRegion struct {

	// Two letter code of the region. **N.B.** - only one of the code2 and code3 will be populated
	Code2 *string `json:"code2,omitempty"`

	// Three letter code of the region. **N.B.** - only one of the code2 and code3 will be populated
	Code3 *string `json:"code3,omitempty"`

	// Two letter country code
	Country *string `json:"country,omitempty"`

	// Human readable name of the region.
	Name *string `json:"name,omitempty"`

	// Unique identifier of the region within the platform
	Region *string `json:"region,omitempty"`
}

DataRegion defines model for DataRegion.

type DataRegions

type DataRegions []DataRegion

DataRegions defines model for DataRegions.

type Document

type Document struct {

	// A bytes buffer containing the document's contents
	Data struct {

		// The actual bytes array
		Data []int `json:"data"`

		// The type of bytes array
		Type string `json:"type"`
	} `json:"data"`

	// The document's meta data as an object
	Meta struct {

		// The file's mimetype
		Mime string `json:"mime"`

		// The file name
		Name string `json:"name"`
	} `json:"meta"`
}

Document defines model for Document.

type DocumentAssembly

type DocumentAssembly struct {

	// Array of stringified grants
	Grants []string `json:"Grants"`

	// Array of the docs objects
	Docs []Document `json:"docs"`
}

DocumentAssembly defines model for DocumentAssembly.

type DocumentCreationResponse

type DocumentCreationResponse struct {

	// Stringified JSON grant of the uploaded document.
	Grant *string `json:"grant,omitempty"`

	// If extractParams === true, returns property `params` with an array of parameter names
	Params *[]string `json:"params,omitempty"`
}

DocumentCreationResponse defines model for DocumentCreationResponse.

type Draft added in v1.5.18

type Draft struct {

	// If the draft is for an agreement made from an archetype, the name of the archetype
	ArchetypeName *string      `json:"archetypeName,omitempty"`
	Body          *interface{} `json:"body,omitempty"`

	// Unix timestamp of when the draft was originally created
	CreatedAt *float32 `json:"createdAt,omitempty"`

	// Blockchain based address of the entity originally creating the draft
	Creator *string `json:"creator,omitempty"`

	// Human readable name of the entity who originally created the draft
	CreatorDisplayName *string `json:"creatorDisplayName,omitempty"`

	// Entity that is currently holding the drafting lock
	CurrentEditor *string `json:"currentEditor,omitempty"`

	// Human readable name of the entity currently holding the drafting lock
	CurrentEditorDisplayName *string `json:"currentEditorDisplayName,omitempty"`

	// The unique identifier of the draft
	Id *int `json:"id,omitempty"`

	// Unix timestamp of when the draft had an editing lock placed on it
	LockedAt *float32 `json:"lockedAt,omitempty"`

	// Human readable name of the entity who will own the agreement/template once it is formally created
	OwnerDisplayName *string `json:"ownerDisplayName,omitempty"`

	// The type of entity the drafted object should ultimately become
	ResourceType *string `json:"resourceType,omitempty"`

	// Unix timestamp of when the draft was most recently updated
	UpdatedAt *float32 `json:"updatedAt,omitempty"`
}

Draft defines model for Draft.

type DraftRequestBody added in v1.5.18

type DraftRequestBody struct {
	Body *interface{} `json:"body,omitempty"`

	// The type of entity the drafted object should ultimately become
	ResourceType *string `json:"resourceType,omitempty"`
}

DraftRequestBody defines model for DraftRequestBody.

type Error

type Error struct {

	// The type of error
	Error *string `json:"error,omitempty"`

	// The error message
	Message *string `json:"message,omitempty"`

	// The HTTP status code of the error
	StatusCode *int `json:"statusCode,omitempty"`
}

Error defines model for Error.

type GetAgreementExternalParams

type GetAgreementExternalParams struct {

	// Encrypted security token granting external user access to the resource
	Token string `json:"token"`
}

GetAgreementExternalParams defines parameters for GetAgreementExternal.

type GetAgreementParams added in v1.5.8

type GetAgreementParams struct {

	// Include the metadata under the `meta` key of each of this agreement's archetypes's documents
	Meta *bool `json:"meta,omitempty"`
}

GetAgreementParams defines parameters for GetAgreement.

type GetDocumentParams

type GetDocumentParams struct {

	// Stringified document reference grant object.
	Grant string `json:"grant"`

	// Parameters in the doc will be extracted into params array
	ExtractParams *bool `json:"extractParams,omitempty"`

	// Also return the metadata of the document within the meta object
	Meta *bool `json:"meta,omitempty"`
}

GetDocumentParams defines parameters for GetDocument.

type GetProcessDefinitionsParams

type GetProcessDefinitionsParams struct {

	// Used to filter by interface
	InterfaceId *string `json:"interfaceId,omitempty"`

	// Used to filter by processDefinitionId
	ProcessDefinitionId *string `json:"processDefinitionId,omitempty"`

	// Used to filter by modelId
	ModelId *string `json:"modelId,omitempty"`
}

GetProcessDefinitionsParams defines parameters for GetProcessDefinitions.

type GetTasksParams

type GetTasksParams struct {

	// Address of process instance to filter on
	ProcessInstance *string `json:"processInstance,omitempty"`

	// Address of agreement to filter on
	AgreementAddress *string `json:"agreementAddress,omitempty"`
}

GetTasksParams defines parameters for GetTasks.

type GetTemplateParams

type GetTemplateParams struct {

	// The password to trigger the decryption key for an
	// opaque template
	Password *string `json:"password,omitempty"`

	// Include the metadata under the `meta` key of each of this archetypes's documents
	Meta *bool `json:"meta,omitempty"`
}

GetTemplateParams defines parameters for GetTemplate.

type HttpRequestDoer added in v1.5.8

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InviteNewUserJSONBody added in v1.5.21

type InviteNewUserJSONBody struct {

	// Email address of the invited user
	Email *string `json:"email,omitempty"`
}

InviteNewUserJSONBody defines parameters for InviteNewUser.

type InviteNewUserJSONRequestBody

type InviteNewUserJSONRequestBody InviteNewUserJSONBody

InviteNewUserRequestBody defines body for InviteNewUser for application/json ContentType.

type ListAgreementTagsParams

type ListAgreementTagsParams struct {

	// Optional query string parameter to filter tags by agreement. Allowed values include the addresses of any agreements the authenticated user (or one of the organizations they are a member of) is the author of or party to.
	Agreement *string `json:"agreement,omitempty"`

	// Optional query string parameter to filter tags by owner.
	// Allowed values include the addresses of any organizations
	// the authenticated user is an approver of, and the authenticated
	// user's address.
	Owners *string `json:"owners,omitempty"`
}

ListAgreementTagsParams defines parameters for ListAgreementTags.

type ListAgreementsByCollaboratorParams

type ListAgreementsByCollaboratorParams struct {

	// Limit the number of objects returned.
	Limit int `json:"limit"`
}

ListAgreementsByCollaboratorParams defines parameters for ListAgreementsByCollaborator.

type ListOrganizationsParams

type ListOrganizationsParams struct {

	// If the value of this optional query parameter is `true`, instead retrieves only organizations where the authenticated user is an approver.
	Approver *bool `json:"approver,omitempty"`
}

ListOrganizationsParams defines parameters for ListOrganizations.

type ListTopTemplatesParams

type ListTopTemplatesParams struct {

	// Limit the number of objects returned.
	Limit *int `json:"limit,omitempty"`
}

ListTopTemplatesParams defines parameters for ListTopTemplates.

type LoginAccessToken added in v1.5.0

type LoginAccessToken string

LoginAccessToken defines model for LoginAccessToken.

type Organization

type Organization struct {

	// Organization's Controller Contract
	Address string `json:"address"`

	// Organization's approvers are the administrators of that
	// organization
	//
	// and may approve the addition of new users into the organization,
	// set the roles of users within the
	//
	// organization, as well as remove users from the organization.
	// This array is optional.
	//
	// If no approvers are passed, the currently logged-in user's
	// address is used as the single approver of for the new organization.
	//
	// Users that belong to the organization as approvers. `undefined`
	// if the user is not an organization approver or member.
	Approvers *[]OrganizationApprovers `json:"approvers,omitempty"`

	// Departments existing within the organization
	Departments *[]OrganizationDepartment `json:"departments,omitempty"`

	// The authenticated is an approver of the organization
	IsApprover bool `json:"isApprover"`

	// The authenticated is a member of the organization
	IsMember bool `json:"isMember"`

	// Organization's human readable name
	Name string `json:"name"`

	// Organization's machine readable ID. Hashed address (keccak256)
	OrganizationKey string `json:"organizationKey"`

	// Users that belong to the organization as members. `undefined` if the user is not an organization approver or member.
	Users *[]OrganizationUsers `json:"users,omitempty"`
}

Organization defines model for Organization.

type OrganizationApprovers

type OrganizationApprovers struct {

	// Blockchain based address of the user
	Address *string `json:"address,omitempty"`

	// Username of the user
	DisplayName *string `json:"displayName,omitempty"`
}

OrganizationApprovers defines model for OrganizationApprovers.

type OrganizationAssetArchetype

type OrganizationAssetArchetype struct {

	// The blockchain based address of the asset
	Address *string `json:"address,omitempty"`

	// Blockchain based address of the author of the asset
	Author *string `json:"author,omitempty"`

	// Human readable name of the author
	AuthorDisplayName *string `json:"authorDisplayName,omitempty"`

	// Human readable description of the asset
	Description *string `json:"description,omitempty"`

	// Is the asset private
	IsPrivate *bool `json:"isPrivate,omitempty"`

	// Human readable name of the asset
	Name *string `json:"name,omitempty"`

	// Blockchain based asset of the owner of the asset
	Owner *string `json:"owner,omitempty"`

	// Human readable name of the owner
	OwnerDisplayName *string `json:"ownerDisplayName,omitempty"`

	// If the template has been succeeded by a later in time version this field will be filled out with the address of the newer version that replaced this asset. Otherwise it will be the hex represenation of `0`.
	Successor *string `json:"successor,omitempty"`
}

OrganizationAssetArchetype defines model for OrganizationAssetArchetype.

type OrganizationAssets

type OrganizationAssets struct {

	// Templates owned by the organization
	Archetypes *[]OrganizationAssetArchetype `json:"archetypes,omitempty"`
}

OrganizationAssets defines model for OrganizationAssets.

type OrganizationByUsers

type OrganizationByUsers struct {

	// Organization's Controller Contract
	Address string `json:"address"`

	// The organization departments the authenticated user is a member of
	Departments []struct {

		// The unique identifier of the department
		Id string `json:"id"`

		// The human readable name of the department
		Name string `json:"name"`
	} `json:"departments"`

	// Organization's human readable name
	Name string `json:"name"`

	// Organization's machine readable ID. Hashed address (keccak256)
	OrganizationKey string `json:"organizationKey"`
}

OrganizationByUsers defines model for OrganizationByUsers.

type OrganizationCreation

type OrganizationCreation struct {

	// Organization's approvers are the administrators of that
	// organization
	//
	// and may approve the addition of new users into the organization,
	// set the roles of users within the
	//
	// organization, as well as remove users from the organization.
	// This array is optional.
	//
	// If no approvers are passed, the currently logged-in user's
	// address is used as the single approver of for the new organization.
	//
	// Users that belong to the organization as approvers. `undefined`
	// if the user is not an organization approver or member.
	Approvers *[]string `json:"approvers,omitempty"`

	// The default department is the department of which all users
	// that are members of the organization are, by default, placed.
	//
	// It can be thought of as the "all hands" team for an organization
	// within the platform.
	DefaultDepartmentName *string `json:"defaultDepartmentName,omitempty"`

	// Organization's human readable name
	Name *string `json:"name,omitempty"`
}

OrganizationCreation defines model for OrganizationCreation.

type OrganizationDepartment

type OrganizationDepartment struct {

	// The unique identifier of the department
	Id *string `json:"id,omitempty"`

	// The human readable name of the department
	Name *string `json:"name,omitempty"`

	// List of the users that belong to the Department by their blockchain based account address
	Users *[]string `json:"users,omitempty"`
}

OrganizationDepartment defines model for OrganizationDepartment.

type OrganizationUsers

type OrganizationUsers struct {

	// Blockchain based address of the user
	Address *string `json:"address,omitempty"`

	// List of the department identifiers that the user belongs to
	Departments *[]string `json:"departments,omitempty"`

	// Username of the user
	DisplayName *string `json:"displayName,omitempty"`
}

OrganizationUsers defines model for OrganizationUsers.

type Organizations

type Organizations []Organization

Organizations defines model for Organizations.

type RegisterUserJSONBody added in v1.5.21

type RegisterUserJSONBody User

RegisterUserJSONBody defines parameters for RegisterUser.

type RegisterUserJSONRequestBody

type RegisterUserJSONRequestBody RegisterUserJSONBody

RegisterUserRequestBody defines body for RegisterUser for application/json ContentType.

type RegisterUserSuccess

type RegisterUserSuccess struct {

	// The blockchain based address of the user
	Address *string `json:"address,omitempty"`

	// The user's userName
	Username *string `json:"username,omitempty"`
}

RegisterUserSuccess defines model for RegisterUserSuccess.

type RequestEditorFn

type RequestEditorFn func(req *http.Request, ctx context.Context) error

RequestEditorFn is the function signature for the RequestEditor callback function

type TagCreation

type TagCreation struct {

	// Blockchain based contract address of the entity (user or
	// organization) that owns the tag.
	//
	// During a write operation, if this field is not specified,
	// the address of the authenticated user will be used.
	Owner *string `json:"owner,omitempty"`

	// List of human readable tags to create
	Tags []string `json:"tags"`
}

TagCreation defines model for TagCreation.

type Tags

type Tags struct {

	// Tags list
	Tags []AgreementTag `json:"tags"`
}

Tags defines model for Tags.

type Template

type Template struct {

	// Whether the template can be used to create
	// new Active Agreements or not
	Active *bool `json:"active,omitempty"`

	// Blockchain based address for the template
	Address *string `json:"address,omitempty"`

	// The department or limiting scope that the owner has placed on the visibility of agreements created via the template
	AgreementOwnerScope *string `json:"agreementOwnerScope,omitempty"`

	// Controller contract of the user or organization that created the template. Note that currently the author is forced to be the logged-in-user's address since there is not yet have a review or approval process for changes made to an organization-authored template by a user who is part of that organization.
	Author *string `json:"author,omitempty"`

	// Human readable name of the author
	AuthorDisplayName *string `json:"authorDisplayName,omitempty"`

	// Description of the template
	Description string `json:"description"`

	// Array of the prose template documents that provide the basis
	// for the human-readable (traditional) contract.
	//
	// N.B. these documents when displayed for a user are "assembled" in
	// that they are ran through our documentary assembly processing system
	// before they are displayed to the user in our webApp. This field
	// only returns the "raw" document which needs to be ran through
	// the Monax assembler if one wants to have the "full" contract
	// equivalent to what is displayed in the webApp.
	Documents *[]AgreementDocument `json:"documents,omitempty"`

	// Blockchain address of the process model contract
	ExecutionModelAddress *string `json:"executionModelAddress,omitempty"`

	// Unique ID of the process model
	ExecutionModelId *string `json:"executionModelId,omitempty"`

	// Address of the template's execution process definition
	ExecutionProcessDefinition string `json:"executionProcessDefinition"`

	// Unique ID of the process model
	ExecutionProcessId *string `json:"executionProcessId,omitempty"`

	// Human readable name of the process
	ExecutionProcessName *string `json:"executionProcessName,omitempty"`

	// Blockchain address of the process model contract
	FormationModelAddress *string `json:"formationModelAddress,omitempty"`

	// Unique ID of the process model
	FormationModelId *string `json:"formationModelId,omitempty"`

	// Address of the template's formation process definition
	FormationProcessDefinition string `json:"formationProcessDefinition"`

	// Unique ID of the process model
	FormationProcessId *string `json:"formationProcessId,omitempty"`

	// Human readable name of the process
	FormationProcessName *string `json:"formationProcessName,omitempty"`

	// The address each of the packages that the template has been added to
	GoverningArchetypes *[]string `json:"governingArchetypes,omitempty"`

	// Does the entity retrieving the information own the template
	IsOwner *bool `json:"isOwner,omitempty"`

	// Whether the encryption framework of the template
	// is operational or not
	IsPrivate *bool `json:"isPrivate,omitempty"`

	// The "country" and "regions" which the template
	//
	// has been registered as relevant to. The "country" is registered
	// as an ISO standard
	//
	// two character string and "regions" is an array of addresses
	// relating to the controlling
	//
	// contracts for the region (see [ISO standards manipulation](#)
	// section).
	Jurisdictions *[]TemplateJurisdiction `json:"jurisdictions,omitempty"`

	// Human readable name of the template
	Name string `json:"name"`

	// Blockchain based address of the owner of the template who can control modifications, updates, and the visibility of the template
	Owner string `json:"owner"`

	// Human readable name of the owner
	OwnerDisplayName *string `json:"ownerDisplayName,omitempty"`

	// The department or limiting scope that the owner has placed on the visibility of the template
	OwnerScope *string `json:"ownerScope,omitempty"`

	// The "id" and "name" of each of the packages that the template has been added to
	Packages *[]TemplatePackage `json:"packages,omitempty"`

	// An array of objects with each parameter's name, value, and data type. See the AgreementParameter object definition for more information on the data types.
	// Note - If a parameter with type `8` (Signing Party) is given, the corresponding value will be added to the agreement's parties.
	Parameters *[]AgreementParameter `json:"parameters,omitempty"`

	// A secret string which is used to trigger the encryption
	// system for the Archetype's documents
	Password *string `json:"password,omitempty"`

	// (**Not currently used**) price of the template to create a new
	// agreement based upon it - in "cents".
	//
	// (This field can be edited later through a `PUT` request to
	// `/archetypes/:address/price`)
	Price *int `json:"price,omitempty"`

	// Whether the same visibility limiting scope placed on the template itself will also be applied **forcibly** to all agreements created via the template or not.
	SameAgreementOwnerScope *bool `json:"sameAgreementOwnerScope,omitempty"`

	// Address of the successor template
	Successor *string `json:"successor,omitempty"`
}

Template defines model for Template.

type TemplateByGroup

type TemplateByGroup struct {

	// Whether the template can be used to create
	// new Active Agreements or not
	Active *bool `json:"active,omitempty"`

	// Blockchain based address for the template
	Address *string `json:"address,omitempty"`

	// Controller contract of the user or organization that created the template. Note that currently the author is forced to be the logged-in-user's address since there is not yet have a review or approval process for changes made to an organization-authored template by a user who is part of that organization.
	Author *string `json:"author,omitempty"`

	// Human readable name of the author
	AuthorDisplayName *string `json:"authorDisplayName,omitempty"`

	// The jurisdictions in which the template has been registered to be active. Needs to be in ISO format
	Countries *[]string `json:"countries,omitempty"`

	// Unix timestamp of when the template was created
	CreatedAt *float32 `json:"createdAt,omitempty"`

	// Description of the template
	Description *string `json:"description,omitempty"`

	// Does the entity retrieving the information own the template
	IsOwner *bool `json:"isOwner,omitempty"`

	// Whether the encryption framework of the template
	// is operational or not
	IsPrivate *bool `json:"isPrivate,omitempty"`

	// Human readable name of the template
	Name *string `json:"name,omitempty"`

	// Blockchain based address of the owner of the template who can control modifications, updates, and the visibility of the template
	Owner *string `json:"owner,omitempty"`

	// Human readable name of the owner
	OwnerDisplayName *string `json:"ownerDisplayName,omitempty"`

	// (**Not currently used**) price of the template to create a new
	// agreement based upon it - in "cents".
	//
	// (This field can be edited later through a `PUT` request to
	// `/archetypes/:address/price`)
	Price *int `json:"price,omitempty"`
}

TemplateByGroup defines model for TemplateByGroup.

type TemplateDraft

type TemplateDraft struct {

	// The name of the archetype
	ArchetypeName *string `json:"archetypeName,omitempty"`

	// A template has the following fields
	Body *Template `json:"body,omitempty"`

	// Unix timestamp of when the draft was originally created
	CreatedAt *float32 `json:"createdAt,omitempty"`

	// Blockchain based address of the entity originally creating the template
	Creator *string `json:"creator,omitempty"`

	// Human readable name of the entity who originally created the template
	CreatorDisplayName *string `json:"creatorDisplayName,omitempty"`

	// Entity that is currently holding the drafting lock on a template
	CurrentEditor *string `json:"currentEditor,omitempty"`

	// Human readable name of the entity currently holding the drafting lock
	CurrentEditorDisplayName *string `json:"currentEditorDisplayName,omitempty"`

	// The unique identifier of the template
	Id *int `json:"id,omitempty"`

	// Unix timestamp of when the draft had an editing lock placed on it
	LockedAt *float32 `json:"lockedAt,omitempty"`

	// Human readable name of the entity who will own the template once it is formally created
	OwnerDisplayName *string `json:"ownerDisplayName,omitempty"`

	// Unix timestamp of when the draft was most recently updated
	UpdatedAt *float32 `json:"updatedAt,omitempty"`
}

TemplateDraft defines model for TemplateDraft.

type TemplateDraftBody added in v1.5.18

type TemplateDraftBody struct {

	// Visibility limitations to be applied to all agreements created from this template that share the same owner. Applied if `sameAgreementOwnerScope` is false. Comma-separated string of the blockchain based department ids within the agreement's owner organization to limit visibility of the agreement to.
	AgreementOwnerScope *string `json:"agreementOwnerScope,omitempty"`

	// Description of the template
	Description *string `json:"description,omitempty"`
	Documents   *[]struct {

		// Reference to the document addressable.
		Grant *string `json:"grant,omitempty"`

		// File name of the document
		Name *string `json:"name,omitempty"`
	} `json:"documents,omitempty"`

	// Blockchain based address of the process definition that should be used for the agreement's execution process
	ExecutionProcessDefinition *string `json:"executionProcessDefinition,omitempty"`

	// Indicates whether agreements created from the templates will expire
	Expiration *bool `json:"expiration,omitempty"`

	// Blockchain based address of the process definition that should be used for the agreement's formation process
	FormationProcessDefinition *string `json:"formationProcessDefinition,omitempty"`

	// Comma-separated string of the blockchain based addresses of any other templates that should govern this one.
	GoverningArchetypes *string `json:"governingArchetypes,omitempty"`
	Jurisdictions       *[]struct {

		// Two letter country code of the jurisdiction that this template is marked as valid for
		Country *string `json:"country,omitempty"`

		// Comma-separated string of the blockchain based addresses of the country's sub-national region
		Regions *string `json:"regions,omitempty"`
	} `json:"jurisdictions,omitempty"`

	// Human readable name of the template
	Name *string `json:"name,omitempty"`

	// Blockchain based address of the user or organization who can control modifications, updates, and the visibility of the template
	Owner *string `json:"owner,omitempty"`

	// Comma-separated string of the blockchain based department ids within the owner organization to limit visibility of the template to
	OwnerScope *string `json:"ownerScope,omitempty"`
	Parameters *[]struct {

		// Indicates whether the parameter should be hidden when retrieving the agreement details
		Confidential *bool `json:"confidential,omitempty"`

		// Name of the parameter
		Name *string `json:"name,omitempty"`

		// Indicates whether the value for the parameter is required at agreement creation
		Required *bool `json:"required,omitempty"`

		// Indicates whether the user/org assigned to the parameter is a signatory
		Signatory *bool `json:"signatory,omitempty"`

		// Code indicating the data type of the parameter
		Type *float32 `json:"type,omitempty"`

		// Code used to indicate whom visibility of the parameter should be limited to
		Visibility *float32 `json:"visibility,omitempty"`
	} `json:"parameters,omitempty"`

	// Indicates whether parameters from the attached documents and workflows have been added to the draft body
	ParametersSet *bool `json:"parametersSet,omitempty"`

	// (**Not currently used**) price of the template to create a new
	// agreement based upon it - in "cents".
	//
	// (This field can be edited later through a `PUT` request to
	// `/archetypes/:address/price`)
	Price *int `json:"price,omitempty"`

	// Whether the same visibility limiting scope placed on the template itself will also be applied **forcibly** to all agreements created via the template or not.
	SameAgreementOwnerScope *bool                     `json:"sameAgreementOwnerScope,omitempty"`
	UploadDocuments         *[]map[string]interface{} `json:"uploadDocuments,omitempty"`

	// Value of 'yes' indicates that custom workflows should be applied to the template via the `formationProcessDefinition` and `executionProcessDefinition` fields. Value of `no` indicates that the platform's default processes should be used.
	WorkflowsRequired *string `json:"workflowsRequired,omitempty"`
}

TemplateDraftBody defines model for TemplateDraftBody.

type TemplateJurisdiction

type TemplateJurisdiction struct {

	// Two letter country code of the jurisdiction that this template is marked as valid for
	Country *string   `json:"country,omitempty"`
	Regions *[]string `json:"regions,omitempty"`
}

TemplateJurisdiction defines model for TemplateJurisdiction.

type TemplatePackage

type TemplatePackage struct {

	// Indicates whether the package has been activated and available for creating collections with that created the package
	Active *bool `json:"active,omitempty"`

	// Blockchain based controller contract of the user or organization
	Author *string `json:"author,omitempty"`

	// Human readable name of the author of the package
	AuthorDisplayName *string `json:"authorDisplayName,omitempty"`

	// Unix timestamp on when the package was created
	CreatedAt *float32 `json:"createdAt,omitempty"`

	// Description of the package
	Description *string `json:"description,omitempty"`

	// The unique identifier of the package
	Id *string `json:"id,omitempty"`

	// Indicates whether the retrieving user is the owner of the package
	IsOwner *bool `json:"isOwner,omitempty"`

	// Indicates whether the package can be read/used publicly
	IsPrivate *bool `json:"isPrivate,omitempty"`

	// Human readable name of the package
	Name *string `json:"name,omitempty"`
}

TemplatePackage defines model for TemplatePackage.

type TemplateRestrictions

type TemplateRestrictions struct {

	// The scope of restrictions on any agreements which are created from the template. An array of department ids under the given organization that have been specified as allowed to access agreements created from the template. When null, means that no such rules have been applied, and the rules for the template should be followed. When empty array, means all departments within the organizations have been granted access.
	AgreementOwnerScope *[]string `json:"agreementOwnerScope,omitempty"`

	// The scope of restrictions on the template placed by its owner. An array of department ids under the given organization that have been specified as allowed to access the template. When null, means that no such rules have been applied. When empty array, means all departments within the organizations have been granted access.
	OwnerScope *[]string `json:"ownerScope,omitempty"`
}

TemplateRestrictions defines model for TemplateRestrictions.

type TopTemplatesReport

type TopTemplatesReport []struct {

	// Whether the template is in the active state
	Active *bool `json:"active,omitempty"`

	// The blockchain based address of the template in question
	Address *string `json:"address,omitempty"`

	// The blockchain based address of the author of the template in question
	Author *string `json:"author,omitempty"`

	// The country or countries which the template is logged as being applicable in.
	Countries *[]string `json:"countries,omitempty"`

	// The human readable description placed on the template by its author
	Description *string `json:"description,omitempty"`

	// Whether the template is private
	IsPrivate *bool `json:"isPrivate,omitempty"`

	// The human readable name of the template
	Name *string `json:"name,omitempty"`

	// The number of documents which the template includes -- formatted as a string.
	NumberOfDocuments *string `json:"numberOfDocuments,omitempty"`

	// The number of parameters used by the template -- formatted as a string.
	NumberOfParameters *string `json:"numberOfParameters,omitempty"`
}

TopTemplatesReport defines model for TopTemplatesReport.

type UpdateAgreementJSONBody added in v1.5.21

type UpdateAgreementJSONBody AgreementUpdateRequest

UpdateAgreementJSONBody defines parameters for UpdateAgreement.

type UpdateAgreementJSONRequestBody

type UpdateAgreementJSONRequestBody UpdateAgreementJSONBody

UpdateAgreementRequestBody defines body for UpdateAgreement for application/json ContentType.

type UpdateAgreementWithAttachmentJSONBody added in v1.5.21

type UpdateAgreementWithAttachmentJSONBody AgreementAttachmentJSON

UpdateAgreementWithAttachmentJSONBody defines parameters for UpdateAgreementWithAttachment.

type UpdateAgreementWithAttachmentJSONRequestBody

type UpdateAgreementWithAttachmentJSONRequestBody UpdateAgreementWithAttachmentJSONBody

UpdateAgreementWithAttachmentRequestBody defines body for UpdateAgreementWithAttachment for application/json ContentType.

type UpdateCollectionJSONBody added in v1.5.21

type UpdateCollectionJSONBody struct {

	// The blockchain based address of the agreement to add to the collection
	Agreement *string `json:"agreement,omitempty"`

	// The unique identifier of the collection
	CollectionId *string `json:"collectionId,omitempty"`
}

UpdateCollectionJSONBody defines parameters for UpdateCollection.

type UpdateCollectionJSONRequestBody

type UpdateCollectionJSONRequestBody UpdateCollectionJSONBody

UpdateCollectionRequestBody defines body for UpdateCollection for application/json ContentType.

type UpdateDepartmentNameJSONBody added in v1.5.21

type UpdateDepartmentNameJSONBody struct {

	// New name of the department
	Name *string `json:"name,omitempty"`
}

UpdateDepartmentNameJSONBody defines parameters for UpdateDepartmentName.

type UpdateDepartmentNameJSONRequestBody added in v1.5.0

type UpdateDepartmentNameJSONRequestBody UpdateDepartmentNameJSONBody

UpdateDepartmentNameRequestBody defines body for UpdateDepartmentName for application/json ContentType.

type UpdateOrganizationJSONBody added in v1.5.21

type UpdateOrganizationJSONBody OrganizationCreation

UpdateOrganizationJSONBody defines parameters for UpdateOrganization.

type UpdateOrganizationJSONRequestBody

type UpdateOrganizationJSONRequestBody UpdateOrganizationJSONBody

UpdateOrganizationRequestBody defines body for UpdateOrganization for application/json ContentType.

type UpdateTagJSONBody added in v1.5.21

type UpdateTagJSONBody struct {

	// The next text of the tag
	Text string `json:"text"`
}

UpdateTagJSONBody defines parameters for UpdateTag.

type UpdateTagJSONRequestBody

type UpdateTagJSONRequestBody UpdateTagJSONBody

UpdateTagRequestBody defines body for UpdateTag for application/json ContentType.

type UpdateTaskDataMappingJSONBody added in v1.5.21

type UpdateTaskDataMappingJSONBody DataMapping

UpdateTaskDataMappingJSONBody defines parameters for UpdateTaskDataMapping.

type UpdateTaskDataMappingJSONRequestBody

type UpdateTaskDataMappingJSONRequestBody UpdateTaskDataMappingJSONBody

UpdateTaskDataMappingRequestBody defines body for UpdateTaskDataMapping for application/json ContentType.

type UpdateTaskDataMappingsJSONBody added in v1.5.21

type UpdateTaskDataMappingsJSONBody []DataMapping

UpdateTaskDataMappingsJSONBody defines parameters for UpdateTaskDataMappings.

type UpdateTaskDataMappingsJSONRequestBody

type UpdateTaskDataMappingsJSONRequestBody UpdateTaskDataMappingsJSONBody

UpdateTaskDataMappingsRequestBody defines body for UpdateTaskDataMappings for application/json ContentType.

type UpdateTemplateDraftJSONBody added in v1.5.21

type UpdateTemplateDraftJSONBody TemplateDraft

UpdateTemplateDraftJSONBody defines parameters for UpdateTemplateDraft.

type UpdateTemplateDraftJSONRequestBody

type UpdateTemplateDraftJSONRequestBody UpdateTemplateDraftJSONBody

UpdateTemplateDraftRequestBody defines body for UpdateTemplateDraft for application/json ContentType.

type UpdateTemplateJSONBody added in v1.5.21

type UpdateTemplateJSONBody struct {

	// To update the description provide this field
	Description *string `json:"description,omitempty"`

	// To update the name provide this field
	Name *string `json:"name,omitempty"`
}

UpdateTemplateJSONBody defines parameters for UpdateTemplate.

type UpdateTemplateJSONRequestBody

type UpdateTemplateJSONRequestBody UpdateTemplateJSONBody

UpdateTemplateRequestBody defines body for UpdateTemplate for application/json ContentType.

type UpdateTemplatePriceJSONBody added in v1.5.21

type UpdateTemplatePriceJSONBody struct {

	// Price of the template
	Price *float32 `json:"price,omitempty"`
}

UpdateTemplatePriceJSONBody defines parameters for UpdateTemplatePrice.

type UpdateTemplatePriceJSONRequestBody

type UpdateTemplatePriceJSONRequestBody UpdateTemplatePriceJSONBody

UpdateTemplatePriceRequestBody defines body for UpdateTemplatePrice for application/json ContentType.

type UpdateTemplateRestrictionsJSONBody added in v1.5.21

type UpdateTemplateRestrictionsJSONBody TemplateRestrictions

UpdateTemplateRestrictionsJSONBody defines parameters for UpdateTemplateRestrictions.

type UpdateTemplateRestrictionsJSONRequestBody

type UpdateTemplateRestrictionsJSONRequestBody UpdateTemplateRestrictionsJSONBody

UpdateTemplateRestrictionsRequestBody defines body for UpdateTemplateRestrictions for application/json ContentType.

type UpdateUserProfileJSONBody added in v1.5.21

type UpdateUserProfileJSONBody UserUpdate

UpdateUserProfileJSONBody defines parameters for UpdateUserProfile.

type UpdateUserProfileJSONRequestBody

type UpdateUserProfileJSONRequestBody UpdateUserProfileJSONBody

UpdateUserProfileRequestBody defines body for UpdateUserProfile for application/json ContentType.

type User

type User struct {

	// The blockchain based address of the user
	Address *string `json:"address,omitempty"`

	// The company name on the billing account of the user
	Company *string `json:"company,omitempty"`

	// User's country code
	Country *string `json:"country,omitempty"`

	// Timestamp of user account creation (non-Unix time)
	CreatedAt *string `json:"createdAt,omitempty"`

	// The user's email address
	Email string `json:"email"`

	// Boolean representing whether user is an external user with no profile on Monax Platform
	ExternalUser *bool `json:"externalUser,omitempty"`

	// The database user id of the authenticated user
	Id *int `json:"id,omitempty"`

	// Present if the user has been invited to join another user's subscription. Contains details of the invitation.
	Invitation *UserInvitation `json:"invitation,omitempty"`

	// The full name of the user
	Name *string `json:"name,omitempty"`

	// Organizations the user belongs to
	Organizations *[]OrganizationByUsers `json:"organizations,omitempty"`

	// A preferred name of the user
	PreferredName *string `json:"preferredName,omitempty"`

	// Hash of the user's region in hex encoding
	Region *string `json:"region,omitempty"`

	// The high level subscription information
	Subscription *UserSubscription `json:"subscription,omitempty"`

	// Whether the user has accepted the platform terms of use by singing the in-built agreement
	TermsAccepted *bool `json:"termsAccepted,omitempty"`

	// The system generated id of the user
	Userid *string `json:"userid,omitempty"`

	// The user's userName
	Username string `json:"username"`
}

User defines model for User.

type UserInvitation added in v1.5.13

type UserInvitation struct {

	// The email address of the invited user.
	Email *string `json:"email,omitempty"`

	// The identifier of the invitation.
	InvitationCode *string `json:"invitationCode,omitempty"`

	// The company that owns the subscription to which the user is invited.
	SubscriberCompany *string `json:"subscriberCompany,omitempty"`

	// The full name of the owner of the subcription to which the user is invited.
	SubscriberName *string `json:"subscriberName,omitempty"`

	// The subscription identifier from the platform's billing provider
	SubscriptionId *string `json:"subscriptionId,omitempty"`
}

UserInvitation defines model for UserInvitation.

type UserSubscription

type UserSubscription struct {

	// The addons to the subscription purchased by the account owner
	Addons *[]string `json:"addons,omitempty"`

	// The customer identifier from the platform's billing provider
	CustomerId *string `json:"customer_id,omitempty"`

	// The subscription identifier from the platform's billing provider
	Id *string `json:"id,omitempty"`

	// The contract address of the account owner
	Owner *string `json:"owner,omitempty"`

	// The identifier of the plan
	PlanId *string `json:"plan_id,omitempty"`

	// The status of the subscription
	Status *string `json:"status,omitempty"`

	// Overview of the current usage on the platform by the user
	Usage *UserSubscriptionUsage `json:"usage,omitempty"`
}

UserSubscription defines model for UserSubscription.

type UserSubscriptionUsage

type UserSubscriptionUsage struct {

	// The number of contracts allowed on the billing account
	ContractsAllowed *int `json:"contractsAllowed,omitempty"`

	// The number of contracts that have yet to be used within the billing account
	ContractsAvailable *int `json:"contractsAvailable,omitempty"`

	// The number of contracts used within the billing account
	ContractsUsed *int `json:"contractsUsed,omitempty"`

	// End of the current billing term.
	CurrentTermEnd *string `json:"currentTermEnd,omitempty"`

	// Start of the current billing term.
	CurrentTermStart *string `json:"currentTermStart,omitempty"`

	// Listing of special contracts that the user's account has been given access to and the user's usage of those special contracts.
	// The form of the object is:
	// “`json {
	//   "CONTRACT_ADDRESS": {
	//     "contractId": "TERMS_OF_SERVICE",
	//     "allowed": 0,
	//     "used": 0,
	//     "available": null
	//   }
	// }
	SpecialContracts *map[string]interface{} `json:"specialContracts,omitempty"`

	// The number of templates allowed on the billing account
	TemplatesAllowed *int `json:"templatesAllowed,omitempty"`

	// The number of templates that have yet to be used within the billing account
	TemplatesAvailable *int `json:"templatesAvailable,omitempty"`

	// The number of templates used within the billing account
	TemplatesUsed *int `json:"templatesUsed,omitempty"`

	// The number of users allowed on the billing account
	UsersAllowed *int `json:"usersAllowed,omitempty"`

	// The number of users that have yet to be used within the billing account
	UsersAvailable *int `json:"usersAvailable,omitempty"`

	// The number of users used within the billing account
	UsersUsed *int `json:"usersUsed,omitempty"`
}

UserSubscriptionUsage defines model for UserSubscriptionUsage.

type UserToken

type UserToken struct {
	// Embedded struct due to allOf(#/components/schemas/AccountUser)
	AccountUser

	// Whether the user has been blocked by administrator
	Blocked *bool `json:"blocked,omitempty"`

	// Unix timestamp of when the token's session will expire
	SessionExp *int `json:"sessionExp,omitempty"`

	// Whether the user has accepted the platform terms of use by singing the in-built agreement
	TermsAccepted *bool `json:"termsAccepted,omitempty"`
}

UserToken defines model for UserToken.

type UserUpdate

type UserUpdate struct {

	// User's country code
	Country *string `json:"country,omitempty"`

	// The user's email address
	Email *string `json:"email,omitempty"`

	// The full name of the user
	Name *string `json:"name,omitempty"`

	// A preferred name of the user
	PreferredName *string `json:"preferredName,omitempty"`

	// Hash of the user's region in hex encoding
	Region *string `json:"region,omitempty"`

	// The user's userName
	Username *string `json:"username,omitempty"`
}

UserUpdate defines model for UserUpdate.

type UsersByGroup

type UsersByGroup []struct {

	// The blockchain based address of the user
	Address *string `json:"address,omitempty"`

	// If the user has registered their name, the user's name and username. Otherwise the user's email address.
	DisplayName *string `json:"displayName,omitempty"`

	// The user's email address
	Email *string `json:"email,omitempty"`

	// Boolean representing whether user is an external user with no profile on Monax Platform
	ExternalUser *bool `json:"externalUser,omitempty"`

	// The database user id of the authenticated user
	Id *int `json:"id,omitempty"`

	// The full name of the user
	Name *string `json:"name,omitempty"`

	// The system generated id of the user
	Userid *string `json:"userid,omitempty"`
}

UsersByGroup defines model for UsersByGroup.

type WorkflowApplications

type WorkflowApplications []struct {
	AccessPoints *[]struct {
		AccessPoints *string `json:"accessPoints,omitempty"`
		DataType     *int    `json:"dataType,omitempty"`
		Direction    *int    `json:"direction,omitempty"`
	} `json:"accessPoints,omitempty"`

	// The type of application and how it handles data
	ApplicationType *int `json:"applicationType,omitempty"`

	// The unique identifier of the application
	Id       *string `json:"id,omitempty"`
	Location *string `json:"location,omitempty"`
	WebForm  *string `json:"webForm,omitempty"`
}

WorkflowApplications defines model for WorkflowApplications.

type WorkflowDiagram

type WorkflowDiagram struct {

	// with details of the model and processes belonging to it
	Model *struct {
		DataStores *[]struct {
			DataPath      *string  `json:"dataPath,omitempty"`
			DataStorage   *string  `json:"dataStorage,omitempty"`
			ParameterType *float32 `json:"parameterType,omitempty"`
		} `json:"dataStores,omitempty"`
		Id      *string    `json:"id,omitempty"`
		Name    *string    `json:"name,omitempty"`
		Private *bool      `json:"private,omitempty"`
		Version *[]float32 `json:"version,omitempty"`
	} `json:"model,omitempty"`
	Processes *[]struct {
		Id           *string `json:"id,omitempty"`
		Interface    *string `json:"interface,omitempty"`
		Name         *string `json:"name,omitempty"`
		Participants *[]struct {
			ConditionalPerformer *bool     `json:"conditionalPerformer,omitempty"`
			DataPath             *string   `json:"dataPath,omitempty"`
			DataStorageId        *string   `json:"dataStorageId,omitempty"`
			Id                   *string   `json:"id,omitempty"`
			Name                 *string   `json:"name,omitempty"`
			Tasks                *[]string `json:"tasks,omitempty"`
		} `json:"participants,omitempty"`
		ReceiveTasks *[]string `json:"receiveTasks,omitempty"`
		SendTasks    *[]string `json:"sendTasks,omitempty"`
		ServiceTasks *[]string `json:"serviceTasks,omitempty"`
		Tasks        *[]string `json:"tasks,omitempty"`
		Transitions  *[]string `json:"transitions,omitempty"`
		UserTasks    *[]struct {
			ActivityType           *float32 `json:"activityType,omitempty"`
			Application            *string  `json:"application,omitempty"`
			Assignee               *string  `json:"assignee,omitempty"`
			Behavior               *float32 `json:"behavior,omitempty"`
			Id                     *string  `json:"id,omitempty"`
			MultiInstance          *bool    `json:"multiInstance,omitempty"`
			Name                   *string  `json:"name,omitempty"`
			SubProcessDefinitionId *string  `json:"subProcessDefinitionId,omitempty"`
			SubProcessModelId      *string  `json:"subProcessModelId,omitempty"`
			TaskType               *float32 `json:"taskType,omitempty"`
		} `json:"userTasks,omitempty"`
	} `json:"processes,omitempty"`
}

WorkflowDiagram defines model for WorkflowDiagram.

type WorkflowModel

type WorkflowModel struct {

	// Marks whether the version of the workflow in question is active within the platform or not.
	Active bool `json:"active"`

	// The blockchain based contract address of the author of the model
	Author string `json:"author"`

	// The unique identifier applied to the model by the modeller software that was used to create it.
	Id string `json:"id"`

	// Marks whether the contents of the model reference file are encrypted or not.
	IsPrivate bool `json:"isPrivate"`

	// The blockchain based contract address containing the overall model contract
	ModelAddress string `json:"modelAddress"`

	// The reference to the contents of the model file (the actual BPMN file).
	ModelFileReference string `json:"modelFileReference"`

	// Human readable name of the model
	Name *string `json:"name,omitempty"`

	// The semver major version number
	VersionMajor int `json:"versionMajor"`

	// The semver minor version number
	VersionMinor int `json:"versionMinor"`

	// The semver patch version number
	VersionPatch int `json:"versionPatch"`
}

WorkflowModel defines model for WorkflowModel.

type WorkflowModels

type WorkflowModels []WorkflowModel

WorkflowModels defines model for WorkflowModels.

type WorkflowProcessDefinition

type WorkflowProcessDefinition struct {

	// The blockchain based address of the contract defining the process definition.
	Address *string `json:"address,omitempty"`

	// The blockchain based address of the contract representing the entity who authored the model by uploading it into the platform.
	Author *string `json:"author,omitempty"`

	// Human readable name of the author of the workflow process
	AuthorDisplayName *string `json:"authorDisplayName,omitempty"`

	// The unique identifier of the interface in question. In other words is the process defining a workflow which can be attached to the formation or the execution of an agreement.
	InterfaceId *string `json:"interfaceId,omitempty"`

	// Whether the encryption system is turned on for the model file reference
	IsPrivate *bool `json:"isPrivate,omitempty"`

	// The blockchain based address of the contract defining the workflow model.
	ModelAddress *string `json:"modelAddress,omitempty"`

	// Reference file locator
	ModelFileReference *string `json:"modelFileReference,omitempty"`

	// The unique identifier of the process model in question.
	ModelId *string `json:"modelId,omitempty"`

	// The unique identifier of the process definition
	ProcessDefinitionId *string `json:"processDefinitionId,omitempty"`

	// Human readable name of the process defined herein
	ProcessName *string `json:"processName,omitempty"`
}

WorkflowProcessDefinition defines model for WorkflowProcessDefinition.

type WorkflowProcessDefinitions

type WorkflowProcessDefinitions []WorkflowProcessDefinition

WorkflowProcessDefinitions defines model for WorkflowProcessDefinitions.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL