Documentation
¶
Index ¶
- type Client
- func (a *Client) CreateOrgChild(params *CreateOrgChildParams, authInfo runtime.ClientAuthInfoWriter) (*CreateOrgChildOK, error)
- func (a *Client) GetOrgChildren(params *GetOrgChildrenParams, authInfo runtime.ClientAuthInfoWriter) (*GetOrgChildrenOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type CreateOrgChildOK
- type CreateOrgChildOKBody
- type CreateOrgChildParams
- func NewCreateOrgChildParams() *CreateOrgChildParams
- func NewCreateOrgChildParamsWithContext(ctx context.Context) *CreateOrgChildParams
- func NewCreateOrgChildParamsWithHTTPClient(client *http.Client) *CreateOrgChildParams
- func NewCreateOrgChildParamsWithTimeout(timeout time.Duration) *CreateOrgChildParams
- func (o *CreateOrgChildParams) SetBody(body *models.NewOrganization)
- func (o *CreateOrgChildParams) SetContext(ctx context.Context)
- func (o *CreateOrgChildParams) SetHTTPClient(client *http.Client)
- func (o *CreateOrgChildParams) SetOrganizationCanonical(organizationCanonical string)
- func (o *CreateOrgChildParams) SetTimeout(timeout time.Duration)
- func (o *CreateOrgChildParams) WithBody(body *models.NewOrganization) *CreateOrgChildParams
- func (o *CreateOrgChildParams) WithContext(ctx context.Context) *CreateOrgChildParams
- func (o *CreateOrgChildParams) WithHTTPClient(client *http.Client) *CreateOrgChildParams
- func (o *CreateOrgChildParams) WithOrganizationCanonical(organizationCanonical string) *CreateOrgChildParams
- func (o *CreateOrgChildParams) WithTimeout(timeout time.Duration) *CreateOrgChildParams
- func (o *CreateOrgChildParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type CreateOrgChildReader
- type GetOrgChildrenDefault
- type GetOrgChildrenForbidden
- type GetOrgChildrenNotFound
- type GetOrgChildrenOK
- type GetOrgChildrenOKBody
- type GetOrgChildrenParams
- func NewGetOrgChildrenParams() *GetOrgChildrenParams
- func NewGetOrgChildrenParamsWithContext(ctx context.Context) *GetOrgChildrenParams
- func NewGetOrgChildrenParamsWithHTTPClient(client *http.Client) *GetOrgChildrenParams
- func NewGetOrgChildrenParamsWithTimeout(timeout time.Duration) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) SetContext(ctx context.Context)
- func (o *GetOrgChildrenParams) SetHTTPClient(client *http.Client)
- func (o *GetOrgChildrenParams) SetOrderBy(orderBy *string)
- func (o *GetOrgChildrenParams) SetOrganizationCanonical(organizationCanonical string)
- func (o *GetOrgChildrenParams) SetOrganizationCreatedAt(organizationCreatedAt *strfmt.DateTime)
- func (o *GetOrgChildrenParams) SetOrganizationName(organizationName *string)
- func (o *GetOrgChildrenParams) SetPageIndex(pageIndex *uint32)
- func (o *GetOrgChildrenParams) SetPageSize(pageSize *uint32)
- func (o *GetOrgChildrenParams) SetTimeout(timeout time.Duration)
- func (o *GetOrgChildrenParams) WithContext(ctx context.Context) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WithHTTPClient(client *http.Client) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WithOrderBy(orderBy *string) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WithOrganizationCanonical(organizationCanonical string) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WithOrganizationCreatedAt(organizationCreatedAt *strfmt.DateTime) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WithOrganizationName(organizationName *string) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WithPageIndex(pageIndex *uint32) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WithPageSize(pageSize *uint32) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WithTimeout(timeout time.Duration) *GetOrgChildrenParams
- func (o *GetOrgChildrenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetOrgChildrenReader
- type GetOrgChildrenUnprocessableEntity
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 organization children API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new organization children API client.
func (*Client) CreateOrgChild ¶ added in v1.0.61
func (a *Client) CreateOrgChild(params *CreateOrgChildParams, authInfo runtime.ClientAuthInfoWriter) (*CreateOrgChildOK, error)
CreateOrgChild Create a new organization child, making the authenticated user the owner of it.
func (*Client) GetOrgChildren ¶ added in v1.0.61
func (a *Client) GetOrgChildren(params *GetOrgChildrenParams, authInfo runtime.ClientAuthInfoWriter) (*GetOrgChildrenOK, error)
GetOrgChildren Get the children organizations that the authenticated user has access.
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type CreateOrgChildOK ¶ added in v1.0.61
type CreateOrgChildOK struct {
Payload *CreateOrgChildOKBody
}
CreateOrgChildOK handles this case with default header values.
Organization created. The body contains the information of the new created organization.
func NewCreateOrgChildOK ¶ added in v1.0.61
func NewCreateOrgChildOK() *CreateOrgChildOK
NewCreateOrgChildOK creates a CreateOrgChildOK with default headers values
func (*CreateOrgChildOK) Error ¶ added in v1.0.61
func (o *CreateOrgChildOK) Error() string
func (*CreateOrgChildOK) GetPayload ¶ added in v1.0.61
func (o *CreateOrgChildOK) GetPayload() *CreateOrgChildOKBody
type CreateOrgChildOKBody ¶ added in v1.0.61
type CreateOrgChildOKBody struct {
// data
// Required: true
Data *models.Organization `json:"data"`
}
CreateOrgChildOKBody create org child o k body swagger:model CreateOrgChildOKBody
func (*CreateOrgChildOKBody) MarshalBinary ¶ added in v1.0.61
func (o *CreateOrgChildOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateOrgChildOKBody) UnmarshalBinary ¶ added in v1.0.61
func (o *CreateOrgChildOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateOrgChildParams ¶ added in v1.0.61
type CreateOrgChildParams struct {
/*Body
The information of the organization to create.
*/
Body *models.NewOrganization
/*OrganizationCanonical
A canonical of an organization.
*/
OrganizationCanonical string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
CreateOrgChildParams contains all the parameters to send to the API endpoint for the create org child operation typically these are written to a http.Request
func NewCreateOrgChildParams ¶ added in v1.0.61
func NewCreateOrgChildParams() *CreateOrgChildParams
NewCreateOrgChildParams creates a new CreateOrgChildParams object with the default values initialized.
func NewCreateOrgChildParamsWithContext ¶ added in v1.0.61
func NewCreateOrgChildParamsWithContext(ctx context.Context) *CreateOrgChildParams
NewCreateOrgChildParamsWithContext creates a new CreateOrgChildParams object with the default values initialized, and the ability to set a context for a request
func NewCreateOrgChildParamsWithHTTPClient ¶ added in v1.0.61
func NewCreateOrgChildParamsWithHTTPClient(client *http.Client) *CreateOrgChildParams
NewCreateOrgChildParamsWithHTTPClient creates a new CreateOrgChildParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewCreateOrgChildParamsWithTimeout ¶ added in v1.0.61
func NewCreateOrgChildParamsWithTimeout(timeout time.Duration) *CreateOrgChildParams
NewCreateOrgChildParamsWithTimeout creates a new CreateOrgChildParams object with the default values initialized, and the ability to set a timeout on a request
func (*CreateOrgChildParams) SetBody ¶ added in v1.0.61
func (o *CreateOrgChildParams) SetBody(body *models.NewOrganization)
SetBody adds the body to the create org child params
func (*CreateOrgChildParams) SetContext ¶ added in v1.0.61
func (o *CreateOrgChildParams) SetContext(ctx context.Context)
SetContext adds the context to the create org child params
func (*CreateOrgChildParams) SetHTTPClient ¶ added in v1.0.61
func (o *CreateOrgChildParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the create org child params
func (*CreateOrgChildParams) SetOrganizationCanonical ¶ added in v1.0.61
func (o *CreateOrgChildParams) SetOrganizationCanonical(organizationCanonical string)
SetOrganizationCanonical adds the organizationCanonical to the create org child params
func (*CreateOrgChildParams) SetTimeout ¶ added in v1.0.61
func (o *CreateOrgChildParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the create org child params
func (*CreateOrgChildParams) WithBody ¶ added in v1.0.61
func (o *CreateOrgChildParams) WithBody(body *models.NewOrganization) *CreateOrgChildParams
WithBody adds the body to the create org child params
func (*CreateOrgChildParams) WithContext ¶ added in v1.0.61
func (o *CreateOrgChildParams) WithContext(ctx context.Context) *CreateOrgChildParams
WithContext adds the context to the create org child params
func (*CreateOrgChildParams) WithHTTPClient ¶ added in v1.0.61
func (o *CreateOrgChildParams) WithHTTPClient(client *http.Client) *CreateOrgChildParams
WithHTTPClient adds the HTTPClient to the create org child params
func (*CreateOrgChildParams) WithOrganizationCanonical ¶ added in v1.0.61
func (o *CreateOrgChildParams) WithOrganizationCanonical(organizationCanonical string) *CreateOrgChildParams
WithOrganizationCanonical adds the organizationCanonical to the create org child params
func (*CreateOrgChildParams) WithTimeout ¶ added in v1.0.61
func (o *CreateOrgChildParams) WithTimeout(timeout time.Duration) *CreateOrgChildParams
WithTimeout adds the timeout to the create org child params
func (*CreateOrgChildParams) WriteToRequest ¶ added in v1.0.61
func (o *CreateOrgChildParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type CreateOrgChildReader ¶ added in v1.0.61
type CreateOrgChildReader struct {
// contains filtered or unexported fields
}
CreateOrgChildReader is a Reader for the CreateOrgChild structure.
func (*CreateOrgChildReader) ReadResponse ¶ added in v1.0.61
func (o *CreateOrgChildReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetOrgChildrenDefault ¶ added in v1.0.61
type GetOrgChildrenDefault struct {
/*The length of the response body in octets (8-bit bytes).
*/
ContentLength uint64
Payload *models.ErrorPayload
// contains filtered or unexported fields
}
GetOrgChildrenDefault handles this case with default header values.
The response sent when an unexpected error happened, as known as an internal server error.
func NewGetOrgChildrenDefault ¶ added in v1.0.61
func NewGetOrgChildrenDefault(code int) *GetOrgChildrenDefault
NewGetOrgChildrenDefault creates a GetOrgChildrenDefault with default headers values
func (*GetOrgChildrenDefault) Code ¶ added in v1.0.61
func (o *GetOrgChildrenDefault) Code() int
Code gets the status code for the get org children default response
func (*GetOrgChildrenDefault) Error ¶ added in v1.0.61
func (o *GetOrgChildrenDefault) Error() string
func (*GetOrgChildrenDefault) GetPayload ¶ added in v1.0.61
func (o *GetOrgChildrenDefault) GetPayload() *models.ErrorPayload
type GetOrgChildrenForbidden ¶ added in v1.0.61
type GetOrgChildrenForbidden struct {
/*The length of the response body in octets (8-bit bytes).
*/
ContentLength uint64
Payload *models.ErrorPayload
}
GetOrgChildrenForbidden handles this case with default header values.
The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.
func NewGetOrgChildrenForbidden ¶ added in v1.0.61
func NewGetOrgChildrenForbidden() *GetOrgChildrenForbidden
NewGetOrgChildrenForbidden creates a GetOrgChildrenForbidden with default headers values
func (*GetOrgChildrenForbidden) Error ¶ added in v1.0.61
func (o *GetOrgChildrenForbidden) Error() string
func (*GetOrgChildrenForbidden) GetPayload ¶ added in v1.0.61
func (o *GetOrgChildrenForbidden) GetPayload() *models.ErrorPayload
type GetOrgChildrenNotFound ¶ added in v1.0.61
type GetOrgChildrenNotFound struct {
/*The length of the response body in octets (8-bit bytes).
*/
ContentLength uint64
Payload *models.ErrorPayload
}
GetOrgChildrenNotFound handles this case with default header values.
The response sent when any of the entities present in the path is not found.
func NewGetOrgChildrenNotFound ¶ added in v1.0.61
func NewGetOrgChildrenNotFound() *GetOrgChildrenNotFound
NewGetOrgChildrenNotFound creates a GetOrgChildrenNotFound with default headers values
func (*GetOrgChildrenNotFound) Error ¶ added in v1.0.61
func (o *GetOrgChildrenNotFound) Error() string
func (*GetOrgChildrenNotFound) GetPayload ¶ added in v1.0.61
func (o *GetOrgChildrenNotFound) GetPayload() *models.ErrorPayload
type GetOrgChildrenOK ¶ added in v1.0.61
type GetOrgChildrenOK struct {
Payload *GetOrgChildrenOKBody
}
GetOrgChildrenOK handles this case with default header values.
List of the children organizations which the authenticated user has access.
func NewGetOrgChildrenOK ¶ added in v1.0.61
func NewGetOrgChildrenOK() *GetOrgChildrenOK
NewGetOrgChildrenOK creates a GetOrgChildrenOK with default headers values
func (*GetOrgChildrenOK) Error ¶ added in v1.0.61
func (o *GetOrgChildrenOK) Error() string
func (*GetOrgChildrenOK) GetPayload ¶ added in v1.0.61
func (o *GetOrgChildrenOK) GetPayload() *GetOrgChildrenOKBody
type GetOrgChildrenOKBody ¶ added in v1.0.61
type GetOrgChildrenOKBody struct {
// data
// Required: true
Data []*models.Organization `json:"data"`
// pagination
// Required: true
Pagination *models.Pagination `json:"pagination"`
}
GetOrgChildrenOKBody get org children o k body swagger:model GetOrgChildrenOKBody
func (*GetOrgChildrenOKBody) MarshalBinary ¶ added in v1.0.61
func (o *GetOrgChildrenOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetOrgChildrenOKBody) UnmarshalBinary ¶ added in v1.0.61
func (o *GetOrgChildrenOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetOrgChildrenParams ¶ added in v1.0.61
type GetOrgChildrenParams struct {
/*OrderBy
Allows to order the list of items. Example usage: field_name:asc
*/
OrderBy *string
/*OrganizationCanonical
A canonical of an organization.
*/
OrganizationCanonical string
/*OrganizationCreatedAt
Search by organization's creation date
*/
OrganizationCreatedAt *strfmt.DateTime
/*OrganizationName
Search by the organization's name
*/
OrganizationName *string
/*PageIndex
The page number to request. The first page is 1.
*/
PageIndex *uint32
/*PageSize
The number of items at most which the response can have.
*/
PageSize *uint32
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetOrgChildrenParams contains all the parameters to send to the API endpoint for the get org children operation typically these are written to a http.Request
func NewGetOrgChildrenParams ¶ added in v1.0.61
func NewGetOrgChildrenParams() *GetOrgChildrenParams
NewGetOrgChildrenParams creates a new GetOrgChildrenParams object with the default values initialized.
func NewGetOrgChildrenParamsWithContext ¶ added in v1.0.61
func NewGetOrgChildrenParamsWithContext(ctx context.Context) *GetOrgChildrenParams
NewGetOrgChildrenParamsWithContext creates a new GetOrgChildrenParams object with the default values initialized, and the ability to set a context for a request
func NewGetOrgChildrenParamsWithHTTPClient ¶ added in v1.0.61
func NewGetOrgChildrenParamsWithHTTPClient(client *http.Client) *GetOrgChildrenParams
NewGetOrgChildrenParamsWithHTTPClient creates a new GetOrgChildrenParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetOrgChildrenParamsWithTimeout ¶ added in v1.0.61
func NewGetOrgChildrenParamsWithTimeout(timeout time.Duration) *GetOrgChildrenParams
NewGetOrgChildrenParamsWithTimeout creates a new GetOrgChildrenParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetOrgChildrenParams) SetContext ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetContext(ctx context.Context)
SetContext adds the context to the get org children params
func (*GetOrgChildrenParams) SetHTTPClient ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get org children params
func (*GetOrgChildrenParams) SetOrderBy ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetOrderBy(orderBy *string)
SetOrderBy adds the orderBy to the get org children params
func (*GetOrgChildrenParams) SetOrganizationCanonical ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetOrganizationCanonical(organizationCanonical string)
SetOrganizationCanonical adds the organizationCanonical to the get org children params
func (*GetOrgChildrenParams) SetOrganizationCreatedAt ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetOrganizationCreatedAt(organizationCreatedAt *strfmt.DateTime)
SetOrganizationCreatedAt adds the organizationCreatedAt to the get org children params
func (*GetOrgChildrenParams) SetOrganizationName ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetOrganizationName(organizationName *string)
SetOrganizationName adds the organizationName to the get org children params
func (*GetOrgChildrenParams) SetPageIndex ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetPageIndex(pageIndex *uint32)
SetPageIndex adds the pageIndex to the get org children params
func (*GetOrgChildrenParams) SetPageSize ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetPageSize(pageSize *uint32)
SetPageSize adds the pageSize to the get org children params
func (*GetOrgChildrenParams) SetTimeout ¶ added in v1.0.61
func (o *GetOrgChildrenParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get org children params
func (*GetOrgChildrenParams) WithContext ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithContext(ctx context.Context) *GetOrgChildrenParams
WithContext adds the context to the get org children params
func (*GetOrgChildrenParams) WithHTTPClient ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithHTTPClient(client *http.Client) *GetOrgChildrenParams
WithHTTPClient adds the HTTPClient to the get org children params
func (*GetOrgChildrenParams) WithOrderBy ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithOrderBy(orderBy *string) *GetOrgChildrenParams
WithOrderBy adds the orderBy to the get org children params
func (*GetOrgChildrenParams) WithOrganizationCanonical ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithOrganizationCanonical(organizationCanonical string) *GetOrgChildrenParams
WithOrganizationCanonical adds the organizationCanonical to the get org children params
func (*GetOrgChildrenParams) WithOrganizationCreatedAt ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithOrganizationCreatedAt(organizationCreatedAt *strfmt.DateTime) *GetOrgChildrenParams
WithOrganizationCreatedAt adds the organizationCreatedAt to the get org children params
func (*GetOrgChildrenParams) WithOrganizationName ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithOrganizationName(organizationName *string) *GetOrgChildrenParams
WithOrganizationName adds the organizationName to the get org children params
func (*GetOrgChildrenParams) WithPageIndex ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithPageIndex(pageIndex *uint32) *GetOrgChildrenParams
WithPageIndex adds the pageIndex to the get org children params
func (*GetOrgChildrenParams) WithPageSize ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithPageSize(pageSize *uint32) *GetOrgChildrenParams
WithPageSize adds the pageSize to the get org children params
func (*GetOrgChildrenParams) WithTimeout ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WithTimeout(timeout time.Duration) *GetOrgChildrenParams
WithTimeout adds the timeout to the get org children params
func (*GetOrgChildrenParams) WriteToRequest ¶ added in v1.0.61
func (o *GetOrgChildrenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetOrgChildrenReader ¶ added in v1.0.61
type GetOrgChildrenReader struct {
// contains filtered or unexported fields
}
GetOrgChildrenReader is a Reader for the GetOrgChildren structure.
func (*GetOrgChildrenReader) ReadResponse ¶ added in v1.0.61
func (o *GetOrgChildrenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetOrgChildrenUnprocessableEntity ¶ added in v1.0.61
type GetOrgChildrenUnprocessableEntity struct {
/*The length of the response body in octets (8-bit bytes).
*/
ContentLength uint64
Payload *models.ErrorPayload
}
GetOrgChildrenUnprocessableEntity handles this case with default header values.
All the custom errors that are generated from the Cycloid API
func NewGetOrgChildrenUnprocessableEntity ¶ added in v1.0.61
func NewGetOrgChildrenUnprocessableEntity() *GetOrgChildrenUnprocessableEntity
NewGetOrgChildrenUnprocessableEntity creates a GetOrgChildrenUnprocessableEntity with default headers values
func (*GetOrgChildrenUnprocessableEntity) Error ¶ added in v1.0.61
func (o *GetOrgChildrenUnprocessableEntity) Error() string
func (*GetOrgChildrenUnprocessableEntity) GetPayload ¶ added in v1.0.61
func (o *GetOrgChildrenUnprocessableEntity) GetPayload() *models.ErrorPayload