Documentation
¶
Index ¶
- type Client
- func (a *Client) GetAllProfiles(params *GetAllProfilesParams) (*GetAllProfilesOK, error)
- func (a *Client) GetProfile(params *GetProfileParams) (*GetProfileOK, error)
- func (a *Client) GetProfileByAccountID(params *GetProfileByAccountIDParams) (*GetProfileByAccountIDOK, error)
- func (a *Client) GetProfileByEmailAddress(params *GetProfileByEmailAddressParams) (*GetProfileByEmailAddressOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- func (a *Client) UpdateProfile(params *UpdateProfileParams) (*UpdateProfileOK, error)
- type GetAllProfilesDefault
- type GetAllProfilesOK
- type GetAllProfilesParams
- func NewGetAllProfilesParams() *GetAllProfilesParams
- func NewGetAllProfilesParamsWithContext(ctx context.Context) *GetAllProfilesParams
- func NewGetAllProfilesParamsWithHTTPClient(client *http.Client) *GetAllProfilesParams
- func NewGetAllProfilesParamsWithTimeout(timeout time.Duration) *GetAllProfilesParams
- func (o *GetAllProfilesParams) SetContext(ctx context.Context)
- func (o *GetAllProfilesParams) SetHTTPClient(client *http.Client)
- func (o *GetAllProfilesParams) SetOffset(offset *int32)
- func (o *GetAllProfilesParams) SetOrder(order *string)
- func (o *GetAllProfilesParams) SetOrderBy(orderBy *string)
- func (o *GetAllProfilesParams) SetOrganizations(organizations []string)
- func (o *GetAllProfilesParams) SetRecords(records *int32)
- func (o *GetAllProfilesParams) SetTimeout(timeout time.Duration)
- func (o *GetAllProfilesParams) WithContext(ctx context.Context) *GetAllProfilesParams
- func (o *GetAllProfilesParams) WithHTTPClient(client *http.Client) *GetAllProfilesParams
- func (o *GetAllProfilesParams) WithOffset(offset *int32) *GetAllProfilesParams
- func (o *GetAllProfilesParams) WithOrder(order *string) *GetAllProfilesParams
- func (o *GetAllProfilesParams) WithOrderBy(orderBy *string) *GetAllProfilesParams
- func (o *GetAllProfilesParams) WithOrganizations(organizations []string) *GetAllProfilesParams
- func (o *GetAllProfilesParams) WithRecords(records *int32) *GetAllProfilesParams
- func (o *GetAllProfilesParams) WithTimeout(timeout time.Duration) *GetAllProfilesParams
- func (o *GetAllProfilesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetAllProfilesReader
- type GetProfileByAccountIDDefault
- type GetProfileByAccountIDOK
- type GetProfileByAccountIDParams
- func NewGetProfileByAccountIDParams() *GetProfileByAccountIDParams
- func NewGetProfileByAccountIDParamsWithContext(ctx context.Context) *GetProfileByAccountIDParams
- func NewGetProfileByAccountIDParamsWithHTTPClient(client *http.Client) *GetProfileByAccountIDParams
- func NewGetProfileByAccountIDParamsWithTimeout(timeout time.Duration) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) SetAccountID(accountID string)
- func (o *GetProfileByAccountIDParams) SetContext(ctx context.Context)
- func (o *GetProfileByAccountIDParams) SetHTTPClient(client *http.Client)
- func (o *GetProfileByAccountIDParams) SetOffset(offset *int32)
- func (o *GetProfileByAccountIDParams) SetOrder(order *string)
- func (o *GetProfileByAccountIDParams) SetOrderBy(orderBy *string)
- func (o *GetProfileByAccountIDParams) SetOrganizations(organizations []string)
- func (o *GetProfileByAccountIDParams) SetRecords(records *int32)
- func (o *GetProfileByAccountIDParams) SetTimeout(timeout time.Duration)
- func (o *GetProfileByAccountIDParams) WithAccountID(accountID string) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WithContext(ctx context.Context) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WithHTTPClient(client *http.Client) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WithOffset(offset *int32) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WithOrder(order *string) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WithOrderBy(orderBy *string) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WithOrganizations(organizations []string) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WithRecords(records *int32) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WithTimeout(timeout time.Duration) *GetProfileByAccountIDParams
- func (o *GetProfileByAccountIDParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetProfileByAccountIDReader
- type GetProfileByEmailAddressDefault
- type GetProfileByEmailAddressOK
- type GetProfileByEmailAddressParams
- func NewGetProfileByEmailAddressParams() *GetProfileByEmailAddressParams
- func NewGetProfileByEmailAddressParamsWithContext(ctx context.Context) *GetProfileByEmailAddressParams
- func NewGetProfileByEmailAddressParamsWithHTTPClient(client *http.Client) *GetProfileByEmailAddressParams
- func NewGetProfileByEmailAddressParamsWithTimeout(timeout time.Duration) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) SetContext(ctx context.Context)
- func (o *GetProfileByEmailAddressParams) SetEmail(email string)
- func (o *GetProfileByEmailAddressParams) SetHTTPClient(client *http.Client)
- func (o *GetProfileByEmailAddressParams) SetIncludeRetired(includeRetired *bool)
- func (o *GetProfileByEmailAddressParams) SetOffset(offset *int32)
- func (o *GetProfileByEmailAddressParams) SetOrder(order *string)
- func (o *GetProfileByEmailAddressParams) SetOrderBy(orderBy *string)
- func (o *GetProfileByEmailAddressParams) SetOrganizations(organizations []string)
- func (o *GetProfileByEmailAddressParams) SetRecords(records *int32)
- func (o *GetProfileByEmailAddressParams) SetTimeout(timeout time.Duration)
- func (o *GetProfileByEmailAddressParams) WithContext(ctx context.Context) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithEmail(email string) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithHTTPClient(client *http.Client) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithIncludeRetired(includeRetired *bool) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithOffset(offset *int32) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithOrder(order *string) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithOrderBy(orderBy *string) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithOrganizations(organizations []string) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithRecords(records *int32) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WithTimeout(timeout time.Duration) *GetProfileByEmailAddressParams
- func (o *GetProfileByEmailAddressParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetProfileByEmailAddressReader
- type GetProfileDefault
- type GetProfileOK
- type GetProfileParams
- func (o *GetProfileParams) SetContext(ctx context.Context)
- func (o *GetProfileParams) SetHTTPClient(client *http.Client)
- func (o *GetProfileParams) SetOrganizations(organizations []string)
- func (o *GetProfileParams) SetProfileID(profileID string)
- func (o *GetProfileParams) SetTimeout(timeout time.Duration)
- func (o *GetProfileParams) WithContext(ctx context.Context) *GetProfileParams
- func (o *GetProfileParams) WithHTTPClient(client *http.Client) *GetProfileParams
- func (o *GetProfileParams) WithOrganizations(organizations []string) *GetProfileParams
- func (o *GetProfileParams) WithProfileID(profileID string) *GetProfileParams
- func (o *GetProfileParams) WithTimeout(timeout time.Duration) *GetProfileParams
- func (o *GetProfileParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetProfileReader
- type UpdateProfileDefault
- type UpdateProfileOK
- type UpdateProfileParams
- func (o *UpdateProfileParams) SetContext(ctx context.Context)
- func (o *UpdateProfileParams) SetHTTPClient(client *http.Client)
- func (o *UpdateProfileParams) SetRequest(request *models.UpdateProfileRequest)
- func (o *UpdateProfileParams) SetTimeout(timeout time.Duration)
- func (o *UpdateProfileParams) WithContext(ctx context.Context) *UpdateProfileParams
- func (o *UpdateProfileParams) WithHTTPClient(client *http.Client) *UpdateProfileParams
- func (o *UpdateProfileParams) WithRequest(request *models.UpdateProfileRequest) *UpdateProfileParams
- func (o *UpdateProfileParams) WithTimeout(timeout time.Duration) *UpdateProfileParams
- func (o *UpdateProfileParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type UpdateProfileReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for profiles API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new profiles API client.
func (*Client) GetAllProfiles ¶
func (a *Client) GetAllProfiles(params *GetAllProfilesParams) (*GetAllProfilesOK, error)
GetAllProfiles returns a collection of all profiles by default 10 values are returned records are returned in natural order
{"nickname":"Get all profiles","response":"getProfileAll.html"}
func (*Client) GetProfile ¶
func (a *Client) GetProfile(params *GetProfileParams) (*GetProfileOK, error)
GetProfile returns a single profile specified by the ID parameter
{"nickname":"Retrieve an existing profile","response":"getProfileByID.html"}
func (*Client) GetProfileByAccountID ¶
func (a *Client) GetProfileByAccountID(params *GetProfileByAccountIDParams) (*GetProfileByAccountIDOK, error)
GetProfileByAccountID returns a collection of profiles specified by the account ID parameter by default 10 values are returned records are returned in natural order
{"nickname":"Retrieve by account","response":"getProfileByAccountID.html"}
func (*Client) GetProfileByEmailAddress ¶
func (a *Client) GetProfileByEmailAddress(params *GetProfileByEmailAddressParams) (*GetProfileByEmailAddressOK, error)
GetProfileByEmailAddress returns a single profile specified by the email parameter
{"nickname":"Retrieve by e-mail","response":"getProfileByEmail.html"}
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) UpdateProfile ¶
func (a *Client) UpdateProfile(params *UpdateProfileParams) (*UpdateProfileOK, error)
UpdateProfile updates a profile
{"nickname":"Update a profile","request":"updateProfileRequest.html","response":"updateProfileResponse.html"}
type GetAllProfilesDefault ¶
type GetAllProfilesDefault struct { Payload *models.BFError // contains filtered or unexported fields }
GetAllProfilesDefault handles this case with default header values.
error
func NewGetAllProfilesDefault ¶
func NewGetAllProfilesDefault(code int) *GetAllProfilesDefault
NewGetAllProfilesDefault creates a GetAllProfilesDefault with default headers values
func (*GetAllProfilesDefault) Code ¶
func (o *GetAllProfilesDefault) Code() int
Code gets the status code for the get all profiles default response
func (*GetAllProfilesDefault) Error ¶
func (o *GetAllProfilesDefault) Error() string
type GetAllProfilesOK ¶
type GetAllProfilesOK struct {
Payload *models.ProfilePagedMetadata
}
GetAllProfilesOK handles this case with default header values.
success
func NewGetAllProfilesOK ¶
func NewGetAllProfilesOK() *GetAllProfilesOK
NewGetAllProfilesOK creates a GetAllProfilesOK with default headers values
func (*GetAllProfilesOK) Error ¶
func (o *GetAllProfilesOK) Error() string
type GetAllProfilesParams ¶
type GetAllProfilesParams struct { /*Offset The offset from the first profile to return. */ Offset *int32 /*Order Ihe direction of any ordering, either ASC or DESC. */ Order *string /*OrderBy Specify a field used to order the result set. */ OrderBy *string /*Organizations A list of organizations used to restrict the scope of API calls. */ Organizations []string /*Records The maximum number of profiles to return. */ Records *int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetAllProfilesParams contains all the parameters to send to the API endpoint for the get all profiles operation typically these are written to a http.Request
func NewGetAllProfilesParams ¶
func NewGetAllProfilesParams() *GetAllProfilesParams
NewGetAllProfilesParams creates a new GetAllProfilesParams object with the default values initialized.
func NewGetAllProfilesParamsWithContext ¶
func NewGetAllProfilesParamsWithContext(ctx context.Context) *GetAllProfilesParams
NewGetAllProfilesParamsWithContext creates a new GetAllProfilesParams object with the default values initialized, and the ability to set a context for a request
func NewGetAllProfilesParamsWithHTTPClient ¶
func NewGetAllProfilesParamsWithHTTPClient(client *http.Client) *GetAllProfilesParams
NewGetAllProfilesParamsWithHTTPClient creates a new GetAllProfilesParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetAllProfilesParamsWithTimeout ¶
func NewGetAllProfilesParamsWithTimeout(timeout time.Duration) *GetAllProfilesParams
NewGetAllProfilesParamsWithTimeout creates a new GetAllProfilesParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetAllProfilesParams) SetContext ¶
func (o *GetAllProfilesParams) SetContext(ctx context.Context)
SetContext adds the context to the get all profiles params
func (*GetAllProfilesParams) SetHTTPClient ¶
func (o *GetAllProfilesParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get all profiles params
func (*GetAllProfilesParams) SetOffset ¶
func (o *GetAllProfilesParams) SetOffset(offset *int32)
SetOffset adds the offset to the get all profiles params
func (*GetAllProfilesParams) SetOrder ¶
func (o *GetAllProfilesParams) SetOrder(order *string)
SetOrder adds the order to the get all profiles params
func (*GetAllProfilesParams) SetOrderBy ¶
func (o *GetAllProfilesParams) SetOrderBy(orderBy *string)
SetOrderBy adds the orderBy to the get all profiles params
func (*GetAllProfilesParams) SetOrganizations ¶
func (o *GetAllProfilesParams) SetOrganizations(organizations []string)
SetOrganizations adds the organizations to the get all profiles params
func (*GetAllProfilesParams) SetRecords ¶
func (o *GetAllProfilesParams) SetRecords(records *int32)
SetRecords adds the records to the get all profiles params
func (*GetAllProfilesParams) SetTimeout ¶
func (o *GetAllProfilesParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get all profiles params
func (*GetAllProfilesParams) WithContext ¶
func (o *GetAllProfilesParams) WithContext(ctx context.Context) *GetAllProfilesParams
WithContext adds the context to the get all profiles params
func (*GetAllProfilesParams) WithHTTPClient ¶
func (o *GetAllProfilesParams) WithHTTPClient(client *http.Client) *GetAllProfilesParams
WithHTTPClient adds the HTTPClient to the get all profiles params
func (*GetAllProfilesParams) WithOffset ¶
func (o *GetAllProfilesParams) WithOffset(offset *int32) *GetAllProfilesParams
WithOffset adds the offset to the get all profiles params
func (*GetAllProfilesParams) WithOrder ¶
func (o *GetAllProfilesParams) WithOrder(order *string) *GetAllProfilesParams
WithOrder adds the order to the get all profiles params
func (*GetAllProfilesParams) WithOrderBy ¶
func (o *GetAllProfilesParams) WithOrderBy(orderBy *string) *GetAllProfilesParams
WithOrderBy adds the orderBy to the get all profiles params
func (*GetAllProfilesParams) WithOrganizations ¶
func (o *GetAllProfilesParams) WithOrganizations(organizations []string) *GetAllProfilesParams
WithOrganizations adds the organizations to the get all profiles params
func (*GetAllProfilesParams) WithRecords ¶
func (o *GetAllProfilesParams) WithRecords(records *int32) *GetAllProfilesParams
WithRecords adds the records to the get all profiles params
func (*GetAllProfilesParams) WithTimeout ¶
func (o *GetAllProfilesParams) WithTimeout(timeout time.Duration) *GetAllProfilesParams
WithTimeout adds the timeout to the get all profiles params
func (*GetAllProfilesParams) WriteToRequest ¶
func (o *GetAllProfilesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetAllProfilesReader ¶
type GetAllProfilesReader struct {
// contains filtered or unexported fields
}
GetAllProfilesReader is a Reader for the GetAllProfiles structure.
func (*GetAllProfilesReader) ReadResponse ¶
func (o *GetAllProfilesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetProfileByAccountIDDefault ¶
type GetProfileByAccountIDDefault struct { Payload *models.BFError // contains filtered or unexported fields }
GetProfileByAccountIDDefault handles this case with default header values.
error
func NewGetProfileByAccountIDDefault ¶
func NewGetProfileByAccountIDDefault(code int) *GetProfileByAccountIDDefault
NewGetProfileByAccountIDDefault creates a GetProfileByAccountIDDefault with default headers values
func (*GetProfileByAccountIDDefault) Code ¶
func (o *GetProfileByAccountIDDefault) Code() int
Code gets the status code for the get profile by account ID default response
func (*GetProfileByAccountIDDefault) Error ¶
func (o *GetProfileByAccountIDDefault) Error() string
type GetProfileByAccountIDOK ¶
type GetProfileByAccountIDOK struct {
Payload *models.ProfilePagedMetadata
}
GetProfileByAccountIDOK handles this case with default header values.
success
func NewGetProfileByAccountIDOK ¶
func NewGetProfileByAccountIDOK() *GetProfileByAccountIDOK
NewGetProfileByAccountIDOK creates a GetProfileByAccountIDOK with default headers values
func (*GetProfileByAccountIDOK) Error ¶
func (o *GetProfileByAccountIDOK) Error() string
type GetProfileByAccountIDParams ¶
type GetProfileByAccountIDParams struct { /*AccountID The account-ID of the profile. */ AccountID string /*Offset The offset from the first profile to return. */ Offset *int32 /*Order Ihe direction of any ordering, either ASC or DESC. */ Order *string /*OrderBy Specify a field used to order the result set. */ OrderBy *string /*Organizations A list of organizations used to restrict the scope of API calls. */ Organizations []string /*Records The maximum number of profiles to return. */ Records *int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetProfileByAccountIDParams contains all the parameters to send to the API endpoint for the get profile by account ID operation typically these are written to a http.Request
func NewGetProfileByAccountIDParams ¶
func NewGetProfileByAccountIDParams() *GetProfileByAccountIDParams
NewGetProfileByAccountIDParams creates a new GetProfileByAccountIDParams object with the default values initialized.
func NewGetProfileByAccountIDParamsWithContext ¶
func NewGetProfileByAccountIDParamsWithContext(ctx context.Context) *GetProfileByAccountIDParams
NewGetProfileByAccountIDParamsWithContext creates a new GetProfileByAccountIDParams object with the default values initialized, and the ability to set a context for a request
func NewGetProfileByAccountIDParamsWithHTTPClient ¶
func NewGetProfileByAccountIDParamsWithHTTPClient(client *http.Client) *GetProfileByAccountIDParams
NewGetProfileByAccountIDParamsWithHTTPClient creates a new GetProfileByAccountIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetProfileByAccountIDParamsWithTimeout ¶
func NewGetProfileByAccountIDParamsWithTimeout(timeout time.Duration) *GetProfileByAccountIDParams
NewGetProfileByAccountIDParamsWithTimeout creates a new GetProfileByAccountIDParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetProfileByAccountIDParams) SetAccountID ¶
func (o *GetProfileByAccountIDParams) SetAccountID(accountID string)
SetAccountID adds the accountId to the get profile by account ID params
func (*GetProfileByAccountIDParams) SetContext ¶
func (o *GetProfileByAccountIDParams) SetContext(ctx context.Context)
SetContext adds the context to the get profile by account ID params
func (*GetProfileByAccountIDParams) SetHTTPClient ¶
func (o *GetProfileByAccountIDParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get profile by account ID params
func (*GetProfileByAccountIDParams) SetOffset ¶
func (o *GetProfileByAccountIDParams) SetOffset(offset *int32)
SetOffset adds the offset to the get profile by account ID params
func (*GetProfileByAccountIDParams) SetOrder ¶
func (o *GetProfileByAccountIDParams) SetOrder(order *string)
SetOrder adds the order to the get profile by account ID params
func (*GetProfileByAccountIDParams) SetOrderBy ¶
func (o *GetProfileByAccountIDParams) SetOrderBy(orderBy *string)
SetOrderBy adds the orderBy to the get profile by account ID params
func (*GetProfileByAccountIDParams) SetOrganizations ¶
func (o *GetProfileByAccountIDParams) SetOrganizations(organizations []string)
SetOrganizations adds the organizations to the get profile by account ID params
func (*GetProfileByAccountIDParams) SetRecords ¶
func (o *GetProfileByAccountIDParams) SetRecords(records *int32)
SetRecords adds the records to the get profile by account ID params
func (*GetProfileByAccountIDParams) SetTimeout ¶
func (o *GetProfileByAccountIDParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithAccountID ¶
func (o *GetProfileByAccountIDParams) WithAccountID(accountID string) *GetProfileByAccountIDParams
WithAccountID adds the accountID to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithContext ¶
func (o *GetProfileByAccountIDParams) WithContext(ctx context.Context) *GetProfileByAccountIDParams
WithContext adds the context to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithHTTPClient ¶
func (o *GetProfileByAccountIDParams) WithHTTPClient(client *http.Client) *GetProfileByAccountIDParams
WithHTTPClient adds the HTTPClient to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithOffset ¶
func (o *GetProfileByAccountIDParams) WithOffset(offset *int32) *GetProfileByAccountIDParams
WithOffset adds the offset to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithOrder ¶
func (o *GetProfileByAccountIDParams) WithOrder(order *string) *GetProfileByAccountIDParams
WithOrder adds the order to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithOrderBy ¶
func (o *GetProfileByAccountIDParams) WithOrderBy(orderBy *string) *GetProfileByAccountIDParams
WithOrderBy adds the orderBy to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithOrganizations ¶
func (o *GetProfileByAccountIDParams) WithOrganizations(organizations []string) *GetProfileByAccountIDParams
WithOrganizations adds the organizations to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithRecords ¶
func (o *GetProfileByAccountIDParams) WithRecords(records *int32) *GetProfileByAccountIDParams
WithRecords adds the records to the get profile by account ID params
func (*GetProfileByAccountIDParams) WithTimeout ¶
func (o *GetProfileByAccountIDParams) WithTimeout(timeout time.Duration) *GetProfileByAccountIDParams
WithTimeout adds the timeout to the get profile by account ID params
func (*GetProfileByAccountIDParams) WriteToRequest ¶
func (o *GetProfileByAccountIDParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetProfileByAccountIDReader ¶
type GetProfileByAccountIDReader struct {
// contains filtered or unexported fields
}
GetProfileByAccountIDReader is a Reader for the GetProfileByAccountID structure.
func (*GetProfileByAccountIDReader) ReadResponse ¶
func (o *GetProfileByAccountIDReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetProfileByEmailAddressDefault ¶
type GetProfileByEmailAddressDefault struct { Payload *models.BFError // contains filtered or unexported fields }
GetProfileByEmailAddressDefault handles this case with default header values.
error
func NewGetProfileByEmailAddressDefault ¶
func NewGetProfileByEmailAddressDefault(code int) *GetProfileByEmailAddressDefault
NewGetProfileByEmailAddressDefault creates a GetProfileByEmailAddressDefault with default headers values
func (*GetProfileByEmailAddressDefault) Code ¶
func (o *GetProfileByEmailAddressDefault) Code() int
Code gets the status code for the get profile by email address default response
func (*GetProfileByEmailAddressDefault) Error ¶
func (o *GetProfileByEmailAddressDefault) Error() string
type GetProfileByEmailAddressOK ¶
type GetProfileByEmailAddressOK struct {
Payload *models.ProfilePagedMetadata
}
GetProfileByEmailAddressOK handles this case with default header values.
success
func NewGetProfileByEmailAddressOK ¶
func NewGetProfileByEmailAddressOK() *GetProfileByEmailAddressOK
NewGetProfileByEmailAddressOK creates a GetProfileByEmailAddressOK with default headers values
func (*GetProfileByEmailAddressOK) Error ¶
func (o *GetProfileByEmailAddressOK) Error() string
type GetProfileByEmailAddressParams ¶
type GetProfileByEmailAddressParams struct { /*Email The email address of the profile. */ Email string /*IncludeRetired Whether retired profiles should be returned. */ IncludeRetired *bool /*Offset The offset from the first profile to return. */ Offset *int32 /*Order Ihe direction of any ordering, either ASC or DESC. */ Order *string /*OrderBy Specify a field used to order the result set. */ OrderBy *string /*Organizations A list of organizations used to restrict the scope of API calls. */ Organizations []string /*Records The maximum number of profiles to return. */ Records *int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetProfileByEmailAddressParams contains all the parameters to send to the API endpoint for the get profile by email address operation typically these are written to a http.Request
func NewGetProfileByEmailAddressParams ¶
func NewGetProfileByEmailAddressParams() *GetProfileByEmailAddressParams
NewGetProfileByEmailAddressParams creates a new GetProfileByEmailAddressParams object with the default values initialized.
func NewGetProfileByEmailAddressParamsWithContext ¶
func NewGetProfileByEmailAddressParamsWithContext(ctx context.Context) *GetProfileByEmailAddressParams
NewGetProfileByEmailAddressParamsWithContext creates a new GetProfileByEmailAddressParams object with the default values initialized, and the ability to set a context for a request
func NewGetProfileByEmailAddressParamsWithHTTPClient ¶
func NewGetProfileByEmailAddressParamsWithHTTPClient(client *http.Client) *GetProfileByEmailAddressParams
NewGetProfileByEmailAddressParamsWithHTTPClient creates a new GetProfileByEmailAddressParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetProfileByEmailAddressParamsWithTimeout ¶
func NewGetProfileByEmailAddressParamsWithTimeout(timeout time.Duration) *GetProfileByEmailAddressParams
NewGetProfileByEmailAddressParamsWithTimeout creates a new GetProfileByEmailAddressParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetProfileByEmailAddressParams) SetContext ¶
func (o *GetProfileByEmailAddressParams) SetContext(ctx context.Context)
SetContext adds the context to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetEmail ¶
func (o *GetProfileByEmailAddressParams) SetEmail(email string)
SetEmail adds the email to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetHTTPClient ¶
func (o *GetProfileByEmailAddressParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetIncludeRetired ¶
func (o *GetProfileByEmailAddressParams) SetIncludeRetired(includeRetired *bool)
SetIncludeRetired adds the includeRetired to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetOffset ¶
func (o *GetProfileByEmailAddressParams) SetOffset(offset *int32)
SetOffset adds the offset to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetOrder ¶
func (o *GetProfileByEmailAddressParams) SetOrder(order *string)
SetOrder adds the order to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetOrderBy ¶
func (o *GetProfileByEmailAddressParams) SetOrderBy(orderBy *string)
SetOrderBy adds the orderBy to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetOrganizations ¶
func (o *GetProfileByEmailAddressParams) SetOrganizations(organizations []string)
SetOrganizations adds the organizations to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetRecords ¶
func (o *GetProfileByEmailAddressParams) SetRecords(records *int32)
SetRecords adds the records to the get profile by email address params
func (*GetProfileByEmailAddressParams) SetTimeout ¶
func (o *GetProfileByEmailAddressParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithContext ¶
func (o *GetProfileByEmailAddressParams) WithContext(ctx context.Context) *GetProfileByEmailAddressParams
WithContext adds the context to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithEmail ¶
func (o *GetProfileByEmailAddressParams) WithEmail(email string) *GetProfileByEmailAddressParams
WithEmail adds the email to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithHTTPClient ¶
func (o *GetProfileByEmailAddressParams) WithHTTPClient(client *http.Client) *GetProfileByEmailAddressParams
WithHTTPClient adds the HTTPClient to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithIncludeRetired ¶
func (o *GetProfileByEmailAddressParams) WithIncludeRetired(includeRetired *bool) *GetProfileByEmailAddressParams
WithIncludeRetired adds the includeRetired to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithOffset ¶
func (o *GetProfileByEmailAddressParams) WithOffset(offset *int32) *GetProfileByEmailAddressParams
WithOffset adds the offset to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithOrder ¶
func (o *GetProfileByEmailAddressParams) WithOrder(order *string) *GetProfileByEmailAddressParams
WithOrder adds the order to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithOrderBy ¶
func (o *GetProfileByEmailAddressParams) WithOrderBy(orderBy *string) *GetProfileByEmailAddressParams
WithOrderBy adds the orderBy to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithOrganizations ¶
func (o *GetProfileByEmailAddressParams) WithOrganizations(organizations []string) *GetProfileByEmailAddressParams
WithOrganizations adds the organizations to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithRecords ¶
func (o *GetProfileByEmailAddressParams) WithRecords(records *int32) *GetProfileByEmailAddressParams
WithRecords adds the records to the get profile by email address params
func (*GetProfileByEmailAddressParams) WithTimeout ¶
func (o *GetProfileByEmailAddressParams) WithTimeout(timeout time.Duration) *GetProfileByEmailAddressParams
WithTimeout adds the timeout to the get profile by email address params
func (*GetProfileByEmailAddressParams) WriteToRequest ¶
func (o *GetProfileByEmailAddressParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetProfileByEmailAddressReader ¶
type GetProfileByEmailAddressReader struct {
// contains filtered or unexported fields
}
GetProfileByEmailAddressReader is a Reader for the GetProfileByEmailAddress structure.
func (*GetProfileByEmailAddressReader) ReadResponse ¶
func (o *GetProfileByEmailAddressReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetProfileDefault ¶
GetProfileDefault handles this case with default header values.
error
func NewGetProfileDefault ¶
func NewGetProfileDefault(code int) *GetProfileDefault
NewGetProfileDefault creates a GetProfileDefault with default headers values
func (*GetProfileDefault) Code ¶
func (o *GetProfileDefault) Code() int
Code gets the status code for the get profile default response
func (*GetProfileDefault) Error ¶
func (o *GetProfileDefault) Error() string
type GetProfileOK ¶
type GetProfileOK struct {
Payload *models.ProfilePagedMetadata
}
GetProfileOK handles this case with default header values.
success
func NewGetProfileOK ¶
func NewGetProfileOK() *GetProfileOK
NewGetProfileOK creates a GetProfileOK with default headers values
func (*GetProfileOK) Error ¶
func (o *GetProfileOK) Error() string
type GetProfileParams ¶
type GetProfileParams struct { /*Organizations A list of organization-IDs used to restrict the scope of API calls. */ Organizations []string /*ProfileID ID of the Profile. */ ProfileID string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetProfileParams contains all the parameters to send to the API endpoint for the get profile operation typically these are written to a http.Request
func NewGetProfileParams ¶
func NewGetProfileParams() *GetProfileParams
NewGetProfileParams creates a new GetProfileParams object with the default values initialized.
func NewGetProfileParamsWithContext ¶
func NewGetProfileParamsWithContext(ctx context.Context) *GetProfileParams
NewGetProfileParamsWithContext creates a new GetProfileParams object with the default values initialized, and the ability to set a context for a request
func NewGetProfileParamsWithHTTPClient ¶
func NewGetProfileParamsWithHTTPClient(client *http.Client) *GetProfileParams
NewGetProfileParamsWithHTTPClient creates a new GetProfileParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetProfileParamsWithTimeout ¶
func NewGetProfileParamsWithTimeout(timeout time.Duration) *GetProfileParams
NewGetProfileParamsWithTimeout creates a new GetProfileParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetProfileParams) SetContext ¶
func (o *GetProfileParams) SetContext(ctx context.Context)
SetContext adds the context to the get profile params
func (*GetProfileParams) SetHTTPClient ¶
func (o *GetProfileParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get profile params
func (*GetProfileParams) SetOrganizations ¶
func (o *GetProfileParams) SetOrganizations(organizations []string)
SetOrganizations adds the organizations to the get profile params
func (*GetProfileParams) SetProfileID ¶
func (o *GetProfileParams) SetProfileID(profileID string)
SetProfileID adds the profileId to the get profile params
func (*GetProfileParams) SetTimeout ¶
func (o *GetProfileParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get profile params
func (*GetProfileParams) WithContext ¶
func (o *GetProfileParams) WithContext(ctx context.Context) *GetProfileParams
WithContext adds the context to the get profile params
func (*GetProfileParams) WithHTTPClient ¶
func (o *GetProfileParams) WithHTTPClient(client *http.Client) *GetProfileParams
WithHTTPClient adds the HTTPClient to the get profile params
func (*GetProfileParams) WithOrganizations ¶
func (o *GetProfileParams) WithOrganizations(organizations []string) *GetProfileParams
WithOrganizations adds the organizations to the get profile params
func (*GetProfileParams) WithProfileID ¶
func (o *GetProfileParams) WithProfileID(profileID string) *GetProfileParams
WithProfileID adds the profileID to the get profile params
func (*GetProfileParams) WithTimeout ¶
func (o *GetProfileParams) WithTimeout(timeout time.Duration) *GetProfileParams
WithTimeout adds the timeout to the get profile params
func (*GetProfileParams) WriteToRequest ¶
func (o *GetProfileParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetProfileReader ¶
type GetProfileReader struct {
// contains filtered or unexported fields
}
GetProfileReader is a Reader for the GetProfile structure.
func (*GetProfileReader) ReadResponse ¶
func (o *GetProfileReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type UpdateProfileDefault ¶
type UpdateProfileDefault struct { Payload *models.BFError // contains filtered or unexported fields }
UpdateProfileDefault handles this case with default header values.
error
func NewUpdateProfileDefault ¶
func NewUpdateProfileDefault(code int) *UpdateProfileDefault
NewUpdateProfileDefault creates a UpdateProfileDefault with default headers values
func (*UpdateProfileDefault) Code ¶
func (o *UpdateProfileDefault) Code() int
Code gets the status code for the update profile default response
func (*UpdateProfileDefault) Error ¶
func (o *UpdateProfileDefault) Error() string
type UpdateProfileOK ¶
type UpdateProfileOK struct {
Payload *models.ProfilePagedMetadata
}
UpdateProfileOK handles this case with default header values.
success
func NewUpdateProfileOK ¶
func NewUpdateProfileOK() *UpdateProfileOK
NewUpdateProfileOK creates a UpdateProfileOK with default headers values
func (*UpdateProfileOK) Error ¶
func (o *UpdateProfileOK) Error() string
type UpdateProfileParams ¶
type UpdateProfileParams struct { /*Request The profile object to be updated. */ Request *models.UpdateProfileRequest Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
UpdateProfileParams contains all the parameters to send to the API endpoint for the update profile operation typically these are written to a http.Request
func NewUpdateProfileParams ¶
func NewUpdateProfileParams() *UpdateProfileParams
NewUpdateProfileParams creates a new UpdateProfileParams object with the default values initialized.
func NewUpdateProfileParamsWithContext ¶
func NewUpdateProfileParamsWithContext(ctx context.Context) *UpdateProfileParams
NewUpdateProfileParamsWithContext creates a new UpdateProfileParams object with the default values initialized, and the ability to set a context for a request
func NewUpdateProfileParamsWithHTTPClient ¶
func NewUpdateProfileParamsWithHTTPClient(client *http.Client) *UpdateProfileParams
NewUpdateProfileParamsWithHTTPClient creates a new UpdateProfileParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewUpdateProfileParamsWithTimeout ¶
func NewUpdateProfileParamsWithTimeout(timeout time.Duration) *UpdateProfileParams
NewUpdateProfileParamsWithTimeout creates a new UpdateProfileParams object with the default values initialized, and the ability to set a timeout on a request
func (*UpdateProfileParams) SetContext ¶
func (o *UpdateProfileParams) SetContext(ctx context.Context)
SetContext adds the context to the update profile params
func (*UpdateProfileParams) SetHTTPClient ¶
func (o *UpdateProfileParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the update profile params
func (*UpdateProfileParams) SetRequest ¶
func (o *UpdateProfileParams) SetRequest(request *models.UpdateProfileRequest)
SetRequest adds the request to the update profile params
func (*UpdateProfileParams) SetTimeout ¶
func (o *UpdateProfileParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the update profile params
func (*UpdateProfileParams) WithContext ¶
func (o *UpdateProfileParams) WithContext(ctx context.Context) *UpdateProfileParams
WithContext adds the context to the update profile params
func (*UpdateProfileParams) WithHTTPClient ¶
func (o *UpdateProfileParams) WithHTTPClient(client *http.Client) *UpdateProfileParams
WithHTTPClient adds the HTTPClient to the update profile params
func (*UpdateProfileParams) WithRequest ¶
func (o *UpdateProfileParams) WithRequest(request *models.UpdateProfileRequest) *UpdateProfileParams
WithRequest adds the request to the update profile params
func (*UpdateProfileParams) WithTimeout ¶
func (o *UpdateProfileParams) WithTimeout(timeout time.Duration) *UpdateProfileParams
WithTimeout adds the timeout to the update profile params
func (*UpdateProfileParams) WriteToRequest ¶
func (o *UpdateProfileParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type UpdateProfileReader ¶
type UpdateProfileReader struct {
// contains filtered or unexported fields
}
UpdateProfileReader is a Reader for the UpdateProfile structure.
func (*UpdateProfileReader) ReadResponse ¶
func (o *UpdateProfileReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files
¶
- get_all_profiles_parameters.go
- get_all_profiles_responses.go
- get_profile_by_account_id_parameters.go
- get_profile_by_account_id_responses.go
- get_profile_by_email_address_parameters.go
- get_profile_by_email_address_responses.go
- get_profile_parameters.go
- get_profile_responses.go
- profiles_client.go
- update_profile_parameters.go
- update_profile_responses.go