v1

package
v1.2.1 Latest Latest
Warning

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

Go to latest
Published: Mar 7, 2026 License: MIT Imports: 30 Imported by: 0

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	FulfillmentService_CreateFulfillment_FullMethodName       = "/fulfillment.v1.FulfillmentService/CreateFulfillment"
	FulfillmentService_GetFulfillment_FullMethodName          = "/fulfillment.v1.FulfillmentService/GetFulfillment"
	FulfillmentService_UpdateFulfillmentStatus_FullMethodName = "/fulfillment.v1.FulfillmentService/UpdateFulfillmentStatus"
)

Variables

View Source
var (
	FulfillmentType_name = map[int32]string{
		0: "FULFILLMENT_TYPE_UNSPECIFIED",
		1: "FULFILLMENT_TYPE_SHIPPING",
		2: "FULFILLMENT_TYPE_LOCAL_PICKUP",
	}
	FulfillmentType_value = map[string]int32{
		"FULFILLMENT_TYPE_UNSPECIFIED":  0,
		"FULFILLMENT_TYPE_SHIPPING":     1,
		"FULFILLMENT_TYPE_LOCAL_PICKUP": 2,
	}
)

Enum value maps for FulfillmentType.

View Source
var (
	FulfillmentStatus_name = map[int32]string{
		0: "FULFILLMENT_STATUS_UNSPECIFIED",
		1: "FULFILLMENT_STATUS_PREPARING",
		2: "FULFILLMENT_STATUS_READY_FOR_PICKUP",
		3: "FULFILLMENT_STATUS_IN_TRANSIT",
		4: "FULFILLMENT_STATUS_DELIVERED",
		5: "FULFILLMENT_STATUS_PICKED_UP",
		6: "FULFILLMENT_STATUS_EXCEPTION",
	}
	FulfillmentStatus_value = map[string]int32{
		"FULFILLMENT_STATUS_UNSPECIFIED":      0,
		"FULFILLMENT_STATUS_PREPARING":        1,
		"FULFILLMENT_STATUS_READY_FOR_PICKUP": 2,
		"FULFILLMENT_STATUS_IN_TRANSIT":       3,
		"FULFILLMENT_STATUS_DELIVERED":        4,
		"FULFILLMENT_STATUS_PICKED_UP":        5,
		"FULFILLMENT_STATUS_EXCEPTION":        6,
	}
)

Enum value maps for FulfillmentStatus.

View Source
var File_fulfillment_v1_fulfillment_proto protoreflect.FileDescriptor
View Source
var FulfillmentService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "fulfillment.v1.FulfillmentService",
	HandlerType: (*FulfillmentServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateFulfillment",
			Handler:    _FulfillmentService_CreateFulfillment_Handler,
		},
		{
			MethodName: "GetFulfillment",
			Handler:    _FulfillmentService_GetFulfillment_Handler,
		},
		{
			MethodName: "UpdateFulfillmentStatus",
			Handler:    _FulfillmentService_UpdateFulfillmentStatus_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "fulfillment/v1/fulfillment.proto",
}

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

Functions

func RegisterFulfillmentServiceHandler added in v1.2.0

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

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

func RegisterFulfillmentServiceHandlerClient added in v1.2.0

func RegisterFulfillmentServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client FulfillmentServiceClient) error

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

func RegisterFulfillmentServiceHandlerFromEndpoint added in v1.2.0

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

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

func RegisterFulfillmentServiceHandlerServer added in v1.2.0

func RegisterFulfillmentServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server FulfillmentServiceServer) error

RegisterFulfillmentServiceHandlerServer registers the http handlers for service FulfillmentService to "mux". UnaryRPC :call FulfillmentServiceServer 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 RegisterFulfillmentServiceHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterFulfillmentServiceServer

func RegisterFulfillmentServiceServer(s grpc.ServiceRegistrar, srv FulfillmentServiceServer)

Types

type CreateFulfillmentRequest

type CreateFulfillmentRequest struct {
	OrderId         string           `protobuf:"bytes,1,opt,name=order_id,json=orderId,proto3" json:"order_id,omitempty"`
	Type            FulfillmentType  `protobuf:"varint,2,opt,name=type,proto3,enum=fulfillment.v1.FulfillmentType" json:"type,omitempty"` // Must be Shipping or Pickup
	ShipmentDetails *ShipmentDetails `protobuf:"bytes,3,opt,name=shipment_details,json=shipmentDetails,proto3" json:"shipment_details,omitempty"`
	PickupDetails   *PickupDetails   `protobuf:"bytes,4,opt,name=pickup_details,json=pickupDetails,proto3" json:"pickup_details,omitempty"`
	// contains filtered or unexported fields
}

Request to initialize the fulfillment process for an order.

func (*CreateFulfillmentRequest) Descriptor deprecated

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

Deprecated: Use CreateFulfillmentRequest.ProtoReflect.Descriptor instead.

func (*CreateFulfillmentRequest) GetOrderId

func (x *CreateFulfillmentRequest) GetOrderId() string

func (*CreateFulfillmentRequest) GetPickupDetails

func (x *CreateFulfillmentRequest) GetPickupDetails() *PickupDetails

func (*CreateFulfillmentRequest) GetShipmentDetails

func (x *CreateFulfillmentRequest) GetShipmentDetails() *ShipmentDetails

func (*CreateFulfillmentRequest) GetType

func (*CreateFulfillmentRequest) ProtoMessage

func (*CreateFulfillmentRequest) ProtoMessage()

func (*CreateFulfillmentRequest) ProtoReflect

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

func (*CreateFulfillmentRequest) Reset

func (x *CreateFulfillmentRequest) Reset()

func (*CreateFulfillmentRequest) String

func (x *CreateFulfillmentRequest) String() string

func (*CreateFulfillmentRequest) Validate

func (m *CreateFulfillmentRequest) Validate() error

Validate checks the field values on CreateFulfillmentRequest 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 (*CreateFulfillmentRequest) ValidateAll

func (m *CreateFulfillmentRequest) ValidateAll() error

ValidateAll checks the field values on CreateFulfillmentRequest 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 CreateFulfillmentRequestMultiError, or nil if none found.

type CreateFulfillmentRequestMultiError

type CreateFulfillmentRequestMultiError []error

CreateFulfillmentRequestMultiError is an error wrapping multiple validation errors returned by CreateFulfillmentRequest.ValidateAll() if the designated constraints aren't met.

func (CreateFulfillmentRequestMultiError) AllErrors

func (m CreateFulfillmentRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CreateFulfillmentRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type CreateFulfillmentRequestValidationError

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

CreateFulfillmentRequestValidationError is the validation error returned by CreateFulfillmentRequest.Validate if the designated constraints aren't met.

func (CreateFulfillmentRequestValidationError) Cause

Cause function returns cause value.

func (CreateFulfillmentRequestValidationError) Error

Error satisfies the builtin error interface

func (CreateFulfillmentRequestValidationError) ErrorName

ErrorName returns error name.

func (CreateFulfillmentRequestValidationError) Field

Field function returns field value.

func (CreateFulfillmentRequestValidationError) Key

Key function returns key value.

func (CreateFulfillmentRequestValidationError) Reason

Reason function returns reason value.

type CreateFulfillmentResponse

type CreateFulfillmentResponse struct {
	Fulfillment *Fulfillment `protobuf:"bytes,1,opt,name=fulfillment,proto3" json:"fulfillment,omitempty"`
	// contains filtered or unexported fields
}

Response mapping the newly registered Fulfillment record.

func (*CreateFulfillmentResponse) Descriptor deprecated

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

Deprecated: Use CreateFulfillmentResponse.ProtoReflect.Descriptor instead.

func (*CreateFulfillmentResponse) GetFulfillment

func (x *CreateFulfillmentResponse) GetFulfillment() *Fulfillment

func (*CreateFulfillmentResponse) ProtoMessage

func (*CreateFulfillmentResponse) ProtoMessage()

func (*CreateFulfillmentResponse) ProtoReflect

func (*CreateFulfillmentResponse) Reset

func (x *CreateFulfillmentResponse) Reset()

func (*CreateFulfillmentResponse) String

func (x *CreateFulfillmentResponse) String() string

func (*CreateFulfillmentResponse) Validate

func (m *CreateFulfillmentResponse) Validate() error

Validate checks the field values on CreateFulfillmentResponse 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 (*CreateFulfillmentResponse) ValidateAll

func (m *CreateFulfillmentResponse) ValidateAll() error

ValidateAll checks the field values on CreateFulfillmentResponse 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 CreateFulfillmentResponseMultiError, or nil if none found.

type CreateFulfillmentResponseMultiError

type CreateFulfillmentResponseMultiError []error

CreateFulfillmentResponseMultiError is an error wrapping multiple validation errors returned by CreateFulfillmentResponse.ValidateAll() if the designated constraints aren't met.

func (CreateFulfillmentResponseMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (CreateFulfillmentResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type CreateFulfillmentResponseValidationError

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

CreateFulfillmentResponseValidationError is the validation error returned by CreateFulfillmentResponse.Validate if the designated constraints aren't met.

func (CreateFulfillmentResponseValidationError) Cause

Cause function returns cause value.

func (CreateFulfillmentResponseValidationError) Error

Error satisfies the builtin error interface

func (CreateFulfillmentResponseValidationError) ErrorName

ErrorName returns error name.

func (CreateFulfillmentResponseValidationError) Field

Field function returns field value.

func (CreateFulfillmentResponseValidationError) Key

Key function returns key value.

func (CreateFulfillmentResponseValidationError) Reason

Reason function returns reason value.

type Fulfillment

type Fulfillment struct {
	Id      string            `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	OrderId string            `protobuf:"bytes,2,opt,name=order_id,json=orderId,proto3" json:"order_id,omitempty"`
	Type    FulfillmentType   `protobuf:"varint,3,opt,name=type,proto3,enum=fulfillment.v1.FulfillmentType" json:"type,omitempty"`
	Status  FulfillmentStatus `protobuf:"varint,4,opt,name=status,proto3,enum=fulfillment.v1.FulfillmentStatus" json:"status,omitempty"`
	// Populated if type == FULFILLMENT_TYPE_SHIPPING
	ShipmentDetails *ShipmentDetails `protobuf:"bytes,5,opt,name=shipment_details,json=shipmentDetails,proto3" json:"shipment_details,omitempty"`
	// Populated if type == FULFILLMENT_TYPE_LOCAL_PICKUP
	PickupDetails *PickupDetails `protobuf:"bytes,6,opt,name=pickup_details,json=pickupDetails,proto3" json:"pickup_details,omitempty"`
	CreatedAt     string         `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	UpdatedAt     string         `protobuf:"bytes,8,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// contains filtered or unexported fields
}

Fulfillment represents how an order gets to the customer (shipping or local store pickup).

func (*Fulfillment) Descriptor deprecated

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

Deprecated: Use Fulfillment.ProtoReflect.Descriptor instead.

func (*Fulfillment) GetCreatedAt

func (x *Fulfillment) GetCreatedAt() string

func (*Fulfillment) GetId

func (x *Fulfillment) GetId() string

func (*Fulfillment) GetOrderId

func (x *Fulfillment) GetOrderId() string

func (*Fulfillment) GetPickupDetails

func (x *Fulfillment) GetPickupDetails() *PickupDetails

func (*Fulfillment) GetShipmentDetails

func (x *Fulfillment) GetShipmentDetails() *ShipmentDetails

func (*Fulfillment) GetStatus

func (x *Fulfillment) GetStatus() FulfillmentStatus

func (*Fulfillment) GetType

func (x *Fulfillment) GetType() FulfillmentType

func (*Fulfillment) GetUpdatedAt

func (x *Fulfillment) GetUpdatedAt() string

func (*Fulfillment) ProtoMessage

func (*Fulfillment) ProtoMessage()

func (*Fulfillment) ProtoReflect

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

func (*Fulfillment) Reset

func (x *Fulfillment) Reset()

func (*Fulfillment) String

func (x *Fulfillment) String() string

func (*Fulfillment) Validate

func (m *Fulfillment) Validate() error

Validate checks the field values on Fulfillment 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 (*Fulfillment) ValidateAll

func (m *Fulfillment) ValidateAll() error

ValidateAll checks the field values on Fulfillment 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 FulfillmentMultiError, or nil if none found.

type FulfillmentMultiError

type FulfillmentMultiError []error

FulfillmentMultiError is an error wrapping multiple validation errors returned by Fulfillment.ValidateAll() if the designated constraints aren't met.

func (FulfillmentMultiError) AllErrors

func (m FulfillmentMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FulfillmentMultiError) Error

func (m FulfillmentMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type FulfillmentServiceClient

type FulfillmentServiceClient interface {
	CreateFulfillment(ctx context.Context, in *CreateFulfillmentRequest, opts ...grpc.CallOption) (*CreateFulfillmentResponse, error)
	GetFulfillment(ctx context.Context, in *GetFulfillmentRequest, opts ...grpc.CallOption) (*GetFulfillmentResponse, error)
	UpdateFulfillmentStatus(ctx context.Context, in *UpdateFulfillmentStatusRequest, opts ...grpc.CallOption) (*UpdateFulfillmentStatusResponse, error)
}

FulfillmentServiceClient is the client API for FulfillmentService 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.

FulfillmentService handles warehouse dispatching, carrier handoffs, and local pickups.

type FulfillmentServiceServer

type FulfillmentServiceServer interface {
	CreateFulfillment(context.Context, *CreateFulfillmentRequest) (*CreateFulfillmentResponse, error)
	GetFulfillment(context.Context, *GetFulfillmentRequest) (*GetFulfillmentResponse, error)
	UpdateFulfillmentStatus(context.Context, *UpdateFulfillmentStatusRequest) (*UpdateFulfillmentStatusResponse, error)
	// contains filtered or unexported methods
}

FulfillmentServiceServer is the server API for FulfillmentService service. All implementations must embed UnimplementedFulfillmentServiceServer for forward compatibility.

FulfillmentService handles warehouse dispatching, carrier handoffs, and local pickups.

type FulfillmentStatus

type FulfillmentStatus int32

Current status of the physical fulfillment.

const (
	FulfillmentStatus_FULFILLMENT_STATUS_UNSPECIFIED      FulfillmentStatus = 0
	FulfillmentStatus_FULFILLMENT_STATUS_PREPARING        FulfillmentStatus = 1
	FulfillmentStatus_FULFILLMENT_STATUS_READY_FOR_PICKUP FulfillmentStatus = 2
	FulfillmentStatus_FULFILLMENT_STATUS_IN_TRANSIT       FulfillmentStatus = 3
	FulfillmentStatus_FULFILLMENT_STATUS_DELIVERED        FulfillmentStatus = 4
	FulfillmentStatus_FULFILLMENT_STATUS_PICKED_UP        FulfillmentStatus = 5
	FulfillmentStatus_FULFILLMENT_STATUS_EXCEPTION        FulfillmentStatus = 6
)

func (FulfillmentStatus) Descriptor

func (FulfillmentStatus) Enum

func (FulfillmentStatus) EnumDescriptor deprecated

func (FulfillmentStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use FulfillmentStatus.Descriptor instead.

func (FulfillmentStatus) Number

func (FulfillmentStatus) String

func (x FulfillmentStatus) String() string

func (FulfillmentStatus) Type

type FulfillmentType

type FulfillmentType int32

Type of fulfillment method chosen for the order.

const (
	FulfillmentType_FULFILLMENT_TYPE_UNSPECIFIED  FulfillmentType = 0
	FulfillmentType_FULFILLMENT_TYPE_SHIPPING     FulfillmentType = 1
	FulfillmentType_FULFILLMENT_TYPE_LOCAL_PICKUP FulfillmentType = 2
)

func (FulfillmentType) Descriptor

func (FulfillmentType) Enum

func (x FulfillmentType) Enum() *FulfillmentType

func (FulfillmentType) EnumDescriptor deprecated

func (FulfillmentType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FulfillmentType.Descriptor instead.

func (FulfillmentType) Number

func (FulfillmentType) String

func (x FulfillmentType) String() string

func (FulfillmentType) Type

type FulfillmentValidationError

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

FulfillmentValidationError is the validation error returned by Fulfillment.Validate if the designated constraints aren't met.

func (FulfillmentValidationError) Cause

Cause function returns cause value.

func (FulfillmentValidationError) Error

Error satisfies the builtin error interface

func (FulfillmentValidationError) ErrorName

func (e FulfillmentValidationError) ErrorName() string

ErrorName returns error name.

func (FulfillmentValidationError) Field

Field function returns field value.

func (FulfillmentValidationError) Key

Key function returns key value.

func (FulfillmentValidationError) Reason

Reason function returns reason value.

type GetFulfillmentRequest

type GetFulfillmentRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Request to fetch tracking or pickup statuses.

func (*GetFulfillmentRequest) Descriptor deprecated

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

Deprecated: Use GetFulfillmentRequest.ProtoReflect.Descriptor instead.

func (*GetFulfillmentRequest) GetId

func (x *GetFulfillmentRequest) GetId() int64

func (*GetFulfillmentRequest) ProtoMessage

func (*GetFulfillmentRequest) ProtoMessage()

func (*GetFulfillmentRequest) ProtoReflect

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

func (*GetFulfillmentRequest) Reset

func (x *GetFulfillmentRequest) Reset()

func (*GetFulfillmentRequest) String

func (x *GetFulfillmentRequest) String() string

func (*GetFulfillmentRequest) Validate

func (m *GetFulfillmentRequest) Validate() error

Validate checks the field values on GetFulfillmentRequest 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 (*GetFulfillmentRequest) ValidateAll

func (m *GetFulfillmentRequest) ValidateAll() error

ValidateAll checks the field values on GetFulfillmentRequest 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 GetFulfillmentRequestMultiError, or nil if none found.

type GetFulfillmentRequestMultiError

type GetFulfillmentRequestMultiError []error

GetFulfillmentRequestMultiError is an error wrapping multiple validation errors returned by GetFulfillmentRequest.ValidateAll() if the designated constraints aren't met.

func (GetFulfillmentRequestMultiError) AllErrors

func (m GetFulfillmentRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GetFulfillmentRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type GetFulfillmentRequestValidationError

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

GetFulfillmentRequestValidationError is the validation error returned by GetFulfillmentRequest.Validate if the designated constraints aren't met.

func (GetFulfillmentRequestValidationError) Cause

Cause function returns cause value.

func (GetFulfillmentRequestValidationError) Error

Error satisfies the builtin error interface

func (GetFulfillmentRequestValidationError) ErrorName

ErrorName returns error name.

func (GetFulfillmentRequestValidationError) Field

Field function returns field value.

func (GetFulfillmentRequestValidationError) Key

Key function returns key value.

func (GetFulfillmentRequestValidationError) Reason

Reason function returns reason value.

type GetFulfillmentResponse

type GetFulfillmentResponse struct {
	Fulfillment *Fulfillment `protobuf:"bytes,1,opt,name=fulfillment,proto3" json:"fulfillment,omitempty"`
	// contains filtered or unexported fields
}

Response returning the current Fulfillment state.

func (*GetFulfillmentResponse) Descriptor deprecated

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

Deprecated: Use GetFulfillmentResponse.ProtoReflect.Descriptor instead.

func (*GetFulfillmentResponse) GetFulfillment

func (x *GetFulfillmentResponse) GetFulfillment() *Fulfillment

func (*GetFulfillmentResponse) ProtoMessage

func (*GetFulfillmentResponse) ProtoMessage()

func (*GetFulfillmentResponse) ProtoReflect

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

func (*GetFulfillmentResponse) Reset

func (x *GetFulfillmentResponse) Reset()

func (*GetFulfillmentResponse) String

func (x *GetFulfillmentResponse) String() string

func (*GetFulfillmentResponse) Validate

func (m *GetFulfillmentResponse) Validate() error

Validate checks the field values on GetFulfillmentResponse 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 (*GetFulfillmentResponse) ValidateAll

func (m *GetFulfillmentResponse) ValidateAll() error

ValidateAll checks the field values on GetFulfillmentResponse 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 GetFulfillmentResponseMultiError, or nil if none found.

type GetFulfillmentResponseMultiError

type GetFulfillmentResponseMultiError []error

GetFulfillmentResponseMultiError is an error wrapping multiple validation errors returned by GetFulfillmentResponse.ValidateAll() if the designated constraints aren't met.

func (GetFulfillmentResponseMultiError) AllErrors

func (m GetFulfillmentResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GetFulfillmentResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type GetFulfillmentResponseValidationError

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

GetFulfillmentResponseValidationError is the validation error returned by GetFulfillmentResponse.Validate if the designated constraints aren't met.

func (GetFulfillmentResponseValidationError) Cause

Cause function returns cause value.

func (GetFulfillmentResponseValidationError) Error

Error satisfies the builtin error interface

func (GetFulfillmentResponseValidationError) ErrorName

ErrorName returns error name.

func (GetFulfillmentResponseValidationError) Field

Field function returns field value.

func (GetFulfillmentResponseValidationError) Key

Key function returns key value.

func (GetFulfillmentResponseValidationError) Reason

Reason function returns reason value.

type PickupDetails

type PickupDetails struct {
	StoreId            string `protobuf:"bytes,1,opt,name=store_id,json=storeId,proto3" json:"store_id,omitempty"`
	PickupInstructions string `protobuf:"bytes,2,opt,name=pickup_instructions,json=pickupInstructions,proto3" json:"pickup_instructions,omitempty"`
	PickupTime         string `protobuf:"bytes,3,opt,name=pickup_time,json=pickupTime,proto3" json:"pickup_time,omitempty"`
	// contains filtered or unexported fields
}

Specifics for a Buy Online, Pick Up In Store (BOPIS) order.

func (*PickupDetails) Descriptor deprecated

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

Deprecated: Use PickupDetails.ProtoReflect.Descriptor instead.

func (*PickupDetails) GetPickupInstructions

func (x *PickupDetails) GetPickupInstructions() string

func (*PickupDetails) GetPickupTime

func (x *PickupDetails) GetPickupTime() string

func (*PickupDetails) GetStoreId

func (x *PickupDetails) GetStoreId() string

func (*PickupDetails) ProtoMessage

func (*PickupDetails) ProtoMessage()

func (*PickupDetails) ProtoReflect

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

func (*PickupDetails) Reset

func (x *PickupDetails) Reset()

func (*PickupDetails) String

func (x *PickupDetails) String() string

func (*PickupDetails) Validate

func (m *PickupDetails) Validate() error

Validate checks the field values on PickupDetails 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 (*PickupDetails) ValidateAll

func (m *PickupDetails) ValidateAll() error

ValidateAll checks the field values on PickupDetails 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 PickupDetailsMultiError, or nil if none found.

type PickupDetailsMultiError

type PickupDetailsMultiError []error

PickupDetailsMultiError is an error wrapping multiple validation errors returned by PickupDetails.ValidateAll() if the designated constraints aren't met.

func (PickupDetailsMultiError) AllErrors

func (m PickupDetailsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PickupDetailsMultiError) Error

func (m PickupDetailsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PickupDetailsValidationError

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

PickupDetailsValidationError is the validation error returned by PickupDetails.Validate if the designated constraints aren't met.

func (PickupDetailsValidationError) Cause

Cause function returns cause value.

func (PickupDetailsValidationError) Error

Error satisfies the builtin error interface

func (PickupDetailsValidationError) ErrorName

func (e PickupDetailsValidationError) ErrorName() string

ErrorName returns error name.

func (PickupDetailsValidationError) Field

Field function returns field value.

func (PickupDetailsValidationError) Key

Key function returns key value.

func (PickupDetailsValidationError) Reason

Reason function returns reason value.

type ShipmentDetails

type ShipmentDetails struct {
	TrackingNumber    string           `protobuf:"bytes,1,opt,name=tracking_number,json=trackingNumber,proto3" json:"tracking_number,omitempty"`
	Carrier           string           `protobuf:"bytes,2,opt,name=carrier,proto3" json:"carrier,omitempty"` // e.g., "UPS", "FedEx", "USPS"
	EstimatedDelivery string           `protobuf:"bytes,3,opt,name=estimated_delivery,json=estimatedDelivery,proto3" json:"estimated_delivery,omitempty"`
	Destination       *ShippingAddress `protobuf:"bytes,4,opt,name=destination,proto3" json:"destination,omitempty"`
	// contains filtered or unexported fields
}

Specifics for a carrier-based delivery.

func (*ShipmentDetails) Descriptor deprecated

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

Deprecated: Use ShipmentDetails.ProtoReflect.Descriptor instead.

func (*ShipmentDetails) GetCarrier

func (x *ShipmentDetails) GetCarrier() string

func (*ShipmentDetails) GetDestination

func (x *ShipmentDetails) GetDestination() *ShippingAddress

func (*ShipmentDetails) GetEstimatedDelivery

func (x *ShipmentDetails) GetEstimatedDelivery() string

func (*ShipmentDetails) GetTrackingNumber

func (x *ShipmentDetails) GetTrackingNumber() string

func (*ShipmentDetails) ProtoMessage

func (*ShipmentDetails) ProtoMessage()

func (*ShipmentDetails) ProtoReflect

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

func (*ShipmentDetails) Reset

func (x *ShipmentDetails) Reset()

func (*ShipmentDetails) String

func (x *ShipmentDetails) String() string

func (*ShipmentDetails) Validate

func (m *ShipmentDetails) Validate() error

Validate checks the field values on ShipmentDetails 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 (*ShipmentDetails) ValidateAll

func (m *ShipmentDetails) ValidateAll() error

ValidateAll checks the field values on ShipmentDetails 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 ShipmentDetailsMultiError, or nil if none found.

type ShipmentDetailsMultiError

type ShipmentDetailsMultiError []error

ShipmentDetailsMultiError is an error wrapping multiple validation errors returned by ShipmentDetails.ValidateAll() if the designated constraints aren't met.

func (ShipmentDetailsMultiError) AllErrors

func (m ShipmentDetailsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ShipmentDetailsMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ShipmentDetailsValidationError

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

ShipmentDetailsValidationError is the validation error returned by ShipmentDetails.Validate if the designated constraints aren't met.

func (ShipmentDetailsValidationError) Cause

Cause function returns cause value.

func (ShipmentDetailsValidationError) Error

Error satisfies the builtin error interface

func (ShipmentDetailsValidationError) ErrorName

func (e ShipmentDetailsValidationError) ErrorName() string

ErrorName returns error name.

func (ShipmentDetailsValidationError) Field

Field function returns field value.

func (ShipmentDetailsValidationError) Key

Key function returns key value.

func (ShipmentDetailsValidationError) Reason

Reason function returns reason value.

type ShippingAddress

type ShippingAddress struct {
	Street  string `protobuf:"bytes,1,opt,name=street,proto3" json:"street,omitempty"`
	City    string `protobuf:"bytes,2,opt,name=city,proto3" json:"city,omitempty"`
	State   string `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
	Zip     string `protobuf:"bytes,4,opt,name=zip,proto3" json:"zip,omitempty"`
	Country string `protobuf:"bytes,5,opt,name=country,proto3" json:"country,omitempty"`
	// contains filtered or unexported fields
}

Basic address representation used strictly for routing.

func (*ShippingAddress) Descriptor deprecated

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

Deprecated: Use ShippingAddress.ProtoReflect.Descriptor instead.

func (*ShippingAddress) GetCity

func (x *ShippingAddress) GetCity() string

func (*ShippingAddress) GetCountry

func (x *ShippingAddress) GetCountry() string

func (*ShippingAddress) GetState

func (x *ShippingAddress) GetState() string

func (*ShippingAddress) GetStreet

func (x *ShippingAddress) GetStreet() string

func (*ShippingAddress) GetZip

func (x *ShippingAddress) GetZip() string

func (*ShippingAddress) ProtoMessage

func (*ShippingAddress) ProtoMessage()

func (*ShippingAddress) ProtoReflect

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

func (*ShippingAddress) Reset

func (x *ShippingAddress) Reset()

func (*ShippingAddress) String

func (x *ShippingAddress) String() string

func (*ShippingAddress) Validate

func (m *ShippingAddress) Validate() error

Validate checks the field values on ShippingAddress 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 (*ShippingAddress) ValidateAll

func (m *ShippingAddress) ValidateAll() error

ValidateAll checks the field values on ShippingAddress 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 ShippingAddressMultiError, or nil if none found.

type ShippingAddressMultiError

type ShippingAddressMultiError []error

ShippingAddressMultiError is an error wrapping multiple validation errors returned by ShippingAddress.ValidateAll() if the designated constraints aren't met.

func (ShippingAddressMultiError) AllErrors

func (m ShippingAddressMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ShippingAddressMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ShippingAddressValidationError

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

ShippingAddressValidationError is the validation error returned by ShippingAddress.Validate if the designated constraints aren't met.

func (ShippingAddressValidationError) Cause

Cause function returns cause value.

func (ShippingAddressValidationError) Error

Error satisfies the builtin error interface

func (ShippingAddressValidationError) ErrorName

func (e ShippingAddressValidationError) ErrorName() string

ErrorName returns error name.

func (ShippingAddressValidationError) Field

Field function returns field value.

func (ShippingAddressValidationError) Key

Key function returns key value.

func (ShippingAddressValidationError) Reason

Reason function returns reason value.

type UnimplementedFulfillmentServiceServer

type UnimplementedFulfillmentServiceServer struct{}

UnimplementedFulfillmentServiceServer 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 (UnimplementedFulfillmentServiceServer) CreateFulfillment

func (UnimplementedFulfillmentServiceServer) GetFulfillment

type UnsafeFulfillmentServiceServer

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

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

type UpdateFulfillmentStatusRequest

type UpdateFulfillmentStatusRequest struct {
	Id     int64             `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Status FulfillmentStatus `protobuf:"varint,2,opt,name=status,proto3,enum=fulfillment.v1.FulfillmentStatus" json:"status,omitempty"`
	// Optional field to append tracking info if the carrier updates it.
	TrackingNumber string `protobuf:"bytes,3,opt,name=tracking_number,json=trackingNumber,proto3" json:"tracking_number,omitempty"`
	// contains filtered or unexported fields
}

Request to update the lifecycle status of a package/pickup (e.g., IN_TRANSIT, READY_FOR_PICKUP).

func (*UpdateFulfillmentStatusRequest) Descriptor deprecated

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

Deprecated: Use UpdateFulfillmentStatusRequest.ProtoReflect.Descriptor instead.

func (*UpdateFulfillmentStatusRequest) GetId

func (*UpdateFulfillmentStatusRequest) GetStatus

func (*UpdateFulfillmentStatusRequest) GetTrackingNumber

func (x *UpdateFulfillmentStatusRequest) GetTrackingNumber() string

func (*UpdateFulfillmentStatusRequest) ProtoMessage

func (*UpdateFulfillmentStatusRequest) ProtoMessage()

func (*UpdateFulfillmentStatusRequest) ProtoReflect

func (*UpdateFulfillmentStatusRequest) Reset

func (x *UpdateFulfillmentStatusRequest) Reset()

func (*UpdateFulfillmentStatusRequest) String

func (*UpdateFulfillmentStatusRequest) Validate

func (m *UpdateFulfillmentStatusRequest) Validate() error

Validate checks the field values on UpdateFulfillmentStatusRequest 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 (*UpdateFulfillmentStatusRequest) ValidateAll

func (m *UpdateFulfillmentStatusRequest) ValidateAll() error

ValidateAll checks the field values on UpdateFulfillmentStatusRequest 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 UpdateFulfillmentStatusRequestMultiError, or nil if none found.

type UpdateFulfillmentStatusRequestMultiError

type UpdateFulfillmentStatusRequestMultiError []error

UpdateFulfillmentStatusRequestMultiError is an error wrapping multiple validation errors returned by UpdateFulfillmentStatusRequest.ValidateAll() if the designated constraints aren't met.

func (UpdateFulfillmentStatusRequestMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (UpdateFulfillmentStatusRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type UpdateFulfillmentStatusRequestValidationError

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

UpdateFulfillmentStatusRequestValidationError is the validation error returned by UpdateFulfillmentStatusRequest.Validate if the designated constraints aren't met.

func (UpdateFulfillmentStatusRequestValidationError) Cause

Cause function returns cause value.

func (UpdateFulfillmentStatusRequestValidationError) Error

Error satisfies the builtin error interface

func (UpdateFulfillmentStatusRequestValidationError) ErrorName

ErrorName returns error name.

func (UpdateFulfillmentStatusRequestValidationError) Field

Field function returns field value.

func (UpdateFulfillmentStatusRequestValidationError) Key

Key function returns key value.

func (UpdateFulfillmentStatusRequestValidationError) Reason

Reason function returns reason value.

type UpdateFulfillmentStatusResponse

type UpdateFulfillmentStatusResponse struct {
	Fulfillment *Fulfillment `protobuf:"bytes,1,opt,name=fulfillment,proto3" json:"fulfillment,omitempty"`
	// contains filtered or unexported fields
}

Response after updating a fulfillment status.

func (*UpdateFulfillmentStatusResponse) Descriptor deprecated

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

Deprecated: Use UpdateFulfillmentStatusResponse.ProtoReflect.Descriptor instead.

func (*UpdateFulfillmentStatusResponse) GetFulfillment

func (x *UpdateFulfillmentStatusResponse) GetFulfillment() *Fulfillment

func (*UpdateFulfillmentStatusResponse) ProtoMessage

func (*UpdateFulfillmentStatusResponse) ProtoMessage()

func (*UpdateFulfillmentStatusResponse) ProtoReflect

func (*UpdateFulfillmentStatusResponse) Reset

func (*UpdateFulfillmentStatusResponse) String

func (*UpdateFulfillmentStatusResponse) Validate

func (m *UpdateFulfillmentStatusResponse) Validate() error

Validate checks the field values on UpdateFulfillmentStatusResponse 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 (*UpdateFulfillmentStatusResponse) ValidateAll

func (m *UpdateFulfillmentStatusResponse) ValidateAll() error

ValidateAll checks the field values on UpdateFulfillmentStatusResponse 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 UpdateFulfillmentStatusResponseMultiError, or nil if none found.

type UpdateFulfillmentStatusResponseMultiError

type UpdateFulfillmentStatusResponseMultiError []error

UpdateFulfillmentStatusResponseMultiError is an error wrapping multiple validation errors returned by UpdateFulfillmentStatusResponse.ValidateAll() if the designated constraints aren't met.

func (UpdateFulfillmentStatusResponseMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (UpdateFulfillmentStatusResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type UpdateFulfillmentStatusResponseValidationError

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

UpdateFulfillmentStatusResponseValidationError is the validation error returned by UpdateFulfillmentStatusResponse.Validate if the designated constraints aren't met.

func (UpdateFulfillmentStatusResponseValidationError) Cause

Cause function returns cause value.

func (UpdateFulfillmentStatusResponseValidationError) Error

Error satisfies the builtin error interface

func (UpdateFulfillmentStatusResponseValidationError) ErrorName

ErrorName returns error name.

func (UpdateFulfillmentStatusResponseValidationError) Field

Field function returns field value.

func (UpdateFulfillmentStatusResponseValidationError) Key

Key function returns key value.

func (UpdateFulfillmentStatusResponseValidationError) Reason

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL