Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterEmailVerificationServer(s grpc.ServiceRegistrar, srv EmailVerificationServer)
- type CheckVerificationCodeRequest
- func (*CheckVerificationCodeRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CheckVerificationCodeRequest) GetAuth() *v1.Auth
- func (x *CheckVerificationCodeRequest) GetCode() *VerificationCode
- func (x *CheckVerificationCodeRequest) GetEmailAddress() *EmailAddress
- func (*CheckVerificationCodeRequest) ProtoMessage()
- func (x *CheckVerificationCodeRequest) ProtoReflect() protoreflect.Message
- func (x *CheckVerificationCodeRequest) Reset()
- func (x *CheckVerificationCodeRequest) String() string
- func (m *CheckVerificationCodeRequest) Validate() error
- func (m *CheckVerificationCodeRequest) ValidateAll() error
- type CheckVerificationCodeRequestMultiError
- type CheckVerificationCodeRequestValidationError
- func (e CheckVerificationCodeRequestValidationError) Cause() error
- func (e CheckVerificationCodeRequestValidationError) Error() string
- func (e CheckVerificationCodeRequestValidationError) ErrorName() string
- func (e CheckVerificationCodeRequestValidationError) Field() string
- func (e CheckVerificationCodeRequestValidationError) Key() bool
- func (e CheckVerificationCodeRequestValidationError) Reason() string
- type CheckVerificationCodeResponse
- func (*CheckVerificationCodeResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CheckVerificationCodeResponse) GetResult() CheckVerificationCodeResponse_Result
- func (*CheckVerificationCodeResponse) ProtoMessage()
- func (x *CheckVerificationCodeResponse) ProtoReflect() protoreflect.Message
- func (x *CheckVerificationCodeResponse) Reset()
- func (x *CheckVerificationCodeResponse) String() string
- func (m *CheckVerificationCodeResponse) Validate() error
- func (m *CheckVerificationCodeResponse) ValidateAll() error
- type CheckVerificationCodeResponseMultiError
- type CheckVerificationCodeResponseValidationError
- func (e CheckVerificationCodeResponseValidationError) Cause() error
- func (e CheckVerificationCodeResponseValidationError) Error() string
- func (e CheckVerificationCodeResponseValidationError) ErrorName() string
- func (e CheckVerificationCodeResponseValidationError) Field() string
- func (e CheckVerificationCodeResponseValidationError) Key() bool
- func (e CheckVerificationCodeResponseValidationError) Reason() string
- type CheckVerificationCodeResponse_Result
- func (CheckVerificationCodeResponse_Result) Descriptor() protoreflect.EnumDescriptor
- func (x CheckVerificationCodeResponse_Result) Enum() *CheckVerificationCodeResponse_Result
- func (CheckVerificationCodeResponse_Result) EnumDescriptor() ([]byte, []int)deprecated
- func (x CheckVerificationCodeResponse_Result) Number() protoreflect.EnumNumber
- func (x CheckVerificationCodeResponse_Result) String() string
- func (CheckVerificationCodeResponse_Result) Type() protoreflect.EnumType
- type EmailAddress
- func (*EmailAddress) Descriptor() ([]byte, []int)deprecated
- func (x *EmailAddress) GetValue() string
- func (*EmailAddress) ProtoMessage()
- func (x *EmailAddress) ProtoReflect() protoreflect.Message
- func (x *EmailAddress) Reset()
- func (x *EmailAddress) String() string
- func (m *EmailAddress) Validate() error
- func (m *EmailAddress) ValidateAll() error
- type EmailAddressMultiError
- type EmailAddressValidationError
- func (e EmailAddressValidationError) Cause() error
- func (e EmailAddressValidationError) Error() string
- func (e EmailAddressValidationError) ErrorName() string
- func (e EmailAddressValidationError) Field() string
- func (e EmailAddressValidationError) Key() bool
- func (e EmailAddressValidationError) Reason() string
- type EmailVerificationClient
- type EmailVerificationServer
- type SendVerificationCodeRequest
- func (*SendVerificationCodeRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SendVerificationCodeRequest) GetAuth() *v1.Auth
- func (x *SendVerificationCodeRequest) GetClientData() string
- func (x *SendVerificationCodeRequest) GetEmailAddress() *EmailAddress
- func (*SendVerificationCodeRequest) ProtoMessage()
- func (x *SendVerificationCodeRequest) ProtoReflect() protoreflect.Message
- func (x *SendVerificationCodeRequest) Reset()
- func (x *SendVerificationCodeRequest) String() string
- func (m *SendVerificationCodeRequest) Validate() error
- func (m *SendVerificationCodeRequest) ValidateAll() error
- type SendVerificationCodeRequestMultiError
- type SendVerificationCodeRequestValidationError
- func (e SendVerificationCodeRequestValidationError) Cause() error
- func (e SendVerificationCodeRequestValidationError) Error() string
- func (e SendVerificationCodeRequestValidationError) ErrorName() string
- func (e SendVerificationCodeRequestValidationError) Field() string
- func (e SendVerificationCodeRequestValidationError) Key() bool
- func (e SendVerificationCodeRequestValidationError) Reason() string
- type SendVerificationCodeResponse
- func (*SendVerificationCodeResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SendVerificationCodeResponse) GetResult() SendVerificationCodeResponse_Result
- func (*SendVerificationCodeResponse) ProtoMessage()
- func (x *SendVerificationCodeResponse) ProtoReflect() protoreflect.Message
- func (x *SendVerificationCodeResponse) Reset()
- func (x *SendVerificationCodeResponse) String() string
- func (m *SendVerificationCodeResponse) Validate() error
- func (m *SendVerificationCodeResponse) ValidateAll() error
- type SendVerificationCodeResponseMultiError
- type SendVerificationCodeResponseValidationError
- func (e SendVerificationCodeResponseValidationError) Cause() error
- func (e SendVerificationCodeResponseValidationError) Error() string
- func (e SendVerificationCodeResponseValidationError) ErrorName() string
- func (e SendVerificationCodeResponseValidationError) Field() string
- func (e SendVerificationCodeResponseValidationError) Key() bool
- func (e SendVerificationCodeResponseValidationError) Reason() string
- type SendVerificationCodeResponse_Result
- func (SendVerificationCodeResponse_Result) Descriptor() protoreflect.EnumDescriptor
- func (x SendVerificationCodeResponse_Result) Enum() *SendVerificationCodeResponse_Result
- func (SendVerificationCodeResponse_Result) EnumDescriptor() ([]byte, []int)deprecated
- func (x SendVerificationCodeResponse_Result) Number() protoreflect.EnumNumber
- func (x SendVerificationCodeResponse_Result) String() string
- func (SendVerificationCodeResponse_Result) Type() protoreflect.EnumType
- type UnimplementedEmailVerificationServer
- func (UnimplementedEmailVerificationServer) CheckVerificationCode(context.Context, *CheckVerificationCodeRequest) (*CheckVerificationCodeResponse, error)
- func (UnimplementedEmailVerificationServer) SendVerificationCode(context.Context, *SendVerificationCodeRequest) (*SendVerificationCodeResponse, error)
- func (UnimplementedEmailVerificationServer) Unlink(context.Context, *UnlinkRequest) (*UnlinkResponse, error)
- type UnlinkRequest
- func (*UnlinkRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UnlinkRequest) GetAuth() *v1.Auth
- func (x *UnlinkRequest) GetEmailAddress() *EmailAddress
- func (*UnlinkRequest) ProtoMessage()
- func (x *UnlinkRequest) ProtoReflect() protoreflect.Message
- func (x *UnlinkRequest) Reset()
- func (x *UnlinkRequest) String() string
- func (m *UnlinkRequest) Validate() error
- func (m *UnlinkRequest) ValidateAll() error
- type UnlinkRequestMultiError
- type UnlinkRequestValidationError
- func (e UnlinkRequestValidationError) Cause() error
- func (e UnlinkRequestValidationError) Error() string
- func (e UnlinkRequestValidationError) ErrorName() string
- func (e UnlinkRequestValidationError) Field() string
- func (e UnlinkRequestValidationError) Key() bool
- func (e UnlinkRequestValidationError) Reason() string
- type UnlinkResponse
- func (*UnlinkResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UnlinkResponse) GetResult() UnlinkResponse_Result
- func (*UnlinkResponse) ProtoMessage()
- func (x *UnlinkResponse) ProtoReflect() protoreflect.Message
- func (x *UnlinkResponse) Reset()
- func (x *UnlinkResponse) String() string
- func (m *UnlinkResponse) Validate() error
- func (m *UnlinkResponse) ValidateAll() error
- type UnlinkResponseMultiError
- type UnlinkResponseValidationError
- func (e UnlinkResponseValidationError) Cause() error
- func (e UnlinkResponseValidationError) Error() string
- func (e UnlinkResponseValidationError) ErrorName() string
- func (e UnlinkResponseValidationError) Field() string
- func (e UnlinkResponseValidationError) Key() bool
- func (e UnlinkResponseValidationError) Reason() string
- type UnlinkResponse_Result
- func (UnlinkResponse_Result) Descriptor() protoreflect.EnumDescriptor
- func (x UnlinkResponse_Result) Enum() *UnlinkResponse_Result
- func (UnlinkResponse_Result) EnumDescriptor() ([]byte, []int)deprecated
- func (x UnlinkResponse_Result) Number() protoreflect.EnumNumber
- func (x UnlinkResponse_Result) String() string
- func (UnlinkResponse_Result) Type() protoreflect.EnumType
- type UnsafeEmailVerificationServer
- type VerificationCode
- func (*VerificationCode) Descriptor() ([]byte, []int)deprecated
- func (x *VerificationCode) GetValue() string
- func (*VerificationCode) ProtoMessage()
- func (x *VerificationCode) ProtoReflect() protoreflect.Message
- func (x *VerificationCode) Reset()
- func (x *VerificationCode) String() string
- func (m *VerificationCode) Validate() error
- func (m *VerificationCode) ValidateAll() error
- type VerificationCodeMultiError
- type VerificationCodeValidationError
- func (e VerificationCodeValidationError) Cause() error
- func (e VerificationCodeValidationError) Error() string
- func (e VerificationCodeValidationError) ErrorName() string
- func (e VerificationCodeValidationError) Field() string
- func (e VerificationCodeValidationError) Key() bool
- func (e VerificationCodeValidationError) Reason() string
Constants ¶
const ( EmailVerification_SendVerificationCode_FullMethodName = "/flipcash.email.v1.EmailVerification/SendVerificationCode" EmailVerification_CheckVerificationCode_FullMethodName = "/flipcash.email.v1.EmailVerification/CheckVerificationCode" EmailVerification_Unlink_FullMethodName = "/flipcash.email.v1.EmailVerification/Unlink" )
Variables ¶
var ( SendVerificationCodeResponse_Result_name = map[int32]string{ 0: "OK", 1: "DENIED", 2: "RATE_LIMITED", 3: "INVALID_EMAIL_ADDRESS", } SendVerificationCodeResponse_Result_value = map[string]int32{ "OK": 0, "DENIED": 1, "RATE_LIMITED": 2, "INVALID_EMAIL_ADDRESS": 3, } )
Enum value maps for SendVerificationCodeResponse_Result.
var ( CheckVerificationCodeResponse_Result_name = map[int32]string{ 0: "OK", 1: "DENIED", 2: "RATE_LIMITED", 3: "INVALID_CODE", 4: "NO_VERIFICATION", } CheckVerificationCodeResponse_Result_value = map[string]int32{ "OK": 0, "DENIED": 1, "RATE_LIMITED": 2, "INVALID_CODE": 3, "NO_VERIFICATION": 4, } )
Enum value maps for CheckVerificationCodeResponse_Result.
var ( UnlinkResponse_Result_name = map[int32]string{ 0: "OK", 1: "DENIED", } UnlinkResponse_Result_value = map[string]int32{ "OK": 0, "DENIED": 1, } )
Enum value maps for UnlinkResponse_Result.
var EmailVerification_ServiceDesc = grpc.ServiceDesc{ ServiceName: "flipcash.email.v1.EmailVerification", HandlerType: (*EmailVerificationServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "SendVerificationCode", Handler: _EmailVerification_SendVerificationCode_Handler, }, { MethodName: "CheckVerificationCode", Handler: _EmailVerification_CheckVerificationCode_Handler, }, { MethodName: "Unlink", Handler: _EmailVerification_Unlink_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "email/v1/email_verification_service.proto", }
EmailVerification_ServiceDesc is the grpc.ServiceDesc for EmailVerification service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_email_v1_email_verification_service_proto protoreflect.FileDescriptor
var File_email_v1_model_proto protoreflect.FileDescriptor
Functions ¶
func RegisterEmailVerificationServer ¶
func RegisterEmailVerificationServer(s grpc.ServiceRegistrar, srv EmailVerificationServer)
Types ¶
type CheckVerificationCodeRequest ¶
type CheckVerificationCodeRequest struct { // The email address being verified EmailAddress *EmailAddress `protobuf:"bytes,1,opt,name=email_address,json=emailAddress,proto3" json:"email_address,omitempty"` // The verification code received via email Code *VerificationCode `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"` Auth *v1.Auth `protobuf:"bytes,3,opt,name=auth,proto3" json:"auth,omitempty"` // contains filtered or unexported fields }
func (*CheckVerificationCodeRequest) Descriptor
deprecated
func (*CheckVerificationCodeRequest) Descriptor() ([]byte, []int)
Deprecated: Use CheckVerificationCodeRequest.ProtoReflect.Descriptor instead.
func (*CheckVerificationCodeRequest) GetAuth ¶
func (x *CheckVerificationCodeRequest) GetAuth() *v1.Auth
func (*CheckVerificationCodeRequest) GetCode ¶
func (x *CheckVerificationCodeRequest) GetCode() *VerificationCode
func (*CheckVerificationCodeRequest) GetEmailAddress ¶
func (x *CheckVerificationCodeRequest) GetEmailAddress() *EmailAddress
func (*CheckVerificationCodeRequest) ProtoMessage ¶
func (*CheckVerificationCodeRequest) ProtoMessage()
func (*CheckVerificationCodeRequest) ProtoReflect ¶
func (x *CheckVerificationCodeRequest) ProtoReflect() protoreflect.Message
func (*CheckVerificationCodeRequest) Reset ¶
func (x *CheckVerificationCodeRequest) Reset()
func (*CheckVerificationCodeRequest) String ¶
func (x *CheckVerificationCodeRequest) String() string
func (*CheckVerificationCodeRequest) Validate ¶
func (m *CheckVerificationCodeRequest) Validate() error
Validate checks the field values on CheckVerificationCodeRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*CheckVerificationCodeRequest) ValidateAll ¶
func (m *CheckVerificationCodeRequest) ValidateAll() error
ValidateAll checks the field values on CheckVerificationCodeRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CheckVerificationCodeRequestMultiError, or nil if none found.
type CheckVerificationCodeRequestMultiError ¶
type CheckVerificationCodeRequestMultiError []error
CheckVerificationCodeRequestMultiError is an error wrapping multiple validation errors returned by CheckVerificationCodeRequest.ValidateAll() if the designated constraints aren't met.
func (CheckVerificationCodeRequestMultiError) AllErrors ¶
func (m CheckVerificationCodeRequestMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (CheckVerificationCodeRequestMultiError) Error ¶
func (m CheckVerificationCodeRequestMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type CheckVerificationCodeRequestValidationError ¶
type CheckVerificationCodeRequestValidationError struct {
// contains filtered or unexported fields
}
CheckVerificationCodeRequestValidationError is the validation error returned by CheckVerificationCodeRequest.Validate if the designated constraints aren't met.
func (CheckVerificationCodeRequestValidationError) Cause ¶
func (e CheckVerificationCodeRequestValidationError) Cause() error
Cause function returns cause value.
func (CheckVerificationCodeRequestValidationError) Error ¶
func (e CheckVerificationCodeRequestValidationError) Error() string
Error satisfies the builtin error interface
func (CheckVerificationCodeRequestValidationError) ErrorName ¶
func (e CheckVerificationCodeRequestValidationError) ErrorName() string
ErrorName returns error name.
func (CheckVerificationCodeRequestValidationError) Field ¶
func (e CheckVerificationCodeRequestValidationError) Field() string
Field function returns field value.
func (CheckVerificationCodeRequestValidationError) Key ¶
func (e CheckVerificationCodeRequestValidationError) Key() bool
Key function returns key value.
func (CheckVerificationCodeRequestValidationError) Reason ¶
func (e CheckVerificationCodeRequestValidationError) Reason() string
Reason function returns reason value.
type CheckVerificationCodeResponse ¶
type CheckVerificationCodeResponse struct { Result CheckVerificationCodeResponse_Result `` /* 126-byte string literal not displayed */ // contains filtered or unexported fields }
func (*CheckVerificationCodeResponse) Descriptor
deprecated
func (*CheckVerificationCodeResponse) Descriptor() ([]byte, []int)
Deprecated: Use CheckVerificationCodeResponse.ProtoReflect.Descriptor instead.
func (*CheckVerificationCodeResponse) GetResult ¶
func (x *CheckVerificationCodeResponse) GetResult() CheckVerificationCodeResponse_Result
func (*CheckVerificationCodeResponse) ProtoMessage ¶
func (*CheckVerificationCodeResponse) ProtoMessage()
func (*CheckVerificationCodeResponse) ProtoReflect ¶
func (x *CheckVerificationCodeResponse) ProtoReflect() protoreflect.Message
func (*CheckVerificationCodeResponse) Reset ¶
func (x *CheckVerificationCodeResponse) Reset()
func (*CheckVerificationCodeResponse) String ¶
func (x *CheckVerificationCodeResponse) String() string
func (*CheckVerificationCodeResponse) Validate ¶
func (m *CheckVerificationCodeResponse) Validate() error
Validate checks the field values on CheckVerificationCodeResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*CheckVerificationCodeResponse) ValidateAll ¶
func (m *CheckVerificationCodeResponse) ValidateAll() error
ValidateAll checks the field values on CheckVerificationCodeResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CheckVerificationCodeResponseMultiError, or nil if none found.
type CheckVerificationCodeResponseMultiError ¶
type CheckVerificationCodeResponseMultiError []error
CheckVerificationCodeResponseMultiError is an error wrapping multiple validation errors returned by CheckVerificationCodeResponse.ValidateAll() if the designated constraints aren't met.
func (CheckVerificationCodeResponseMultiError) AllErrors ¶
func (m CheckVerificationCodeResponseMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (CheckVerificationCodeResponseMultiError) Error ¶
func (m CheckVerificationCodeResponseMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type CheckVerificationCodeResponseValidationError ¶
type CheckVerificationCodeResponseValidationError struct {
// contains filtered or unexported fields
}
CheckVerificationCodeResponseValidationError is the validation error returned by CheckVerificationCodeResponse.Validate if the designated constraints aren't met.
func (CheckVerificationCodeResponseValidationError) Cause ¶
func (e CheckVerificationCodeResponseValidationError) Cause() error
Cause function returns cause value.
func (CheckVerificationCodeResponseValidationError) Error ¶
func (e CheckVerificationCodeResponseValidationError) Error() string
Error satisfies the builtin error interface
func (CheckVerificationCodeResponseValidationError) ErrorName ¶
func (e CheckVerificationCodeResponseValidationError) ErrorName() string
ErrorName returns error name.
func (CheckVerificationCodeResponseValidationError) Field ¶
func (e CheckVerificationCodeResponseValidationError) Field() string
Field function returns field value.
func (CheckVerificationCodeResponseValidationError) Key ¶
func (e CheckVerificationCodeResponseValidationError) Key() bool
Key function returns key value.
func (CheckVerificationCodeResponseValidationError) Reason ¶
func (e CheckVerificationCodeResponseValidationError) Reason() string
Reason function returns reason value.
type CheckVerificationCodeResponse_Result ¶
type CheckVerificationCodeResponse_Result int32
const ( CheckVerificationCodeResponse_OK CheckVerificationCodeResponse_Result = 0 CheckVerificationCodeResponse_DENIED CheckVerificationCodeResponse_Result = 1 // The call is rate limited (eg. by IP, email address, etc). The code is // not verified. CheckVerificationCodeResponse_RATE_LIMITED CheckVerificationCodeResponse_Result = 2 // The provided verification code is invalid. The user may retry // enterring the code if this is received. When max attempts are // received, NO_VERIFICATION will be returned. CheckVerificationCodeResponse_INVALID_CODE CheckVerificationCodeResponse_Result = 3 // There is no verification in progress for the email address. Several // reasons this can occur include a verification being expired or having // reached a maximum check threshold. The client must initiate a new // verification using SendVerificationCode. CheckVerificationCodeResponse_NO_VERIFICATION CheckVerificationCodeResponse_Result = 4 )
func (CheckVerificationCodeResponse_Result) Descriptor ¶
func (CheckVerificationCodeResponse_Result) Descriptor() protoreflect.EnumDescriptor
func (CheckVerificationCodeResponse_Result) Enum ¶
func (x CheckVerificationCodeResponse_Result) Enum() *CheckVerificationCodeResponse_Result
func (CheckVerificationCodeResponse_Result) EnumDescriptor
deprecated
func (CheckVerificationCodeResponse_Result) EnumDescriptor() ([]byte, []int)
Deprecated: Use CheckVerificationCodeResponse_Result.Descriptor instead.
func (CheckVerificationCodeResponse_Result) Number ¶
func (x CheckVerificationCodeResponse_Result) Number() protoreflect.EnumNumber
func (CheckVerificationCodeResponse_Result) String ¶
func (x CheckVerificationCodeResponse_Result) String() string
func (CheckVerificationCodeResponse_Result) Type ¶
func (CheckVerificationCodeResponse_Result) Type() protoreflect.EnumType
type EmailAddress ¶
type EmailAddress struct { Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
EmailAddress is an email address
func (*EmailAddress) Descriptor
deprecated
func (*EmailAddress) Descriptor() ([]byte, []int)
Deprecated: Use EmailAddress.ProtoReflect.Descriptor instead.
func (*EmailAddress) GetValue ¶
func (x *EmailAddress) GetValue() string
func (*EmailAddress) ProtoMessage ¶
func (*EmailAddress) ProtoMessage()
func (*EmailAddress) ProtoReflect ¶
func (x *EmailAddress) ProtoReflect() protoreflect.Message
func (*EmailAddress) Reset ¶
func (x *EmailAddress) Reset()
func (*EmailAddress) String ¶
func (x *EmailAddress) String() string
func (*EmailAddress) Validate ¶
func (m *EmailAddress) Validate() error
Validate checks the field values on EmailAddress with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*EmailAddress) ValidateAll ¶
func (m *EmailAddress) ValidateAll() error
ValidateAll checks the field values on EmailAddress with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in EmailAddressMultiError, or nil if none found.
type EmailAddressMultiError ¶
type EmailAddressMultiError []error
EmailAddressMultiError is an error wrapping multiple validation errors returned by EmailAddress.ValidateAll() if the designated constraints aren't met.
func (EmailAddressMultiError) AllErrors ¶
func (m EmailAddressMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (EmailAddressMultiError) Error ¶
func (m EmailAddressMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type EmailAddressValidationError ¶
type EmailAddressValidationError struct {
// contains filtered or unexported fields
}
EmailAddressValidationError is the validation error returned by EmailAddress.Validate if the designated constraints aren't met.
func (EmailAddressValidationError) Cause ¶
func (e EmailAddressValidationError) Cause() error
Cause function returns cause value.
func (EmailAddressValidationError) Error ¶
func (e EmailAddressValidationError) Error() string
Error satisfies the builtin error interface
func (EmailAddressValidationError) ErrorName ¶
func (e EmailAddressValidationError) ErrorName() string
ErrorName returns error name.
func (EmailAddressValidationError) Field ¶
func (e EmailAddressValidationError) Field() string
Field function returns field value.
func (EmailAddressValidationError) Key ¶
func (e EmailAddressValidationError) Key() bool
Key function returns key value.
func (EmailAddressValidationError) Reason ¶
func (e EmailAddressValidationError) Reason() string
Reason function returns reason value.
type EmailVerificationClient ¶
type EmailVerificationClient interface { // SendVerificationCode sends a verification code to the provided email address. // If an active verification is already taking place, the existing code will be // resent. SendVerificationCode(ctx context.Context, in *SendVerificationCodeRequest, opts ...grpc.CallOption) (*SendVerificationCodeResponse, error) // CheckVerificationCode validates a verification code. On success, the email // address is linked to the user. Any previous links are overwritten. CheckVerificationCode(ctx context.Context, in *CheckVerificationCodeRequest, opts ...grpc.CallOption) (*CheckVerificationCodeResponse, error) // Unlink removes the link of an email address from a user. Unlink(ctx context.Context, in *UnlinkRequest, opts ...grpc.CallOption) (*UnlinkResponse, error) }
EmailVerificationClient is the client API for EmailVerification service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewEmailVerificationClient ¶
func NewEmailVerificationClient(cc grpc.ClientConnInterface) EmailVerificationClient
type EmailVerificationServer ¶
type EmailVerificationServer interface { // SendVerificationCode sends a verification code to the provided email address. // If an active verification is already taking place, the existing code will be // resent. SendVerificationCode(context.Context, *SendVerificationCodeRequest) (*SendVerificationCodeResponse, error) // CheckVerificationCode validates a verification code. On success, the email // address is linked to the user. Any previous links are overwritten. CheckVerificationCode(context.Context, *CheckVerificationCodeRequest) (*CheckVerificationCodeResponse, error) // Unlink removes the link of an email address from a user. Unlink(context.Context, *UnlinkRequest) (*UnlinkResponse, error) // contains filtered or unexported methods }
EmailVerificationServer is the server API for EmailVerification service. All implementations must embed UnimplementedEmailVerificationServer for forward compatibility.
type SendVerificationCodeRequest ¶
type SendVerificationCodeRequest struct { // The email address to send a verification code to EmailAddress *EmailAddress `protobuf:"bytes,1,opt,name=email_address,json=emailAddress,proto3" json:"email_address,omitempty"` Auth *v1.Auth `protobuf:"bytes,2,opt,name=auth,proto3" json:"auth,omitempty"` // Additional client data that is sent in the deep link ClientData string `protobuf:"bytes,3,opt,name=client_data,json=clientData,proto3" json:"client_data,omitempty"` // contains filtered or unexported fields }
func (*SendVerificationCodeRequest) Descriptor
deprecated
func (*SendVerificationCodeRequest) Descriptor() ([]byte, []int)
Deprecated: Use SendVerificationCodeRequest.ProtoReflect.Descriptor instead.
func (*SendVerificationCodeRequest) GetAuth ¶
func (x *SendVerificationCodeRequest) GetAuth() *v1.Auth
func (*SendVerificationCodeRequest) GetClientData ¶ added in v1.9.7
func (x *SendVerificationCodeRequest) GetClientData() string
func (*SendVerificationCodeRequest) GetEmailAddress ¶
func (x *SendVerificationCodeRequest) GetEmailAddress() *EmailAddress
func (*SendVerificationCodeRequest) ProtoMessage ¶
func (*SendVerificationCodeRequest) ProtoMessage()
func (*SendVerificationCodeRequest) ProtoReflect ¶
func (x *SendVerificationCodeRequest) ProtoReflect() protoreflect.Message
func (*SendVerificationCodeRequest) Reset ¶
func (x *SendVerificationCodeRequest) Reset()
func (*SendVerificationCodeRequest) String ¶
func (x *SendVerificationCodeRequest) String() string
func (*SendVerificationCodeRequest) Validate ¶
func (m *SendVerificationCodeRequest) Validate() error
Validate checks the field values on SendVerificationCodeRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*SendVerificationCodeRequest) ValidateAll ¶
func (m *SendVerificationCodeRequest) ValidateAll() error
ValidateAll checks the field values on SendVerificationCodeRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SendVerificationCodeRequestMultiError, or nil if none found.
type SendVerificationCodeRequestMultiError ¶
type SendVerificationCodeRequestMultiError []error
SendVerificationCodeRequestMultiError is an error wrapping multiple validation errors returned by SendVerificationCodeRequest.ValidateAll() if the designated constraints aren't met.
func (SendVerificationCodeRequestMultiError) AllErrors ¶
func (m SendVerificationCodeRequestMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (SendVerificationCodeRequestMultiError) Error ¶
func (m SendVerificationCodeRequestMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type SendVerificationCodeRequestValidationError ¶
type SendVerificationCodeRequestValidationError struct {
// contains filtered or unexported fields
}
SendVerificationCodeRequestValidationError is the validation error returned by SendVerificationCodeRequest.Validate if the designated constraints aren't met.
func (SendVerificationCodeRequestValidationError) Cause ¶
func (e SendVerificationCodeRequestValidationError) Cause() error
Cause function returns cause value.
func (SendVerificationCodeRequestValidationError) Error ¶
func (e SendVerificationCodeRequestValidationError) Error() string
Error satisfies the builtin error interface
func (SendVerificationCodeRequestValidationError) ErrorName ¶
func (e SendVerificationCodeRequestValidationError) ErrorName() string
ErrorName returns error name.
func (SendVerificationCodeRequestValidationError) Field ¶
func (e SendVerificationCodeRequestValidationError) Field() string
Field function returns field value.
func (SendVerificationCodeRequestValidationError) Key ¶
func (e SendVerificationCodeRequestValidationError) Key() bool
Key function returns key value.
func (SendVerificationCodeRequestValidationError) Reason ¶
func (e SendVerificationCodeRequestValidationError) Reason() string
Reason function returns reason value.
type SendVerificationCodeResponse ¶
type SendVerificationCodeResponse struct { Result SendVerificationCodeResponse_Result `protobuf:"varint,1,opt,name=result,proto3,enum=flipcash.email.v1.SendVerificationCodeResponse_Result" json:"result,omitempty"` // contains filtered or unexported fields }
func (*SendVerificationCodeResponse) Descriptor
deprecated
func (*SendVerificationCodeResponse) Descriptor() ([]byte, []int)
Deprecated: Use SendVerificationCodeResponse.ProtoReflect.Descriptor instead.
func (*SendVerificationCodeResponse) GetResult ¶
func (x *SendVerificationCodeResponse) GetResult() SendVerificationCodeResponse_Result
func (*SendVerificationCodeResponse) ProtoMessage ¶
func (*SendVerificationCodeResponse) ProtoMessage()
func (*SendVerificationCodeResponse) ProtoReflect ¶
func (x *SendVerificationCodeResponse) ProtoReflect() protoreflect.Message
func (*SendVerificationCodeResponse) Reset ¶
func (x *SendVerificationCodeResponse) Reset()
func (*SendVerificationCodeResponse) String ¶
func (x *SendVerificationCodeResponse) String() string
func (*SendVerificationCodeResponse) Validate ¶
func (m *SendVerificationCodeResponse) Validate() error
Validate checks the field values on SendVerificationCodeResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*SendVerificationCodeResponse) ValidateAll ¶
func (m *SendVerificationCodeResponse) ValidateAll() error
ValidateAll checks the field values on SendVerificationCodeResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SendVerificationCodeResponseMultiError, or nil if none found.
type SendVerificationCodeResponseMultiError ¶
type SendVerificationCodeResponseMultiError []error
SendVerificationCodeResponseMultiError is an error wrapping multiple validation errors returned by SendVerificationCodeResponse.ValidateAll() if the designated constraints aren't met.
func (SendVerificationCodeResponseMultiError) AllErrors ¶
func (m SendVerificationCodeResponseMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (SendVerificationCodeResponseMultiError) Error ¶
func (m SendVerificationCodeResponseMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type SendVerificationCodeResponseValidationError ¶
type SendVerificationCodeResponseValidationError struct {
// contains filtered or unexported fields
}
SendVerificationCodeResponseValidationError is the validation error returned by SendVerificationCodeResponse.Validate if the designated constraints aren't met.
func (SendVerificationCodeResponseValidationError) Cause ¶
func (e SendVerificationCodeResponseValidationError) Cause() error
Cause function returns cause value.
func (SendVerificationCodeResponseValidationError) Error ¶
func (e SendVerificationCodeResponseValidationError) Error() string
Error satisfies the builtin error interface
func (SendVerificationCodeResponseValidationError) ErrorName ¶
func (e SendVerificationCodeResponseValidationError) ErrorName() string
ErrorName returns error name.
func (SendVerificationCodeResponseValidationError) Field ¶
func (e SendVerificationCodeResponseValidationError) Field() string
Field function returns field value.
func (SendVerificationCodeResponseValidationError) Key ¶
func (e SendVerificationCodeResponseValidationError) Key() bool
Key function returns key value.
func (SendVerificationCodeResponseValidationError) Reason ¶
func (e SendVerificationCodeResponseValidationError) Reason() string
Reason function returns reason value.
type SendVerificationCodeResponse_Result ¶
type SendVerificationCodeResponse_Result int32
const ( SendVerificationCodeResponse_OK SendVerificationCodeResponse_Result = 0 // Email is denied SendVerificationCodeResponse_DENIED SendVerificationCodeResponse_Result = 1 // Email is rate limited (eg. by IP, email address, user, etc) and was not sent. SendVerificationCodeResponse_RATE_LIMITED SendVerificationCodeResponse_Result = 2 // The email address is not real SendVerificationCodeResponse_INVALID_EMAIL_ADDRESS SendVerificationCodeResponse_Result = 3 )
func (SendVerificationCodeResponse_Result) Descriptor ¶
func (SendVerificationCodeResponse_Result) Descriptor() protoreflect.EnumDescriptor
func (SendVerificationCodeResponse_Result) Enum ¶
func (x SendVerificationCodeResponse_Result) Enum() *SendVerificationCodeResponse_Result
func (SendVerificationCodeResponse_Result) EnumDescriptor
deprecated
func (SendVerificationCodeResponse_Result) EnumDescriptor() ([]byte, []int)
Deprecated: Use SendVerificationCodeResponse_Result.Descriptor instead.
func (SendVerificationCodeResponse_Result) Number ¶
func (x SendVerificationCodeResponse_Result) Number() protoreflect.EnumNumber
func (SendVerificationCodeResponse_Result) String ¶
func (x SendVerificationCodeResponse_Result) String() string
func (SendVerificationCodeResponse_Result) Type ¶
func (SendVerificationCodeResponse_Result) Type() protoreflect.EnumType
type UnimplementedEmailVerificationServer ¶
type UnimplementedEmailVerificationServer struct{}
UnimplementedEmailVerificationServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedEmailVerificationServer) CheckVerificationCode ¶
func (UnimplementedEmailVerificationServer) CheckVerificationCode(context.Context, *CheckVerificationCodeRequest) (*CheckVerificationCodeResponse, error)
func (UnimplementedEmailVerificationServer) SendVerificationCode ¶
func (UnimplementedEmailVerificationServer) SendVerificationCode(context.Context, *SendVerificationCodeRequest) (*SendVerificationCodeResponse, error)
func (UnimplementedEmailVerificationServer) Unlink ¶ added in v1.9.10
func (UnimplementedEmailVerificationServer) Unlink(context.Context, *UnlinkRequest) (*UnlinkResponse, error)
type UnlinkRequest ¶ added in v1.9.10
type UnlinkRequest struct { // The email address to unlink EmailAddress *EmailAddress `protobuf:"bytes,1,opt,name=email_address,json=emailAddress,proto3" json:"email_address,omitempty"` Auth *v1.Auth `protobuf:"bytes,2,opt,name=auth,proto3" json:"auth,omitempty"` // contains filtered or unexported fields }
func (*UnlinkRequest) Descriptor
deprecated
added in
v1.9.10
func (*UnlinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use UnlinkRequest.ProtoReflect.Descriptor instead.
func (*UnlinkRequest) GetAuth ¶ added in v1.9.10
func (x *UnlinkRequest) GetAuth() *v1.Auth
func (*UnlinkRequest) GetEmailAddress ¶ added in v1.9.10
func (x *UnlinkRequest) GetEmailAddress() *EmailAddress
func (*UnlinkRequest) ProtoMessage ¶ added in v1.9.10
func (*UnlinkRequest) ProtoMessage()
func (*UnlinkRequest) ProtoReflect ¶ added in v1.9.10
func (x *UnlinkRequest) ProtoReflect() protoreflect.Message
func (*UnlinkRequest) Reset ¶ added in v1.9.10
func (x *UnlinkRequest) Reset()
func (*UnlinkRequest) String ¶ added in v1.9.10
func (x *UnlinkRequest) String() string
func (*UnlinkRequest) Validate ¶ added in v1.9.10
func (m *UnlinkRequest) Validate() error
Validate checks the field values on UnlinkRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*UnlinkRequest) ValidateAll ¶ added in v1.9.10
func (m *UnlinkRequest) ValidateAll() error
ValidateAll checks the field values on UnlinkRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in UnlinkRequestMultiError, or nil if none found.
type UnlinkRequestMultiError ¶ added in v1.9.10
type UnlinkRequestMultiError []error
UnlinkRequestMultiError is an error wrapping multiple validation errors returned by UnlinkRequest.ValidateAll() if the designated constraints aren't met.
func (UnlinkRequestMultiError) AllErrors ¶ added in v1.9.10
func (m UnlinkRequestMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (UnlinkRequestMultiError) Error ¶ added in v1.9.10
func (m UnlinkRequestMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type UnlinkRequestValidationError ¶ added in v1.9.10
type UnlinkRequestValidationError struct {
// contains filtered or unexported fields
}
UnlinkRequestValidationError is the validation error returned by UnlinkRequest.Validate if the designated constraints aren't met.
func (UnlinkRequestValidationError) Cause ¶ added in v1.9.10
func (e UnlinkRequestValidationError) Cause() error
Cause function returns cause value.
func (UnlinkRequestValidationError) Error ¶ added in v1.9.10
func (e UnlinkRequestValidationError) Error() string
Error satisfies the builtin error interface
func (UnlinkRequestValidationError) ErrorName ¶ added in v1.9.10
func (e UnlinkRequestValidationError) ErrorName() string
ErrorName returns error name.
func (UnlinkRequestValidationError) Field ¶ added in v1.9.10
func (e UnlinkRequestValidationError) Field() string
Field function returns field value.
func (UnlinkRequestValidationError) Key ¶ added in v1.9.10
func (e UnlinkRequestValidationError) Key() bool
Key function returns key value.
func (UnlinkRequestValidationError) Reason ¶ added in v1.9.10
func (e UnlinkRequestValidationError) Reason() string
Reason function returns reason value.
type UnlinkResponse ¶ added in v1.9.10
type UnlinkResponse struct { Result UnlinkResponse_Result `protobuf:"varint,1,opt,name=result,proto3,enum=flipcash.email.v1.UnlinkResponse_Result" json:"result,omitempty"` // contains filtered or unexported fields }
func (*UnlinkResponse) Descriptor
deprecated
added in
v1.9.10
func (*UnlinkResponse) Descriptor() ([]byte, []int)
Deprecated: Use UnlinkResponse.ProtoReflect.Descriptor instead.
func (*UnlinkResponse) GetResult ¶ added in v1.9.10
func (x *UnlinkResponse) GetResult() UnlinkResponse_Result
func (*UnlinkResponse) ProtoMessage ¶ added in v1.9.10
func (*UnlinkResponse) ProtoMessage()
func (*UnlinkResponse) ProtoReflect ¶ added in v1.9.10
func (x *UnlinkResponse) ProtoReflect() protoreflect.Message
func (*UnlinkResponse) Reset ¶ added in v1.9.10
func (x *UnlinkResponse) Reset()
func (*UnlinkResponse) String ¶ added in v1.9.10
func (x *UnlinkResponse) String() string
func (*UnlinkResponse) Validate ¶ added in v1.9.10
func (m *UnlinkResponse) Validate() error
Validate checks the field values on UnlinkResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*UnlinkResponse) ValidateAll ¶ added in v1.9.10
func (m *UnlinkResponse) ValidateAll() error
ValidateAll checks the field values on UnlinkResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in UnlinkResponseMultiError, or nil if none found.
type UnlinkResponseMultiError ¶ added in v1.9.10
type UnlinkResponseMultiError []error
UnlinkResponseMultiError is an error wrapping multiple validation errors returned by UnlinkResponse.ValidateAll() if the designated constraints aren't met.
func (UnlinkResponseMultiError) AllErrors ¶ added in v1.9.10
func (m UnlinkResponseMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (UnlinkResponseMultiError) Error ¶ added in v1.9.10
func (m UnlinkResponseMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type UnlinkResponseValidationError ¶ added in v1.9.10
type UnlinkResponseValidationError struct {
// contains filtered or unexported fields
}
UnlinkResponseValidationError is the validation error returned by UnlinkResponse.Validate if the designated constraints aren't met.
func (UnlinkResponseValidationError) Cause ¶ added in v1.9.10
func (e UnlinkResponseValidationError) Cause() error
Cause function returns cause value.
func (UnlinkResponseValidationError) Error ¶ added in v1.9.10
func (e UnlinkResponseValidationError) Error() string
Error satisfies the builtin error interface
func (UnlinkResponseValidationError) ErrorName ¶ added in v1.9.10
func (e UnlinkResponseValidationError) ErrorName() string
ErrorName returns error name.
func (UnlinkResponseValidationError) Field ¶ added in v1.9.10
func (e UnlinkResponseValidationError) Field() string
Field function returns field value.
func (UnlinkResponseValidationError) Key ¶ added in v1.9.10
func (e UnlinkResponseValidationError) Key() bool
Key function returns key value.
func (UnlinkResponseValidationError) Reason ¶ added in v1.9.10
func (e UnlinkResponseValidationError) Reason() string
Reason function returns reason value.
type UnlinkResponse_Result ¶ added in v1.9.10
type UnlinkResponse_Result int32
const ( UnlinkResponse_OK UnlinkResponse_Result = 0 UnlinkResponse_DENIED UnlinkResponse_Result = 1 )
func (UnlinkResponse_Result) Descriptor ¶ added in v1.9.10
func (UnlinkResponse_Result) Descriptor() protoreflect.EnumDescriptor
func (UnlinkResponse_Result) Enum ¶ added in v1.9.10
func (x UnlinkResponse_Result) Enum() *UnlinkResponse_Result
func (UnlinkResponse_Result) EnumDescriptor
deprecated
added in
v1.9.10
func (UnlinkResponse_Result) EnumDescriptor() ([]byte, []int)
Deprecated: Use UnlinkResponse_Result.Descriptor instead.
func (UnlinkResponse_Result) Number ¶ added in v1.9.10
func (x UnlinkResponse_Result) Number() protoreflect.EnumNumber
func (UnlinkResponse_Result) String ¶ added in v1.9.10
func (x UnlinkResponse_Result) String() string
func (UnlinkResponse_Result) Type ¶ added in v1.9.10
func (UnlinkResponse_Result) Type() protoreflect.EnumType
type UnsafeEmailVerificationServer ¶
type UnsafeEmailVerificationServer interface {
// contains filtered or unexported methods
}
UnsafeEmailVerificationServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EmailVerificationServer will result in compilation errors.
type VerificationCode ¶
type VerificationCode struct { Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
VerificationCode is a 4-10 digit numerical code for verification
func (*VerificationCode) Descriptor
deprecated
func (*VerificationCode) Descriptor() ([]byte, []int)
Deprecated: Use VerificationCode.ProtoReflect.Descriptor instead.
func (*VerificationCode) GetValue ¶
func (x *VerificationCode) GetValue() string
func (*VerificationCode) ProtoMessage ¶
func (*VerificationCode) ProtoMessage()
func (*VerificationCode) ProtoReflect ¶
func (x *VerificationCode) ProtoReflect() protoreflect.Message
func (*VerificationCode) Reset ¶
func (x *VerificationCode) Reset()
func (*VerificationCode) String ¶
func (x *VerificationCode) String() string
func (*VerificationCode) Validate ¶
func (m *VerificationCode) Validate() error
Validate checks the field values on VerificationCode with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*VerificationCode) ValidateAll ¶
func (m *VerificationCode) ValidateAll() error
ValidateAll checks the field values on VerificationCode with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in VerificationCodeMultiError, or nil if none found.
type VerificationCodeMultiError ¶
type VerificationCodeMultiError []error
VerificationCodeMultiError is an error wrapping multiple validation errors returned by VerificationCode.ValidateAll() if the designated constraints aren't met.
func (VerificationCodeMultiError) AllErrors ¶
func (m VerificationCodeMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (VerificationCodeMultiError) Error ¶
func (m VerificationCodeMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type VerificationCodeValidationError ¶
type VerificationCodeValidationError struct {
// contains filtered or unexported fields
}
VerificationCodeValidationError is the validation error returned by VerificationCode.Validate if the designated constraints aren't met.
func (VerificationCodeValidationError) Cause ¶
func (e VerificationCodeValidationError) Cause() error
Cause function returns cause value.
func (VerificationCodeValidationError) Error ¶
func (e VerificationCodeValidationError) Error() string
Error satisfies the builtin error interface
func (VerificationCodeValidationError) ErrorName ¶
func (e VerificationCodeValidationError) ErrorName() string
ErrorName returns error name.
func (VerificationCodeValidationError) Field ¶
func (e VerificationCodeValidationError) Field() string
Field function returns field value.
func (VerificationCodeValidationError) Key ¶
func (e VerificationCodeValidationError) Key() bool
Key function returns key value.
func (VerificationCodeValidationError) Reason ¶
func (e VerificationCodeValidationError) Reason() string
Reason function returns reason value.