Skip to content

AuthenticationUsersAPI.md

Latest commit

 

History

History
204 lines (130 loc) · 5.27 KB

AuthenticationUsersAPI.md

File metadata and controls

204 lines (130 loc) · 5.27 KB

AuthenticationUsersAPI

All URIs are relative to https://api.reveng.ai

Method HTTP request Description
GetUser Get /v2/users/{user_id} Get a user's public information
GetUserActivity Get /v2/users/activity Get auth user activity
SubmitUserFeedback Post /v2/users/feedback Submit feedback about the application

GetUser

BaseResponseGetPublicUserResponse GetUser(ctx, userId).Execute()

Get a user's public information

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v3"
)

func main() {
	userId := int32(56) // int32 | 

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.GetUser(context.Background(), userId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.GetUser``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUser`: BaseResponseGetPublicUserResponse
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.GetUser`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId int32

Other Parameters

Other parameters are passed through a pointer to a apiGetUserRequest struct via the builder pattern

Name Type Description Notes

Return type

BaseResponseGetPublicUserResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUserActivity

BaseResponseListUserActivityResponse GetUserActivity(ctx).Execute()

Get auth user activity

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v3"
)

func main() {

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.GetUserActivity(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.GetUserActivity``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUserActivity`: BaseResponseListUserActivityResponse
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.GetUserActivity`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetUserActivityRequest struct via the builder pattern

Return type

BaseResponseListUserActivityResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SubmitUserFeedback

BaseResponse SubmitUserFeedback(ctx).SubmitUserFeedbackRequest(submitUserFeedbackRequest).Execute()

Submit feedback about the application

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v3"
)

func main() {
	submitUserFeedbackRequest := *revengai.NewSubmitUserFeedbackRequest("CurrentRoute_example", "Feedback_example") // SubmitUserFeedbackRequest | 

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.SubmitUserFeedback(context.Background()).SubmitUserFeedbackRequest(submitUserFeedbackRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.SubmitUserFeedback``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SubmitUserFeedback`: BaseResponse
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.SubmitUserFeedback`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSubmitUserFeedbackRequest struct via the builder pattern

Name Type Description Notes
submitUserFeedbackRequest SubmitUserFeedbackRequest

Return type

BaseResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]