shared

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Mar 24, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreatorBasic

type CreatorBasic struct {
	// Creator unique identifier
	ID string `json:"id" api:"required" format:"uuid"`
	// Avatar URL
	AvatarURL string `json:"avatar_url" api:"required" format:"uri"`
	// Creator bio
	Bio string `json:"bio" api:"required"`
	// Creator display name
	Name string `json:"name" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		AvatarURL   respjson.Field
		Bio         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Basic creator information

func (CreatorBasic) RawJSON

func (r CreatorBasic) RawJSON() string

Returns the unmodified JSON received from the API

func (*CreatorBasic) UnmarshalJSON

func (r *CreatorBasic) UnmarshalJSON(data []byte) error

type ProfileSummary

type ProfileSummary struct {
	// Profile unique identifier
	ID string `json:"id" api:"required" format:"uuid"`
	// Engagement rate as a percentage, null if unknown (e.g. 3.5 means 3.5%)
	EngagementRate float64 `json:"engagement_rate" api:"required"`
	// Follower count (null if unknown)
	Followers int64 `json:"followers" api:"required"`
	// Whether the account is verified
	IsVerified bool `json:"is_verified" api:"required"`
	// Social media platform
	//
	// Any of "instagram".
	Platform ProfileSummaryPlatform `json:"platform" api:"required"`
	// Profile URL
	URL string `json:"url" api:"required" format:"uri"`
	// Profile username
	Username string `json:"username" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		EngagementRate respjson.Field
		Followers      respjson.Field
		IsVerified     respjson.Field
		Platform       respjson.Field
		URL            respjson.Field
		Username       respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Abbreviated profile information

func (ProfileSummary) RawJSON

func (r ProfileSummary) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProfileSummary) UnmarshalJSON

func (r *ProfileSummary) UnmarshalJSON(data []byte) error

type ProfileSummaryPlatform

type ProfileSummaryPlatform string

Social media platform

const (
	ProfileSummaryPlatformInstagram ProfileSummaryPlatform = "instagram"
)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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