carrierep

type CarrierSvc interface {
	ListCarriers(ctx context.Context, req *ListCarriersRequest) (*apiresource.List[apiresource.Carrier], *apierror.APIError)
	GetCarrier(ctx context.Context, req *RetrieveCarrierRequest) (*apiresource.Carrier, *apierror.APIError)
	CreateCarrier(ctx context.Context, req *CreateCarrierRequest) (*apiresource.Carrier, *apierror.APIError)
	UpdateCarrier(ctx context.Context, req *UpdateCarrierRequest) (*apiresource.Carrier, *apierror.APIError)
	DeleteCarrier(ctx context.Context, req *DeleteCarrierRequest) (*apiresource.EmptyResource, *apierror.APIError)
	InitiateOAuth(ctx context.Context, req *InitiateOAuthRequest) (*apiresource.OAuthResponse, *apierror.APIError)
	GetOAuthStatus(ctx context.Context, req *GetOAuthStatusRequest) (*apiresource.OAuthStatusResponse, *apierror.APIError)
	SyncOptions(ctx context.Context, req *SyncOptionsRequest) (*apiresource.Carrier, *apierror.APIError)
}

type CarrierSvcConfig struct {
	// CoreClient (required) is the core-service gRPC client.
	CoreClient pb.CoreServiceClient
}

type CreateCarrierEndpoint struct{}

type CreateCarrierRequest struct {
	// Human-readable name for the carrier.
	//
	// Must not match another carrier already visible to your account, including the system-provided ones.
	Name string `json:"name" validate:"required,max=255"`
	// Well-known carrier code.
	//
	// Providing a Shippo-supported code (`fedex`, `ups`, `usps`) connects the carrier through Shippo and syncs its service levels; the other codes, such as `will_call` and `delivery`, simply describe a self-managed shipping method. Omit the code entirely when none of them fit. The code cannot be changed after the carrier is created.
	Code field.Optional[constants.CarrierCode] `json:"code,omitzero"`
	// Your account number with this carrier.
	//
	// Required when `code` is `ups` or `usps`, whose carrier accounts are connected to Shippo using this number; FedEx authorizes through OAuth instead, so no account number is needed.
	AccountNumber field.Optional[string] `json:"account_number,omitzero" validate:"omitempty,max=255"`
	// Whether customers can see and select this carrier at checkout in the customer portal.
	CustomerPortalVisibility field.Optional[constants.CustomerPortalVisibility] `json:"customer_portal_visibility,omitzero" default:"visible"`
}

type DeleteCarrierEndpoint struct{}

type DeleteCarrierRequest struct {
	// Carrier ID.
	CarrierID string `path:"id" validate:"required"`
}

type GetOAuthStatusEndpoint struct{}

type GetOAuthStatusRequest struct {
	// Carrier ID.
	CarrierID string `path:"id" validate:"required"`
}

type InitiateOAuthEndpoint struct{}

type InitiateOAuthRequest struct {
	// Carrier ID.
	CarrierID string `path:"id" validate:"required"`
	// URL the carrier sends the user back to once they finish authorizing.
	RedirectURI string `json:"redirect_uri" validate:"required"`
	// Opaque value passed through the OAuth flow and handed back on the redirect.
	//
	// Use it to correlate the callback with the request that started it, or to carry the page the user should return to.
	State field.Optional[string] `json:"state,omitzero"`
}

type ListCarriersEndpoint struct{}

type ListCarriersRequest struct {
	apiresource.PaginationRequest
}

type RetrieveCarrierEndpoint struct{}

type RetrieveCarrierRequest struct {
	// Carrier ID.
	CarrierID string `path:"id" validate:"required"`
}

type SyncOptionsEndpoint struct{}

type SyncOptionsRequest struct {
	// Carrier ID.
	CarrierID string `path:"id" validate:"required"`
}

type UpdateCarrierEndpoint struct{}

type UpdateCarrierRequest struct {
	// Carrier ID.
	CarrierID string `path:"id" validate:"required"`
	// Human-readable name for the carrier.
	//
	// Must not match another carrier already visible to your account, including the system-provided ones.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Whether customers can see and select this carrier at checkout in the customer portal.
	//
	// Each of the carrier's service levels carries its own customer portal visibility, which this does not change.
	CustomerPortalVisibility field.Optional[constants.CustomerPortalVisibility] `json:"customer_portal_visibility,omitzero"`
}