adminapi

package
v0.0.0-...-c407d37 Latest Latest
Warning

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

Go to latest
Published: Apr 12, 2024 License: MIT Imports: 59 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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

Handle creates an admin user

type CreateClientCertHandler

type CreateClientCertHandler struct {
	handlers.HandlerConfig
	services.ClientCertCreator
}

CreateClientCertHandler is the handler for creating users.

func (CreateClientCertHandler) Handle

Handle creates a client certificate

type CreateOfficeUserHandler

CreateOfficeUserHandler creates an office user

func (CreateOfficeUserHandler) Handle

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

Handle creates an admin user

type GetAdminUserHandler

GetAdminUserHandler retrieves a handler for admin users

func (GetAdminUserHandler) Handle

Handle retrieves a new admin user

type GetClientCertHandler

GetClientCertHandler retrieves a handler for admin users

func (GetClientCertHandler) Handle

Handle retrieves a new admin user

type GetElectronicOrdersTotalsHandler

GetElectronicOrdersTotalsHandler returns totals of electronic orders

func (GetElectronicOrdersTotalsHandler) Handle

Handle returns electronic orders totals

type GetMoveHandler

type GetMoveHandler struct {
	handlers.HandlerConfig
}

GetMoveHandler retrieves the info for a given move

func (GetMoveHandler) Handle

Handle retrieves a given move by move id

type GetOfficeUserHandler

GetOfficeUserHandler retrieves office user handler

func (GetOfficeUserHandler) Handle

Handle retrieves an office user

type GetRequestedOfficeUserHandler

GetRequestedOfficeUserHandler returns a list of office users via GET /requested_office_users/{officeUserId}

func (GetRequestedOfficeUserHandler) Handle

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

Handle retrieves a specific upload

type GetUserHandler

GetUserHandler returns a user via GET /users/{userID}

func (GetUserHandler) Handle

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

Handle retrieves a webhook subscription

type IndexAdminUsersHandler

IndexAdminUsersHandler returns a list of admin users via GET /admin_users

func (IndexAdminUsersHandler) Handle

Handle retrieves a list of admin users

type IndexClientCertsHandler

IndexClientCertsHandler returns a list of client certs via GET /client_certs

func (IndexClientCertsHandler) Handle

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

IndexElectronicOrdersHandler returns an index of electronic orders

func (IndexElectronicOrdersHandler) Handle

Handle returns an index of electronic orders

type IndexMovesHandler

IndexMovesHandler returns a list of moves/MTOs via GET /moves

func (IndexMovesHandler) Handle

Handle retrieves a list of moves/MTOs

type IndexNotificationsHandler

IndexNotificationsHandler is the index notification handler

func (IndexNotificationsHandler) Handle

Handle does the index notification

type IndexOfficeUsersHandler

IndexOfficeUsersHandler returns a list of office users via GET /office_users

func (IndexOfficeUsersHandler) Handle

Handle retrieves a list of office users

type IndexOfficesHandler

IndexOfficesHandler returns a list of office users via GET /office_users

func (IndexOfficesHandler) Handle

Handle retrieves a list of office users

type IndexOrganizationsHandler

IndexOrganizationsHandler returns a list of organizations via GET /organizations

func (IndexOrganizationsHandler) Handle

Handle retrieves a list of organizations

type IndexRequestedOfficeUsersHandler

IndexRequestedOfficeUsersHandler returns a list of requested office users via GET /requested_office_users

func (IndexRequestedOfficeUsersHandler) Handle

Handle retrieves a list of requested office users

type IndexUsersHandler

IndexUsersHandler returns a list of users via GET /users

func (IndexUsersHandler) Handle

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

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

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

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

Handle updates admin users

type UpdateMoveHandler

type UpdateMoveHandler struct {
	handlers.HandlerConfig
	services.MoveTaskOrderUpdater
}

UpdateMoveHandler updates a given move

func (UpdateMoveHandler) Handle

Handle updates a given move

type UpdateOfficeUserHandler

UpdateOfficeUserHandler updates an office user

func (UpdateOfficeUserHandler) Handle

Handle updates an office user

type UpdateRequestedOfficeUserHandler

GetRequestedOfficeUserHandler returns a list of office users via GET /requested_office_users/{officeUserId}

func (UpdateRequestedOfficeUserHandler) Handle

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

UpdateUserHandler is the handler for updating users.

func (UpdateUserHandler) Handle

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

Handle updates a webhook subscription

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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