Documentation ¶
Index ¶
- Constants
- type CreateNotificationPublisherInput
- type DeleteNotificationPublisherInput
- type GetActionInput
- type GetActionsInput
- type GetNotificationPublisherInput
- type GetNotificationPublisherPluginDescriptorInput
- type InvokeActionInput
- type NotificationPublishersAPI
- type NotificationPublishersService
- func (s *NotificationPublishersService) CreateNotificationPublisher(input *CreateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
- func (s *NotificationPublishersService) CreateNotificationPublisherWithContext(ctx context.Context, input *CreateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
- func (s *NotificationPublishersService) DeleteNotificationPublisher(input *DeleteNotificationPublisherInput) (output *models.ApiResult, resp *http.Response, err error)
- func (s *NotificationPublishersService) DeleteNotificationPublisherWithContext(ctx context.Context, input *DeleteNotificationPublisherInput) (output *models.ApiResult, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetAction(input *GetActionInput) (output *models.Action, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetActionWithContext(ctx context.Context, input *GetActionInput) (output *models.Action, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetActions(input *GetActionsInput) (output *models.Actions, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetActionsWithContext(ctx context.Context, input *GetActionsInput) (output *models.Actions, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetNotificationPublisher(input *GetNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetNotificationPublisherPluginDescriptor(input *GetNotificationPublisherPluginDescriptorInput) (output *models.NotificationPublisherDescriptor, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetNotificationPublisherPluginDescriptorWithContext(ctx context.Context, input *GetNotificationPublisherPluginDescriptorInput) (output *models.NotificationPublisherDescriptor, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetNotificationPublisherPluginDescriptors() (output *models.NotificationPublisherDescriptors, resp *http.Response, ...)
- func (s *NotificationPublishersService) GetNotificationPublisherPluginDescriptorsWithContext(ctx context.Context) (output *models.NotificationPublisherDescriptors, resp *http.Response, ...)
- func (s *NotificationPublishersService) GetNotificationPublisherWithContext(ctx context.Context, input *GetNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetNotificationPublishers() (output *models.NotificationPublishers, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetNotificationPublishersWithContext(ctx context.Context) (output *models.NotificationPublishers, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetSettings() (output *models.NotificationPublishersSettings, resp *http.Response, err error)
- func (s *NotificationPublishersService) GetSettingsWithContext(ctx context.Context) (output *models.NotificationPublishersSettings, resp *http.Response, err error)
- func (s *NotificationPublishersService) InvokeAction(input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error)
- func (s *NotificationPublishersService) InvokeActionWithContext(ctx context.Context, input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error)
- func (s *NotificationPublishersService) UpdateNotificationPublisher(input *UpdateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
- func (s *NotificationPublishersService) UpdateNotificationPublisherWithContext(ctx context.Context, input *UpdateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
- func (s *NotificationPublishersService) UpdateSettings(input *UpdateSettingsInput) (output *models.NotificationPublishersSettings, resp *http.Response, err error)
- func (s *NotificationPublishersService) UpdateSettingsWithContext(ctx context.Context, input *UpdateSettingsInput) (output *models.NotificationPublishersSettings, resp *http.Response, err error)
- type UpdateNotificationPublisherInput
- type UpdateSettingsInput
Constants ¶
const (
// ServiceName - The name of service.
ServiceName = "NotificationPublishers"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateNotificationPublisherInput ¶
type CreateNotificationPublisherInput struct {
Body models.NotificationPublisher
}
type DeleteNotificationPublisherInput ¶
type DeleteNotificationPublisherInput struct {
Id string
}
type GetActionInput ¶
type GetActionsInput ¶
type GetActionsInput struct {
Id string
}
type GetNotificationPublisherInput ¶
type GetNotificationPublisherInput struct {
Id string
}
type GetNotificationPublisherPluginDescriptorInput ¶
type GetNotificationPublisherPluginDescriptorInput struct {
Id string
}
type InvokeActionInput ¶
type NotificationPublishersAPI ¶
type NotificationPublishersAPI interface { GetSettings() (output *models.NotificationPublishersSettings, resp *http.Response, err error) GetSettingsWithContext(ctx context.Context) (output *models.NotificationPublishersSettings, resp *http.Response, err error) UpdateSettings(input *UpdateSettingsInput) (output *models.NotificationPublishersSettings, resp *http.Response, err error) UpdateSettingsWithContext(ctx context.Context, input *UpdateSettingsInput) (output *models.NotificationPublishersSettings, resp *http.Response, err error) GetNotificationPublisherPluginDescriptors() (output *models.NotificationPublisherDescriptors, resp *http.Response, err error) GetNotificationPublisherPluginDescriptorsWithContext(ctx context.Context) (output *models.NotificationPublisherDescriptors, resp *http.Response, err error) GetNotificationPublisherPluginDescriptor(input *GetNotificationPublisherPluginDescriptorInput) (output *models.NotificationPublisherDescriptor, resp *http.Response, err error) GetNotificationPublisherPluginDescriptorWithContext(ctx context.Context, input *GetNotificationPublisherPluginDescriptorInput) (output *models.NotificationPublisherDescriptor, resp *http.Response, err error) GetNotificationPublishers() (output *models.NotificationPublishers, resp *http.Response, err error) GetNotificationPublishersWithContext(ctx context.Context) (output *models.NotificationPublishers, resp *http.Response, err error) CreateNotificationPublisher(input *CreateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error) CreateNotificationPublisherWithContext(ctx context.Context, input *CreateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error) GetNotificationPublisher(input *GetNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error) GetNotificationPublisherWithContext(ctx context.Context, input *GetNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error) UpdateNotificationPublisher(input *UpdateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error) UpdateNotificationPublisherWithContext(ctx context.Context, input *UpdateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error) DeleteNotificationPublisher(input *DeleteNotificationPublisherInput) (output *models.ApiResult, resp *http.Response, err error) DeleteNotificationPublisherWithContext(ctx context.Context, input *DeleteNotificationPublisherInput) (output *models.ApiResult, resp *http.Response, err error) GetActions(input *GetActionsInput) (output *models.Actions, resp *http.Response, err error) GetActionsWithContext(ctx context.Context, input *GetActionsInput) (output *models.Actions, resp *http.Response, err error) GetAction(input *GetActionInput) (output *models.Action, resp *http.Response, err error) GetActionWithContext(ctx context.Context, input *GetActionInput) (output *models.Action, resp *http.Response, err error) InvokeAction(input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error) InvokeActionWithContext(ctx context.Context, input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error) }
type NotificationPublishersService ¶
func New ¶
func New(cfg *config.Config) *NotificationPublishersService
New creates a new instance of the NotificationPublishersService client.
func (*NotificationPublishersService) CreateNotificationPublisher ¶
func (s *NotificationPublishersService) CreateNotificationPublisher(input *CreateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
CreateNotificationPublisher - Create a notification publisher plugin instance. RequestType: POST Input: input *CreateNotificationPublisherInput
func (*NotificationPublishersService) CreateNotificationPublisherWithContext ¶
func (s *NotificationPublishersService) CreateNotificationPublisherWithContext(ctx context.Context, input *CreateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
CreateNotificationPublisherWithContext - Create a notification publisher plugin instance. RequestType: POST Input: ctx context.Context, input *CreateNotificationPublisherInput
func (*NotificationPublishersService) DeleteNotificationPublisher ¶
func (s *NotificationPublishersService) DeleteNotificationPublisher(input *DeleteNotificationPublisherInput) (output *models.ApiResult, resp *http.Response, err error)
DeleteNotificationPublisher - Delete a notification publisher plugin instance. RequestType: DELETE Input: input *DeleteNotificationPublisherInput
func (*NotificationPublishersService) DeleteNotificationPublisherWithContext ¶
func (s *NotificationPublishersService) DeleteNotificationPublisherWithContext(ctx context.Context, input *DeleteNotificationPublisherInput) (output *models.ApiResult, resp *http.Response, err error)
DeleteNotificationPublisherWithContext - Delete a notification publisher plugin instance. RequestType: DELETE Input: ctx context.Context, input *DeleteNotificationPublisherInput
func (*NotificationPublishersService) GetAction ¶
func (s *NotificationPublishersService) GetAction(input *GetActionInput) (output *models.Action, resp *http.Response, err error)
GetAction - Find an notification publisher plugin instance's action by ID. RequestType: GET Input: input *GetActionInput
func (*NotificationPublishersService) GetActionWithContext ¶
func (s *NotificationPublishersService) GetActionWithContext(ctx context.Context, input *GetActionInput) (output *models.Action, resp *http.Response, err error)
GetActionWithContext - Find an notification publisher plugin instance's action by ID. RequestType: GET Input: ctx context.Context, input *GetActionInput
func (*NotificationPublishersService) GetActions ¶
func (s *NotificationPublishersService) GetActions(input *GetActionsInput) (output *models.Actions, resp *http.Response, err error)
GetActions - List the actions for a notification publisher plugin instance. RequestType: GET Input: input *GetActionsInput
func (*NotificationPublishersService) GetActionsWithContext ¶
func (s *NotificationPublishersService) GetActionsWithContext(ctx context.Context, input *GetActionsInput) (output *models.Actions, resp *http.Response, err error)
GetActionsWithContext - List the actions for a notification publisher plugin instance. RequestType: GET Input: ctx context.Context, input *GetActionsInput
func (*NotificationPublishersService) GetNotificationPublisher ¶
func (s *NotificationPublishersService) GetNotificationPublisher(input *GetNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
GetNotificationPublisher - Get a specific notification publisher plugin instance. RequestType: GET Input: input *GetNotificationPublisherInput
func (*NotificationPublishersService) GetNotificationPublisherPluginDescriptor ¶
func (s *NotificationPublishersService) GetNotificationPublisherPluginDescriptor(input *GetNotificationPublisherPluginDescriptorInput) (output *models.NotificationPublisherDescriptor, resp *http.Response, err error)
GetNotificationPublisherPluginDescriptor - Get the description of a notification publisher plugin descriptor. RequestType: GET Input: input *GetNotificationPublisherPluginDescriptorInput
func (*NotificationPublishersService) GetNotificationPublisherPluginDescriptorWithContext ¶
func (s *NotificationPublishersService) GetNotificationPublisherPluginDescriptorWithContext(ctx context.Context, input *GetNotificationPublisherPluginDescriptorInput) (output *models.NotificationPublisherDescriptor, resp *http.Response, err error)
GetNotificationPublisherPluginDescriptorWithContext - Get the description of a notification publisher plugin descriptor. RequestType: GET Input: ctx context.Context, input *GetNotificationPublisherPluginDescriptorInput
func (*NotificationPublishersService) GetNotificationPublisherPluginDescriptors ¶
func (s *NotificationPublishersService) GetNotificationPublisherPluginDescriptors() (output *models.NotificationPublisherDescriptors, resp *http.Response, err error)
GetNotificationPublisherPluginDescriptors - Get the list of available Notification Publisher Plugin descriptors. RequestType: GET Input:
func (*NotificationPublishersService) GetNotificationPublisherPluginDescriptorsWithContext ¶
func (s *NotificationPublishersService) GetNotificationPublisherPluginDescriptorsWithContext(ctx context.Context) (output *models.NotificationPublisherDescriptors, resp *http.Response, err error)
GetNotificationPublisherPluginDescriptorsWithContext - Get the list of available Notification Publisher Plugin descriptors. RequestType: GET Input: ctx context.Context,
func (*NotificationPublishersService) GetNotificationPublisherWithContext ¶
func (s *NotificationPublishersService) GetNotificationPublisherWithContext(ctx context.Context, input *GetNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
GetNotificationPublisherWithContext - Get a specific notification publisher plugin instance. RequestType: GET Input: ctx context.Context, input *GetNotificationPublisherInput
func (*NotificationPublishersService) GetNotificationPublishers ¶
func (s *NotificationPublishersService) GetNotificationPublishers() (output *models.NotificationPublishers, resp *http.Response, err error)
GetNotificationPublishers - Get a list of notification publisher plugin instances. RequestType: GET Input:
func (*NotificationPublishersService) GetNotificationPublishersWithContext ¶
func (s *NotificationPublishersService) GetNotificationPublishersWithContext(ctx context.Context) (output *models.NotificationPublishers, resp *http.Response, err error)
GetNotificationPublishersWithContext - Get a list of notification publisher plugin instances. RequestType: GET Input: ctx context.Context,
func (*NotificationPublishersService) GetSettings ¶
func (s *NotificationPublishersService) GetSettings() (output *models.NotificationPublishersSettings, resp *http.Response, err error)
GetSettings - Get general notification publisher settings. RequestType: GET Input:
func (*NotificationPublishersService) GetSettingsWithContext ¶
func (s *NotificationPublishersService) GetSettingsWithContext(ctx context.Context) (output *models.NotificationPublishersSettings, resp *http.Response, err error)
GetSettingsWithContext - Get general notification publisher settings. RequestType: GET Input: ctx context.Context,
func (*NotificationPublishersService) InvokeAction ¶
func (s *NotificationPublishersService) InvokeAction(input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error)
InvokeAction - Invokes an action for notification publisher plugin instance. RequestType: POST Input: input *InvokeActionInput
func (*NotificationPublishersService) InvokeActionWithContext ¶
func (s *NotificationPublishersService) InvokeActionWithContext(ctx context.Context, input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error)
InvokeActionWithContext - Invokes an action for notification publisher plugin instance. RequestType: POST Input: ctx context.Context, input *InvokeActionInput
func (*NotificationPublishersService) UpdateNotificationPublisher ¶
func (s *NotificationPublishersService) UpdateNotificationPublisher(input *UpdateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
UpdateNotificationPublisher - Update a notification publisher plugin instance. RequestType: PUT Input: input *UpdateNotificationPublisherInput
func (*NotificationPublishersService) UpdateNotificationPublisherWithContext ¶
func (s *NotificationPublishersService) UpdateNotificationPublisherWithContext(ctx context.Context, input *UpdateNotificationPublisherInput) (output *models.NotificationPublisher, resp *http.Response, err error)
UpdateNotificationPublisherWithContext - Update a notification publisher plugin instance. RequestType: PUT Input: ctx context.Context, input *UpdateNotificationPublisherInput
func (*NotificationPublishersService) UpdateSettings ¶
func (s *NotificationPublishersService) UpdateSettings(input *UpdateSettingsInput) (output *models.NotificationPublishersSettings, resp *http.Response, err error)
UpdateSettings - Update general notification publisher settings. RequestType: PUT Input: input *UpdateSettingsInput
func (*NotificationPublishersService) UpdateSettingsWithContext ¶
func (s *NotificationPublishersService) UpdateSettingsWithContext(ctx context.Context, input *UpdateSettingsInput) (output *models.NotificationPublishersSettings, resp *http.Response, err error)
UpdateSettingsWithContext - Update general notification publisher settings. RequestType: PUT Input: ctx context.Context, input *UpdateSettingsInput
type UpdateNotificationPublisherInput ¶
type UpdateNotificationPublisherInput struct { Body models.NotificationPublisher Id string }
type UpdateSettingsInput ¶
type UpdateSettingsInput struct {
Body models.NotificationPublishersSettings
}