Documentation ¶
Index ¶
- Constants
- type Address
- type AdminUser
- type AdminUserCreatePayload
- func (m *AdminUserCreatePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AdminUserCreatePayload) MarshalBinary() ([]byte, error)
- func (m *AdminUserCreatePayload) UnmarshalBinary(b []byte) error
- func (m *AdminUserCreatePayload) Validate(formats strfmt.Registry) error
- type AdminUserUpdatePayload
- func (m *AdminUserUpdatePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AdminUserUpdatePayload) MarshalBinary() ([]byte, error)
- func (m *AdminUserUpdatePayload) UnmarshalBinary(b []byte) error
- func (m *AdminUserUpdatePayload) Validate(formats strfmt.Registry) error
- type AdminUsers
- type ClientError
- type CreateWebhookSubscription
- func (m *CreateWebhookSubscription) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CreateWebhookSubscription) MarshalBinary() ([]byte, error)
- func (m *CreateWebhookSubscription) UnmarshalBinary(b []byte) error
- func (m *CreateWebhookSubscription) Validate(formats strfmt.Registry) error
- type ElectronicOrder
- type ElectronicOrders
- type ElectronicOrdersTotal
- type ElectronicOrdersTotals
- type Issuer
- type Move
- type MoveStatus
- type MoveUpdatePayload
- type Moves
- type Notification
- type Notifications
- type OfficeUser
- type OfficeUserCreatePayload
- func (m *OfficeUserCreatePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *OfficeUserCreatePayload) MarshalBinary() ([]byte, error)
- func (m *OfficeUserCreatePayload) UnmarshalBinary(b []byte) error
- func (m *OfficeUserCreatePayload) Validate(formats strfmt.Registry) error
- type OfficeUserRole
- type OfficeUserUpdatePayload
- func (m *OfficeUserUpdatePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *OfficeUserUpdatePayload) MarshalBinary() ([]byte, error)
- func (m *OfficeUserUpdatePayload) UnmarshalBinary(b []byte) error
- func (m *OfficeUserUpdatePayload) Validate(formats strfmt.Registry) error
- type OfficeUsers
- type Organization
- type Organizations
- type Role
- type ServiceMember
- type TransportationOffice
- type TransportationOffices
- type TransportationServiceProviderPerformance
- func (m *TransportationServiceProviderPerformance) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TransportationServiceProviderPerformance) MarshalBinary() ([]byte, error)
- func (m *TransportationServiceProviderPerformance) UnmarshalBinary(b []byte) error
- func (m *TransportationServiceProviderPerformance) Validate(formats strfmt.Registry) error
- type TransportationServiceProviderPerformances
- type Upload
- type UploadInformation
- type User
- type UserUpdatePayload
- type Users
- type ValidationError
- func (m *ValidationError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ValidationError) MarshalBinary() ([]byte, error)
- func (m ValidationError) MarshalJSON() ([]byte, error)
- func (m *ValidationError) UnmarshalBinary(b []byte) error
- func (m *ValidationError) UnmarshalJSON(raw []byte) error
- func (m *ValidationError) Validate(formats strfmt.Registry) error
- type ValidationErrorAllOf1
- type WebhookSubscription
- type WebhookSubscriptionStatus
- type WebhookSubscriptions
Constants ¶
const ( // AddressStateAL captures enum value "AL" AddressStateAL string = "AL" // AddressStateAK captures enum value "AK" AddressStateAK string = "AK" // AddressStateAR captures enum value "AR" AddressStateAR string = "AR" // AddressStateAZ captures enum value "AZ" AddressStateAZ string = "AZ" // AddressStateCA captures enum value "CA" AddressStateCA string = "CA" // AddressStateCO captures enum value "CO" AddressStateCO string = "CO" // AddressStateCT captures enum value "CT" AddressStateCT string = "CT" // AddressStateDC captures enum value "DC" AddressStateDC string = "DC" // AddressStateDE captures enum value "DE" AddressStateDE string = "DE" // AddressStateFL captures enum value "FL" AddressStateFL string = "FL" // AddressStateGA captures enum value "GA" AddressStateGA string = "GA" // AddressStateHI captures enum value "HI" AddressStateHI string = "HI" // AddressStateIA captures enum value "IA" AddressStateIA string = "IA" // AddressStateID captures enum value "ID" AddressStateID string = "ID" // AddressStateIL captures enum value "IL" AddressStateIL string = "IL" // AddressStateIN captures enum value "IN" AddressStateIN string = "IN" // AddressStateKS captures enum value "KS" AddressStateKS string = "KS" // AddressStateKY captures enum value "KY" AddressStateKY string = "KY" // AddressStateLA captures enum value "LA" AddressStateLA string = "LA" // AddressStateMA captures enum value "MA" AddressStateMA string = "MA" // AddressStateMD captures enum value "MD" AddressStateMD string = "MD" // AddressStateME captures enum value "ME" AddressStateME string = "ME" // AddressStateMI captures enum value "MI" AddressStateMI string = "MI" // AddressStateMN captures enum value "MN" AddressStateMN string = "MN" // AddressStateMO captures enum value "MO" AddressStateMO string = "MO" // AddressStateMS captures enum value "MS" AddressStateMS string = "MS" // AddressStateMT captures enum value "MT" AddressStateMT string = "MT" // AddressStateNC captures enum value "NC" AddressStateNC string = "NC" // AddressStateND captures enum value "ND" AddressStateND string = "ND" // AddressStateNE captures enum value "NE" AddressStateNE string = "NE" // AddressStateNH captures enum value "NH" AddressStateNH string = "NH" // AddressStateNJ captures enum value "NJ" AddressStateNJ string = "NJ" // AddressStateNM captures enum value "NM" AddressStateNM string = "NM" // AddressStateNV captures enum value "NV" AddressStateNV string = "NV" // AddressStateNY captures enum value "NY" AddressStateNY string = "NY" // AddressStateOH captures enum value "OH" AddressStateOH string = "OH" // AddressStateOK captures enum value "OK" AddressStateOK string = "OK" // AddressStateOR captures enum value "OR" AddressStateOR string = "OR" // AddressStatePA captures enum value "PA" AddressStatePA string = "PA" // AddressStateRI captures enum value "RI" AddressStateRI string = "RI" // AddressStateSC captures enum value "SC" AddressStateSC string = "SC" // AddressStateSD captures enum value "SD" AddressStateSD string = "SD" // AddressStateTN captures enum value "TN" AddressStateTN string = "TN" // AddressStateTX captures enum value "TX" AddressStateTX string = "TX" // AddressStateUT captures enum value "UT" AddressStateUT string = "UT" // AddressStateVA captures enum value "VA" AddressStateVA string = "VA" // AddressStateVT captures enum value "VT" AddressStateVT string = "VT" // AddressStateWA captures enum value "WA" AddressStateWA string = "WA" // AddressStateWI captures enum value "WI" AddressStateWI string = "WI" // AddressStateWV captures enum value "WV" AddressStateWV string = "WV" // AddressStateWY captures enum value "WY" AddressStateWY string = "WY" )
const ( // NotificationNotificationTypeMOVEREVIEWEDEMAIL captures enum value "MOVE_REVIEWED_EMAIL" NotificationNotificationTypeMOVEREVIEWEDEMAIL string = "MOVE_REVIEWED_EMAIL" // NotificationNotificationTypeMOVEPAYMENTREMINDEREMAIL captures enum value "MOVE_PAYMENT_REMINDER_EMAIL" NotificationNotificationTypeMOVEPAYMENTREMINDEREMAIL string = "MOVE_PAYMENT_REMINDER_EMAIL" )
const ( // UploadContentTypeApplicationPdf captures enum value "application/pdf" UploadContentTypeApplicationPdf string = "application/pdf" // UploadContentTypeImageJpeg captures enum value "image/jpeg" UploadContentTypeImageJpeg string = "image/jpeg" // UploadContentTypeImagePng captures enum value "image/png" UploadContentTypeImagePng string = "image/png" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address struct { // City // Example: Anytown // Required: true City *string `json:"city"` // Country // Example: USA Country *string `json:"country,omitempty"` // ZIP // // zip code, international allowed // Example: '90210' or 'N15 3NL' // Required: true PostalCode *string `json:"postalCode"` // State // Required: true // Enum: [AL AK AR AZ CA CO CT DC DE FL GA HI IA ID IL IN KS KY LA MA MD ME MI MN MO MS MT NC ND NE NH NJ NM NV NY OH OK OR PA RI SC SD TN TX UT VA VT WA WI WV WY] State *string `json:"state"` // Address line 1 // Example: 123 Main Ave // Required: true StreetAddress1 *string `json:"streetAddress1"` // Address line 2 // Example: Apartment 9000 StreetAddress2 *string `json:"streetAddress2,omitempty"` // Address line 3 // Example: Montmârtre StreetAddress3 *string `json:"streetAddress3,omitempty"` }
Address address
swagger:model Address
func (*Address) ContextValidate ¶
ContextValidate validates this address based on context it is used
func (*Address) MarshalBinary ¶
MarshalBinary interface implementation
func (*Address) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AdminUser ¶
type AdminUser struct { // active // Required: true Active *bool `json:"active"` // created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // email // Required: true // Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ Email *string `json:"email"` // first name // Required: true FirstName *string `json:"firstName"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // last name // Required: true LastName *string `json:"lastName"` // organization Id // Required: true // Format: uuid OrganizationID *strfmt.UUID `json:"organizationId"` // updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` // user Id // Required: true // Format: uuid UserID *strfmt.UUID `json:"userId"` }
AdminUser admin user
swagger:model AdminUser
func (*AdminUser) ContextValidate ¶
ContextValidate validates this admin user based on context it is used
func (*AdminUser) MarshalBinary ¶
MarshalBinary interface implementation
func (*AdminUser) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AdminUserCreatePayload ¶
type AdminUserCreatePayload struct { // Email // Example: user@userdomain.com Email string `json:"email,omitempty"` // First Name FirstName string `json:"firstName,omitempty"` // Last Name LastName string `json:"lastName,omitempty"` // organization Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Format: uuid OrganizationID strfmt.UUID `json:"organizationId,omitempty"` }
AdminUserCreatePayload admin user create payload
swagger:model AdminUserCreatePayload
func (*AdminUserCreatePayload) ContextValidate ¶
func (m *AdminUserCreatePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this admin user create payload based on context it is used
func (*AdminUserCreatePayload) MarshalBinary ¶
func (m *AdminUserCreatePayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AdminUserCreatePayload) UnmarshalBinary ¶
func (m *AdminUserCreatePayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AdminUserUpdatePayload ¶
type AdminUserUpdatePayload struct { // active Active *bool `json:"active,omitempty"` // First Name FirstName *string `json:"firstName,omitempty"` // Last Name LastName *string `json:"lastName,omitempty"` }
AdminUserUpdatePayload admin user update payload
swagger:model AdminUserUpdatePayload
func (*AdminUserUpdatePayload) ContextValidate ¶
func (m *AdminUserUpdatePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this admin user update payload based on context it is used
func (*AdminUserUpdatePayload) MarshalBinary ¶
func (m *AdminUserUpdatePayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AdminUserUpdatePayload) UnmarshalBinary ¶
func (m *AdminUserUpdatePayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AdminUsers ¶
type AdminUsers []*AdminUser
AdminUsers admin users
swagger:model AdminUsers
func (AdminUsers) ContextValidate ¶
ContextValidate validate this admin users based on the context it is used
type ClientError ¶
type ClientError struct { // detail // Required: true Detail *string `json:"detail"` // instance // Required: true // Format: uuid Instance *strfmt.UUID `json:"instance"` // title // Required: true Title *string `json:"title"` }
ClientError client error
swagger:model ClientError
func (*ClientError) ContextValidate ¶
ContextValidate validates this client error based on context it is used
func (*ClientError) MarshalBinary ¶
func (m *ClientError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClientError) UnmarshalBinary ¶
func (m *ClientError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateWebhookSubscription ¶
type CreateWebhookSubscription struct { // The URL to which the notifications for this subscription will be pushed to. // Required: true CallbackURL *string `json:"callbackUrl"` // A string used to represent which events this subscriber expects to be notified about. Corresponds to the possible event_key values in webhook_notifications. // Required: true EventKey *string `json:"eventKey"` // status // Required: true Status *WebhookSubscriptionStatus `json:"status"` // subscriber Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid SubscriberID *strfmt.UUID `json:"subscriberId"` }
CreateWebhookSubscription create webhook subscription
swagger:model CreateWebhookSubscription
func (*CreateWebhookSubscription) ContextValidate ¶
func (m *CreateWebhookSubscription) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this create webhook subscription based on the context it is used
func (*CreateWebhookSubscription) MarshalBinary ¶
func (m *CreateWebhookSubscription) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateWebhookSubscription) UnmarshalBinary ¶
func (m *CreateWebhookSubscription) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElectronicOrder ¶
type ElectronicOrder struct { // Created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // issuer // Required: true Issuer *Issuer `json:"issuer"` // Orders Number // Required: true OrdersNumber *string `json:"ordersNumber"` // Updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` }
ElectronicOrder electronic order
swagger:model ElectronicOrder
func (*ElectronicOrder) ContextValidate ¶
ContextValidate validate this electronic order based on the context it is used
func (*ElectronicOrder) MarshalBinary ¶
func (m *ElectronicOrder) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElectronicOrder) UnmarshalBinary ¶
func (m *ElectronicOrder) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElectronicOrders ¶
type ElectronicOrders []*ElectronicOrder
ElectronicOrders electronic orders
swagger:model ElectronicOrders
func (ElectronicOrders) ContextValidate ¶
ContextValidate validate this electronic orders based on the context it is used
type ElectronicOrdersTotal ¶
type ElectronicOrdersTotal struct { // category Category string `json:"category,omitempty"` // Total Orders Count // Minimum: 0 Count *int64 `json:"count,omitempty"` }
ElectronicOrdersTotal electronic orders total
swagger:model ElectronicOrdersTotal
func (*ElectronicOrdersTotal) ContextValidate ¶
ContextValidate validates this electronic orders total based on context it is used
func (*ElectronicOrdersTotal) MarshalBinary ¶
func (m *ElectronicOrdersTotal) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElectronicOrdersTotal) UnmarshalBinary ¶
func (m *ElectronicOrdersTotal) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElectronicOrdersTotals ¶
type ElectronicOrdersTotals []*ElectronicOrdersTotal
ElectronicOrdersTotals electronic orders totals
swagger:model ElectronicOrdersTotals
func (ElectronicOrdersTotals) ContextValidate ¶
ContextValidate validate this electronic orders totals based on the context it is used
type Issuer ¶
type Issuer string
Issuer Organization that issues orders. If more organizations, especially civilian ones, become clients of this API in the future, this enumeration may need to be expanded.
swagger:model Issuer
const ( // IssuerArmy captures enum value "army" IssuerArmy Issuer = "army" IssuerNavy Issuer = "navy" // IssuerAirDashForce captures enum value "air-force" IssuerAirDashForce Issuer = "air-force" // IssuerMarineDashCorps captures enum value "marine-corps" IssuerMarineDashCorps Issuer = "marine-corps" // IssuerCoastDashGuard captures enum value "coast-guard" IssuerCoastDashGuard Issuer = "coast-guard" )
func (Issuer) ContextValidate ¶
ContextValidate validates this issuer based on context it is used
type Move ¶
type Move struct { // created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // locator // Example: 12432 // Required: true Locator *string `json:"locator"` // orders Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid OrdersID *strfmt.UUID `json:"ordersId"` // service member ServiceMember *ServiceMember `json:"serviceMember,omitempty"` // show Show *bool `json:"show,omitempty"` // status Status MoveStatus `json:"status,omitempty"` // updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` }
Move move
swagger:model Move
func (*Move) ContextValidate ¶
ContextValidate validate this move based on the context it is used
func (*Move) MarshalBinary ¶
MarshalBinary interface implementation
func (*Move) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MoveStatus ¶
type MoveStatus string
MoveStatus Move status
swagger:model MoveStatus
const ( // MoveStatusDRAFT captures enum value "DRAFT" MoveStatusDRAFT MoveStatus = "DRAFT" // MoveStatusSUBMITTED captures enum value "SUBMITTED" MoveStatusSUBMITTED MoveStatus = "SUBMITTED" // MoveStatusAPPROVED captures enum value "APPROVED" MoveStatusAPPROVED MoveStatus = "APPROVED" // MoveStatusCANCELED captures enum value "CANCELED" MoveStatusCANCELED MoveStatus = "CANCELED" )
func NewMoveStatus ¶
func NewMoveStatus(value MoveStatus) *MoveStatus
func (MoveStatus) ContextValidate ¶
ContextValidate validates this move status based on context it is used
func (MoveStatus) Pointer ¶
func (m MoveStatus) Pointer() *MoveStatus
Pointer returns a pointer to a freshly-allocated MoveStatus.
type MoveUpdatePayload ¶
type MoveUpdatePayload struct { // show // Required: true Show *bool `json:"show"` }
MoveUpdatePayload move update payload
swagger:model MoveUpdatePayload
func (*MoveUpdatePayload) ContextValidate ¶
ContextValidate validates this move update payload based on context it is used
func (*MoveUpdatePayload) MarshalBinary ¶
func (m *MoveUpdatePayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveUpdatePayload) UnmarshalBinary ¶
func (m *MoveUpdatePayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Moves ¶
type Moves []*Move
Moves moves
swagger:model Moves
func (Moves) ContextValidate ¶
ContextValidate validate this moves based on the context it is used
type Notification ¶
type Notification struct { // created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // email // Required: true Email *string `json:"email"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // notification type // Required: true // Enum: [MOVE_REVIEWED_EMAIL MOVE_PAYMENT_REMINDER_EMAIL] NotificationType *string `json:"notificationType"` // service member Id // Required: true // Format: uuid ServiceMemberID *strfmt.UUID `json:"serviceMemberId"` // ses message Id // Required: true SesMessageID *string `json:"sesMessageId"` }
Notification notification
swagger:model Notification
func (*Notification) ContextValidate ¶
ContextValidate validates this notification based on context it is used
func (*Notification) MarshalBinary ¶
func (m *Notification) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Notification) UnmarshalBinary ¶
func (m *Notification) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Notifications ¶
type Notifications []*Notification
Notifications notifications
swagger:model Notifications
func (Notifications) ContextValidate ¶
ContextValidate validate this notifications based on the context it is used
type OfficeUser ¶
type OfficeUser struct { // active // Required: true Active *bool `json:"active"` // created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // email // Required: true // Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ Email *string `json:"email"` // first name // Required: true FirstName *string `json:"firstName"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // last name // Required: true LastName *string `json:"lastName"` // middle initials // Required: true MiddleInitials *string `json:"middleInitials"` // roles // Required: true Roles []*Role `json:"roles"` // telephone // Required: true // Pattern: ^[2-9]\d{2}-\d{3}-\d{4}$ Telephone *string `json:"telephone"` // transportation office Id // Required: true // Format: uuid TransportationOfficeID *strfmt.UUID `json:"transportationOfficeId"` // updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` // user Id // Format: uuid UserID strfmt.UUID `json:"userId,omitempty"` }
OfficeUser office user
swagger:model OfficeUser
func (*OfficeUser) ContextValidate ¶
ContextValidate validate this office user based on the context it is used
func (*OfficeUser) MarshalBinary ¶
func (m *OfficeUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OfficeUser) UnmarshalBinary ¶
func (m *OfficeUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OfficeUserCreatePayload ¶
type OfficeUserCreatePayload struct { // Email // Example: user@userdomain.com Email string `json:"email,omitempty"` // First Name FirstName string `json:"firstName,omitempty"` // Last Name LastName string `json:"lastName,omitempty"` // Middle Initials // Example: L. MiddleInitials *string `json:"middleInitials,omitempty"` // roles Roles []*OfficeUserRole `json:"roles"` // telephone // Example: 212-555-5555 // Pattern: ^[2-9]\d{2}-\d{3}-\d{4}$ Telephone string `json:"telephone,omitempty"` // transportation office Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Format: uuid TransportationOfficeID strfmt.UUID `json:"transportationOfficeId,omitempty"` }
OfficeUserCreatePayload office user create payload
swagger:model OfficeUserCreatePayload
func (*OfficeUserCreatePayload) ContextValidate ¶
func (m *OfficeUserCreatePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this office user create payload based on the context it is used
func (*OfficeUserCreatePayload) MarshalBinary ¶
func (m *OfficeUserCreatePayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OfficeUserCreatePayload) UnmarshalBinary ¶
func (m *OfficeUserCreatePayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OfficeUserRole ¶
type OfficeUserRole struct { // name // Example: Transportation Ordering Officer Name *string `json:"name,omitempty"` // roleType // Example: transportation_ordering_officer RoleType *string `json:"roleType,omitempty"` }
OfficeUserRole office user role
swagger:model OfficeUserRole
func (*OfficeUserRole) ContextValidate ¶
ContextValidate validates this office user role based on context it is used
func (*OfficeUserRole) MarshalBinary ¶
func (m *OfficeUserRole) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OfficeUserRole) UnmarshalBinary ¶
func (m *OfficeUserRole) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OfficeUserUpdatePayload ¶
type OfficeUserUpdatePayload struct { // active Active *bool `json:"active,omitempty"` // First Name FirstName *string `json:"firstName,omitempty"` // Last Name LastName *string `json:"lastName,omitempty"` // Middle Initials // Example: Q. MiddleInitials *string `json:"middleInitials,omitempty"` // roles Roles []*OfficeUserRole `json:"roles"` // telephone // Example: 212-555-5555 // Pattern: ^[2-9]\d{2}-\d{3}-\d{4}$ Telephone *string `json:"telephone,omitempty"` // transportation office Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Format: uuid TransportationOfficeID strfmt.UUID `json:"transportationOfficeId,omitempty"` }
OfficeUserUpdatePayload office user update payload
swagger:model OfficeUserUpdatePayload
func (*OfficeUserUpdatePayload) ContextValidate ¶
func (m *OfficeUserUpdatePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this office user update payload based on the context it is used
func (*OfficeUserUpdatePayload) MarshalBinary ¶
func (m *OfficeUserUpdatePayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OfficeUserUpdatePayload) UnmarshalBinary ¶
func (m *OfficeUserUpdatePayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OfficeUsers ¶
type OfficeUsers []*OfficeUser
OfficeUsers office users
swagger:model OfficeUsers
func (OfficeUsers) ContextValidate ¶
ContextValidate validate this office users based on the context it is used
type Organization ¶
type Organization struct { // Created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // email // Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ Email *string `json:"email,omitempty"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // Name // Required: true Name *string `json:"name"` // telephone // Pattern: ^[2-9]\d{2}-\d{3}-\d{4}$ Telephone *string `json:"telephone,omitempty"` // Updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` }
Organization organization
swagger:model Organization
func (*Organization) ContextValidate ¶
ContextValidate validates this organization based on context it is used
func (*Organization) MarshalBinary ¶
func (m *Organization) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Organization) UnmarshalBinary ¶
func (m *Organization) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Organizations ¶
type Organizations []*Organization
Organizations organizations
swagger:model Organizations
func (Organizations) ContextValidate ¶
ContextValidate validate this organizations based on the context it is used
type Role ¶
type Role struct { // created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // role name // Example: Transportation Ordering Officer // Required: true RoleName *string `json:"roleName"` // role type // Example: customer // Required: true RoleType *string `json:"roleType"` // updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` }
Role role
swagger:model Role
func (*Role) ContextValidate ¶
ContextValidate validates this role based on context it is used
func (*Role) MarshalBinary ¶
MarshalBinary interface implementation
func (*Role) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ServiceMember ¶
type ServiceMember struct { // First Name FirstName *string `json:"firstName,omitempty"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Read Only: true // Format: uuid ID strfmt.UUID `json:"id,omitempty"` // Last Name LastName *string `json:"lastName,omitempty"` // Middle Name MiddleName *string `json:"middleName,omitempty"` // user Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Read Only: true // Format: uuid UserID strfmt.UUID `json:"userId,omitempty"` }
ServiceMember service member
swagger:model ServiceMember
func (*ServiceMember) ContextValidate ¶
ContextValidate validate this service member based on the context it is used
func (*ServiceMember) MarshalBinary ¶
func (m *ServiceMember) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceMember) UnmarshalBinary ¶
func (m *ServiceMember) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransportationOffice ¶
type TransportationOffice struct { // address // Required: true Address *Address `json:"address"` // created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // gbloc // Example: JENQ // Pattern: ^[A-Z]{4}$ Gbloc string `json:"gbloc,omitempty"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // latitude // Example: 29.382973 Latitude float32 `json:"latitude,omitempty"` // longitude // Example: -98.62759 Longitude float32 `json:"longitude,omitempty"` // name // Example: Fort Bragg North Station // Required: true Name *string `json:"name"` // phone lines PhoneLines []string `json:"phoneLines"` // updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` }
TransportationOffice transportation office
swagger:model TransportationOffice
func (*TransportationOffice) ContextValidate ¶
ContextValidate validate this transportation office based on the context it is used
func (*TransportationOffice) MarshalBinary ¶
func (m *TransportationOffice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TransportationOffice) UnmarshalBinary ¶
func (m *TransportationOffice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransportationOffices ¶
type TransportationOffices []*TransportationOffice
TransportationOffices transportation offices
swagger:model TransportationOffices
func (TransportationOffices) ContextValidate ¶
ContextValidate validate this transportation offices based on the context it is used
type TransportationServiceProviderPerformance ¶
type TransportationServiceProviderPerformance struct { // best value score // Example: 98.01 // Required: true BestValueScore *float64 `json:"bestValueScore"` // created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // linehaul rate // Example: 0.26085695149376986 // Required: true LinehaulRate *float64 `json:"linehaulRate"` // offer count // Example: 1 // Required: true OfferCount *int64 `json:"offerCount"` // performance period end // Required: true // Format: date-time PerformancePeriodEnd *strfmt.DateTime `json:"performancePeriodEnd"` // performance period start // Required: true // Format: date-time PerformancePeriodStart *strfmt.DateTime `json:"performancePeriodStart"` // quality band // Example: 29 QualityBand *int64 `json:"qualityBand,omitempty"` // rate cycle end // Required: true // Format: date-time RateCycleEnd *strfmt.DateTime `json:"rateCycleEnd"` // rate cycle start // Required: true // Format: date-time RateCycleStart *strfmt.DateTime `json:"rateCycleStart"` // sit rate // Example: 0.26085695149376986 // Required: true SitRate *float64 `json:"sitRate"` // traffic distribution list Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid TrafficDistributionListID *strfmt.UUID `json:"trafficDistributionListId"` // transportation service provider Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Required: true // Format: uuid TransportationServiceProviderID *strfmt.UUID `json:"transportationServiceProviderId"` // updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` }
TransportationServiceProviderPerformance transportation service provider performance
swagger:model TransportationServiceProviderPerformance
func (*TransportationServiceProviderPerformance) ContextValidate ¶
func (m *TransportationServiceProviderPerformance) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this transportation service provider performance based on context it is used
func (*TransportationServiceProviderPerformance) MarshalBinary ¶
func (m *TransportationServiceProviderPerformance) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TransportationServiceProviderPerformance) UnmarshalBinary ¶
func (m *TransportationServiceProviderPerformance) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransportationServiceProviderPerformances ¶
type TransportationServiceProviderPerformances []*TransportationServiceProviderPerformance
TransportationServiceProviderPerformances transportation service provider performances
swagger:model TransportationServiceProviderPerformances
func (TransportationServiceProviderPerformances) ContextValidate ¶
func (m TransportationServiceProviderPerformances) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this transportation service provider performances based on the context it is used
type Upload ¶
type Upload struct { // content type // Enum: [application/pdf image/jpeg image/png] ContentType string `json:"contentType,omitempty"` // Created at // Format: date-time CreatedAt strfmt.DateTime `json:"createdAt,omitempty"` // filename Filename string `json:"filename,omitempty"` // Size in Bytes Size int64 `json:"size,omitempty"` }
Upload upload
swagger:model Upload
func (*Upload) ContextValidate ¶
ContextValidate validates this upload based on context it is used
func (*Upload) MarshalBinary ¶
MarshalBinary interface implementation
func (*Upload) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UploadInformation ¶
type UploadInformation struct { // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Format: uuid ID strfmt.UUID `json:"id,omitempty"` // move locator // Example: 12432 MoveLocator *string `json:"moveLocator,omitempty"` // office user email OfficeUserEmail *string `json:"officeUserEmail,omitempty"` // office user first name OfficeUserFirstName *string `json:"officeUserFirstName,omitempty"` // office user Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Format: uuid OfficeUserID *strfmt.UUID `json:"officeUserId,omitempty"` // office user last name OfficeUserLastName *string `json:"officeUserLastName,omitempty"` // office user phone OfficeUserPhone *string `json:"officeUserPhone,omitempty"` // service member email ServiceMemberEmail *string `json:"serviceMemberEmail,omitempty"` // service member first name ServiceMemberFirstName *string `json:"serviceMemberFirstName,omitempty"` // service member Id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Format: uuid ServiceMemberID *strfmt.UUID `json:"serviceMemberId,omitempty"` // service member last name ServiceMemberLastName *string `json:"serviceMemberLastName,omitempty"` // service member phone ServiceMemberPhone *string `json:"serviceMemberPhone,omitempty"` // upload Upload *Upload `json:"upload,omitempty"` }
UploadInformation upload information
swagger:model UploadInformation
func (*UploadInformation) ContextValidate ¶
ContextValidate validate this upload information based on the context it is used
func (*UploadInformation) MarshalBinary ¶
func (m *UploadInformation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UploadInformation) UnmarshalBinary ¶
func (m *UploadInformation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type User ¶
type User struct { // active // Required: true Active *bool `json:"active"` // created at // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"createdAt"` // current admin session Id // Example: WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w // Required: true CurrentAdminSessionID *string `json:"currentAdminSessionId"` // current mil session Id // Example: WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w // Required: true CurrentMilSessionID *string `json:"currentMilSessionId"` // current office session Id // Example: WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w // Required: true CurrentOfficeSessionID *string `json:"currentOfficeSessionId"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Format: uuid ID strfmt.UUID `json:"id,omitempty"` // login gov email // Required: true // Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ LoginGovEmail *string `json:"loginGovEmail"` // updated at // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updatedAt"` }
User user
swagger:model User
func (*User) ContextValidate ¶
ContextValidate validates this user based on context it is used
func (*User) MarshalBinary ¶
MarshalBinary interface implementation
func (*User) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UserUpdatePayload ¶
type UserUpdatePayload struct { // active Active *bool `json:"active,omitempty"` // revoke admin session RevokeAdminSession *bool `json:"revokeAdminSession,omitempty"` // revoke mil session RevokeMilSession *bool `json:"revokeMilSession,omitempty"` // revoke office session RevokeOfficeSession *bool `json:"revokeOfficeSession,omitempty"` }
UserUpdatePayload user update payload
swagger:model UserUpdatePayload
func (*UserUpdatePayload) ContextValidate ¶
ContextValidate validates this user update payload based on context it is used
func (*UserUpdatePayload) MarshalBinary ¶
func (m *UserUpdatePayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserUpdatePayload) UnmarshalBinary ¶
func (m *UserUpdatePayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Users ¶
type Users []*User
Users users
swagger:model Users
func (Users) ContextValidate ¶
ContextValidate validate this users based on the context it is used
type ValidationError ¶
type ValidationError struct { ClientError ValidationErrorAllOf1 // invalid fields // Required: true InvalidFields map[string]string `json:"invalidFields"` }
ValidationError validation error
swagger:model ValidationError
func (*ValidationError) ContextValidate ¶
ContextValidate validate this validation error based on the context it is used
func (*ValidationError) MarshalBinary ¶
func (m *ValidationError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ValidationError) MarshalJSON ¶
func (m ValidationError) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ValidationError) UnmarshalBinary ¶
func (m *ValidationError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ValidationError) UnmarshalJSON ¶
func (m *ValidationError) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type ValidationErrorAllOf1 ¶
type ValidationErrorAllOf1 interface{}
ValidationErrorAllOf1 validation error all of1
swagger:model ValidationErrorAllOf1
type WebhookSubscription ¶
type WebhookSubscription struct { // The URL to which the notifications for this subscription will be pushed to. CallbackURL *string `json:"callbackUrl,omitempty"` // created at // Format: date-time CreatedAt strfmt.DateTime `json:"createdAt,omitempty"` // e tag // Read Only: true ETag string `json:"eTag,omitempty"` // A string used to represent which events this subscriber expects to be notified about. Corresponds to the possible event_key values in webhook_notifications. EventKey *string `json:"eventKey,omitempty"` // id // Example: c56a4180-65aa-42ec-a945-5fd21dec0538 // Read Only: true // Format: uuid ID strfmt.UUID `json:"id,omitempty"` // severity // Minimum: 0 Severity *int64 `json:"severity,omitempty"` // status Status *WebhookSubscriptionStatus `json:"status,omitempty"` // Unique identifier for the subscriber // Example: d494f114-05a2-4b39-840c-3d33243b7e29 // Format: uuid SubscriberID *strfmt.UUID `json:"subscriberId,omitempty"` // updated at // Format: date-time UpdatedAt strfmt.DateTime `json:"updatedAt,omitempty"` }
WebhookSubscription Represents subscribers who expect certain notifications to be pushed to their servers. Used for the Prime and Prime-related events specifically.
swagger:model WebhookSubscription
func (*WebhookSubscription) ContextValidate ¶
ContextValidate validate this webhook subscription based on the context it is used
func (*WebhookSubscription) MarshalBinary ¶
func (m *WebhookSubscription) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WebhookSubscription) UnmarshalBinary ¶
func (m *WebhookSubscription) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WebhookSubscriptionStatus ¶
type WebhookSubscriptionStatus string
WebhookSubscriptionStatus Webhook subscription status
swagger:model WebhookSubscriptionStatus
const ( // WebhookSubscriptionStatusACTIVE captures enum value "ACTIVE" WebhookSubscriptionStatusACTIVE WebhookSubscriptionStatus = "ACTIVE" // WebhookSubscriptionStatusFAILING captures enum value "FAILING" WebhookSubscriptionStatusFAILING WebhookSubscriptionStatus = "FAILING" // WebhookSubscriptionStatusDISABLED captures enum value "DISABLED" WebhookSubscriptionStatusDISABLED WebhookSubscriptionStatus = "DISABLED" )
func NewWebhookSubscriptionStatus ¶
func NewWebhookSubscriptionStatus(value WebhookSubscriptionStatus) *WebhookSubscriptionStatus
func (WebhookSubscriptionStatus) ContextValidate ¶
func (m WebhookSubscriptionStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this webhook subscription status based on context it is used
func (WebhookSubscriptionStatus) Pointer ¶
func (m WebhookSubscriptionStatus) Pointer() *WebhookSubscriptionStatus
Pointer returns a pointer to a freshly-allocated WebhookSubscriptionStatus.
type WebhookSubscriptions ¶
type WebhookSubscriptions []*WebhookSubscription
WebhookSubscriptions webhook subscriptions
swagger:model WebhookSubscriptions
func (WebhookSubscriptions) ContextValidate ¶
ContextValidate validate this webhook subscriptions based on the context it is used
Source Files ¶
- address.go
- admin_user.go
- admin_user_create_payload.go
- admin_user_update_payload.go
- admin_users.go
- client_error.go
- create_webhook_subscription.go
- electronic_order.go
- electronic_orders.go
- electronic_orders_total.go
- electronic_orders_totals.go
- issuer.go
- move.go
- move_status.go
- move_update_payload.go
- moves.go
- notification.go
- notifications.go
- office_user.go
- office_user_create_payload.go
- office_user_role.go
- office_user_update_payload.go
- office_users.go
- organization.go
- organizations.go
- role.go
- service_member.go
- transportation_office.go
- transportation_offices.go
- transportation_service_provider_performance.go
- transportation_service_provider_performances.go
- upload.go
- upload_information.go
- user.go
- user_update_payload.go
- users.go
- validation_error.go
- webhook_subscription.go
- webhook_subscription_status.go
- webhook_subscriptions.go