Documentation
¶
Index ¶
- type APIClient
- type APIError
- type AlertsManager
- type AuditLogsManager
- type ClientOptions
- type ContactsManager
- type EscalationsManager
- type ForwardingRulesManager
- type HeartbeatsManager
- type IntegrationActionsManager
- type IntegrationFiltersManager
- type IntegrationsManager
- type JECManager
- type LogLevel
- type MaintenancesManager
- type NotificationRuleStepsManager
- type NotificationRulesManager
- type PoliciesManager
- type RolesManager
- type RoutingRulesManager
- type SchedulesManager
- type SchedulesOnCallsManager
- type SchedulesOverridesManager
- type SchedulesRotationsManager
- type SchedulesTimelinesManager
- type SyncsActionGroupsManager
- type SyncsActionsManager
- type SyncsManager
- type TeamPoliciesManager
- type TeamRolesManager
- type TeamsManager
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIClient ¶
type APIClient struct {
Alert AlertsManager
AuditLogs AuditLogsManager
Contacts ContactsManager
Teams TeamsManager
Roles RolesManager
Escalations EscalationsManager
ForwardingRules ForwardingRulesManager
Heartbeats HeartbeatsManager
Integrations IntegrationsManager
IntegrationActions IntegrationActionsManager
IntegrationFilters IntegrationFiltersManager
Maintenances MaintenancesManager
NotificationRules NotificationRulesManager
NotificationRuleSteps NotificationRuleStepsManager
Policies PoliciesManager
TeamPolicies TeamPoliciesManager
TeamRoles TeamRolesManager
RoutingRules RoutingRulesManager
Schedules SchedulesManager
SchedulesOnCalls SchedulesOnCallsManager
SchedulesOverrides SchedulesOverridesManager
SchedulesRotations SchedulesRotationsManager
SchedulesTimelines SchedulesTimelinesManager
Syncs SyncsManager
SyncsActions SyncsActionsManager
SyncsActionGroups SyncsActionGroupsManager
JEC JECManager
// contains filtered or unexported fields
}
APIClient ...
func Init ¶
func Init(cloudID, apiToken, userName string, options *ClientOptions) *APIClient
Init initializes the package
func (*APIClient) BackupJSON ¶
BackupJSON ...
type APIError ¶
type APIError struct {
APIError string
// contains filtered or unexported fields
}
APIError ...
type AlertsManager ¶
type AlertsManager interface {
GetRequestStatus(*alert.GetRequestStatusRequest) (*alert.RequestStatusResponse, error)
CreateAlert(*alert.CreateAlertRequest) (*alert.SuccessResponse, error)
ListAlerts(*alert.ListAlertsRequest) (*alert.ListAlertsResult, error)
GetAlert(*alert.GetAlertRequest) (*alert.Alert, error)
DeleteAlert(*alert.DeleteAlertRequest) error
GetAlertByAlias(*alert.GetAlertByAliasRequest) (*alert.Alert, error)
AcknowledgeAlert(*alert.AcknowledgeAlertRequest) (*alert.SuccessResponse, error)
AssignAlert(*alert.AssignAlertRequest) (*alert.SuccessResponse, error)
AddResponder(*alert.AddResponderRequest) (*alert.SuccessResponse, error)
AddExtraProperties(*alert.AddExtraPropertiesRequest) (*alert.SuccessResponse, error)
DeleteExtraProperties(*alert.DeleteExtraPropertiesRequest) error
AddTags(*alert.AddTagsRequest) (*alert.SuccessResponse, error)
DeleteTags(*alert.DeleteTagsRequest) error
CloseAlert(*alert.CloseAlertRequest) (*alert.SuccessResponse, error)
EscalateAlert(*alert.EscalateAlertRequest) (*alert.SuccessResponse, error)
ExecuteCustomAction(*alert.ExecuteCustomActionRequest) (*alert.SuccessResponse, error)
SnoozeAlert(*alert.SnoozeAlertRequest) (*alert.SuccessResponse, error)
UnacknowledgeAlert(*alert.UnacknowledgeAlertRequest) (*alert.SuccessResponse, error)
ListAlertNotes(*alert.ListAlertNotesRequest) (*alert.ListAlertNotesResult, error)
AddAlertNote(*alert.AddNoteRequest) (*alert.AddNoteResponse, error)
DeleteAlertNote(*alert.DeleteAlertNoteRequest) error
UpdateAlertNote(*alert.UpdateAlertNoteRequest) (*alert.AlertNote, error)
UpdateAlertPriority(*alert.UpdateAlertPriorityRequest) (*alert.SuccessResponse, error)
UpdateAlertMessage(*alert.UpdateAlertMessageRequest) (*alert.SuccessResponse, error)
UpdateAlertDescription(*alert.UpdateAlertDescriptionRequest) (*alert.SuccessResponse, error)
ListAlertLogs(*alert.ListAlertLogsRequest) (*alert.ListAlertLogsResult, error)
}
type AuditLogsManager ¶ added in v1.0.0
type AuditLogsManager interface {
GetAuditLogs(*auditlogs.GetAuditLogsRequest) (*auditlogs.ListAuditLogsResult, error)
}
type ContactsManager ¶ added in v1.0.0
type ContactsManager interface {
ListContacts(*contacts.ListContactsRequest) (*contacts.ListContactsResult, error)
CreateContact(*contacts.CreateContactRequest) (*contacts.Contact, error)
GetContact(*contacts.GetContactRequest) (*contacts.Contact, error)
DeleteContact(*contacts.DeleteContactRequest) error
UpdateContact(*contacts.UpdateContactRequest) (*contacts.Contact, error)
ActivateContact(*contacts.ActivateContactRequest) (*contacts.Contact, error)
DeactivateContact(*contacts.DeactivateContactRequest) (*contacts.Contact, error)
}
type EscalationsManager ¶ added in v1.0.0
type EscalationsManager interface {
ListEscalations(*escalations.ListEscalationsRequest) (*escalations.ListEscalationsResult, error)
CreateEscalation(*escalations.CreateEscalationRequest) (*escalations.Escalation, error)
GetEscalation(*escalations.GetEscalationRequest) (*escalations.Escalation, error)
UpdateEscalation(*escalations.UpdateEscalationRequest) (*escalations.Escalation, error)
DeleteEscalation(*escalations.DeleteEscalationRequest) error
}
type ForwardingRulesManager ¶ added in v1.0.0
type ForwardingRulesManager interface {
ListForwardingRules(*forwardingrules.ListForwardingRulesRequest) (*forwardingrules.ListForwardingRulesResult, error)
CreateForwardingRule(*forwardingrules.CreateForwardingRuleRequest) (*forwardingrules.ForwardingRule, error)
GetForwardingRule(*forwardingrules.GetForwardingRuleRequest) (*forwardingrules.ForwardingRule, error)
UpdateForwardingRule(*forwardingrules.UpdateForwardingRuleRequest) (*forwardingrules.ForwardingRule, error)
DeleteForwardingRule(*forwardingrules.DeleteForwardingRuleRequest) error
}
type HeartbeatsManager ¶ added in v1.0.0
type HeartbeatsManager interface {
ListHeartbeats(*heartbeats.ListHeartbeatsRequest) (*heartbeats.ListHeartbeatsResult, error)
CreateHeartbeat(*heartbeats.CreateHeartbeatRequest) (*heartbeats.Heartbeat, error)
UpdateHeartbeat(*heartbeats.UpdateHeartbeatRequest) (*heartbeats.Heartbeat, error)
DeleteHeartbeat(*heartbeats.DeleteHeartbeatRequest) error
PingHeartbeat(*heartbeats.PingHeartbeatRequest) (*heartbeats.PingResponse, error)
}
type IntegrationActionsManager ¶ added in v1.0.0
type IntegrationActionsManager interface {
ListIntegrationActions(*actions.ListIntegrationActionsRequest) (*actions.ListIntegrationActionsResult, error)
CreateIntegrationAction(*actions.CreateIntegrationActionRequest) (*actions.IntegrationAction, error)
GetIntegrationAction(*actions.GetIntegrationActionRequest) (*actions.IntegrationAction, error)
UpdateIntegrationAction(*actions.UpdateIntegrationActionRequest) (*actions.IntegrationAction, error)
DeleteIntegrationAction(*actions.DeleteIntegrationActionRequest) error
ReorderIntegrationAction(*actions.ReorderIntegrationActionRequest) (*actions.IntegrationAction, error)
}
type IntegrationFiltersManager ¶ added in v1.0.0
type IntegrationFiltersManager interface {
GetIntegrationAlertFilter(*filters.GetIntegrationAlertFilterRequest) (*filters.IntegrationAlertFilter, error)
UpdateIntegrationAlertFilter(*filters.UpdateIntegrationAlertFilterRequest) (*filters.IntegrationAlertFilter, error)
}
type IntegrationsManager ¶ added in v1.0.0
type IntegrationsManager interface {
ListIntegrations(*integrations.ListIntegrationsRequest) (*integrations.ListIntegrationsResult, error)
CreateIntegration(*integrations.CreateIntegrationRequest) (*integrations.Integration, error)
GetIntegration(*integrations.GetIntegrationRequest) (*integrations.Integration, error)
UpdateIntegration(*integrations.UpdateIntegrationRequest) (*integrations.Integration, error)
DeleteIntegration(*integrations.DeleteIntegrationRequest) error
}
type JECManager ¶ added in v1.0.0
type JECManager interface {
ListJECChannels(*jec.ListJECChannelsRequest) (*jec.ListJECChannelsResult, error)
CreateJECChannel(*jec.CreateJECChannelRequest) (*jec.JECChannel, error)
GetJECChannel(*jec.GetJECChannelRequest) (*jec.JECChannel, error)
DeleteJECChannel(*jec.DeleteJECChannelRequest) error
SendJECAction(*jec.SendJECActionRequest) (*jec.SendJECActionResponse, error)
}
type MaintenancesManager ¶ added in v1.0.0
type MaintenancesManager interface {
ListGlobalMaintenances(*maintenances.ListGlobalMaintenancesRequest) (*maintenances.ListMaintenancesResult, error)
CreateGlobalMaintenance(*maintenances.CreateGlobalMaintenanceRequest) (*maintenances.Maintenance, error)
GetGlobalMaintenance(*maintenances.GetGlobalMaintenanceRequest) (*maintenances.Maintenance, error)
UpdateGlobalMaintenance(*maintenances.UpdateGlobalMaintenanceRequest) (*maintenances.Maintenance, error)
DeleteGlobalMaintenance(*maintenances.DeleteGlobalMaintenanceRequest) error
CancelGlobalMaintenance(*maintenances.CancelGlobalMaintenanceRequest) (*maintenances.Maintenance, error)
ListTeamMaintenances(*maintenances.ListTeamMaintenancesRequest) (*maintenances.ListMaintenancesResult, error)
CreateTeamMaintenance(*maintenances.CreateTeamMaintenanceRequest) (*maintenances.Maintenance, error)
GetTeamMaintenance(*maintenances.GetTeamMaintenanceRequest) (*maintenances.Maintenance, error)
UpdateTeamMaintenance(*maintenances.UpdateTeamMaintenanceRequest) (*maintenances.Maintenance, error)
DeleteTeamMaintenance(*maintenances.DeleteTeamMaintenanceRequest) error
CancelTeamMaintenance(*maintenances.CancelTeamMaintenanceRequest) (*maintenances.Maintenance, error)
}
type NotificationRuleStepsManager ¶ added in v1.0.0
type NotificationRuleStepsManager interface {
ListNotificationRuleSteps(*steps.ListNotificationRuleStepsRequest) (*steps.ListNotificationRuleStepsResult, error)
CreateNotificationRuleStep(*steps.CreateNotificationRuleStepRequest) (*steps.NotificationRuleStep, error)
GetNotificationRuleStep(*steps.GetNotificationRuleStepRequest) (*steps.NotificationRuleStep, error)
UpdateNotificationRuleStep(*steps.UpdateNotificationRuleStepRequest) (*steps.NotificationRuleStep, error)
DeleteNotificationRuleStep(*steps.DeleteNotificationRuleStepRequest) error
}
type NotificationRulesManager ¶ added in v1.0.0
type NotificationRulesManager interface {
ListNotificationRules(*notificationrules.ListNotificationRulesRequest) (*notificationrules.ListNotificationRulesResult, error)
CreateNotificationRule(*notificationrules.CreateNotificationRuleRequest) (*notificationrules.NotificationRule, error)
GetNotificationRule(*notificationrules.GetNotificationRuleRequest) (*notificationrules.NotificationRule, error)
UpdateNotificationRule(*notificationrules.UpdateNotificationRuleRequest) (*notificationrules.NotificationRule, error)
DeleteNotificationRule(*notificationrules.DeleteNotificationRuleRequest) error
}
type PoliciesManager ¶ added in v1.0.0
type PoliciesManager interface {
ListGlobalAlertPolicies(*policies.ListGlobalAlertPoliciesRequest) (*policies.ListPoliciesResult, error)
CreateGlobalAlertPolicy(*policies.CreateGlobalAlertPolicyRequest) (*policies.Policy, error)
GetGlobalAlertPolicy(*policies.GetGlobalAlertPolicyRequest) (*policies.Policy, error)
PutGlobalAlertPolicy(*policies.PutGlobalAlertPolicyRequest) (*policies.Policy, error)
DeleteGlobalAlertPolicy(*policies.DeleteGlobalAlertPolicyRequest) error
ChangeOrderGlobalAlertPolicy(*policies.ChangeOrderGlobalAlertPolicyRequest) (*policies.Policy, error)
EnableGlobalAlertPolicy(*policies.EnableGlobalAlertPolicyRequest) (*policies.Policy, error)
DisableGlobalAlertPolicy(*policies.DisableGlobalAlertPolicyRequest) (*policies.Policy, error)
}
type RolesManager ¶ added in v1.0.0
type RolesManager interface {
ListCustomUserRoles(*roles.ListCustomUserRolesRequest) (*roles.ListCustomUserRolesResult, error)
GetCustomUserRole(*roles.GetCustomUserRoleRequest) (*roles.CustomUserRole, error)
CreateCustomUserRole(*roles.CreateCustomUserRoleRequest) (*roles.CustomUserRole, error)
UpdateCustomUserRole(*roles.UpdateCustomUserRoleRequest) (*roles.CustomUserRole, error)
DeleteCustomUserRole(*roles.DeleteCustomUserRoleRequest) error
AssignCustomUserRole(*roles.AssignCustomUserRoleRequest) (*roles.SuccessResponse, error)
}
type RoutingRulesManager ¶ added in v1.0.0
type RoutingRulesManager interface {
ListRoutingRules(*routingrules.ListRoutingRulesRequest) (*routingrules.ListRoutingRulesResult, error)
CreateRoutingRule(*routingrules.CreateRoutingRuleRequest) (*routingrules.RoutingRule, error)
GetRoutingRule(*routingrules.GetRoutingRuleRequest) (*routingrules.RoutingRule, error)
UpdateRoutingRule(*routingrules.UpdateRoutingRuleRequest) (*routingrules.RoutingRule, error)
DeleteRoutingRule(*routingrules.DeleteRoutingRuleRequest) error
ChangeOrderRoutingRule(*routingrules.ChangeOrderRoutingRuleRequest) (*routingrules.RoutingRule, error)
}
type SchedulesManager ¶ added in v1.0.0
type SchedulesManager interface {
ListSchedules(*schedules.ListSchedulesRequest) (*schedules.ListSchedulesResult, error)
CreateSchedule(*schedules.CreateScheduleRequest) (*schedules.Schedule, error)
GetSchedule(*schedules.GetScheduleRequest) (*schedules.Schedule, error)
UpdateSchedule(*schedules.UpdateScheduleRequest) (*schedules.Schedule, error)
DeleteSchedule(*schedules.DeleteScheduleRequest) error
}
type SchedulesOnCallsManager ¶ added in v1.0.0
type SchedulesOnCallsManager interface {
ListOnCallResponders(*oncalls.ListOnCallRespondersRequest) (*oncalls.ListOnCallRespondersResult, error)
ListNextOnCallResponders(*oncalls.ListNextOnCallRespondersRequest) (*oncalls.ListOnCallRespondersResult, error)
ExportOnCallResponders(*oncalls.ExportOnCallRespondersRequest) (*bytes.Reader, error)
}
type SchedulesOverridesManager ¶ added in v1.0.0
type SchedulesOverridesManager interface {
ListOverrides(*overrides.ListOverridesRequest) (*overrides.ListOverridesResult, error)
CreateOverride(*overrides.CreateOverrideRequest) (*overrides.Override, error)
GetOverride(*overrides.GetOverrideRequest) (*overrides.Override, error)
UpdateOverride(*overrides.UpdateOverrideRequest) (*overrides.Override, error)
DeleteOverride(*overrides.DeleteOverrideRequest) error
}
type SchedulesRotationsManager ¶ added in v1.0.0
type SchedulesRotationsManager interface {
ListRotations(*rotations.ListRotationsRequest) (*rotations.ListRotationsResult, error)
CreateRotation(*rotations.CreateRotationRequest) (*rotations.Rotation, error)
GetRotation(*rotations.GetRotationRequest) (*rotations.Rotation, error)
UpdateRotation(*rotations.UpdateRotationRequest) (*rotations.Rotation, error)
DeleteRotation(*rotations.DeleteRotationRequest) error
}
type SchedulesTimelinesManager ¶ added in v1.0.0
type SchedulesTimelinesManager interface {
GetScheduleTimeline(*timelines.GetScheduleTimelineRequest) (*timelines.ScheduleTimeline, error)
ExportScheduleTimeline(*timelines.ExportScheduleTimelineRequest) (*bytes.Reader, error)
}
type SyncsActionGroupsManager ¶ added in v1.0.0
type SyncsActionGroupsManager interface {
ListSyncActionGroups(*actiongroups.ListSyncActionGroupsRequest) (*actiongroups.ListSyncActionGroupsResult, error)
CreateSyncActionGroup(*actiongroups.CreateSyncActionGroupRequest) (*actiongroups.SyncActionGroup, error)
GetSyncActionGroup(*actiongroups.GetSyncActionGroupRequest) (*actiongroups.SyncActionGroup, error)
UpdateSyncActionGroup(*actiongroups.UpdateSyncActionGroupRequest) (*actiongroups.SyncActionGroup, error)
DeleteSyncActionGroup(*actiongroups.DeleteSyncActionGroupRequest) error
ReorderSyncActionGroup(*actiongroups.ReorderSyncActionGroupRequest) (*actiongroups.SyncActionGroup, error)
}
type SyncsActionsManager ¶ added in v1.0.0
type SyncsActionsManager interface {
ListSyncActions(*actions.ListSyncActionsRequest) (*actions.ListSyncActionsResult, error)
CreateSyncAction(*actions.CreateSyncActionRequest) (*actions.SyncAction, error)
GetSyncAction(*actions.GetSyncActionRequest) (*actions.SyncAction, error)
UpdateSyncAction(*actions.UpdateSyncActionRequest) (*actions.SyncAction, error)
DeleteSyncAction(*actions.DeleteSyncActionRequest) error
ReorderSyncAction(*actions.ReorderSyncActionRequest) (*actions.SyncAction, error)
}
type SyncsManager ¶ added in v1.0.0
type SyncsManager interface {
ListSyncs(*syncs.ListSyncsRequest) (*syncs.ListSyncsResult, error)
CreateSync(*syncs.CreateSyncRequest) (*syncs.Sync, error)
GetSync(*syncs.GetSyncRequest) (*syncs.Sync, error)
UpdateSync(*syncs.UpdateSyncRequest) (*syncs.Sync, error)
DeleteSync(*syncs.DeleteSyncRequest) error
}
type TeamPoliciesManager ¶ added in v1.0.0
type TeamPoliciesManager interface {
ListTeamPolicies(*policies.ListTeamPoliciesRequest) (*policies.ListTeamPoliciesResult, error)
CreateTeamPolicy(*policies.CreateTeamPolicyRequest) (*policies.TeamPolicy, error)
GetTeamPolicy(*policies.GetTeamPolicyRequest) (*policies.TeamPolicy, error)
PutTeamPolicy(*policies.PutTeamPolicyRequest) (*policies.TeamPolicy, error)
DeleteTeamPolicy(*policies.DeleteTeamPolicyRequest) error
ChangeOrderTeamPolicy(*policies.ChangeOrderTeamPolicyRequest) (*policies.TeamPolicy, error)
EnableTeamPolicy(*policies.EnableTeamPolicyRequest) (*policies.TeamPolicy, error)
DisableTeamPolicy(*policies.DisableTeamPolicyRequest) (*policies.TeamPolicy, error)
}
type TeamRolesManager ¶ added in v1.0.0
type TeamRolesManager interface {
ListTeamRoles(*roles.ListTeamRolesRequest) (*roles.ListTeamRolesResult, error)
GetTeamRole(*roles.GetTeamRoleRequest) (*roles.TeamRole, error)
CreateTeamRole(*roles.CreateTeamRoleRequest) (*roles.TeamRole, error)
UpdateTeamRole(*roles.UpdateTeamRoleRequest) (*roles.TeamRole, error)
DeleteTeamRole(*roles.DeleteTeamRoleRequest) error
}
type TeamsManager ¶ added in v1.0.0
type TeamsManager interface {
ListTeams(*teams.ListTeamsRequest) (*teams.ListTeamsResult, error)
EnableOps(*teams.EnableOpsRequest) (*teams.SuccessResponse, error)
GetTeamRequestStatus(*teams.GetTeamRequestStatusRequest) (*teams.RequestStatusResponse, error)
}
Source Files
¶
- alerts.go
- auditlogs.go
- contacts.go
- endpoints.go
- errors.go
- escalations.go
- forwardingrules.go
- heartbeats.go
- http.go
- integrations.go
- integrations_actions.go
- integrations_filters.go
- jec.go
- main.go
- maintenances.go
- notificationrules.go
- notificationrules_steps.go
- policies.go
- roles.go
- routingrules.go
- schedules.go
- schedules_oncalls.go
- schedules_overrides.go
- schedules_rotations.go
- schedules_timelines.go
- syncs.go
- syncs_actiongroups.go
- syncs_actions.go
- teams.go
- teams_policies.go
- teams_roles.go
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
alerts
command
|
|
|
basic
command
|
|
|
integrations
command
|
|
|
schedules
command
|
|
Click to show internal directories.
Click to hide internal directories.