Skip to content

Latest commit

 

History

History
677 lines (426 loc) · 21.4 KB

AccountNotificationsAPI.md

File metadata and controls

677 lines (426 loc) · 21.4 KB

\AccountNotificationsAPI

All URIs are relative to https://up.go-adserver.com

Method HTTP request Description
ApiV1AccountNotificationDestinationsGet Get /api/v1/account/notification-destinations The account's notification destinations.
ApiV1AccountNotificationDestinationsIdDelete Delete /api/v1/account/notification-destinations/{id} Delete a notification destination.
ApiV1AccountNotificationDestinationsIdStatusGet Get /api/v1/account/notification-destinations/{id}/status Whether a destination is linked.
ApiV1AccountNotificationDestinationsIdTestPost Post /api/v1/account/notification-destinations/{id}/test Send a test message to a destination.
ApiV1AccountNotificationDestinationsPost Post /api/v1/account/notification-destinations Add a notification destination.
ApiV1AccountNotificationPreferencesGet Get /api/v1/account/notification-preferences Per-event channel preferences.
ApiV1AccountNotificationPreferencesPut Put /api/v1/account/notification-preferences Save channel preferences.
ApiV1AccountNotificationsGet Get /api/v1/account/notifications The in-app notification feed.
ApiV1AccountNotificationsReadPost Post /api/v1/account/notifications/read Mark notifications read.
ApiV1AccountNotificationsUnreadCountGet Get /api/v1/account/notifications/unread-count Unread notification count.

ApiV1AccountNotificationDestinationsGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNotificationDestinationsGet(ctx).Execute()

The account's notification destinations.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1AccountNotificationDestinationsIdDelete

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNotificationDestinationsIdDelete(ctx, id).Execute()

Delete a notification destination.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | Destination ID.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1AccountNotificationDestinationsIdStatusGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNotificationDestinationsIdStatusGet(ctx, id).Execute()

Whether a destination is linked.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | Destination ID.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1AccountNotificationDestinationsIdTestPost

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNotificationDestinationsIdTestPost(ctx, id).Execute()

Send a test message to a destination.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | Destination ID.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1AccountNotificationDestinationsPost

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNotificationDestinationsPost(ctx).ApiV1AccountNotificationDestinationsPostRequest(apiV1AccountNotificationDestinationsPostRequest).Execute()

Add a notification destination.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1AccountNotificationDestinationsPostRequest := *openapiclient.NewApiV1AccountNotificationDestinationsPostRequest("Kind_example") // ApiV1AccountNotificationDestinationsPostRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
apiV1AccountNotificationDestinationsPostRequest ApiV1AccountNotificationDestinationsPostRequest

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1AccountNotificationPreferencesGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNotificationPreferencesGet(ctx).Execute()

Per-event channel preferences.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1AccountNotificationPreferencesPut

ApiV1WebhooksIdDelete200Response ApiV1AccountNotificationPreferencesPut(ctx).ApiV1AccountNotificationPreferencesPutRequest(apiV1AccountNotificationPreferencesPutRequest).Execute()

Save channel preferences.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1AccountNotificationPreferencesPutRequest := *openapiclient.NewApiV1AccountNotificationPreferencesPutRequest() // ApiV1AccountNotificationPreferencesPutRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
apiV1AccountNotificationPreferencesPutRequest ApiV1AccountNotificationPreferencesPutRequest

Return type

ApiV1WebhooksIdDelete200Response

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]

ApiV1AccountNotificationsGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNotificationsGet(ctx).Limit(limit).Unread(unread).Execute()

The in-app notification feed.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	limit := int32(56) // int32 | Rows to return. (optional)
	unread := "unread_example" // string | Pass 1 to return only unread items. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccountNotificationsAPI.ApiV1AccountNotificationsGet(context.Background()).Limit(limit).Unread(unread).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccountNotificationsAPI.ApiV1AccountNotificationsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1AccountNotificationsGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `AccountNotificationsAPI.ApiV1AccountNotificationsGet`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
limit int32 Rows to return.
unread string Pass 1 to return only unread items.

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1AccountNotificationsReadPost

ApiV1WebhooksIdDelete200Response ApiV1AccountNotificationsReadPost(ctx).ApiV1AccountNotificationsReadPostRequest(apiV1AccountNotificationsReadPostRequest).Execute()

Mark notifications read.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1AccountNotificationsReadPostRequest := *openapiclient.NewApiV1AccountNotificationsReadPostRequest() // ApiV1AccountNotificationsReadPostRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
apiV1AccountNotificationsReadPostRequest ApiV1AccountNotificationsReadPostRequest

Return type

ApiV1WebhooksIdDelete200Response

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]

ApiV1AccountNotificationsUnreadCountGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNotificationsUnreadCountGet(ctx).Execute()

Unread notification count.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]