api

package
v0.0.0-...-26a0867 Latest Latest
Warning

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

 Go to latest Published: Feb 1, 2022 License: MIT Imports: 18 Imported by: 0

Documentation

Overview

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_service_proto protoreflect.FileDescriptor
View Source 
var QontoService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.qonto.QontoService",
	HandlerType: (*QontoServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "TransferBulk",
			Handler:    _QontoService_TransferBulk_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "service.proto",
}

QontoService_ServiceDesc is the grpc.ServiceDesc for QontoService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterQontoServiceHandler 

func RegisterQontoServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterQontoServiceHandler registers the http handlers for service QontoService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterQontoServiceHandlerClient 

func RegisterQontoServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client QontoServiceClient) error

RegisterQontoServiceHandlerClient registers the http handlers for service QontoService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "QontoServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "QontoServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "QontoServiceClient" to call the correct interceptors.

func RegisterQontoServiceHandlerFromEndpoint 

func RegisterQontoServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterQontoServiceHandlerFromEndpoint is same as RegisterQontoServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterQontoServiceHandlerServer 

func RegisterQontoServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server QontoServiceServer) error

RegisterQontoServiceHandlerServer registers the http handlers for service QontoService to "mux". UnaryRPC :call QontoServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterQontoServiceHandlerFromEndpoint instead.

func RegisterQontoServiceServer 

func RegisterQontoServiceServer(s grpc.ServiceRegistrar, srv QontoServiceServer)

Types

type QontoServiceClient 

type QontoServiceClient interface {
	// TransferBulk performs given transfers.
	//
	// Receives a request with bulk of transfer to perform. Responses whether the transfer were done successfully or not, due to:
	// - account not found
	// - not enough funds in the account
	// - internal server.
	TransferBulk(ctx context.Context, in *TransferBulkRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

QontoServiceClient is the client API for QontoService 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 NewQontoServiceClient 

func NewQontoServiceClient(cc grpc.ClientConnInterface) QontoServiceClient

type QontoServiceServer 

type QontoServiceServer interface {
	// TransferBulk performs given transfers.
	//
	// Receives a request with bulk of transfer to perform. Responses whether the transfer were done successfully or not, due to:
	// - account not found
	// - not enough funds in the account
	// - internal server.
	TransferBulk(context.Context, *TransferBulkRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

QontoServiceServer is the server API for QontoService service. All implementations must embed UnimplementedQontoServiceServer for forward compatibility

type TransferBulkRequest 

type TransferBulkRequest struct {

	// Organization name.
	OrganizationName string `protobuf:"bytes,1,opt,name=organization_name,json=organizationName,proto3" json:"organization_name,omitempty"`
	// Uniquely identify the Qonto customer's bic account.
	OrganizationBic string `protobuf:"bytes,2,opt,name=organization_bic,json=organizationBic,proto3" json:"organization_bic,omitempty"`
	// Uniquely identify the Qonto customer's iban account.
	OrganizationIban string `protobuf:"bytes,3,opt,name=organization_iban,json=organizationIban,proto3" json:"organization_iban,omitempty"`
	// Transfer rows.
	CreditTransfers []*TransferBulkRequest_CreditTransfersRow `protobuf:"bytes,4,rep,name=credit_transfers,json=creditTransfers,proto3" json:"credit_transfers,omitempty"`
	// contains filtered or unexported fields
}

func (*TransferBulkRequest) Descriptor deprecated 

func (*TransferBulkRequest) Descriptor() ([]byte, []int)

Deprecated: Use TransferBulkRequest.ProtoReflect.Descriptor instead.

func (*TransferBulkRequest) GetCreditTransfers 

func (x *TransferBulkRequest) GetCreditTransfers() []*TransferBulkRequest_CreditTransfersRow

func (*TransferBulkRequest) GetOrganizationBic 

func (x *TransferBulkRequest) GetOrganizationBic() string

func (*TransferBulkRequest) GetOrganizationIban 

func (x *TransferBulkRequest) GetOrganizationIban() string

func (*TransferBulkRequest) GetOrganizationName 

func (x *TransferBulkRequest) GetOrganizationName() string

func (*TransferBulkRequest) ProtoMessage 

func (*TransferBulkRequest) ProtoMessage()

func (*TransferBulkRequest) ProtoReflect 

func (x *TransferBulkRequest) ProtoReflect() protoreflect.Message

func (*TransferBulkRequest) Reset 

func (x *TransferBulkRequest) Reset()

func (*TransferBulkRequest) String 

func (x *TransferBulkRequest) String() string

type TransferBulkRequest_CreditTransfersRow 

type TransferBulkRequest_CreditTransfersRow struct {

	// The amount of the individual transfer.
	Amount float64 `protobuf:"fixed64,1,opt,name=amount,proto3" json:"amount,omitempty"`
	// The currency of the transfer.
	Currency string `protobuf:"bytes,2,opt,name=currency,proto3" json:"currency,omitempty"`
	// Represent the name of the counterparty.
	CounterpartyName string `protobuf:"bytes,3,opt,name=counterparty_name,json=counterpartyName,proto3" json:"counterparty_name,omitempty"`
	// Represent the account bic of the counterparty.
	CounterpartyBic string `protobuf:"bytes,4,opt,name=counterparty_bic,json=counterpartyBic,proto3" json:"counterparty_bic,omitempty"`
	// Represent the account iban of the counterparty.
	CounterpartyIban string `protobuf:"bytes,5,opt,name=counterparty_iban,json=counterpartyIban,proto3" json:"counterparty_iban,omitempty"`
	// Description of the transfer.
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*TransferBulkRequest_CreditTransfersRow) Descriptor deprecated 

func (*TransferBulkRequest_CreditTransfersRow) Descriptor() ([]byte, []int)

Deprecated: Use TransferBulkRequest_CreditTransfersRow.ProtoReflect.Descriptor instead.

func (*TransferBulkRequest_CreditTransfersRow) GetAmount 

func (x *TransferBulkRequest_CreditTransfersRow) GetAmount() float64

func (*TransferBulkRequest_CreditTransfersRow) GetCounterpartyBic 

func (x *TransferBulkRequest_CreditTransfersRow) GetCounterpartyBic() string

func (*TransferBulkRequest_CreditTransfersRow) GetCounterpartyIban 

func (x *TransferBulkRequest_CreditTransfersRow) GetCounterpartyIban() string

func (*TransferBulkRequest_CreditTransfersRow) GetCounterpartyName 

func (x *TransferBulkRequest_CreditTransfersRow) GetCounterpartyName() string

func (*TransferBulkRequest_CreditTransfersRow) GetCurrency 

func (x *TransferBulkRequest_CreditTransfersRow) GetCurrency() string

func (*TransferBulkRequest_CreditTransfersRow) GetDescription 

func (x *TransferBulkRequest_CreditTransfersRow) GetDescription() string

func (*TransferBulkRequest_CreditTransfersRow) ProtoMessage 

func (*TransferBulkRequest_CreditTransfersRow) ProtoMessage()

func (*TransferBulkRequest_CreditTransfersRow) ProtoReflect 

func (x *TransferBulkRequest_CreditTransfersRow) ProtoReflect() protoreflect.Message

func (*TransferBulkRequest_CreditTransfersRow) Reset 

func (x *TransferBulkRequest_CreditTransfersRow) Reset()

func (*TransferBulkRequest_CreditTransfersRow) String 

func (x *TransferBulkRequest_CreditTransfersRow) String() string

type UnimplementedQontoServiceServer 

type UnimplementedQontoServiceServer struct {
}

UnimplementedQontoServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedQontoServiceServer) TransferBulk 

func (UnimplementedQontoServiceServer) TransferBulk(context.Context, *TransferBulkRequest) (*emptypb.Empty, error)

type UnsafeQontoServiceServer 

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

UnsafeQontoServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QontoServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.