Skip to content

Latest commit

 

History

History
206 lines (130 loc) · 5.29 KB

NotificationsAPI.md

File metadata and controls

206 lines (130 loc) · 5.29 KB

\NotificationsAPI

All URIs are relative to http://localhost

Method HTTP request Description
GetNotificationLogGet Get /notifications/{id}
GetNotificationLogGetAll Get /notifications
PostNotificationLogResend Post /notifications/{id}/resend

GetNotificationLogGet

NotificationSchema GetNotificationLogGet(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    id := "id_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

NotificationSchema

Authorization

auth_token

HTTP request headers

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

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

GetNotificationLogGetAll

PaginationSchema GetNotificationLogGetAll(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

PaginationSchema

Authorization

auth_token

HTTP request headers

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

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

PostNotificationLogResend

NotificationSchema PostNotificationLogResend(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    id := "id_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

NotificationSchema

Authorization

auth_token

HTTP request headers

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

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