UserNotificationsAPI.md

\UserNotificationsAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
UserNotificationsClearNotifications	Delete /api/manage/v1/notifications	Use this endpoint to "clear" your notifications
UserNotificationsGetNotifications	Get /api/manage/v1/notifications	Use this endpoint to recieve notifications

UserNotificationsClearNotifications

UserNotificationsClearNotifications(ctx).ClearNotificationsVM(clearNotificationsVM).Execute()

Use this endpoint to "clear" your notifications

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	clearNotificationsVM := *openapiclient.NewClearNotificationsVM("T_example") // ClearNotificationsVM |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.UserNotificationsAPI.UserNotificationsClearNotifications(context.Background()).ClearNotificationsVM(clearNotificationsVM).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UserNotificationsAPI.UserNotificationsClearNotifications``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
clearNotificationsVM	ClearNotificationsVM

Return type

(empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

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

UserNotificationsGetNotifications

AuditActionsVM UserNotificationsGetNotifications(ctx).Skip(skip).Take(take).SubscriptionId(subscriptionId).Execute()

Use this endpoint to recieve notifications

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	skip := int32(56) // int32 |  (optional) (default to 0)
	take := int32(56) // int32 |  (optional) (default to 5)
	subscriptionId := "subscriptionId_example" // string |  (optional) (default to "")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.UserNotificationsAPI.UserNotificationsGetNotifications(context.Background()).Skip(skip).Take(take).SubscriptionId(subscriptionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UserNotificationsAPI.UserNotificationsGetNotifications``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UserNotificationsGetNotifications`: AuditActionsVM
	fmt.Fprintf(os.Stdout, "Response from `UserNotificationsAPI.UserNotificationsGetNotifications`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
skip	int32		[default to 0]
take	int32		[default to 5]
subscriptionId	string		[default to ""]

Return type

AuditActionsVM

Authorization

ApiKey, JWT

HTTP request headers

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

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