fflogs

type Client struct {
	Raw *Raw
	// contains filtered or unexported fields
}

type ClientOpt struct {
	ApiKey     string
	HttpClient *http.Client // default: http.DefaultClient
	BaseUrl    string       // default: fflogs.BaseUrlDefault
}

type Metric string

type ParsesCharacterOptions struct {
	CharacterName        string     `path:"characterName"`         // The name of the character to collect rankings for.
	ServerName           string     `path:"serverName"`            // The server that the character is found on. For World of Warcraft this is the 'slug' field returned from their realm status API.
	ServerRegion         Region     `path:"serverRegion"`          // The short region name for the server on which the character is located: US, EU, KR, TW, CN.
	Zone                 *int       `query:"zone"`                 // The zone to fetch rankings for. If omitted, the latest open raid zone is used.
	Encounter            *int       `query:"encounter"`            // An encounter within the zone to fetch parses for. If omitted, all encounters in the zone will be checked. If a valid encounter is specified, then historical graph data for the encounter will also be included in the results.
	Metric               *Metric    `query:"metric"`               // The metric to query for. Valid character metrics are 'dps', 'hps', 'bossdps, 'tankhps', or 'playerspeed'. For WoW only, 'krsi' can be used for tank survivability ranks.
	Bracket              *int       `query:"bracket"`              // The bracket to query for. If omitted or if a value of 0 is specified, then all brackets are examined. Brackets can be obtained from a /zones API request. The special value -1 can be used to obtain scores by bracket %, i.e., to automatically look only at the bracket each parse falls in.
	Compare              *int       `query:"compare"`              // Optional. Whether or not to compare against rankings (0) when computing performance percentiles or to compare against statistics (1). A value of 0 is assumed if omitted.
	Partition            *int       `query:"partition"`            // The partition group to query for. Most zones have only one partition, and this can be omitted. Hellfire Citadel has two partitions (1 for original, 2 for pre-patch). Highmaul and BRF have two partitions (1 for US/EU, 2 for Asia).
	Timeframe            *Timeframe `query:"timeframe"`            // Whether to compare against today's rankings or to return historical information (where the rank was back when it was earned. The accepted values are 'today' and 'historical', with the default being 'today'.
	IncludeCombatantInfo *bool      `query:"includeCombatantInfo"` // Whether or not to include combatant info like gear and talents. Optional. Defaults to false.
}

type RankingCharacterOptions struct {
	CharacterName        string     `path:"characterName"`         // The name of the character to collect rankings for.
	ServerName           string     `path:"serverName"`            // The server that the character is found on. For World of Warcraft this is the 'slug' field returned from their realm status API.
	ServerRegion         Region     `path:"serverRegion"`          // The short region name for the server on which the character is located: US, EU, KR, TW, CN.
	Zone                 *int       `query:"zone"`                 // The zone to fetch rankings for. If omitted, the latest open raid zone is used.
	Encounter            *int       `query:"encounter"`            // An encounter within the zone to fetch rankings for. If omitted, all encounters in the zone will be checked.
	Metric               *Metric    `query:"metric"`               // The metric to query for. Valid character metrics are 'dps', 'hps', 'bossdps, 'tankhps', or 'playerspeed'. For WoW only, 'krsi' can be used for tank survivability ranks.
	Bracket              *int       `query:"bracket"`              // The bracket to query for. If omitted or if a value of 0 is specified, then all brackets are examined. Brackets can be obtained from a /zones API request.
	Partition            *int       `query:"partition"`            // The partition group to query for. Most zones have only one partition, and this can be omitted. Hellfire Citadel has two partitions (1 for original, 2 for pre-patch). Highmaul and BRF have two partitions (1 for US/EU, 2 for Asia).	query	integer
	Timeframe            *Timeframe `query:"timeframe"`            // Whether to compare against today's rankings or to return historical information (where the rank was back when it was earned. The accepted values are 'today' and 'historical', with the default being 'today'.	query	string
	IncludeCombatantInfo *bool      `query:"includeCombatantInfo"` // Whether or not to include combatant info like gear and talents. Optional. Defaults to false.
}

type RankingEncounterOptions struct {
	EncounterID          int     `path:"encounterID"`           // The encounter to collect rankings for. Encounter IDs can be obtained using a /zones reuest.
	Metric               *Metric `query:"metric"`               // The metric to query for. Valid fight metrics are 'speed', 'execution' and 'feats'. Valid character metrics are 'dps', 'hps', 'bossdps, 'tankhps', or 'playerspeed'. For WoW only, 'krsi' can be used for tank survivability ranks and 'progress' can be used for guild progressinfo.
	Size                 *string `query:"size"`                 // The raid size to query for. This is only valid for fixed size raids. Raids with flexible sizing must omit this paraeter.
	Difficulty           *string `query:"difficulty"`           // The difficulty setting to query for. Valid difficulty settings are 1 = LFR, 2 = Flex, 3 = Normal, 4 = Heroic, 5 = Mythic, 10 = Challenge Mode, 100 = WildStar/FF. Can be omitted for encounters with only one difficulty seting.
	Partition            *int    `query:"partition"`            // The partition group to query for. Most zones have only one partition, and this can be omitted. Hellfire Citadel has two partitions (1 for original, 2 for pre-patch). Highmaul and BRF have two partitions (1 for US/EU, 2 for sia).
	Class                *int    `query:"class"`                // The class to query for if a character metric is specified. Valid class IDs can be obtained from a /classes API request. Optonal.
	Spec                 *int    `query:"spec"`                 // The spec to query for if a character metric is specified. Valid spec IDs can be obtained from a /classes API request. Optonal.
	Bracket              *int    `query:"bracket"`              // The bracket to query for. If omitted or if a value of 0 is specified, then all brackets are examined. Brackets can be obtained from a /zones API reuest.
	Server               *string `query:"server"`               // A server to filter on. If set, the region must also be specified. This is the slug field in Blizzard terminlogy.
	Region               *Region `query:"region"`               // The short name of a region to filter on (e.g., US, NAEU)
	Page                 *int    `query:"page"`                 // The page to examine, starting from 1. If the value is omitted, then 1 is assumed. For example, with a page of 2 and a limit of 300, you will be fetching rankings 30-600.
	Filter               *string `query:"filter"`               // A search filter string, limiting the search to specific classes, specs, fight durations, raid sizes, etc. The format should match the string used on the public rankings ages.
	IncludeCombatantInfo *bool   `query:"includeCombatantInfo"` // Whether or not to include combatant info like gear and talents. Optional. Defaults to alse.
}

type Raw struct {
	// contains filtered or unexported fields
}

type Region string

type ReportEventsOptions struct {
	//View               string `path:"view"`                // The type of data requested. Supported values are 'summary', 'damage-done', 'damage-taken', 'healing', 'casts', 'summons', 'buffs', 'debuffs', 'deaths', 'threat', 'resources', 'interrupts' and 'dispels'.
	Code               string  `path:"code"`                // The specific report to collect table entries for.
	Start              *int    `query:"start"`              // A start time. This is a time from the start of the report in milliseconds. If omitted, 0 is assumed.
	End                *int    `query:"end"`                // An end time. This is a time from the start of the report in milliseconds. If omitted, 0 is assumed.
	Hostility          *int    `query:"hostility"`          // An optional hostility value of 0 or 1. The default is 0. A value of 0 means to collect data for Friendlies. A value of 1 means to collect data for Enemies.
	Sourceid           *int    `query:"sourceid"`           // An optional actor ID to filter to. If set, only events where the ID matches the source (or target for damage-taken) of the event will be returned. The actor's pets will also be included (unless the options field overrides).
	Sourceinstance     *int    `query:"sourceinstance"`     // An optional actor instance ID to filter to. If set, only events where the instance ID matches the source (or target for damage-taken) of the event will be returned. This is useful to look for all events involving NPC N, where N is the actor instance ID.
	Sourceclass        *string `query:"sourceclass"`        // An optional actor class to filter to. If set, only events where the source (or target for damage-taken) involves that class (e.g., Mage) will be returned.
	Targetid           *int    `query:"targetid"`           // An optional actor ID to filter to. If set, only events where the ID matches the target (or source for damage-taken) of the event will be returned. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	Targetinstance     *int    `query:"targetinstance"`     // An optional actor instance ID to filter to. If set, only events where the instance ID matches the target (or source for damage-taken) of the event will be returned. This is useful to look for all events involving NPC N, where N is the actor instance ID. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	Targetclass        *string `query:"targetclass"`        // An optional actor class to filter to. If set, only events where the target (or source for damage-taken) involves that class (e.g., Mage) will be returned. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	SourceAurasPresent *string `query:"sourceAurasPresent"` // A comma-separated string of aura game IDs. Only matches if the aura is present on the source.
	SourceAurasAbsent  *string `query:"sourceAurasAbsent"`  // A comma-separated string of aura game IDs. Only matches if the aura is absent on the source.
	TargetAurasPresent *string `query:"targetAurasPresent"` // A comma-separated string of aura game IDs. Only matches if the aura is present on the target.
	TargetAurasAbsent  *string `query:"targetAurasAbsent"`  // A comma-separated string of aura game IDs. Only matches if the aura is absent on the target.
	Abilityid          *int    `query:"abilityid"`          // An optional ability ID to filter to. If set, only events where the ability matches will be returned. Consolidated abilities (WCL only) are represented using a negative number that matches the ability ID that everything is consolidated under. For the 'deaths' view, this represents a specific killing blow. For the resources views, the abilityid is not an ability but a resource type. Valid resource types can be viewed at https://www.fflogs.com/reports/resource_types/
	Death              *int    `query:"death"`              // An optional death to filter to. Only used for the deaths command. Select the Nth death in the time range that matches all the other filters.
	Options            *int    `query:"options"`            // A set of options for what to include/exclude. These correspond to options like Include Overkill in the Damage Done pane. Complete list will be forthcoming. If omitted, appropriate defaults that match WCL's default behavior will be chosen. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	Cutoff             *int    `query:"cutoff"`             // An optional death cutoff. If set, events after that number of deaths have occurred will not be examined.
	Encounter          *int    `query:"encounter"`          // An optional encounter filter. If set to a specific encounter ID, only fights involving a specific encounter will be considered. The encounter IDs match those used in rankings/statistics.
	Wipes              *int    `query:"wipes"`              // An optional wipes filter. If set to 1, only wipes will be considered.
	Difficulty         *int    `query:"difficulty"`         // An optional difficulty filter.
	Filter             *string `query:"filter"`             // An optional filter written in WCL's expression language. Events must match the filter to be included.
	Translate          *bool   `query:"translate"`          // An optional flag indicating that the results should be translated into the language of the host (e.g., cn.warcraftlogs.com would get Chinese results).
}

type ReportFightsOptions struct {
	Code      string `path:"code"`       // The specific report to collect fights and participants for.
	Translate *bool  `query:"translate"` // An optional flag indicating that the results should be translated into the language of the host (e.g., cn.warcraftlogs.com would get Chinese results).
}

type ReportTablesOptions struct {
	//view               string `path:"view"`                // The type of data requested. Supported values are 'summary', 'damage-done', 'damage-taken', 'healing', 'casts', 'summons', 'buffs', 'debuffs', 'deaths', 'survivability', 'resources' and 'resources-gains'.
	Code               string  `path:"code"`                // The specific report to collect table entries for.
	Start              *int    `query:"start"`              // A start time. This is a time from the start of the report in milliseconds. If omitted, 0 is assumed.
	End                *int    `query:"end"`                // An end time. This is a time from the start of the report in milliseconds. If omitted, 0 is assumed.
	Hostility          *int    `query:"hostility"`          // An optional hostility value of 0 or 1. The default is 0. A value of 0 means to collect data for Friendlies. A value of 1 means to collect data for Enemies.
	By                 *string `query:"by"`                 // An optional parameter indicating how to group entries. They can be grouped by 'source', by 'target', or by 'ability'. This value matches WCL's default behavior if omitted. For buffs and debuffs, a value of 'source' means auras gained by the source, and a value of 'target' means auras cast by the source. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	Sourceid           *int    `query:"sourceid"`           // An optional actor ID to filter to. If set, only events where the ID matches the source (or target for damage-taken) of the event will be returned. The actor's pets will also be included (unless the options field overrides).
	Sourceinstance     *int    `query:"sourceinstance"`     // An optional actor instance ID to filter to. If set, only events where the instance ID matches the source (or target for damage-taken) of the event will be returned. This is useful to look for all events involving NPC N, where N is the actor instance ID.
	Sourceclass        *string `query:"sourceclass"`        // An optional actor class to filter to. If set, only events where the source (or target for damage-taken) involves that class (e.g., Mage) will be returned.
	Targetid           *int    `query:"targetid"`           // An optional actor ID to filter to. If set, only events where the ID matches the target (or source for damage-taken) of the event will be returned. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	Targetinstance     *int    `query:"targetinstance"`     // An optional actor instance ID to filter to. If set, only events where the instance ID matches the target (or source for damage-taken) of the event will be returned. This is useful to look for all events involving NPC N, where N is the actor instance ID. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	Targetclass        *string `query:"targetclass"`        // An optional actor class to filter to. If set, only events where the target (or source for damage-taken) involves that class (e.g., Mage) will be returned. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	SourceAurasAbsent  *string `query:"sourceAurasAbsent"`  // A comma-separated string of aura game IDs. Only matches if the aura is absent on the source.
	TargetAurasPresent *string `query:"targetAurasPresent"` // A comma-separated string of aura game IDs. Only matches if the aura is present on the target.
	TargetAurasAbsent  *string `query:"targetAurasAbsent"`  // A comma-separated string of aura game IDs. Only matches if the aura is absent on the target.
	Abilityid          *int    `query:"abilityid"`          // An optional ability ID to filter to. If set, only events where the ability matches will be returned. Consolidated abilities (WCL only) are represented using a negative number that matches the ability ID that everything is consolidated under. For the 'deaths' view, this represents a specific killing blow. For the resources views, the abilityid is not an ability but a resource type. Valid resource types can be viewed at https://www.fflogs.com/reports/resource_types/
	Options            *int    `query:"options"`            // A set of options for what to include/exclude. These correspond to options like Include Overkill in the Damage Done pane. Complete list will be forthcoming. If omitted, appropriate defaults that match WCL's default behavior will be chosen. This value is not used in the 'deaths', 'survivability', 'resources' and 'resources-gains' views.
	Cutoff             *int    `query:"cutoff"`             // An optional death cutoff. If set, events after that number of deaths have occurred will not be examined.
	Encounter          *int    `query:"encounter"`          // An optional encounter filter. If set to a specific encounter ID, only fights involving a specific encounter will be considered. The encounter IDs match those used in rankings/statistics.
	Wipes              *int    `query:"wipes"`              // An optional wipes filter. If set to 1, only wipes will be considered.
	Difficulty         *int    `query:"difficulty"`         // An optional difficulty filter.
	Filter             *string `query:"filter"`             // An optional filter written in WCL's expression language. Events must match the filter to be included.
	Translate          *bool   `query:"translate"`          // An optional flag indicating that the results should be translated into the language of the host (e.g., cn.warcraftlogs.com would get Chinese results).
}

type ReportsGuildOptions struct {
	GuildName    string `path:"guildName"`    // The name of the guild to collect reports for.
	ServerName   string `path:"serverName"`   // The server that the guild is found on. For World of Warcraft this is the 'slug' field returned from their realm status API.
	ServerRegion Region `path:"serverRegion"` // The short region name for the server on which the guild is located: US, EU, KR, TW, CN.
	Start        *int   `query:"start"`       // An optional start time. This is a UNIX timestamp but with millisecond precision. If omitted, 0 is assumed.
	End          *int   `query:"end"`         // An optional end time. This is a UNIX timestamp but with millisecond precision. If omitted, the current time is assumed.
}

type ReportsUserOptions struct {
	UserName string `path:"userName"` // The name of the user to collect reports for.
	Start    *int   `query:"start"`   // An optional start time. This is a UNIX timestamp but with millisecond precision. If omitted, 0 is assumed.
	End      *int   `query:"end"`     // An optional end time. This is a UNIX timestamp but with millisecond precision. If omitted, the current time is assumed.
}

type Timeframe string