profileregions

Documentation

Index

• Variables
• type Client
  • func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)
• type ClientImpl
  • func (client *ClientImpl) GetGeoRegion(ctx context.Context, args GetGeoRegionArgs) (*GeoRegion, error)
  • func (client *ClientImpl) GetRegions(ctx context.Context, args GetRegionsArgs) (*ProfileRegions, error)
• type GeoRegion
• type GetGeoRegionArgs
• type GetRegionsArgs
• type ProfileRegion
• type ProfileRegions

Variables

var ResourceAreaId, _ = uuid.Parse("8ccfef3d-2b87-4e99-8ccb-66e343d2daa8")

Types

type Client

type Client interface {
	// [Preview API] Lookup up country/region based on provided IPv4, null if using the remote IPv4 address.
	GetGeoRegion(context.Context, GetGeoRegionArgs) (*GeoRegion, error)
	// [Preview API]
	GetRegions(context.Context, GetRegionsArgs) (*ProfileRegions, error)
}

func NewClient

func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)

type ClientImpl

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) GetGeoRegion

func (client *ClientImpl) GetGeoRegion(ctx context.Context, args GetGeoRegionArgs) (*GeoRegion, error)

[Preview API] Lookup up country/region based on provided IPv4, null if using the remote IPv4 address.

func (*ClientImpl) GetRegions

func (client *ClientImpl) GetRegions(ctx context.Context, args GetRegionsArgs) (*ProfileRegions, error)

[Preview API]

type GeoRegion

type GeoRegion struct {
	RegionCode *string `json:"regionCode,omitempty"`
}

type GetGeoRegionArgs

type GetGeoRegionArgs struct {
	// (required)
	Ip *string
}

Arguments for the GetGeoRegion function

type GetRegionsArgs

type GetRegionsArgs struct {
}

Arguments for the GetRegions function

type ProfileRegion

type ProfileRegion struct {
	// The two-letter code defined in ISO 3166 for the country/region.
	Code *string `json:"code,omitempty"`
	// Localized country/region name
	Name *string `json:"name,omitempty"`
}

Country/region information

type ProfileRegions

type ProfileRegions struct {
	// List of country/region code with contact consent requirement type of notice
	NoticeContactConsentRequirementRegions *[]string `json:"noticeContactConsentRequirementRegions,omitempty"`
	// List of country/region code with contact consent requirement type of opt-out
	OptOutContactConsentRequirementRegions *[]string `json:"optOutContactConsentRequirementRegions,omitempty"`
	// List of country/regions
	Regions *[]ProfileRegion `json:"regions,omitempty"`
}

Container of country/region information