en-US/posh-Brawl-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-BrawlStars</command:name> <command:verb>Connect</command:verb> <command:noun>BrawlStars</command:noun> <maml:description> <maml:para>Establishes Connection to Brawl Stars API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Establishes Connection to Brawl Stars API.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-BrawlStars</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>Specifies the key file which contains the token needed for authentication against the endpoints. -Default KeyFile is set $Script:DefaultKeyFile, found in $Script:KeysDirectory -Default originally set in PSM1 File. if specified, this function overrides it -If you want to use a different token, specify entire path E.G.: C:\Users\username\Documents\MyLittleSecret.Secret</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"$Script:DefaultKeyFile"</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>Specifies the key file which contains the token needed for authentication against the endpoints. -Default KeyFile is set $Script:DefaultKeyFile, found in $Script:KeysDirectory -Default originally set in PSM1 File. if specified, this function overrides it -If you want to use a different token, specify entire path E.G.: C:\Users\username\Documents\MyLittleSecret.Secret</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"$Script:DefaultKeyFile"</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/getting-started</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Connect-BrawlStars</dev:code> <dev:remarks> <maml:para>Connection Successful.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-BattleData</command:name> <command:verb>Get</command:verb> <command:noun>BattleData</command:noun> <maml:description> <maml:para>Get Battle Summary Data of last 25 games of player</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Battle Summary Data of last 25 games of player</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BattleData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>PlayerTag</maml:name> <maml:description> <maml:para>PlayerTag of a user/player</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IgnoreDraws</maml:name> <maml:description> <maml:para>Ignore games that ended in a draw. This may mean the total count is less than 25.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>PlayerTag</maml:name> <maml:description> <maml:para>PlayerTag of a user/player</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IgnoreDraws</maml:name> <maml:description> <maml:para>Ignore games that ended in a draw. This may mean the total count is less than 25.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-BattleData -PlayerTag 'YGU20CRG'</dev:code> <dev:remarks> <maml:para>Player : VitalShark PlayerTag : YGU20CRG Wins : 24 RoyaleWins : 0 StarPlayerTotal : 12 StarPlayerPercentage : 50 Loses : 1 Draws : 0 WinPercent : 96 TotalRoyaleGames : TotalGames : 25 Modes : {@{GamesPlayed=3; Name=bounty}, @{GamesPlayed=22; Name=brawlBall}}</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-BattleData -PlayerTag '#YGU20CRG' -IgnoreDraws</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-BattleLog</command:name> <command:verb>Get</command:verb> <command:noun>BattleLog</command:noun> <maml:description> <maml:para>Get list of recent battle results for a player</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get list of recent battle results for a player. If no recent matches have been played, may return a status 404 NOTE: It may take up to 30 minutes for a new battle to appear in the battlelog</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BattleLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>PlayerTag</maml:name> <maml:description> <maml:para>Playertag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>uri of endpoint..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"$Script:PlayersEndPoint/%23$PlayerTag/battlelog"</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>PlayerTag</maml:name> <maml:description> <maml:para>Playertag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>uri of endpoint..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"$Script:PlayersEndPoint/%23$PlayerTag/battlelog"</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-BattleLog -PlayerTag 'YGU20CRG'</dev:code> <dev:remarks> <maml:para>battleTime event battle ---------- ----- ------ 20220602T062543.000Z @{id=0; map=} @{mode=bounty; type=friendly; result=victory; duration=120; starPlayer=; teams=System.Object[]} 20220602T062245.000Z @{id=0; map=} @{mode=bounty; type=friendly; result=victory; duration=120; starPlayer=; teams=System.Object[]} 20220602T061942.000Z @{id=0; map=} @{mode=bounty; type=friendly; result=defeat; duration=120; starPlayer=; teams=System.Object[]} 20220602T061704.000Z @{id=15000531; mode=brawlBall; map=Extra Bouncy} @{mode=brawlBall; type=friendly; result=victory; duration=32; starPlayer=; teams=System.Object[]} 20220530T052241.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=118; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T051448.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=28; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T050909.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=65; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T050218.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=36; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T045627.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=90; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T044741.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=67; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T044120.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=45; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T043503.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=38; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T042350.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=120; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T041903.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=78; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T041218.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=67; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T040459.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=32; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T035916.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=150; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T034611.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=75; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T034033.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=106; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T033405.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=37; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T032729.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=88; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T032226.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=60; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T031550.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=63; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T030021.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=134; trophyChange=3; starPlayer=; teams=System.Object[]} 20220530T025445.000Z @{id=15000132; mode=brawlBall; map=Center Stage} @{mode=brawlBall; type=ranked; result=victory; duration=85; trophyChange=3; starPlayer=; teams=System.Object[]}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Brawler</command:name> <command:verb>Get</command:verb> <command:noun>Brawler</command:noun> <maml:description> <maml:para>Get Brawler information</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-Brawler, simply put, returns brawler information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Brawler</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ID, Identifier"> <maml:name>BrawlerID</maml:name> <maml:description> <maml:para>Part of the ParameterSet 'BrawlerID'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Brawler</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Brawler, Hero"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the Brawler. Part of the ParameterSet 'Name'. This will use a local index to determine the ID to pass to the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Brawler</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Part of the default ParameterSet 'All'. If no parameters are passed and no pipeline data is pass, the all parameterset is used. This will return all brawlers from the /brawlers endpoint.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ID, Identifier"> <maml:name>BrawlerID</maml:name> <maml:description> <maml:para>Part of the ParameterSet 'BrawlerID'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Brawler, Hero"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the Brawler. Part of the ParameterSet 'Name'. This will use a local index to determine the ID to pass to the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Part of the default ParameterSet 'All'. If no parameters are passed and no pipeline data is pass, the all parameterset is used. This will return all brawlers from the /brawlers endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation GET /brawlers/{brawlerId} GET /brawlers</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-brawler</dev:code> <dev:remarks> <maml:para>id name starPowers gadgets -- ---- ---------- ------- 16000000 SHELLY {@{id=23000076; name=SHELL SHOCK}, @{id=23000135; name=BAND-AID}} {@{id=23000255; name=FAST FORWARD}, @{id=23000288; name=CLAY PIGEONS}} 16000001 COLT {@{id=23000077; name=SLICK BOOTS}, @{id=23000138; name=MAGNUM SPECIAL}} {@{id=23000273; name=SPEEDLOADER}, @{id=23000319; name=SILVER BULLET}} 16000002 BULL {@{id=23000078; name=BERSERKER}, @{id=23000137; name=TOUGH GUY}} {@{id=23000272; name=T-BONE INJECTOR}, @{id=23000310; name=STOMPER}} 16000003 BROCK {@{id=23000079; name=INCENDIARY}, @{id=23000150; name=ROCKET NO. 4}} {@{id=23000245; name=ROCKET LACES}, @{id=23000316; name=ROCKET FUEL}} 16000004 RICO {@{id=23000080; name=SUPER BOUNCY}, @{id=23000156; name=ROBO RETREAT}} {@{id=23000246; name=MULTIBALL LAUNCHER}} 16000005 SPIKE {@{id=23000081; name=FERTILIZE}, @{id=23000151; name=CURVEBALL}} {@{id=23000247; name=POPPING PINCUSHION}} 16000006 BARLEY {@{id=23000082; name=MEDICAL USE}, @{id=23000158; name=EXTRA NOXIOUS}} {@{id=23000250; name=STICKY SYRUP MIXER}, @{id=23000293; name=HERBAL TONIC}} 16000007 JESSIE {@{id=23000083; name=ENERGIZE}, @{id=23000149; name=SHOCKY}} {@{id=23000251; name=SPARK PLUG}, @{id=23000295; name=RECOIL SPRING}} 16000008 NITA {@{id=23000084; name=BEAR WITH ME}, @{id=23000136; name=HYPER BEAR}} {@{id=23000249; name=BEAR PAWS}, @{id=23000314; name=FAUX FUR}} 16000009 DYNAMIKE {@{id=23000085; name=DYNA-JUMP}, @{id=23000155; name=DEMOLITION}} {@{id=23000258; name=FIDGET SPINNER}, @{id=23000294; name=SATCHEL CHARGE}} 16000010 EL PRIMO {@{id=23000086; name=EL FUEGO}, @{id=23000140; name=METEOR RUSH}} {@{id=23000264; name=SUPLEX SUPPLEMENT}, @{id=23000292; name=ASTEROID BELT}} ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Trimmed Response for Comment-based help~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Brawler -BrawlerID "16000011" id name starPowers gadgets -- ---- ---------- ------- 16000011 MORTIS {@{id=23000087; name=CREEPY HARVEST}, @{id=23000154; name=COILED SNAKE}} {@{id=23000265; name=COMBO SPINNER}, @{id=23000290; name=SURVIVAL SHOVEL}}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-Brawler -Name Brock id name starPowers gadgets -- ---- ---------- ------- 16000003 BROCK {@{id=23000079; name=INCENDIARY}, @{id=23000150; name=ROCKET NO. 4}} {@{id=23000245; name=ROCKET LACES}, @{id=23000316; name=ROCKET FUEL}}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>"El Primo" | Get-Brawler id name starPowers gadgets -- ---- ---------- ------- 16000010 EL PRIMO {@{id=23000086; name=EL FUEGO}, @{id=23000140; name=METEOR RUSH}} {@{id=23000264; name=SUPLEX SUPPLEMENT}, @{id=23000292; name=ASTEROID BELT}}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-BrawlerRanking</command:name> <command:verb>Get</command:verb> <command:noun>BrawlerRanking</command:noun> <maml:description> <maml:para>Get brawler rankings for a country or global ranking.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get brawler rankings for a country or global rankings. Brawler identifiers can be found by using the /v1/brawlers API endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BrawlerRanking</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ID"> <maml:name>BrawlerID</maml:name> <maml:description> <maml:para>Type: INT Alias: ID Identifier of the brawler. Can be queried using Get-Brawler</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-BrawlerRanking</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ID"> <maml:name>BrawlerID</maml:name> <maml:description> <maml:para>Type: INT Alias: ID Identifier of the brawler. Can be queried using Get-Brawler</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Global</maml:name> <maml:description> <maml:para>Type: Switch This parameter forces checking the Global endpoint</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ID"> <maml:name>BrawlerID</maml:name> <maml:description> <maml:para>Type: INT Alias: ID Identifier of the brawler. Can be queried using Get-Brawler</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Global</maml:name> <maml:description> <maml:para>Type: Switch This parameter forces checking the Global endpoint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation To do: This endpoint supports before and after query strings, need to add logic and parameter sets to support this scenario.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-BrawlerRanking -BrawlerID 16000011 -Limit 1</dev:code> <dev:remarks> <maml:para>tag : #20288898G name : ☔︎LT|Rayy-Nex☔︎ nameColor : 0xffffffff icon : @{id=28000014} trophies : 1270 rank : 1 club : @{name=ReVant}</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Brawler -Name Shelly | Get-BrawlerRanking</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>16000012 | Get-BrawlerRanking</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>16000013 | Get-BrawlerRanking -Limit 1</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Club</command:name> <command:verb>Get</command:verb> <command:noun>Club</command:noun> <maml:description> <maml:para>Get Infomration about a single club</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about a single club by tag. Club tags can be found in game.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Club</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ClubTag</maml:name> <maml:description> <maml:para>Club tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ClubTag</maml:name> <maml:description> <maml:para>Club tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>GET /clubs/{clubTag}</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Club -ClubTag "#2089L0PG2"</dev:code> <dev:remarks> <maml:para>tag : #2089L0PG2 name : CODEMAGIC description : Clan OFFICIEL de CODEMAGIC.web : codemagic.fr 🧙♂️ twitter : @ CODEMAGIC 🧙♂️ discord.gg/codemagic 🧙♂️youtube.com/codemagic type : closed badgeId : 8000025 requiredTrophies : 25000 trophies : 0 members : {}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClubMember</command:name> <command:verb>Get</command:verb> <command:noun>ClubMember</command:noun> <maml:description> <maml:para>List Club Members</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function gets a list of club members.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClubMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>ClubTag</maml:name> <maml:description> <maml:para>tag of club</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>ClubTag</maml:name> <maml:description> <maml:para>tag of club</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ClubMember -ClubTag "208UU822P" | Select-Object -First 2</dev:code> <dev:remarks> <maml:para>tag : #90QUR2QY name : TQ | RaaFa nameColor : 0xfff9c908 role : member trophies : 54485 icon : @{id=28000038}</maml:para> <maml:para> tag : #VGQ0P2VU name : Uncle Carry nameColor : 0xff1ba5f5 role : president trophies : 51279 icon : @{id=28000011}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClubRanking</command:name> <command:verb>Get</command:verb> <command:noun>ClubRanking</command:noun> <maml:description> <maml:para>Get information about a single player by player tag</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about a single player by player tag</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClubRanking</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Global</maml:name> <maml:description> <maml:para>Global endpoint</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Global</maml:name> <maml:description> <maml:para>Global endpoint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ClubRanking tag : #2GUU9908V name : BC*|Family* badgeId : 8000006 trophies : 1504063 rank : 1 memberCount : 30</dev:code> <dev:remarks> <maml:para>tag : #P8PV2YU9 name : Game.Tv ITA badgeId : 8000055 trophies : 1474250 rank : 2 memberCount : 30</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Player</command:name> <command:verb>Get</command:verb> <command:noun>Player</command:noun> <maml:description> <maml:para>Get information about a single player by player tag</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about a single player by player tag</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Player</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>PlayerTag</maml:name> <maml:description> <maml:para>Player tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BestBrawler</maml:name> <maml:description> <maml:para>Type: Switch outputs the brawler with the highest trophy this player has.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>PlayerTag</maml:name> <maml:description> <maml:para>Player tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BestBrawler</maml:name> <maml:description> <maml:para>Type: Switch outputs the brawler with the highest trophy this player has.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Player -PlayerTag '#C08UC2C'</dev:code> <dev:remarks> <maml:para>tag : #C08UC2C name : Imagine nameColor : 0xffffce89 icon : @{id=28000000} trophies : 27802 highestTrophies : 38103 highestPowerPlayPoints : 1123 expLevel : 264 expPoints : 357018 isQualifiedFromChampionshipChallenge : False 3vs3Victories : 20896 soloVictories : 569 duoVictories : 2744 bestRoboRumbleTime : 5 bestTimeAsBigBrawler : 0 club : brawlers : {@{id=16000000; name=SHELLY; power=9; rank=26; trophies=574; highestTrophies=807; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}, @{id=16000001; name=COLT; power=9; rank=27; trophies=524; highestTrophies=874; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}, @{id=16000002; name=BULL; power=9; rank=27; trophies=549; highestTrophies=858; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}, @{id=16000003; name=BROCK; power=9; rank=30; trophies=574; highestTrophies=1039; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}…}</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Player -PlayerTag C08UC2C -BestBrawler</dev:code> <dev:remarks> <maml:para>tag : #C08UC2C name : Imagine nameColor : 0xffffce89 icon : @{id=28000000} trophies : 27802 highestTrophies : 38103 highestPowerPlayPoints : 1123 expLevel : 264 expPoints : 357018 isQualifiedFromChampionshipChallenge : False 3vs3Victories : 20896 soloVictories : 569 duoVictories : 2744 bestRoboRumbleTime : 5 bestTimeAsBigBrawler : 0 club : brawlers : {@{id=16000000; name=SHELLY; power=9; rank=26; trophies=574; highestTrophies=807; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}, @{id=16000001; name=COLT; power=9; rank=27; trophies=524; highestTrophies=874; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}, @{id=16000002; name=BULL; power=9; rank=27; trophies=549; highestTrophies=858; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}, @{id=16000003; name=BROCK; power=9; rank=30; trophies=574; highestTrophies=1039; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}…} bestbrawler : @{id=16000003; name=BROCK; power=9; rank=30; trophies=574; highestTrophies=1039; gears=System.Object[]; starPowers=System.Object[]; gadgets=System.Object[]}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PlayerRanking</command:name> <command:verb>Get</command:verb> <command:noun>PlayerRanking</command:noun> <maml:description> <maml:para>Get player rankings for a country or global rankings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get player rankings for a country or global rankings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PlayerRanking</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Global</maml:name> <maml:description> <maml:para>Switches context to global endpoint.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Global</maml:name> <maml:description> <maml:para>Switches context to global endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PlayerRanking -Limit 1</dev:code> <dev:remarks> <maml:para>tag : #YGU20CRG name : VitalShark nameColor : 0xffcb5aff icon : @{id=28000029} trophies : 64534 rank : 1 club : @{name=<c1>MERCY</c>}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PowerPlayRanking</command:name> <command:verb>Get</command:verb> <command:noun>PowerPlayRanking</command:noun> <maml:description> <maml:para>Coming Soon</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Coming Soon</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PowerPlayRanking</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Probably not needed but URI of endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"$script:BaseUri/$script:RankingsEndpoint/Global/powerplay/seasons?limit=$Limit"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SeasonID</maml:name> <maml:description> <maml:para>ID of Season, found by running Get-PowerPlaySeasonID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Latest</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Probably not needed but URI of endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"$script:BaseUri/$script:RankingsEndpoint/Global/powerplay/seasons?limit=$Limit"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SeasonID</maml:name> <maml:description> <maml:para>ID of Season, found by running Get-PowerPlaySeasonID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Latest</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation GET /rankings/{countryCode}/powerplay/seasons/{seasonId}</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PowerPlayRanking</dev:code> <dev:remarks> <maml:para>Coming Soon</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PowerPlaySeasonID</command:name> <command:verb>Get</command:verb> <command:noun>PowerPlaySeasonID</command:noun> <maml:description> <maml:para>Get information about a single player by player tag</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about a single player by player tag</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PowerPlaySeasonID</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code or 'GLOBAL' to query global endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Date</maml:name> <maml:description> <maml:para>Date to query in MM-dd-yyyy OR M-d-yyyy format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Type: String Two letter country code or 'GLOBAL' to query global endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Type: INT Default Value: 200 Limit the number of items returned in the response. Valid value is between 1 and 200</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Date</maml:name> <maml:description> <maml:para>Date to query in MM-dd-yyyy OR M-d-yyyy format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>https://developer.brawlstars.com/#/documentation</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PowerPlaySeasonID -Limit 5</dev:code> <dev:remarks> <maml:para>id startDate endDate -- --------- ------- 56 10-28-2019 11-11-2019 57 11-11-2019 11-25-2019 58 11-25-2019 12-09-2019 59 12-09-2019 12-23-2019 60 12-23-2019 01-06-2020</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-PowerPlaySeasonID -CountryCode US -Date 6-2-2022</dev:code> <dev:remarks> <maml:para>id startDate endDate -- --------- ------- 123 05-23-2022 06-06-2022</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-BrawlKeyFile</command:name> <command:verb>New</command:verb> <command:noun>BrawlKeyFile</command:noun> <maml:description> <maml:para>Creates a key file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a key file. This is used to authenticate to the brawl stars API Under the hood it uses Export-CLIXML to utilize windows dpapi encryption.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-BrawlKeyFile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Directory</maml:name> <maml:description> <maml:para>directory to store file in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"$Script:KeysDirectory"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>SecretName</maml:name> <maml:description> <maml:para>Name of file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default.Secret</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Directory</maml:name> <maml:description> <maml:para>directory to store file in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"$Script:KeysDirectory"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>SecretName</maml:name> <maml:description> <maml:para>Name of file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default.Secret</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Should make this a little cleaner.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-BrawlKeyFile</dev:code> <dev:remarks> <maml:para>File ---- Test.Secret</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-PowerPlayDate</command:name> <command:verb>Test</command:verb> <command:noun>PowerPlayDate</command:noun> <maml:description> <maml:para>Tests to ensure the dates being checked is between the proper dates for powerplay</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tests to ensure the dates being checked is between the proper dates for powerplay</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-PowerPlayDate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Date</maml:name> <maml:description> <maml:para>Date to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Date</maml:name> <maml:description> <maml:para>Date to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Test-PowerPlayDate -Date "$((Get-Date).date)"</dev:code> <dev:remarks> <maml:para>True</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Test-PowerPlayDate -Date 10/30/2019</dev:code> <dev:remarks> <maml:para>True</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Test-PowerPlayDate -Date 10/01/2018</dev:code> <dev:remarks> <maml:para>False</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |