networklists

package
v9.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 14, 2024 License: Apache-2.0 Imports: 12 Imported by: 1

Documentation

Overview

Package networklists provides access to the Akamai Networklist APIs

See: https://techdocs.akamai.com/network-lists/reference/api#networklist

Index

Constants

View Source
const (
	// ActivationTypeActivate Activation.ActivationType value ACTIVATE
	ActivationTypeActivate ActivationValue = "ACTIVATE"
	// ActivationTypeDeactivate Activation.ActivationType value DEACTIVATE
	ActivationTypeDeactivate ActivationValue = "DEACTIVATE"

	// NetworkProduction Activation.Network value PRODUCTION
	NetworkProduction NetworkValue = "PRODUCTION"
	// NetworkStaging Activation.Network value STAGING
	NetworkStaging NetworkValue = "STAGING"

	// StatusActive Activation.Status value ACTIVE
	StatusActive StatusValue = "ACTIVATED"
	// StatusInactive Activation.Status value INACTIVE
	StatusInactive StatusValue = "INACTIVE"
	// StatusPending Activation.Status value RECEIVED
	StatusPending StatusValue = "RECEIVED"
	// StatusAborted Activation.Status value ABORTED
	StatusAborted StatusValue = "ABORTED"
	// StatusFailed Activation.Status value FAILED
	StatusFailed StatusValue = "FAILED"
	// StatusDeactivated Activation.Status value DEACTIVATED
	StatusDeactivated StatusValue = "DEACTIVATED"
	// StatusPendingDeactivation Activation.Status value PENDING_DEACTIVATION
	StatusPendingDeactivation StatusValue = "PENDING_DEACTIVATION"
	// StatusNew Activation.Status value NEW
	StatusNew StatusValue = "NEW"
)

Variables

View Source
var (
	// ErrBadRequest is returned when a required parameter is missing
	ErrBadRequest = errors.New("missing argument")
)
View Source
var (
	// ErrStructValidation is returned when given struct validation failed
	ErrStructValidation = errors.New("struct validation")
)

Functions

This section is empty.

Types

type ActivationValue

type ActivationValue string

ActivationValue is used to create an "enum" of possible Activation.ActivationType values

type ClientFunc

type ClientFunc func(sess session.Session, opts ...Option) NetworkList

ClientFunc is a networklist client new method, this can used for mocking

type CreateActivationsRequest

type CreateActivationsRequest struct {
	UniqueID               string   `json:"-"`
	Action                 string   `json:"-"`
	Network                string   `json:"network"`
	Comments               string   `json:"comments"`
	NotificationRecipients []string `json:"notificationRecipients"`
}

CreateActivationsRequest contains request parameters for creating new activation

type CreateActivationsResponse

type CreateActivationsResponse struct {
	ActivationID       int    `json:"activationId"`
	ActivationComments string `json:"activationComments"`
	ActivationStatus   string `json:"activationStatus"`
	SyncPoint          int    `json:"syncPoint"`
	UniqueID           string `json:"uniqueId"`
	Fast               bool   `json:"fast"`
	DispatchCount      int    `json:"dispatchCount"`
	Links              struct {
		AppendItems struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"appendItems"`
		Retrieve struct {
			Href string `json:"href"`
		} `json:"retrieve"`
		StatusInProduction struct {
			Href string `json:"href"`
		} `json:"statusInProduction"`
		StatusInStaging struct {
			Href string `json:"href"`
		} `json:"statusInStaging"`
		SyncPointHistory struct {
			Href string `json:"href"`
		} `json:"syncPointHistory"`
		Update struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"update"`
		ActivationDetails struct {
			Href string `json:"href"`
		} `json:"activationDetails"`
	} `json:"links"`
}

CreateActivationsResponse contains response after creating new activation

type CreateNetworkListRequest

type CreateNetworkListRequest struct {
	Name        string   `json:"name"`
	Type        string   `json:"type"`
	Description string   `json:"description"`
	ContractID  string   `json:"contractId,omitempty"`
	GroupID     int      `json:"groupId,omitempty"`
	List        []string `json:"list"`
}

CreateNetworkListRequest contains request parameters for CreateNetworkList method

func (CreateNetworkListRequest) Validate

func (v CreateNetworkListRequest) Validate() error

Validate validates CreateNetworkListRequest

type CreateNetworkListResponse

type CreateNetworkListResponse struct {
	Name            string   `json:"name"`
	Description     string   `json:"description,omitempty"`
	UniqueID        string   `json:"uniqueId"`
	SyncPoint       int      `json:"syncPoint"`
	Type            string   `json:"type"`
	NetworkListType string   `json:"networkListType"`
	ElementCount    int      `json:"elementCount"`
	ReadOnly        bool     `json:"readOnly"`
	Shared          bool     `json:"shared"`
	List            []string `json:"list"`
	Links           struct {
		ActivateInProduction struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"activateInProduction"`
		ActivateInStaging struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"activateInStaging"`
		AppendItems struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"appendItems"`
		Retrieve struct {
			Href string `json:"href"`
		} `json:"retrieve"`
		StatusInProduction struct {
			Href string `json:"href"`
		} `json:"statusInProduction"`
		StatusInStaging struct {
			Href string `json:"href"`
		} `json:"statusInStaging"`
		Update struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"update"`
	} `json:"links"`
}

CreateNetworkListResponse contains response from CreateNetworkList method

type Error

type Error struct {
	Type          string `json:"type"`
	Title         string `json:"title"`
	Detail        string `json:"detail"`
	Instance      string `json:"instance,omitempty"`
	BehaviorName  string `json:"behaviorName,omitempty"`
	ErrorLocation string `json:"errorLocation,omitempty"`
	StatusCode    int    `json:"-"`
}

Error is a appsec error interface

func (*Error) Error

func (e *Error) Error() string

func (*Error) Is

func (e *Error) Is(target error) bool

Is handles error comparisons

type GetActivationRequest

type GetActivationRequest struct {
	ActivationID int `json:"activationId"`
}

GetActivationRequest contains request parameters for getting activation details

func (GetActivationRequest) Validate

func (v GetActivationRequest) Validate() error

Validate validates GetActivationRequest

type GetActivationResponse

type GetActivationResponse struct {
	ActivationID     int       `json:"activationId"`
	CreateDate       time.Time `json:"createDate"`
	CreatedBy        string    `json:"createdBy"`
	Environment      string    `json:"environment"`
	Fast             bool      `json:"fast"`
	ActivationStatus string    `json:"status"`
	NetworkList      struct {
		ActivationComments string `json:"activationComments"`
		ActivationStatus   string `json:"activationStatus"`
		Links              struct {
			AppendItems struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"appendItems"`
			Retrieve struct {
				Href string `json:"href"`
			} `json:"retrieve"`
			StatusInProduction struct {
				Href string `json:"href"`
			} `json:"statusInProduction"`
			StatusInStaging struct {
				Href string `json:"href"`
			} `json:"statusInStaging"`
			SyncPointHistory struct {
				Href string `json:"href"`
			} `json:"syncPointHistory"`
			Update struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"update"`
		} `json:"links"`
		SyncPoint int    `json:"syncPoint"`
		UniqueID  string `json:"uniqueId"`
	} `json:"networkList"`
}

GetActivationResponse contains response with activation details

type GetActivationsRequest

type GetActivationsRequest struct {
	UniqueID     string `json:"-"`
	Action       string `json:"-"`
	Network      string `json:"network"`
	ActivationID int    `json:"activationId"`
}

GetActivationsRequest contains request parameters for getting activation status

func (GetActivationsRequest) Validate

func (v GetActivationsRequest) Validate() error

Validate validates GetActivationsRequest

type GetActivationsResponse

type GetActivationsResponse struct {
	ActivationID       int    `json:"activationId"`
	ActivationComments string `json:"activationComments"`
	ActivationStatus   string `json:"activationStatus"`
	SyncPoint          int    `json:"syncPoint"`
	UniqueID           string `json:"uniqueId"`
	Fast               bool   `json:"fast"`
	DispatchCount      int    `json:"dispatchCount"`
	Links              struct {
		AppendItems struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"appendItems"`
		Retrieve struct {
			Href string `json:"href"`
		} `json:"retrieve"`
		StatusInProduction struct {
			Href string `json:"href"`
		} `json:"statusInProduction"`
		StatusInStaging struct {
			Href string `json:"href"`
		} `json:"statusInStaging"`
		SyncPointHistory struct {
			Href string `json:"href"`
		} `json:"syncPointHistory"`
		Update struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"update"`
		ActivationDetails struct {
			Href string `json:"href"`
		} `json:"activationDetails"`
	} `json:"links"`
}

GetActivationsResponse contains response with activation status

type GetNetworkListDescriptionRequest

type GetNetworkListDescriptionRequest struct {
	UniqueID    string `json:"uniqueId"`
	Name        string `json:"name"`
	Description string `json:"description"`
}

GetNetworkListDescriptionRequest contains request parameters for GetNetworkListDescription method

func (GetNetworkListDescriptionRequest) Validate

Validate validates GetNetworkListDescriptionRequest

type GetNetworkListDescriptionResponse

type GetNetworkListDescriptionResponse struct {
	Name            string   `json:"name"`
	UniqueID        string   `json:"uniqueId"`
	Description     string   `json:"description"`
	SyncPoint       int      `json:"syncPoint"`
	Type            string   `json:"type"`
	NetworkListType string   `json:"networkListType"`
	ElementCount    int      `json:"elementCount"`
	ReadOnly        bool     `json:"readOnly"`
	Shared          bool     `json:"shared"`
	List            []string `json:"list"`
	Links           struct {
		ActivateInProduction struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"activateInProduction"`
		ActivateInStaging struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"activateInStaging"`
		AppendItems struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"appendItems"`
		Retrieve struct {
			Href string `json:"href"`
		} `json:"retrieve"`
		StatusInProduction struct {
			Href string `json:"href"`
		} `json:"statusInProduction"`
		StatusInStaging struct {
			Href string `json:"href"`
		} `json:"statusInStaging"`
		Update struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"update"`
	} `json:"links"`
}

GetNetworkListDescriptionResponse contains response from GetNetworkListDescription method

type GetNetworkListRequest

type GetNetworkListRequest struct {
	UniqueID string `json:"-"`
}

GetNetworkListRequest contains request parameters for GetNetworkList method

func (GetNetworkListRequest) Validate

func (v GetNetworkListRequest) Validate() error

Validate validates GetNetworkListRequest

type GetNetworkListResponse

type GetNetworkListResponse struct {
	Name            string   `json:"name"`
	UniqueID        string   `json:"uniqueId"`
	ContractID      string   `json:"contractId"`
	GroupID         int      `json:"groupId"`
	SyncPoint       int      `json:"syncPoint"`
	Type            string   `json:"type"`
	Description     string   `json:"description,omitempty"`
	NetworkListType string   `json:"networkListType"`
	ElementCount    int      `json:"elementCount"`
	ReadOnly        bool     `json:"readOnly"`
	Shared          bool     `json:"shared"`
	List            []string `json:"list"`
	Links           struct {
		ActivateInProduction struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"activateInProduction"`
		ActivateInStaging struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"activateInStaging"`
		AppendItems struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"appendItems"`
		Retrieve struct {
			Href string `json:"href"`
		} `json:"retrieve"`
		StatusInProduction struct {
			Href string `json:"href"`
		} `json:"statusInProduction"`
		StatusInStaging struct {
			Href string `json:"href"`
		} `json:"statusInStaging"`
		Update struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"update"`
	} `json:"links"`
}

GetNetworkListResponse contains response from GetNetworkList method

type GetNetworkListSubscriptionRequest

type GetNetworkListSubscriptionRequest struct {
	Recipients []string `json:"-"`
	UniqueIds  []string `json:"-"`
}

GetNetworkListSubscriptionRequest contains request parameters for GetNetworkListSubscription

type GetNetworkListSubscriptionResponse

type GetNetworkListSubscriptionResponse struct {
	Links struct {
		Create struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"create"`
	} `json:"links"`
	NetworkLists []struct {
		ElementCount int `json:"elementCount"`
		Links        struct {
			ActivateInProduction struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"activateInProduction"`
			ActivateInStaging struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"activateInStaging"`
			AppendItems struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"appendItems"`
			Retrieve struct {
				Href string `json:"href"`
			} `json:"retrieve"`
			StatusInProduction struct {
				Href string `json:"href"`
			} `json:"statusInProduction"`
			StatusInStaging struct {
				Href string `json:"href"`
			} `json:"statusInStaging"`
			Update struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"update"`
		} `json:"links"`
		Name               string `json:"name"`
		NetworkListType    string `json:"networkListType"`
		ReadOnly           bool   `json:"readOnly"`
		Shared             bool   `json:"shared"`
		SyncPoint          int    `json:"syncPoint"`
		Type               string `json:"type"`
		UniqueID           string `json:"uniqueId"`
		AccessControlGroup string `json:"accessControlGroup,omitempty"`
		Description        string `json:"description,omitempty"`
	} `json:"networkLists"`
}

GetNetworkListSubscriptionResponse contains response from GetNetworkListSubscription

type GetNetworkListsRequest

type GetNetworkListsRequest struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

GetNetworkListsRequest contains request parameters for GetNetworkLists method

type GetNetworkListsResponse

type GetNetworkListsResponse struct {
	Links        *NetworkListsResponseLinks           `json:"links,omitempty"`
	NetworkLists []GetNetworkListsResponseListElement `json:"networkLists"`
}

GetNetworkListsResponse contains response from GetNetworkLists method

type GetNetworkListsResponseListElement

type GetNetworkListsResponseListElement struct {
	ElementCount       int                `json:"elementCount"`
	Links              *NetworkListsLinks `json:"links,omitempty"`
	Name               string             `json:"name"`
	NetworkListType    string             `json:"networkListType"`
	ReadOnly           bool               `json:"readOnly"`
	Shared             bool               `json:"shared"`
	SyncPoint          int                `json:"syncPoint"`
	Type               string             `json:"type"`
	UniqueID           string             `json:"uniqueId"`
	AccessControlGroup string             `json:"accessControlGroup,omitempty"`
	Description        string             `json:"description,omitempty"`
}

GetNetworkListsResponseListElement contains information about a single network list

type LinkInfo

type LinkInfo struct {
	Href   string `json:"href,omitempty"`
	Method string `json:"method,omitempty"`
}

LinkInfo contains hypermedia link

type Mock

type Mock struct {
	mock.Mock
}

func (*Mock) CreateActivations

func (p *Mock) CreateActivations(ctx context.Context, params CreateActivationsRequest) (*CreateActivationsResponse, error)

func (*Mock) CreateNetworkList

func (p *Mock) CreateNetworkList(ctx context.Context, params CreateNetworkListRequest) (*CreateNetworkListResponse, error)

func (*Mock) GetActivation

func (p *Mock) GetActivation(ctx context.Context, params GetActivationRequest) (*GetActivationResponse, error)

func (*Mock) GetActivations

func (p *Mock) GetActivations(ctx context.Context, params GetActivationsRequest) (*GetActivationsResponse, error)

func (*Mock) GetNetworkList

func (p *Mock) GetNetworkList(ctx context.Context, params GetNetworkListRequest) (*GetNetworkListResponse, error)

func (*Mock) GetNetworkLists

func (p *Mock) GetNetworkLists(ctx context.Context, params GetNetworkListsRequest) (*GetNetworkListsResponse, error)

func (*Mock) RemoveActivations

func (p *Mock) RemoveActivations(ctx context.Context, params RemoveActivationsRequest) (*RemoveActivationsResponse, error)

func (*Mock) RemoveNetworkList

func (p *Mock) RemoveNetworkList(ctx context.Context, params RemoveNetworkListRequest) (*RemoveNetworkListResponse, error)

func (*Mock) UpdateNetworkList

func (p *Mock) UpdateNetworkList(ctx context.Context, params UpdateNetworkListRequest) (*UpdateNetworkListResponse, error)

type NetworkList

type NetworkList interface {

	// GetActivations retrieves list of network list activations.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/get-network-list-status
	GetActivations(ctx context.Context, params GetActivationsRequest) (*GetActivationsResponse, error)

	// GetActivation retrieves network list activation.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/get-activation
	GetActivation(ctx context.Context, params GetActivationRequest) (*GetActivationResponse, error)

	// CreateActivations activates network list.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/post-network-list-activate
	CreateActivations(ctx context.Context, params CreateActivationsRequest) (*CreateActivationsResponse, error)

	// RemoveActivations deactivates network list.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/post-network-list-activate
	RemoveActivations(ctx context.Context, params RemoveActivationsRequest) (*RemoveActivationsResponse, error)

	// GetNetworkLists lists all network lists available for an authenticated user.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/get-network-lists
	GetNetworkLists(ctx context.Context, params GetNetworkListsRequest) (*GetNetworkListsResponse, error)

	// GetNetworkList retrieves network list with specific network list id.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/get-network-list
	GetNetworkList(ctx context.Context, params GetNetworkListRequest) (*GetNetworkListResponse, error)

	// CreateNetworkList creates a new network list.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/post-network-lists
	CreateNetworkList(ctx context.Context, params CreateNetworkListRequest) (*CreateNetworkListResponse, error)

	// UpdateNetworkList modifies the network list.
	//
	//See: https://techdocs.akamai.com/network-lists/reference/put-network-list
	UpdateNetworkList(ctx context.Context, params UpdateNetworkListRequest) (*UpdateNetworkListResponse, error)

	// RemoveNetworkList removes a network list.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/delete-network-list
	RemoveNetworkList(ctx context.Context, params RemoveNetworkListRequest) (*RemoveNetworkListResponse, error)

	// GetNetworkListDescription retrieves network list with description.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/get-network-list
	GetNetworkListDescription(ctx context.Context, params GetNetworkListDescriptionRequest) (*GetNetworkListDescriptionResponse, error)

	// UpdateNetworkListDescription modifies network list description.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/put-network-list-details
	UpdateNetworkListDescription(ctx context.Context, params UpdateNetworkListDescriptionRequest) (*UpdateNetworkListDescriptionResponse, error)

	// GetNetworkListSubscription retrieves networklist subscription.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/post-notifications-subscribe
	GetNetworkListSubscription(ctx context.Context, params GetNetworkListSubscriptionRequest) (*GetNetworkListSubscriptionResponse, error)

	// UpdateNetworkListSubscription updates networklist subscription.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/post-notifications-subscribe
	UpdateNetworkListSubscription(ctx context.Context, params UpdateNetworkListSubscriptionRequest) (*UpdateNetworkListSubscriptionResponse, error)

	// RemoveNetworkListSubscription unsubscribes networklist.
	//
	// See: https://techdocs.akamai.com/network-lists/reference/post-notifications-unsubscribe
	RemoveNetworkListSubscription(ctx context.Context, params RemoveNetworkListSubscriptionRequest) (*RemoveNetworkListSubscriptionResponse, error)
}

NetworkList is the networklist api interface

func Client

func Client(sess session.Session, opts ...Option) NetworkList

Client returns a new networklist Client instance with the specified controller

type NetworkListsLinks struct {
	ActivateInProduction *LinkInfo `json:"activateInProduction,omitempty"`
	ActivateInStaging    *LinkInfo `json:"activateInStaging,omitempty"`
	AppendItems          *LinkInfo `json:"appendItems,omitempty"`
	Retrieve             *LinkInfo `json:"retrieve,omitempty"`
	StatusInProduction   *LinkInfo `json:"statusInProduction,omitempty"`
	StatusInStaging      *LinkInfo `json:"statusInStaging,omitempty"`
	Update               *LinkInfo `json:"update,omitempty"`
}

nolint:revive NetworkListsLinks encapsulates the set of API hypermedia

type NetworkListsResponseLinks struct {
	Create *LinkInfo `json:"create,omitempty"`
}

nolint:revive NetworkListsResponseLinks contains LinkInfo

type NetworkValue

type NetworkValue string

NetworkValue is used to create an "enum" of possible Activation.Network values

type Option

type Option func(*networklists)

Option defines a networklist option

type Recipients

type Recipients struct {
	Recipients string `json:"notificationRecipients"`
}

Recipients contains recipients

type RemoveActivationsRequest

type RemoveActivationsRequest struct {
	UniqueID               string   `json:"-"`
	ActivationID           int      `json:"-"`
	Action                 string   `json:"action"`
	Network                string   `json:"network"`
	Comments               string   `json:"comments"`
	NotificationRecipients []string `json:"notificationRecipients"`
}

RemoveActivationsRequest contains request parameters of Activation to deactivate

type RemoveActivationsResponse

type RemoveActivationsResponse struct {
	ActivationID       int    `json:"activationId"`
	ActivationComments string `json:"activationComments"`
	ActivationStatus   string `json:"activationStatus"`
	SyncPoint          int    `json:"syncPoint"`
	UniqueID           string `json:"uniqueId"`
	Fast               bool   `json:"fast"`
	DispatchCount      int    `json:"dispatchCount"`
	Links              struct {
		AppendItems struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"appendItems"`
		Retrieve struct {
			Href string `json:"href"`
		} `json:"retrieve"`
		StatusInProduction struct {
			Href string `json:"href"`
		} `json:"statusInProduction"`
		StatusInStaging struct {
			Href string `json:"href"`
		} `json:"statusInStaging"`
		SyncPointHistory struct {
			Href string `json:"href"`
		} `json:"syncPointHistory"`
		Update struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"update"`
		ActivationDetails struct {
			Href string `json:"href"`
		} `json:"activationDetails"`
	} `json:"links"`
}

RemoveActivationsResponse contains response of Activation deactivation

type RemoveNetworkListRequest

type RemoveNetworkListRequest struct {
	UniqueID string `json:"-"`
}

RemoveNetworkListRequest contains request parameters for RemoveNetworkList method

func (RemoveNetworkListRequest) Validate

func (v RemoveNetworkListRequest) Validate() error

Validate validates RemoveNetworkListRequest

type RemoveNetworkListResponse

type RemoveNetworkListResponse struct {
	Status    int    `json:"status"`
	UniqueID  string `json:"uniqueId"`
	SyncPoint int    `json:"syncPoint"`
}

RemoveNetworkListResponse contains response from RemoveNetworkList method

type RemoveNetworkListSubscriptionRequest

type RemoveNetworkListSubscriptionRequest struct {
	Recipients []string `json:"recipients"`
	UniqueIds  []string `json:"uniqueIds"`
}

RemoveNetworkListSubscriptionRequest contains request parameters for RemoveNetworkListSubscription method

type RemoveNetworkListSubscriptionResponse

type RemoveNetworkListSubscriptionResponse struct {
	Empty string `json:"-"`
}

RemoveNetworkListSubscriptionResponse contains response from RemoveNetworkListSubscription method

type StatusValue

type StatusValue string

StatusValue is used to create an "enum" of possible Activation.Status values

type UpdateNetworkListDescriptionRequest

type UpdateNetworkListDescriptionRequest struct {
	UniqueID    string `json:"-"`
	Name        string `json:"name"`
	Description string `json:"description"`
}

UpdateNetworkListDescriptionRequest contains request parameters for UpdateNetworkListDescription method

func (UpdateNetworkListDescriptionRequest) Validate

Validate validates UpdateNetworkListDescriptionRequest

type UpdateNetworkListDescriptionResponse

type UpdateNetworkListDescriptionResponse struct {
	Empty string `json:"-"`
}

UpdateNetworkListDescriptionResponse contains response from UpdateNetworkListDescription method

type UpdateNetworkListRequest

type UpdateNetworkListRequest struct {
	Name        string   `json:"name"`
	Type        string   `json:"type"`
	Description string   `json:"description"`
	ContractID  string   `json:"contractId,omitempty"`
	GroupID     int      `json:"groupId,omitempty"`
	SyncPoint   int      `json:"syncPoint"`
	List        []string `json:"list"`
	UniqueID    string   `json:"uniqueId"`
}

UpdateNetworkListRequest contains request parameters for CreateNetworkLists method

func (UpdateNetworkListRequest) Validate

func (v UpdateNetworkListRequest) Validate() error

Validate validates UpdateNetworkListRequest

type UpdateNetworkListResponse

type UpdateNetworkListResponse struct {
	Links struct {
		Create struct {
			Href   string `json:"href"`
			Method string `json:"method"`
		} `json:"create"`
	} `json:"links"`
	NetworkLists []struct {
		ElementCount int `json:"elementCount"`
		Links        struct {
			ActivateInProduction struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"activateInProduction"`
			ActivateInStaging struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"activateInStaging"`
			AppendItems struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"appendItems"`
			Retrieve struct {
				Href string `json:"href"`
			} `json:"retrieve"`
			StatusInProduction struct {
				Href string `json:"href"`
			} `json:"statusInProduction"`
			StatusInStaging struct {
				Href string `json:"href"`
			} `json:"statusInStaging"`
			Update struct {
				Href   string `json:"href"`
				Method string `json:"method"`
			} `json:"update"`
		} `json:"links"`
		Name               string `json:"name"`
		NetworkListType    string `json:"networkListType"`
		ReadOnly           bool   `json:"readOnly"`
		Shared             bool   `json:"shared"`
		SyncPoint          int    `json:"syncPoint"`
		Type               string `json:"type"`
		UniqueID           string `json:"uniqueId"`
		AccessControlGroup string `json:"accessControlGroup,omitempty"`
		Description        string `json:"description,omitempty"`
	} `json:"networkLists"`
}

UpdateNetworkListResponse contains response from CreateNetworkList method

type UpdateNetworkListSubscriptionRequest

type UpdateNetworkListSubscriptionRequest struct {
	Recipients []string `json:"recipients"`
	UniqueIds  []string `json:"uniqueIds"`
}

UpdateNetworkListSubscriptionRequest contains request parameters for UpdateNetworkListSubscription method

type UpdateNetworkListSubscriptionResponse

type UpdateNetworkListSubscriptionResponse struct {
	Empty string `json:"-"`
}

UpdateNetworkListSubscriptionResponse contains response from UpdateNetworkListSubscription method

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL