Documentation ¶
Index ¶
- Constants
- type CreateRequestedOfficeUser
- type CreateRequestedOfficeUserCreated
- func (o *CreateRequestedOfficeUserCreated) SetPayload(payload *ghcmessages.OfficeUser)
- func (o *CreateRequestedOfficeUserCreated) WithPayload(payload *ghcmessages.OfficeUser) *CreateRequestedOfficeUserCreated
- func (o *CreateRequestedOfficeUserCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateRequestedOfficeUserHandler
- type CreateRequestedOfficeUserHandlerFunc
- type CreateRequestedOfficeUserInternalServerError
- type CreateRequestedOfficeUserParams
- type CreateRequestedOfficeUserURL
- func (o *CreateRequestedOfficeUserURL) Build() (*url.URL, error)
- func (o *CreateRequestedOfficeUserURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *CreateRequestedOfficeUserURL) Must(u *url.URL, err error) *url.URL
- func (o *CreateRequestedOfficeUserURL) SetBasePath(bp string)
- func (o *CreateRequestedOfficeUserURL) String() string
- func (o *CreateRequestedOfficeUserURL) StringFull(scheme, host string) string
- func (o *CreateRequestedOfficeUserURL) WithBasePath(bp string) *CreateRequestedOfficeUserURL
- type CreateRequestedOfficeUserUnprocessableEntity
- func (o *CreateRequestedOfficeUserUnprocessableEntity) SetPayload(payload *ghcmessages.ValidationError)
- func (o *CreateRequestedOfficeUserUnprocessableEntity) WithPayload(payload *ghcmessages.ValidationError) *CreateRequestedOfficeUserUnprocessableEntity
- func (o *CreateRequestedOfficeUserUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
Constants ¶
const CreateRequestedOfficeUserCreatedCode int = 201
CreateRequestedOfficeUserCreatedCode is the HTTP code returned for type CreateRequestedOfficeUserCreated
const CreateRequestedOfficeUserInternalServerErrorCode int = 500
CreateRequestedOfficeUserInternalServerErrorCode is the HTTP code returned for type CreateRequestedOfficeUserInternalServerError
const CreateRequestedOfficeUserUnprocessableEntityCode int = 422
CreateRequestedOfficeUserUnprocessableEntityCode is the HTTP code returned for type CreateRequestedOfficeUserUnprocessableEntity
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateRequestedOfficeUser ¶
type CreateRequestedOfficeUser struct { Context *middleware.Context Handler CreateRequestedOfficeUserHandler }
CreateRequestedOfficeUser swagger:route POST /open/requested-office-users officeUsers createRequestedOfficeUser
Create an Office User ¶
This endpoint is publicly accessible as it is utilized for individuals who do not have an office account to request the creation of an office account. Request the creation of an office user. An administrator will need to approve them after creation. Note on requirements: An identification method must be present. The following 2 fields have an "OR" requirement. - edipi - other_unique_id One of these two fields MUST be present to serve as identification for the office user being created. This logic is handled at the application level.
func NewCreateRequestedOfficeUser ¶
func NewCreateRequestedOfficeUser(ctx *middleware.Context, handler CreateRequestedOfficeUserHandler) *CreateRequestedOfficeUser
NewCreateRequestedOfficeUser creates a new http.Handler for the create requested office user operation
func (*CreateRequestedOfficeUser) ServeHTTP ¶
func (o *CreateRequestedOfficeUser) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type CreateRequestedOfficeUserCreated ¶
type CreateRequestedOfficeUserCreated struct { /* In: Body */ Payload *ghcmessages.OfficeUser `json:"body,omitempty"` }
CreateRequestedOfficeUserCreated successfully requested the creation of provided office user
swagger:response createRequestedOfficeUserCreated
func NewCreateRequestedOfficeUserCreated ¶
func NewCreateRequestedOfficeUserCreated() *CreateRequestedOfficeUserCreated
NewCreateRequestedOfficeUserCreated creates CreateRequestedOfficeUserCreated with default headers values
func (*CreateRequestedOfficeUserCreated) SetPayload ¶
func (o *CreateRequestedOfficeUserCreated) SetPayload(payload *ghcmessages.OfficeUser)
SetPayload sets the payload to the create requested office user created response
func (*CreateRequestedOfficeUserCreated) WithPayload ¶
func (o *CreateRequestedOfficeUserCreated) WithPayload(payload *ghcmessages.OfficeUser) *CreateRequestedOfficeUserCreated
WithPayload adds the payload to the create requested office user created response
func (*CreateRequestedOfficeUserCreated) WriteResponse ¶
func (o *CreateRequestedOfficeUserCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateRequestedOfficeUserHandler ¶
type CreateRequestedOfficeUserHandler interface {
Handle(CreateRequestedOfficeUserParams) middleware.Responder
}
CreateRequestedOfficeUserHandler interface for that can handle valid create requested office user params
type CreateRequestedOfficeUserHandlerFunc ¶
type CreateRequestedOfficeUserHandlerFunc func(CreateRequestedOfficeUserParams) middleware.Responder
CreateRequestedOfficeUserHandlerFunc turns a function with the right signature into a create requested office user handler
func (CreateRequestedOfficeUserHandlerFunc) Handle ¶
func (fn CreateRequestedOfficeUserHandlerFunc) Handle(params CreateRequestedOfficeUserParams) middleware.Responder
Handle executing the request and returning a response
type CreateRequestedOfficeUserInternalServerError ¶
type CreateRequestedOfficeUserInternalServerError struct { }
CreateRequestedOfficeUserInternalServerError internal server error
swagger:response createRequestedOfficeUserInternalServerError
func NewCreateRequestedOfficeUserInternalServerError ¶
func NewCreateRequestedOfficeUserInternalServerError() *CreateRequestedOfficeUserInternalServerError
NewCreateRequestedOfficeUserInternalServerError creates CreateRequestedOfficeUserInternalServerError with default headers values
func (*CreateRequestedOfficeUserInternalServerError) WriteResponse ¶
func (o *CreateRequestedOfficeUserInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateRequestedOfficeUserParams ¶
type CreateRequestedOfficeUserParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*Office User information In: body */ OfficeUser *ghcmessages.OfficeUserCreate }
CreateRequestedOfficeUserParams contains all the bound params for the create requested office user operation typically these are obtained from a http.Request
swagger:parameters createRequestedOfficeUser
func NewCreateRequestedOfficeUserParams ¶
func NewCreateRequestedOfficeUserParams() CreateRequestedOfficeUserParams
NewCreateRequestedOfficeUserParams creates a new CreateRequestedOfficeUserParams object
There are no default values defined in the spec.
func (*CreateRequestedOfficeUserParams) BindRequest ¶
func (o *CreateRequestedOfficeUserParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewCreateRequestedOfficeUserParams() beforehand.
type CreateRequestedOfficeUserURL ¶
type CreateRequestedOfficeUserURL struct {
// contains filtered or unexported fields
}
CreateRequestedOfficeUserURL generates an URL for the create requested office user operation
func (*CreateRequestedOfficeUserURL) Build ¶
func (o *CreateRequestedOfficeUserURL) Build() (*url.URL, error)
Build a url path and query string
func (*CreateRequestedOfficeUserURL) BuildFull ¶
func (o *CreateRequestedOfficeUserURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*CreateRequestedOfficeUserURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*CreateRequestedOfficeUserURL) SetBasePath ¶
func (o *CreateRequestedOfficeUserURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*CreateRequestedOfficeUserURL) String ¶
func (o *CreateRequestedOfficeUserURL) String() string
String returns the string representation of the path with query string
func (*CreateRequestedOfficeUserURL) StringFull ¶
func (o *CreateRequestedOfficeUserURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*CreateRequestedOfficeUserURL) WithBasePath ¶
func (o *CreateRequestedOfficeUserURL) WithBasePath(bp string) *CreateRequestedOfficeUserURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type CreateRequestedOfficeUserUnprocessableEntity ¶
type CreateRequestedOfficeUserUnprocessableEntity struct { /* In: Body */ Payload *ghcmessages.ValidationError `json:"body,omitempty"` }
CreateRequestedOfficeUserUnprocessableEntity validation error
swagger:response createRequestedOfficeUserUnprocessableEntity
func NewCreateRequestedOfficeUserUnprocessableEntity ¶
func NewCreateRequestedOfficeUserUnprocessableEntity() *CreateRequestedOfficeUserUnprocessableEntity
NewCreateRequestedOfficeUserUnprocessableEntity creates CreateRequestedOfficeUserUnprocessableEntity with default headers values
func (*CreateRequestedOfficeUserUnprocessableEntity) SetPayload ¶
func (o *CreateRequestedOfficeUserUnprocessableEntity) SetPayload(payload *ghcmessages.ValidationError)
SetPayload sets the payload to the create requested office user unprocessable entity response
func (*CreateRequestedOfficeUserUnprocessableEntity) WithPayload ¶
func (o *CreateRequestedOfficeUserUnprocessableEntity) WithPayload(payload *ghcmessages.ValidationError) *CreateRequestedOfficeUserUnprocessableEntity
WithPayload adds the payload to the create requested office user unprocessable entity response
func (*CreateRequestedOfficeUserUnprocessableEntity) WriteResponse ¶
func (o *CreateRequestedOfficeUserUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client