api

Sep 9, 2024

Changes in this version

type FieldValidationError

+ func (f *FieldValidationError) String() string

Aug 26, 2023

Changes in this version

type APIv1

+ func (s *APIv1) LookupAutocomplete(ctx context.Context) (out map[string]string, err error)

+ func (s *APIv1) NetworkActivity(ctx context.Context) (out *NetworkActivityReply, err error)

+ type Activity struct

+ Date string

+ Events int

type BFFClient

+ LookupAutocomplete func(context.Context) (map[string]string, error)

+ NetworkActivity func(context.Context) (*NetworkActivityReply, error)

+ type NetworkActivityReply struct

+ MainNet []Activity

+ TestNet []Activity

Jul 13, 2023

Changes in this version

+ var ErrMissingMemberID = errors.New("member ID is required to query member details")

type APIv1

+ func (s *APIv1) MemberList(ctx context.Context, in *MemberPageInfo) (out *MemberListReply, err error)

type BFFClient

+ MemberList func(context.Context, *MemberPageInfo) (*MemberListReply, error)

type MemberDetailsReply

+ Contacts map[string]interface{}

+ type MemberListReply struct

+ NextPageToken string

+ VASPs []*members.VASPMember

+ type MemberPageInfo struct

+ Directory string

+ PageSize int32

+ PageToken string

Jun 1, 2023

Changes in this version

type APIv1

+ func (s *APIv1) DeleteOrganization(ctx context.Context, id string) (err error)

+ func (s *APIv1) PatchOrganization(ctx context.Context, id string, in *OrganizationParams) (out *OrganizationReply, err error)

+ func (s *APIv1) ResetRegistrationForm(ctx context.Context, in *RegistrationFormParams) (form *RegistrationForm, err error)

type BFFClient

+ DeleteOrganization func(_ context.Context, id string) error

+ PatchOrganization func(_ context.Context, id string, request *OrganizationParams) (*OrganizationReply, error)

+ ResetRegistrationForm func(context.Context, *RegistrationFormParams) (*RegistrationForm, error)

+ type FieldValidationError struct

+ Error string

+ Field string

+ Index int

+ func FromValidationErrors(err error) []*FieldValidationError

+ func NewFieldValidationError(err error) *FieldValidationError

+ type ListOrganizationsParams struct

+ Name string

+ Page int

+ PageSize int

+ type ListOrganizationsReply struct

+ Count int

+ Organizations []*OrganizationReply

+ Page int

+ PageSize int

+ type RegistrationForm struct

+ Errors []*FieldValidationError

+ Form *models.RegistrationForm

+ Step RegistrationFormStep

+ func (r *RegistrationForm) MarshalStepJSON() (_ gin.H, err error)

+ type RegistrationFormParams struct

+ Step RegistrationFormStep

+ type RegistrationFormStep string

+ const StepBasicDetails

+ const StepContacts

+ const StepLegalPerson

+ const StepTRISA

+ const StepTRIXO

Dec 12, 2022

Changes in this version

type APIv1

+ func (s *APIv1) UpdateUser(ctx context.Context, in *UpdateUserParams) (err error)

type BFFClient

+ UpdateUser func(context.Context, *UpdateUserParams) error

type OrganizationReply

+ LastLogin string

+ type UpdateUserParams struct

+ Name string

Dec 2, 2022

Changes in this version

type APIv1

+ func (s *APIv1) CreateOrganization(ctx context.Context, in *OrganizationParams) (out *OrganizationReply, err error)

+ func (s *APIv1) ListCollaborators(ctx context.Context) (out *ListCollaboratorsReply, err error)

+ func (s *APIv1) ListOrganizations(ctx context.Context) (out []*OrganizationReply, err error)

+ func (s *APIv1) ListUserRoles(ctx context.Context) (out []string, err error)

+ func (s *APIv1) UserOrganization(ctx context.Context) (out *OrganizationReply, err error)

type BFFClient

+ CreateOrganization func(context.Context, *OrganizationParams) (*OrganizationReply, error)

+ ListCollaborators func(context.Context) (*ListCollaboratorsReply, error)

+ ListOrganizations func(context.Context) ([]*OrganizationReply, error)

+ ListUserRoles func(context.Context) ([]string, error)

+ UserOrganization func(context.Context) (*OrganizationReply, error)

+ type ListCollaboratorsReply struct

+ Collaborators []*models.Collaborator

+ type LoginParams struct

+ OrgID string

+ type OrganizationParams struct

+ Domain string

+ Name string

+ type OrganizationReply struct

+ CreatedAt string

+ Domain string

+ ID string

+ Name string

+ RefreshToken bool

Nov 2, 2022

Changes in this version

+ var ErrIDRequired = errors.New("request requires a valid ID to determine the endpoint path")

type APIv1

+ func (s *APIv1) DeleteCollaborator(ctx context.Context, id string) (err error)

+ func (s *APIv1) UpdateCollaboratorRoles(ctx context.Context, id string, request *UpdateRolesParams) (collaborator *models.Collaborator, err error)

type BFFClient

+ DeleteCollaborator func(_ context.Context, id string) error

+ UpdateCollaboratorRoles func(_ context.Context, id string, request *UpdateRolesParams) (*models.Collaborator, error)

+ type UpdateRolesParams struct

+ Roles []string

Sep 24, 2022

Changes in this version

type APIv1

+ func (s *APIv1) AddCollaborator(ctx context.Context, request *models.Collaborator) (collaborator *models.Collaborator, err error)

+ func (s *APIv1) ReplaceCollaborator(ctx context.Context, request *models.Collaborator) (collaborator *models.Collaborator, err error)

type BFFClient

+ AddCollaborator func(context.Context, *models.Collaborator) (*models.Collaborator, error)

+ ReplaceCollaborator func(context.Context, *models.Collaborator) (*models.Collaborator, error)

Sep 17, 2022

Changes in this version

type MemberDetails

+ FirstListed string

+ LastUpdated string

+ VerifiedOn string

type RegisterReply

+ RefreshToken bool

Aug 30, 2022

Changes in this version

+ var ErrExpiredCredentials = errors.New("auth0 credentials have expired")

+ var ErrInvalidCredentials = errors.New("auth0 credentials are missing or invalid")

+ var ErrPathRequired = errors.New("local credentials requires a path to the stored json credential")

+ func MustRefreshToken(c *gin.Context, err interface{})

type APIv1

+ func (c *APIv1) SetCSRFProtect(protect bool) error

+ func (c *APIv1) SetCredentials(creds Credentials)

+ func (s *APIv1) Announcements(ctx context.Context) (out *AnnouncementsReply, err error)

+ func (s *APIv1) Attention(ctx context.Context) (out *AttentionReply, err error)

+ func (s *APIv1) Certificates(ctx context.Context) (out *CertificatesReply, err error)

+ func (s *APIv1) LoadRegistrationForm(ctx context.Context) (form *models.RegistrationForm, err error)

+ func (s *APIv1) Login(ctx context.Context) (err error)

+ func (s *APIv1) MakeAnnouncement(ctx context.Context, in *models.Announcement) (err error)

+ func (s *APIv1) MemberDetails(ctx context.Context, in *MemberDetailsParams) (out *MemberDetailsReply, err error)

+ func (s *APIv1) Overview(ctx context.Context) (out *OverviewReply, err error)

+ func (s *APIv1) RegistrationStatus(ctx context.Context) (out *RegistrationStatus, err error)

+ func (s *APIv1) SaveRegistrationForm(ctx context.Context, form *models.RegistrationForm) (err error)

+ func (s *APIv1) SubmitRegistration(ctx context.Context, network string) (out *RegisterReply, err error)

+ type AnnouncementsReply struct

+ Announcements []*models.Announcement

+ LastUpdated string

+ type AttentionMessage struct

+ Action string

+ Message string

+ Severity string

+ type AttentionReply struct

+ Messages []*AttentionMessage

+ type Auth0Token struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ExpiresIn int64

+ Scope string

+ Token string

+ Type string

+ func (t *Auth0Token) AccessToken() (_ string, err error)

type BFFClient

+ Announcements func(context.Context) (*AnnouncementsReply, error)

+ Attention func(context.Context) (*AttentionReply, error)

+ Certificates func(context.Context) (*CertificatesReply, error)

+ LoadRegistrationForm func(context.Context) (*models.RegistrationForm, error)

+ Login func(context.Context) error

+ MakeAnnouncement func(context.Context, *models.Announcement) error

+ MemberDetails func(context.Context, *MemberDetailsParams) (*MemberDetailsReply, error)

+ Overview func(context.Context) (*OverviewReply, error)

+ RegistrationStatus func(context.Context) (*RegistrationStatus, error)

+ SaveRegistrationForm func(context.Context, *models.RegistrationForm) error

+ SubmitRegistration func(_ context.Context, network string) (*RegisterReply, error)

+ type Certificate struct

+ Details map[string]interface{}

+ ExpiresAt string

+ IssuedAt string

+ Revoked bool

+ SerialNumber string

+ type CertificatesReply struct

+ Error NetworkError

+ MainNet []Certificate

+ TestNet []Certificate

+ type ClientOption func(c *APIv1) error

+ func WithClient(client *http.Client) ClientOption

+ func WithCredentials(creds Credentials) ClientOption

+ type Credentials interface

+ AccessToken func() (string, error)

+ type LocalCredentials struct

+ Path string

+ Token *Auth0Token

+ func (t *LocalCredentials) AccessToken() (_ string, err error)

+ func (t *LocalCredentials) Dump() (err error)

+ func (t *LocalCredentials) Load() (err error)

type LookupReply

+ MainNet map[string]interface{}

+ TestNet map[string]interface{}

+ type MemberDetails struct

+ Certificate map[string]interface{}

+ CountryCode string

+ ID string

+ Status string

+ type MemberDetailsParams struct

+ Directory string

+ ID string

+ type MemberDetailsReply struct

+ LegalPerson map[string]interface{}

+ Summary *members.VASPMember

+ Trixo map[string]interface{}

+ type NetworkError struct

+ MainNet string

+ TestNet string

+ type NetworkOverview struct

+ CertificatesIssued int

+ MemberDetails MemberDetails

+ NewMembers int

+ Status string

+ Vasps int

+ type OverviewReply struct

+ Error NetworkError

+ MainNet NetworkOverview

+ OrgID string

+ TestNet NetworkOverview

+ type RegistrationStatus struct

+ MainNetSubmitted string

+ TestNetSubmitted string

type Reply

+ RefreshToken bool

+ type Token string

+ func (t Token) AccessToken() (string, error)

Apr 21, 2022

Changes in this version

+ var ErrNetworkRequired = errors.New("request requires a valid network (mainnet or testnet)")

+ func NotAllowed(c *gin.Context)

+ func NotFound(c *gin.Context)

+ type APIv1 struct

+ func (s *APIv1) Do(req *http.Request, data interface{}, checkStatus bool) (rep *http.Response, err error)

+ func (s *APIv1) Lookup(ctx context.Context, in *LookupParams) (out *LookupReply, err error)

+ func (s *APIv1) NewRequest(ctx context.Context, method, path string, data interface{}, params *url.Values) (req *http.Request, err error)

+ func (s *APIv1) Register(ctx context.Context, in *RegisterRequest) (out *RegisterReply, err error)

+ func (s *APIv1) Status(ctx context.Context, in *StatusParams) (out *StatusReply, err error)

+ func (s *APIv1) VerifyContact(ctx context.Context, in *VerifyContactParams) (out *VerifyContactReply, err error)

+ type BFFClient interface

+ Lookup func(ctx context.Context, in *LookupParams) (out *LookupReply, err error)

+ Register func(ctx context.Context, in *RegisterRequest) (out *RegisterReply, err error)

+ Status func(ctx context.Context, in *StatusParams) (out *StatusReply, err error)

+ VerifyContact func(ctx context.Context, in *VerifyContactParams) (out *VerifyContactReply, err error)

+ func New(endpoint string) (_ BFFClient, err error)

+ type LookupParams struct

+ CommonName string

+ ID string

+ type LookupReply struct

+ Results []map[string]interface{}

+ type RegisterReply struct

+ CommonName string

+ Error map[string]interface{}

+ Id string

+ Message string

+ PKCS12Password string

+ RegisteredDirectory string

+ Status string

+ type RegisterRequest struct

+ BusinessCategory string

+ CommonName string

+ Contacts map[string]interface{}

+ Entity map[string]interface{}

+ EstablishedOn string

+ Network string

+ TRISAEndpoint string

+ TRIXO map[string]interface{}

+ VASPCategories []string

+ Website string

+ type Reply struct

+ Error string

+ Success bool

+ func ErrorResponse(err interface{}) Reply

+ type StatusParams struct

+ NoGDS bool

+ type StatusReply struct

+ MainNet string

+ Status string

+ TestNet string

+ Uptime string

+ Version string

+ type VerifyContactParams struct

+ Directory string

+ ID string

+ Token string

+ type VerifyContactReply struct

+ Error map[string]interface{}

+ Message string

+ Status string