Added description

bitcoin-sv · Feb 2, 2024 · 87d84c2 · 87d84c2
1 parent f8453fa
commit 87d84c2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/paymail_addresses.go b/paymail_addresses.go
@@ -8,6 +8,8 @@ import (
 )
 
 // NewPaymail will create a new paymail
+//
+// Paymail address (ie. [email protected])
 func (b *BuxClient) NewPaymail(ctx context.Context, rawXPub, paymailAddress, avatar, publicName string, metadata *buxmodels.Metadata) transports.ResponseError {
 	return b.transport.NewPaymail(ctx, rawXPub, paymailAddress, avatar, publicName, metadata)
 }
diff --git a/transports/interface.go b/transports/interface.go
@@ -71,6 +71,9 @@ type AdminService interface {
 	AdminGetPaymail(ctx context.Context, address string) (*buxmodels.PaymailAddress, ResponseError)
 	AdminGetPaymails(ctx context.Context, conditions map[string]interface{}, metadata *buxmodels.Metadata, queryParams *QueryParams) ([]*buxmodels.PaymailAddress, ResponseError)
 	AdminGetPaymailsCount(ctx context.Context, conditions map[string]interface{}, metadata *buxmodels.Metadata) (int64, ResponseError)
+	// AdminCreatePaymail Create a paymail.
+	//
+	// Paymail address (ie. [email protected])
 	AdminCreatePaymail(ctx context.Context, xPubID string, address string, publicName string, avatar string) (*buxmodels.PaymailAddress, ResponseError)
 	AdminDeletePaymail(ctx context.Context, address string) (*buxmodels.PaymailAddress, ResponseError)
 	AdminGetTransactions(ctx context.Context, conditions map[string]interface{}, metadata *buxmodels.Metadata, queryParams *QueryParams) ([]*buxmodels.Transaction, ResponseError)