v0

type DeleteVoicemailRequest struct {

	// *
	// The ID of the voicemail. (UUID format)
	VoicemailId string `protobuf:"bytes,1,opt,name=voicemail_id,json=voicemailId,proto3" json:"voicemail_id,omitempty"`
	// contains filtered or unexported fields
}

type DeleteVoicemailResponse struct {
	// contains filtered or unexported fields
}

type GetAllVoicemailMetadataRequest struct {

	// *
	// The MSISDN of the receiver.
	To *v0.PhoneNumber `protobuf:"bytes,1,opt,name=to,proto3" json:"to,omitempty"`
	// contains filtered or unexported fields
}

type GetAllVoicemailMetadataResponse struct {
	Metadata []*VoicemailMetadata `protobuf:"bytes,1,rep,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

type GetVoicemailRequest struct {

	// *
	// The ID of the voicemail. (UUID format)
	VoicemailId string `protobuf:"bytes,1,opt,name=voicemail_id,json=voicemailId,proto3" json:"voicemail_id,omitempty"`
	// contains filtered or unexported fields
}

type GetVoicemailResponse struct {

	// *
	// The voicemail media file in .wav format.
	Metadata *VoicemailMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Types that are assignable to Bytes:
	//
	//	*GetVoicemailResponse_Wav
	Bytes isGetVoicemailResponse_Bytes `protobuf_oneof:"bytes"`
	// contains filtered or unexported fields
}

type GetVoicemailResponse_Wav struct {
	Wav []byte `protobuf:"bytes,2,opt,name=wav,proto3,oneof"`
}

type MarkVoicemailAsReadRequest struct {

	// *
	// The ID of the voicemail. (UUID format)
	VoicemailId string `protobuf:"bytes,1,opt,name=voicemail_id,json=voicemailId,proto3" json:"voicemail_id,omitempty"`
	// contains filtered or unexported fields
}

type MarkVoicemailAsReadResponse struct {
	// contains filtered or unexported fields
}

type ResetVoicemailGreetingRequest struct {

	// *
	// The MSISDN of the subscriber.
	Subscriber *v0.PhoneNumber `protobuf:"bytes,1,opt,name=subscriber,proto3" json:"subscriber,omitempty"`
	// contains filtered or unexported fields
}

type ResetVoicemailGreetingResponse struct {
	// contains filtered or unexported fields
}

type UnimplementedVoicemailMediaServiceServer struct {
}

type UnsafeVoicemailMediaServiceServer interface {
	// contains filtered or unexported methods
}

type VoicemailMediaServiceClient interface {
	// *
	// Receive metadata for each voicemail available for a given MSISDN.
	// The metadata contains information about the corresponding voicemail including its ID,
	// allowing the user to fetch the voicemail media file.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid MSISDN
	// - INTERNAL: DB error
	GetAllVoicemailMetadata(ctx context.Context, in *GetAllVoicemailMetadataRequest, opts ...grpc.CallOption) (*GetAllVoicemailMetadataResponse, error)
	// *
	// Receive voicemail media file corresponding to the given voicemail ID.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid voicemail ID
	// - NOT FOUND: Voicemail not found
	//
	// Server-side errors:
	// - INTERNAL: Voicemail file is too big to be returned
	// - INTERNAL: DB error
	GetVoicemail(ctx context.Context, in *GetVoicemailRequest, opts ...grpc.CallOption) (*GetVoicemailResponse, error)
	// *
	// Mark as read the voicemail corresponding to the given voicemail ID.
	// This updates the "played" metadata of the voicemail to true.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid voicemail ID
	// - NOT FOUND: Voicemail not found
	//
	// Server-side errors:
	// - INTERNAL: DB error
	MarkVoicemailAsRead(ctx context.Context, in *MarkVoicemailAsReadRequest, opts ...grpc.CallOption) (*MarkVoicemailAsReadResponse, error)
	// *
	// Delete the voicemail corresponding to the given voicemail ID.
	// The voicemail media file and its metadata will be deleted.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid voicemail ID
	// - NOT FOUND: Voicemail not found
	//
	// Server-side errors:
	// - INTERNAL: DB error
	DeleteVoicemail(ctx context.Context, in *DeleteVoicemailRequest, opts ...grpc.CallOption) (*DeleteVoicemailResponse, error)
	// *
	// Resets the voicemail greeting of the given subscriber (MSISDN).
	// The voicemail greeting (media file) will be deleted.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid MSISDN
	//
	// Server-side errors:
	// - INTERNAL: DB error
	ResetVoicemailGreeting(ctx context.Context, in *ResetVoicemailGreetingRequest, opts ...grpc.CallOption) (*ResetVoicemailGreetingResponse, error)
}

type VoicemailMediaServiceServer interface {
	// *
	// Receive metadata for each voicemail available for a given MSISDN.
	// The metadata contains information about the corresponding voicemail including its ID,
	// allowing the user to fetch the voicemail media file.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid MSISDN
	// - INTERNAL: DB error
	GetAllVoicemailMetadata(context.Context, *GetAllVoicemailMetadataRequest) (*GetAllVoicemailMetadataResponse, error)
	// *
	// Receive voicemail media file corresponding to the given voicemail ID.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid voicemail ID
	// - NOT FOUND: Voicemail not found
	//
	// Server-side errors:
	// - INTERNAL: Voicemail file is too big to be returned
	// - INTERNAL: DB error
	GetVoicemail(context.Context, *GetVoicemailRequest) (*GetVoicemailResponse, error)
	// *
	// Mark as read the voicemail corresponding to the given voicemail ID.
	// This updates the "played" metadata of the voicemail to true.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid voicemail ID
	// - NOT FOUND: Voicemail not found
	//
	// Server-side errors:
	// - INTERNAL: DB error
	MarkVoicemailAsRead(context.Context, *MarkVoicemailAsReadRequest) (*MarkVoicemailAsReadResponse, error)
	// *
	// Delete the voicemail corresponding to the given voicemail ID.
	// The voicemail media file and its metadata will be deleted.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid voicemail ID
	// - NOT FOUND: Voicemail not found
	//
	// Server-side errors:
	// - INTERNAL: DB error
	DeleteVoicemail(context.Context, *DeleteVoicemailRequest) (*DeleteVoicemailResponse, error)
	// *
	// Resets the voicemail greeting of the given subscriber (MSISDN).
	// The voicemail greeting (media file) will be deleted.
	//
	// Client-side errors:
	// - INVALID ARGUMENT: Invalid MSISDN
	//
	// Server-side errors:
	// - INTERNAL: DB error
	ResetVoicemailGreeting(context.Context, *ResetVoicemailGreetingRequest) (*ResetVoicemailGreetingResponse, error)
}

type VoicemailMetadata struct {

	// *
	// The ID of the voicemail. (UUID format)
	VoicemailId string `protobuf:"bytes,1,opt,name=voicemail_id,json=voicemailId,proto3" json:"voicemail_id,omitempty"`
	// *
	// The MSISDN of the receiver.
	To *v0.PhoneNumber `protobuf:"bytes,2,opt,name=to,proto3" json:"to,omitempty"`
	// *
	// The MSISDN of the sender.
	From *v0.PhoneNumber `protobuf:"bytes,3,opt,name=from,proto3" json:"from,omitempty"`
	// *
	// The length of the voicemail media file in seconds.
	Duration *durationpb.Duration `protobuf:"bytes,4,opt,name=duration,proto3" json:"duration,omitempty"`
	// *
	// Whether or not the voicemail media file has been played.
	Played bool `protobuf:"varint,5,opt,name=played,proto3" json:"played,omitempty"`
	// *
	// The creation date (epoch in seconds) of the voicemail media file.
	Created *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created,proto3" json:"created,omitempty"`
	// *
	// The expiry date (epoch in seconds) of the voicemail media file.
	// 7 days from the moment the voicemail is created.
	Expires *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=expires,proto3" json:"expires,omitempty"`
	// contains filtered or unexported fields
}