Documentation
¶
Index ¶
- func CreateOfficeOktaAccount(appCtx appcontext.AppContext, ...) (*http.Response, error)
- func NewAdminAPI(handlerConfig handlers.HandlerConfig) *adminops.MymoveAPI
- type CreateAdminUserHandler
- type CreateClientCertHandler
- type CreateOfficeUserHandler
- type CreateWebhookSubscriptionHandler
- type GetAdminUserHandler
- type GetClientCertHandler
- type GetElectronicOrdersTotalsHandler
- type GetLoggedInUserHandler
- type GetMoveHandler
- type GetOfficeUserHandler
- type GetRequestedOfficeUserHandler
- type GetUploadHandler
- type GetUserHandler
- type GetWebhookSubscriptionHandler
- type IndexAdminUsersHandler
- type IndexClientCertsHandler
- type IndexElectronicOrdersHandler
- type IndexMovesHandler
- type IndexNotificationsHandler
- type IndexOfficeUsersHandler
- type IndexOfficesHandler
- type IndexOrganizationsHandler
- type IndexRequestedOfficeUsersHandler
- type IndexUsersHandler
- type IndexWebhookSubscriptionsHandler
- type RemoveClientCertHandler
- type UpdateAdminUserHandler
- type UpdateClientCertHandler
- type UpdateMoveHandler
- type UpdateOfficeUserHandler
- type UpdateRequestedOfficeUserHandler
- type UpdateUserHandler
- type UpdateWebhookSubscriptionHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateOfficeOktaAccount ¶
func CreateOfficeOktaAccount(appCtx appcontext.AppContext, params requested_office_users.UpdateRequestedOfficeUserParams) (*http.Response, error)
func NewAdminAPI ¶
func NewAdminAPI(handlerConfig handlers.HandlerConfig) *adminops.MymoveAPI
NewAdminAPI returns the admin API
Types ¶
type CreateAdminUserHandler ¶
type CreateAdminUserHandler struct {
handlers.HandlerConfig
services.AdminUserCreator
services.NewQueryFilter
}
CreateAdminUserHandler is the handler for creating users.
func (CreateAdminUserHandler) Handle ¶
func (h CreateAdminUserHandler) Handle(params adminuserop.CreateAdminUserParams) middleware.Responder
Handle creates an admin user
type CreateClientCertHandler ¶
type CreateClientCertHandler struct {
handlers.HandlerConfig
services.ClientCertCreator
}
CreateClientCertHandler is the handler for creating users.
func (CreateClientCertHandler) Handle ¶
func (h CreateClientCertHandler) Handle(params clientcertop.CreateClientCertificateParams) middleware.Responder
Handle creates a client certificate
type CreateOfficeUserHandler ¶
type CreateOfficeUserHandler struct {
handlers.HandlerConfig
services.OfficeUserCreator
services.NewQueryFilter
services.UserRoleAssociator
services.RoleAssociater
services.UserPrivilegeAssociator
}
CreateOfficeUserHandler creates an office user
func (CreateOfficeUserHandler) Handle ¶
func (h CreateOfficeUserHandler) Handle(params officeuserop.CreateOfficeUserParams) middleware.Responder
Handle creates an office user
type CreateWebhookSubscriptionHandler ¶
type CreateWebhookSubscriptionHandler struct {
handlers.HandlerConfig
services.WebhookSubscriptionCreator
services.NewQueryFilter
}
CreateWebhookSubscriptionHandler is the handler for creating users.
func (CreateWebhookSubscriptionHandler) Handle ¶
func (h CreateWebhookSubscriptionHandler) Handle(params webhooksubscriptionop.CreateWebhookSubscriptionParams) middleware.Responder
Handle creates an admin user
type GetAdminUserHandler ¶
type GetAdminUserHandler struct {
handlers.HandlerConfig
services.AdminUserFetcher
services.NewQueryFilter
}
GetAdminUserHandler retrieves a handler for admin users
func (GetAdminUserHandler) Handle ¶
func (h GetAdminUserHandler) Handle(params adminuserop.GetAdminUserParams) middleware.Responder
Handle retrieves a new admin user
type GetClientCertHandler ¶
type GetClientCertHandler struct {
handlers.HandlerConfig
services.ClientCertFetcher
services.NewQueryFilter
}
GetClientCertHandler retrieves a handler for admin users
func (GetClientCertHandler) Handle ¶
func (h GetClientCertHandler) Handle(params clientcertop.GetClientCertificateParams) middleware.Responder
Handle retrieves a new admin user
type GetElectronicOrdersTotalsHandler ¶
type GetElectronicOrdersTotalsHandler struct {
handlers.HandlerConfig
services.ElectronicOrderCategoryCountFetcher
services.NewQueryFilter
}
GetElectronicOrdersTotalsHandler returns totals of electronic orders
func (GetElectronicOrdersTotalsHandler) Handle ¶
func (h GetElectronicOrdersTotalsHandler) Handle(params electronicorderop.GetElectronicOrdersTotalsParams) middleware.Responder
Handle returns electronic orders totals
type GetLoggedInUserHandler ¶
type GetLoggedInUserHandler struct {
handlers.HandlerConfig
services.AdminUserFetcher
services.NewQueryFilter
}
GetLoggedInUserHandler retrieves a handler for retrieving info of the currently logged in admin user
func (GetLoggedInUserHandler) Handle ¶
func (h GetLoggedInUserHandler) Handle(params userop.GetLoggedInAdminUserParams) middleware.Responder
Handle retrieves the currently logged in admin user
type GetMoveHandler ¶
type GetMoveHandler struct {
handlers.HandlerConfig
}
GetMoveHandler retrieves the info for a given move
func (GetMoveHandler) Handle ¶
func (h GetMoveHandler) Handle(params moveop.GetMoveParams) middleware.Responder
Handle retrieves a given move by move id
type GetOfficeUserHandler ¶
type GetOfficeUserHandler struct {
handlers.HandlerConfig
services.OfficeUserFetcher
services.NewQueryFilter
}
GetOfficeUserHandler retrieves office user handler
func (GetOfficeUserHandler) Handle ¶
func (h GetOfficeUserHandler) Handle(params officeuserop.GetOfficeUserParams) middleware.Responder
Handle retrieves an office user
type GetRequestedOfficeUserHandler ¶
type GetRequestedOfficeUserHandler struct {
handlers.HandlerConfig
services.RequestedOfficeUserFetcher
services.RoleAssociater
services.NewQueryFilter
}
GetRequestedOfficeUserHandler returns a list of office users via GET /requested_office_users/{officeUserId}
func (GetRequestedOfficeUserHandler) Handle ¶
func (h GetRequestedOfficeUserHandler) Handle(params requested_office_users.GetRequestedOfficeUserParams) middleware.Responder
Handle retrieves a single requested office user
type GetUploadHandler ¶
type GetUploadHandler struct {
handlers.HandlerConfig
services.UploadInformationFetcher
}
GetUploadHandler returns an upload via GET /uploads/{uploadID}
func (GetUploadHandler) Handle ¶
func (h GetUploadHandler) Handle(params uploadop.GetUploadParams) middleware.Responder
Handle retrieves a specific upload
type GetUserHandler ¶
type GetUserHandler struct {
handlers.HandlerConfig
services.UserFetcher
services.NewQueryFilter
}
GetUserHandler returns a user via GET /users/{userID}
func (GetUserHandler) Handle ¶
func (h GetUserHandler) Handle(params userop.GetUserParams) middleware.Responder
Handle retrieves a specific user
type GetWebhookSubscriptionHandler ¶
type GetWebhookSubscriptionHandler struct {
handlers.HandlerConfig
services.WebhookSubscriptionFetcher
services.NewQueryFilter
}
GetWebhookSubscriptionHandler returns one webhookSubscription via GET /webhook-subscriptions/:ID
func (GetWebhookSubscriptionHandler) Handle ¶
func (h GetWebhookSubscriptionHandler) Handle(params webhooksubscriptionop.GetWebhookSubscriptionParams) middleware.Responder
Handle retrieves a webhook subscription
type IndexAdminUsersHandler ¶
type IndexAdminUsersHandler struct {
handlers.HandlerConfig
services.AdminUserListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexAdminUsersHandler returns a list of admin users via GET /admin_users
func (IndexAdminUsersHandler) Handle ¶
func (h IndexAdminUsersHandler) Handle(params adminuserop.IndexAdminUsersParams) middleware.Responder
Handle retrieves a list of admin users
type IndexClientCertsHandler ¶
type IndexClientCertsHandler struct {
handlers.HandlerConfig
services.ClientCertListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexClientCertsHandler returns a list of client certs via GET /client_certs
func (IndexClientCertsHandler) Handle ¶
func (h IndexClientCertsHandler) Handle(params clientcertop.IndexClientCertificatesParams) middleware.Responder
Handle retrieves a list of client certificates. This list is used to authorize certificates used in the authentication and authorization of Prime API requests.
type IndexElectronicOrdersHandler ¶
type IndexElectronicOrdersHandler struct {
handlers.HandlerConfig
services.ElectronicOrderListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexElectronicOrdersHandler returns an index of electronic orders
func (IndexElectronicOrdersHandler) Handle ¶
func (h IndexElectronicOrdersHandler) Handle(params electronicorderop.IndexElectronicOrdersParams) middleware.Responder
Handle returns an index of electronic orders
type IndexMovesHandler ¶
type IndexMovesHandler struct {
handlers.HandlerConfig
services.MoveListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexMovesHandler returns a list of moves/MTOs via GET /moves
func (IndexMovesHandler) Handle ¶
func (h IndexMovesHandler) Handle(params moveop.IndexMovesParams) middleware.Responder
Handle retrieves a list of moves/MTOs
type IndexNotificationsHandler ¶
type IndexNotificationsHandler struct {
handlers.HandlerConfig
services.ListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexNotificationsHandler is the index notification handler
func (IndexNotificationsHandler) Handle ¶
func (h IndexNotificationsHandler) Handle(params notificationsop.IndexNotificationsParams) middleware.Responder
Handle does the index notification
type IndexOfficeUsersHandler ¶
type IndexOfficeUsersHandler struct {
handlers.HandlerConfig
services.ListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexOfficeUsersHandler returns a list of office users via GET /office_users
func (IndexOfficeUsersHandler) Handle ¶
func (h IndexOfficeUsersHandler) Handle(params officeuserop.IndexOfficeUsersParams) middleware.Responder
Handle retrieves a list of office users
type IndexOfficesHandler ¶
type IndexOfficesHandler struct {
handlers.HandlerConfig
services.OfficeListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexOfficesHandler returns a list of office users via GET /office_users
func (IndexOfficesHandler) Handle ¶
func (h IndexOfficesHandler) Handle(params transportation_officesop.IndexOfficesParams) middleware.Responder
Handle retrieves a list of office users
type IndexOrganizationsHandler ¶
type IndexOrganizationsHandler struct {
handlers.HandlerConfig
services.OrganizationListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexOrganizationsHandler returns a list of organizations via GET /organizations
func (IndexOrganizationsHandler) Handle ¶
func (h IndexOrganizationsHandler) Handle(params organizationop.IndexOrganizationsParams) middleware.Responder
Handle retrieves a list of organizations
type IndexRequestedOfficeUsersHandler ¶
type IndexRequestedOfficeUsersHandler struct {
handlers.HandlerConfig
services.RequestedOfficeUserListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexRequestedOfficeUsersHandler returns a list of requested office users via GET /requested_office_users
func (IndexRequestedOfficeUsersHandler) Handle ¶
func (h IndexRequestedOfficeUsersHandler) Handle(params requested_office_users.IndexRequestedOfficeUsersParams) middleware.Responder
Handle retrieves a list of requested office users
type IndexUsersHandler ¶
type IndexUsersHandler struct {
handlers.HandlerConfig
services.ListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexUsersHandler returns a list of users via GET /users
func (IndexUsersHandler) Handle ¶
func (h IndexUsersHandler) Handle(params userop.IndexUsersParams) middleware.Responder
Handle lists all users
type IndexWebhookSubscriptionsHandler ¶
type IndexWebhookSubscriptionsHandler struct {
handlers.HandlerConfig
services.ListFetcher
services.NewQueryFilter
services.NewPagination
}
IndexWebhookSubscriptionsHandler returns a list of webhook subscriptions via GET /webhook-subscriptions
func (IndexWebhookSubscriptionsHandler) Handle ¶
func (h IndexWebhookSubscriptionsHandler) Handle(params webhooksubscriptionop.IndexWebhookSubscriptionsParams) middleware.Responder
Handle retrieves a list of webhook subscriptions
type RemoveClientCertHandler ¶
type RemoveClientCertHandler struct {
handlers.HandlerConfig
services.ClientCertRemover
services.NewQueryFilter
}
UpdateClientCertHandler is the handler for updating users
func (RemoveClientCertHandler) Handle ¶
func (h RemoveClientCertHandler) Handle(params clientcertop.RemoveClientCertificateParams) middleware.Responder
Handle updates admin users
type UpdateAdminUserHandler ¶
type UpdateAdminUserHandler struct {
handlers.HandlerConfig
services.AdminUserUpdater
services.NewQueryFilter
}
UpdateAdminUserHandler is the handler for updating users
func (UpdateAdminUserHandler) Handle ¶
func (h UpdateAdminUserHandler) Handle(params adminuserop.UpdateAdminUserParams) middleware.Responder
Handle updates admin users
type UpdateClientCertHandler ¶
type UpdateClientCertHandler struct {
handlers.HandlerConfig
services.ClientCertUpdater
services.NewQueryFilter
}
UpdateClientCertHandler is the handler for updating users
func (UpdateClientCertHandler) Handle ¶
func (h UpdateClientCertHandler) Handle(params clientcertop.UpdateClientCertificateParams) middleware.Responder
Handle updates admin users
type UpdateMoveHandler ¶
type UpdateMoveHandler struct {
handlers.HandlerConfig
services.MoveTaskOrderUpdater
}
UpdateMoveHandler updates a given move
func (UpdateMoveHandler) Handle ¶
func (h UpdateMoveHandler) Handle(params moveop.UpdateMoveParams) middleware.Responder
Handle updates a given move
type UpdateOfficeUserHandler ¶
type UpdateOfficeUserHandler struct {
handlers.HandlerConfig
services.OfficeUserUpdater
services.NewQueryFilter
services.UserRoleAssociator
services.UserPrivilegeAssociator
services.UserSessionRevocation
}
UpdateOfficeUserHandler updates an office user
func (UpdateOfficeUserHandler) Handle ¶
func (h UpdateOfficeUserHandler) Handle(params officeuserop.UpdateOfficeUserParams) middleware.Responder
Handle updates an office user
type UpdateRequestedOfficeUserHandler ¶
type UpdateRequestedOfficeUserHandler struct {
handlers.HandlerConfig
services.RequestedOfficeUserUpdater
services.UserRoleAssociator
services.RoleAssociater
}
GetRequestedOfficeUserHandler returns a list of office users via GET /requested_office_users/{officeUserId}
func (UpdateRequestedOfficeUserHandler) Handle ¶
func (h UpdateRequestedOfficeUserHandler) Handle(params requested_office_users.UpdateRequestedOfficeUserParams) middleware.Responder
Handle updates a single requested office user this endpoint will be used when an admin is approving/rejecting the user without updates as well as approving/rejecting the user with updates
type UpdateUserHandler ¶
type UpdateUserHandler struct {
handlers.HandlerConfig
services.UserSessionRevocation
services.UserUpdater
services.NewQueryFilter
}
UpdateUserHandler is the handler for updating users.
func (UpdateUserHandler) Handle ¶
func (h UpdateUserHandler) Handle(params userop.UpdateUserParams) middleware.Responder
Handle updates a user's Active status and/or their sessions
type UpdateWebhookSubscriptionHandler ¶
type UpdateWebhookSubscriptionHandler struct {
handlers.HandlerConfig
services.WebhookSubscriptionUpdater
services.NewQueryFilter
}
UpdateWebhookSubscriptionHandler returns an updated webhook subscription via PATCH
func (UpdateWebhookSubscriptionHandler) Handle ¶
func (h UpdateWebhookSubscriptionHandler) Handle(params webhooksubscriptionop.UpdateWebhookSubscriptionParams) middleware.Responder
Handle updates a webhook subscription