Documentation ¶
Index ¶
- type AuditLogEntry
- type AuditLogEntryListResponse
- type AuditLogRequest
- type AuthClient
- func (c AuthClient) AcceptProjectInvite(id string) (EmptyResponse, *http.Response, error)
- func (c AuthClient) AddProjectMember(in ProjectMemberCreateRequest, id string) (ProjectMemberSingleResponse, *http.Response, error)
- func (c AuthClient) ChangeEmail(in EmailChangeRequest) (EmptyResponse, *http.Response, error)
- func (c AuthClient) ChangePassword(in PasswordChangeRequest) (EmptyResponse, *http.Response, error)
- func (c AuthClient) CreateProject(in ProjectCreateRequest) (ProjectSingleResponse, *http.Response, error)
- func (c AuthClient) CreateProjectInvite(in ProjectInviteCreateRequest) (ProjectInviteSingleResponse, *http.Response, error)
- func (c AuthClient) CreateToken(in TokenCreateRequest) (TokenSingleResponse, *http.Response, error)
- func (c AuthClient) CreateUser(in UserCreateRequest) (UserSingleResponse, *http.Response, error)
- func (c AuthClient) DeleteProject(id string) (EmptyResponse, *http.Response, error)
- func (c AuthClient) DeleteProjectInvite(id string) (EmptyResponse, *http.Response, error)
- func (c AuthClient) DeleteToken(id string) (EmptyResponse, *http.Response, error)
- func (c AuthClient) ExecutePasswordReset(in ExecutePasswordResetRequest) (EmptyResponse, *http.Response, error)
- func (c AuthClient) GetCountries(qParams GetCountriesQueryParams) (CountryListResponse, *http.Response, error)
- func (c AuthClient) GetCountry(code string) (CountrySingleResponse, *http.Response, error)
- func (c *AuthClient) GetCurrentProject() string
- func (c AuthClient) GetProject(id string, qParams GetProjectQueryParams) (ProjectSingleResponse, *http.Response, error)
- func (c AuthClient) GetProjectInvites(qParams GetProjectInvitesQueryParams) (ProjectInviteListResponse, *http.Response, error)
- func (c AuthClient) GetProjectMembers(id string, qParams GetProjectMembersQueryParams) (ProjectMemberListResponse, *http.Response, error)
- func (c AuthClient) GetProjects(qParams GetProjectsQueryParams) (ProjectListResponse, *http.Response, error)
- func (c AuthClient) GetToken(id string) (TokenSingleResponse, *http.Response, error)
- func (c AuthClient) GetTokens(qParams GetTokensQueryParams) (TokenListResponse, *http.Response, error)
- func (c AuthClient) GetUser(id string) (UserSingleResponse, *http.Response, error)
- func (c AuthClient) GetUserProjectMemberships(id string, qParams GetUserProjectMembershipsQueryParams) (ProjectMemberListResponse, *http.Response, error)
- func (c AuthClient) GetUsers(qParams GetUsersQueryParams) (UserListResponse, *http.Response, error)
- func (c AuthClient) InsertAuditLogEntry(in AuditLogRequest) (EmptyResponse, *http.Response, error)
- func (c AuthClient) Login(in LoginRequest) (LoginResponse, *http.Response, error)
- func (c AuthClient) RejectProjectInvite(id string) (EmptyResponse, *http.Response, error)
- func (c AuthClient) RemoveProjectMember(id string, user_id string) (EmptyResponse, *http.Response, error)
- func (c *AuthClient) Request(method string, path string, postBody io.Reader) (*http.Response, []byte, error)
- func (c AuthClient) RequestPasswordReset(in RequestPasswordResetRequest) (EmptyResponse, *http.Response, error)
- func (c AuthClient) SearchAuditLog(qParams SearchAuditLogQueryParams) (AuditLogEntryListResponse, *http.Response, error)
- func (c AuthClient) SearchTransactionLog(in TransactionLogRequest) (TransactionLogResponse, *http.Response, error)
- func (c *AuthClient) SetAccessToken(token string)
- func (c *AuthClient) SetCurrentProject(project string)
- func (c *AuthClient) SetHttpClient(client *http.Client)
- func (c AuthClient) UpdateProject(in ProjectUpdateRequest, id string) (ProjectSingleResponse, *http.Response, error)
- func (c AuthClient) UpdateUser(in UserUpdateRequest, id string) (UserSingleResponse, *http.Response, error)
- func (c AuthClient) ValidateSelf() (TokenValidationResponse, *http.Response, error)
- func (c AuthClient) ValidateToken(token string) (TokenValidationResponse, *http.Response, error)
- type Country
- type CountryListResponse
- type CountrySingleResponse
- type EmailChangeRequest
- type EmptyResponse
- type ExecutePasswordResetRequest
- type Gender
- type GetCountriesQueryParams
- type GetProjectInvitesQueryParams
- type GetProjectInvitesQueryParamsFilter
- type GetProjectMembersQueryParams
- type GetProjectMembersQueryParamsFilter
- type GetProjectQueryParams
- type GetProjectsQueryParams
- type GetProjectsQueryParamsFilter
- type GetTokensQueryParams
- type GetTokensQueryParamsFilter
- type GetUserProjectMembershipsQueryParams
- type GetUsersQueryParams
- type GetUsersQueryParamsFilter
- type InvalidRequestResponse
- type LoginRequest
- type LoginResponse
- type ObjectType
- type PasswordChangeRequest
- type Project
- type ProjectCreateRequest
- type ProjectInvite
- type ProjectInviteCreateRequest
- type ProjectInviteListResponse
- type ProjectInviteSingleResponse
- type ProjectListResponse
- type ProjectMember
- type ProjectMemberCreateRequest
- type ProjectMemberListResponse
- type ProjectMemberSingleResponse
- type ProjectSingleResponse
- type ProjectUpdateRequest
- type RequestPasswordResetRequest
- type ResponseMessage
- type ResponseMessages
- type ResponseMetadata
- type ResponsePagination
- type SearchAuditLogQueryParams
- type Token
- type TokenCreateRequest
- type TokenListResponse
- type TokenScope
- type TokenSingleResponse
- type TokenValidationInfo
- type TokenValidationResponse
- type TransactionLogRequest
- type TransactionLogResponse
- type User
- type UserCreateRequest
- type UserListResponse
- type UserSingleResponse
- type UserState
- type UserType
- type UserUpdateRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogEntry ¶
type AuditLogEntry struct { Date string `json:"date"` TokenId string `json:"token_id"` UserId string `json:"user_id"` ProjectId *string `json:"project_id"` ObjectType *ObjectType `json:"object_type"` Context interface{} `json:"context"` Action string `json:"action"` Id string `json:"id"` IpAddress *string `json:"ip_address"` ObjectId *string `json:"object_id"` }
type AuditLogEntryListResponse ¶
type AuditLogEntryListResponse struct { Metadata ResponseMetadata `json:"metadata"` Pagination *ResponsePagination `json:"pagination"` Data []AuditLogEntry `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type AuditLogRequest ¶
type AuthClient ¶
type AuthClient struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(apiKey string) AuthClient
func NewClientWithUrl ¶
func NewClientWithUrl(apiKey string, baseUrl string) AuthClient
func (AuthClient) AcceptProjectInvite ¶
func (c AuthClient) AcceptProjectInvite(id string) (EmptyResponse, *http.Response, error)
func (AuthClient) AddProjectMember ¶
func (c AuthClient) AddProjectMember(in ProjectMemberCreateRequest, id string) (ProjectMemberSingleResponse, *http.Response, error)
func (AuthClient) ChangeEmail ¶
func (c AuthClient) ChangeEmail(in EmailChangeRequest) (EmptyResponse, *http.Response, error)
func (AuthClient) ChangePassword ¶
func (c AuthClient) ChangePassword(in PasswordChangeRequest) (EmptyResponse, *http.Response, error)
func (AuthClient) CreateProject ¶
func (c AuthClient) CreateProject(in ProjectCreateRequest) (ProjectSingleResponse, *http.Response, error)
func (AuthClient) CreateProjectInvite ¶
func (c AuthClient) CreateProjectInvite(in ProjectInviteCreateRequest) (ProjectInviteSingleResponse, *http.Response, error)
func (AuthClient) CreateToken ¶
func (c AuthClient) CreateToken(in TokenCreateRequest) (TokenSingleResponse, *http.Response, error)
func (AuthClient) CreateUser ¶
func (c AuthClient) CreateUser(in UserCreateRequest) (UserSingleResponse, *http.Response, error)
func (AuthClient) DeleteProject ¶
func (c AuthClient) DeleteProject(id string) (EmptyResponse, *http.Response, error)
func (AuthClient) DeleteProjectInvite ¶
func (c AuthClient) DeleteProjectInvite(id string) (EmptyResponse, *http.Response, error)
func (AuthClient) DeleteToken ¶
func (c AuthClient) DeleteToken(id string) (EmptyResponse, *http.Response, error)
func (AuthClient) ExecutePasswordReset ¶
func (c AuthClient) ExecutePasswordReset(in ExecutePasswordResetRequest) (EmptyResponse, *http.Response, error)
func (AuthClient) GetCountries ¶
func (c AuthClient) GetCountries(qParams GetCountriesQueryParams) (CountryListResponse, *http.Response, error)
func (AuthClient) GetCountry ¶
func (c AuthClient) GetCountry(code string) (CountrySingleResponse, *http.Response, error)
func (*AuthClient) GetCurrentProject ¶
func (c *AuthClient) GetCurrentProject() string
func (AuthClient) GetProject ¶
func (c AuthClient) GetProject(id string, qParams GetProjectQueryParams) (ProjectSingleResponse, *http.Response, error)
func (AuthClient) GetProjectInvites ¶
func (c AuthClient) GetProjectInvites(qParams GetProjectInvitesQueryParams) (ProjectInviteListResponse, *http.Response, error)
func (AuthClient) GetProjectMembers ¶
func (c AuthClient) GetProjectMembers(id string, qParams GetProjectMembersQueryParams) (ProjectMemberListResponse, *http.Response, error)
func (AuthClient) GetProjects ¶
func (c AuthClient) GetProjects(qParams GetProjectsQueryParams) (ProjectListResponse, *http.Response, error)
func (AuthClient) GetToken ¶
func (c AuthClient) GetToken(id string) (TokenSingleResponse, *http.Response, error)
func (AuthClient) GetTokens ¶
func (c AuthClient) GetTokens(qParams GetTokensQueryParams) (TokenListResponse, *http.Response, error)
func (AuthClient) GetUser ¶
func (c AuthClient) GetUser(id string) (UserSingleResponse, *http.Response, error)
func (AuthClient) GetUserProjectMemberships ¶
func (c AuthClient) GetUserProjectMemberships(id string, qParams GetUserProjectMembershipsQueryParams) (ProjectMemberListResponse, *http.Response, error)
func (AuthClient) GetUsers ¶
func (c AuthClient) GetUsers(qParams GetUsersQueryParams) (UserListResponse, *http.Response, error)
func (AuthClient) InsertAuditLogEntry ¶
func (c AuthClient) InsertAuditLogEntry(in AuditLogRequest) (EmptyResponse, *http.Response, error)
func (AuthClient) Login ¶
func (c AuthClient) Login(in LoginRequest) (LoginResponse, *http.Response, error)
func (AuthClient) RejectProjectInvite ¶
func (c AuthClient) RejectProjectInvite(id string) (EmptyResponse, *http.Response, error)
func (AuthClient) RemoveProjectMember ¶
func (c AuthClient) RemoveProjectMember(id string, user_id string) (EmptyResponse, *http.Response, error)
func (AuthClient) RequestPasswordReset ¶
func (c AuthClient) RequestPasswordReset(in RequestPasswordResetRequest) (EmptyResponse, *http.Response, error)
func (AuthClient) SearchAuditLog ¶
func (c AuthClient) SearchAuditLog(qParams SearchAuditLogQueryParams) (AuditLogEntryListResponse, *http.Response, error)
func (AuthClient) SearchTransactionLog ¶
func (c AuthClient) SearchTransactionLog(in TransactionLogRequest) (TransactionLogResponse, *http.Response, error)
func (*AuthClient) SetAccessToken ¶
func (c *AuthClient) SetAccessToken(token string)
func (*AuthClient) SetCurrentProject ¶
func (c *AuthClient) SetCurrentProject(project string)
func (*AuthClient) SetHttpClient ¶
func (c *AuthClient) SetHttpClient(client *http.Client)
func (AuthClient) UpdateProject ¶
func (c AuthClient) UpdateProject(in ProjectUpdateRequest, id string) (ProjectSingleResponse, *http.Response, error)
func (AuthClient) UpdateUser ¶
func (c AuthClient) UpdateUser(in UserUpdateRequest, id string) (UserSingleResponse, *http.Response, error)
func (AuthClient) ValidateSelf ¶
func (c AuthClient) ValidateSelf() (TokenValidationResponse, *http.Response, error)
func (AuthClient) ValidateToken ¶
func (c AuthClient) ValidateToken(token string) (TokenValidationResponse, *http.Response, error)
type CountryListResponse ¶
type CountryListResponse struct { Metadata ResponseMetadata `json:"metadata"` Pagination *ResponsePagination `json:"pagination"` Data []Country `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type CountrySingleResponse ¶
type CountrySingleResponse struct { Metadata ResponseMetadata `json:"metadata"` Data Country `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type EmailChangeRequest ¶
type EmptyResponse ¶
type EmptyResponse struct { Metadata ResponseMetadata `json:"metadata"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type GetCountriesQueryParams ¶
type GetProjectInvitesQueryParams ¶
type GetProjectInvitesQueryParams struct { Order *string `url:"order,omitempty"` Filter *GetProjectInvitesQueryParamsFilter `url:"filter,omitempty"` PageSize *int `url:"page_size,omitempty"` OrderBy *string `url:"order_by,omitempty"` Search *string `url:"search,omitempty"` Page *int `url:"page,omitempty"` }
type GetProjectMembersQueryParams ¶
type GetProjectMembersQueryParams struct { Order *string `url:"order,omitempty"` Filter *GetProjectMembersQueryParamsFilter `url:"filter,omitempty"` PageSize *int `url:"page_size,omitempty"` OrderBy *string `url:"order_by,omitempty"` Search *string `url:"search,omitempty"` Page *int `url:"page,omitempty"` }
type GetProjectMembersQueryParamsFilter ¶
type GetProjectMembersQueryParamsFilter struct {
Role *string `url:"role,omitempty"`
}
type GetProjectQueryParams ¶
type GetProjectQueryParams struct {
Detail *bool `url:"detail,omitempty"`
}
type GetProjectsQueryParams ¶
type GetProjectsQueryParams struct { Order *string `url:"order,omitempty"` Filter *GetProjectsQueryParamsFilter `url:"filter,omitempty"` PageSize *int `url:"page_size,omitempty"` OrderBy *string `url:"order_by,omitempty"` Search *string `url:"search,omitempty"` Page *int `url:"page,omitempty"` Detail *bool `url:"detail,omitempty"` }
type GetTokensQueryParams ¶
type GetUsersQueryParams ¶
type InvalidRequestResponse ¶
type InvalidRequestResponse struct { Metadata ResponseMetadata `json:"metadata"` Data interface{} `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type LoginRequest ¶
type LoginResponse ¶
type LoginResponse struct { Metadata ResponseMetadata `json:"metadata"` Data Token `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type ObjectType ¶
type ObjectType string
type PasswordChangeRequest ¶
type ProjectCreateRequest ¶
type ProjectCreateRequest struct {
Title string `json:"title"`
}
type ProjectInvite ¶
type ProjectInviteListResponse ¶
type ProjectInviteListResponse struct { Metadata ResponseMetadata `json:"metadata"` Pagination *ResponsePagination `json:"pagination"` Data []ProjectInvite `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type ProjectInviteSingleResponse ¶
type ProjectInviteSingleResponse struct { Metadata string `json:"metadata"` Data ProjectInvite `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type ProjectListResponse ¶
type ProjectListResponse struct { Metadata ResponseMetadata `json:"metadata"` Pagination *ResponsePagination `json:"pagination"` Data []Project `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type ProjectMember ¶
type ProjectMemberListResponse ¶
type ProjectMemberListResponse struct { Metadata ResponseMetadata `json:"metadata"` Pagination *ResponsePagination `json:"pagination"` Data []ProjectMember `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type ProjectMemberSingleResponse ¶
type ProjectMemberSingleResponse struct { Metadata ResponseMetadata `json:"metadata"` Data ProjectMember `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type ProjectSingleResponse ¶
type ProjectSingleResponse struct { Metadata ResponseMetadata `json:"metadata"` Data Project `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type ProjectUpdateRequest ¶
type ProjectUpdateRequest struct {
Title *string `json:"title"`
}
type RequestPasswordResetRequest ¶
type RequestPasswordResetRequest struct {
Username string `json:"username"`
}
type ResponseMessage ¶
type ResponseMessages ¶
type ResponseMessages struct { Warnings []ResponseMessage `json:"warnings"` Errors []ResponseMessage `json:"errors"` Infos []ResponseMessage `json:"infos"` }
type ResponseMetadata ¶
type ResponsePagination ¶
type TokenCreateRequest ¶
type TokenCreateRequest struct { UserId *string `json:"user_id"` Scope *TokenScope `json:"scope"` Title string `json:"title"` }
type TokenListResponse ¶
type TokenListResponse struct { Metadata ResponseMetadata `json:"metadata"` Pagination *ResponsePagination `json:"pagination"` Data []Token `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type TokenScope ¶
type TokenScope struct {
ProjectId *string `json:"project_id"`
}
type TokenSingleResponse ¶
type TokenSingleResponse struct { Metadata ResponseMetadata `json:"metadata"` Data Token `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type TokenValidationInfo ¶
type TokenValidationInfo struct { ProjectMemberships []ProjectMember `json:"project_memberships"` User User `json:"user"` Token Token `json:"token"` }
type TokenValidationResponse ¶
type TokenValidationResponse struct { Metadata ResponseMetadata `json:"metadata"` Data TokenValidationInfo `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type TransactionLogRequest ¶
type TransactionLogRequest struct { Query interface{} `json:"query"` Limit *int `json:"limit"` Sort interface{} `json:"sort"` }
type TransactionLogResponse ¶
type TransactionLogResponse struct { Metadata ResponseMetadata `json:"metadata"` Data []interface{} `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type UserCreateRequest ¶
type UserListResponse ¶
type UserListResponse struct { Metadata ResponseMetadata `json:"metadata"` Pagination *ResponsePagination `json:"pagination"` Data []User `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type UserSingleResponse ¶
type UserSingleResponse struct { Metadata ResponseMetadata `json:"metadata"` Data User `json:"data"` Success bool `json:"success"` Messages ResponseMessages `json:"messages"` }
type UserUpdateRequest ¶
type UserUpdateRequest struct { Password *string `json:"password"` Gender *Gender `json:"gender"` LastName *string `json:"last_name"` Company *string `json:"company"` State *UserState `json:"state"` Type *UserType `json:"type"` CustomerId *string `json:"customer_id"` FirstName *string `json:"first_name"` Email *string `json:"email"` }
Click to show internal directories.
Click to hide internal directories.