[{"data":1,"prerenderedAt":909},["ShallowReactive",2],{"navigation":3,"\u002Fuser":43,"\u002Fuser-surround":904},[4,8,13,18,23,28,33,38],{"title":5,"path":6,"stem":7},"Getting started","\u002F","index",{"title":9,"path":10,"stem":11,"order":12},"Numbers","\u002Fnumbers","numbers",1,{"title":14,"path":15,"stem":16,"order":17},"Rent","\u002Frent","rent",2,{"title":19,"path":20,"stem":21,"order":22},"User","\u002Fuser","user",3,{"title":24,"path":25,"stem":26,"order":27},"Free numbers","\u002Ffree","free",4,{"title":29,"path":30,"stem":31,"order":32},"Webhooks","\u002Fwebhooks","webhooks",5,{"title":34,"path":35,"stem":36,"order":37},"Testing","\u002Ftesting","testing",6,{"title":39,"path":40,"stem":41,"order":42},"Changelog","\u002Fchangelog","changelog",7,{"id":44,"title":19,"body":45,"description":898,"extension":899,"meta":900,"navigation":901,"path":20,"seo":902,"stem":21,"__hash__":903},"docs\u002Fuser.md",{"type":46,"value":47,"toc":890},"minimark",[48,52,56,90,125,211,230,233,236,256,305,372,376,379,414,466,556,560,567,592,620,632,636,639,658,681,685,688,724,781,886],[49,50,51],"h2",{"id":51},"balance",[53,54,55],"p",{},"Balance in USD.",[57,58,63],"pre",{"className":59,"code":60,"language":61,"meta":62,"style":62},"language-dart shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","Future\u003CBalance> balance()\n","dart","",[64,65,66],"code",{"__ignoreMap":62},[67,68,70,74,78,81,84,87],"span",{"class":69,"line":12},"line",[67,71,73],{"class":72},"sBMFI","Future",[67,75,77],{"class":76},"sTEyZ","\u003C",[67,79,80],{"class":72},"Balance",[67,82,83],{"class":76},"> ",[67,85,51],{"class":86},"s2Zo4",[67,88,89],{"class":76},"()\n",[53,91,92,94,95,97,98,97,101,104,105,108,109,111,112,114,115,117,118,108,121,124],{},[64,93,80],{},": ",[64,96,51],{},", ",[64,99,100],{},"zbalance",[64,102,103],{},"income?",", and the getter ",[64,106,107],{},"available",". ",[64,110,51],{}," includes the sum frozen by numbers and unconfirmed rents in progress (",[64,113,100],{},", which may be negative): ",[64,116,107],{}," = ",[64,119,120],{},"balance − max(zbalance, 0)",[64,122,123],{},"income"," is the partner income. The server caches the answer for 60 s.",[57,126,128],{"className":59,"code":127,"language":61,"meta":62,"style":62},"final balance = await client.user.balance();\nprint('${balance.available} of ${balance.balance} USD available');\n",[64,129,130,165],{"__ignoreMap":62},[67,131,132,136,139,143,147,150,153,155,157,159,162],{"class":69,"line":12},[67,133,135],{"class":134},"spNyl","final",[67,137,138],{"class":76}," balance ",[67,140,142],{"class":141},"sMK4o","=",[67,144,146],{"class":145},"s7zQu"," await",[67,148,149],{"class":76}," client",[67,151,152],{"class":141},".",[67,154,21],{"class":76},[67,156,152],{"class":141},[67,158,51],{"class":86},[67,160,161],{"class":76},"()",[67,163,164],{"class":141},";\n",[67,166,167,170,173,177,180,183,185,187,190,193,195,197,199,201,203,206,209],{"class":69,"line":17},[67,168,169],{"class":86},"print",[67,171,172],{"class":76},"(",[67,174,176],{"class":175},"sfazB","'",[67,178,179],{"class":76},"${",[67,181,51],{"class":182},"sHdIc",[67,184,152],{"class":76},[67,186,107],{"class":182},[67,188,189],{"class":76},"}",[67,191,192],{"class":175}," of ",[67,194,179],{"class":76},[67,196,51],{"class":182},[67,198,152],{"class":76},[67,200,51],{"class":182},[67,202,189],{"class":76},[67,204,205],{"class":175}," USD available'",[67,207,208],{"class":76},")",[67,210,164],{"class":141},[53,212,213,214,217,218,97,221,97,224,97,227,152],{},"Errors: ",[64,215,216],{},"ApiException"," ",[64,219,220],{},"ERROR_WRONG_KEY",[64,222,223],{},"ACCOUNT_BLOCKED",[64,225,226],{},"API_ACCESS_DISABLED",[64,228,229],{},"API_ACCESS_IP",[49,231,232],{"id":232},"profile",[53,234,235],{},"The account profile.",[57,237,239],{"className":59,"code":238,"language":61,"meta":62,"style":62},"Future\u003CProfile> profile()\n",[64,240,241],{"__ignoreMap":62},[67,242,243,245,247,250,252,254],{"class":69,"line":12},[67,244,73],{"class":72},[67,246,77],{"class":76},[67,248,249],{"class":72},"Profile",[67,251,83],{"class":76},[67,253,232],{"class":86},[67,255,89],{"class":76},[53,257,258,94,260,97,263,97,266,97,269,97,272,97,275,97,278,97,281,97,284,97,287,97,290,293,294,297,298,293,301,304],{},[64,259,249],{},[64,261,262],{},"id",[64,264,265],{},"name?",[64,267,268],{},"username?",[64,270,271],{},"email?",[64,273,274],{},"locale?",[64,276,277],{},"currency?",[64,279,280],{},"numberCountry?",[64,282,283],{},"numberReject",[64,285,286],{},"webhookUrl?",[64,288,289],{},"apiAccess?",[64,291,292],{},"number?"," (",[64,295,296],{},"int","), ",[64,299,300],{},"country?",[64,302,303],{},"String","), …",[57,306,308],{"className":59,"code":307,"language":61,"meta":62,"style":62},"final profile = await client.user.profile();\nprint('${profile.email} ${profile.webhookUrl}');\n",[64,309,310,335],{"__ignoreMap":62},[67,311,312,314,317,319,321,323,325,327,329,331,333],{"class":69,"line":12},[67,313,135],{"class":134},[67,315,316],{"class":76}," profile ",[67,318,142],{"class":141},[67,320,146],{"class":145},[67,322,149],{"class":76},[67,324,152],{"class":141},[67,326,21],{"class":76},[67,328,152],{"class":141},[67,330,232],{"class":86},[67,332,161],{"class":76},[67,334,164],{"class":141},[67,336,337,339,341,343,345,347,349,352,354,357,359,361,364,366,368,370],{"class":69,"line":17},[67,338,169],{"class":86},[67,340,172],{"class":76},[67,342,176],{"class":175},[67,344,179],{"class":76},[67,346,232],{"class":182},[67,348,152],{"class":76},[67,350,351],{"class":182},"email",[67,353,189],{"class":76},[67,355,356],{"class":76}," ${",[67,358,232],{"class":182},[67,360,152],{"class":76},[67,362,363],{"class":182},"webhookUrl",[67,365,189],{"class":76},[67,367,176],{"class":175},[67,369,208],{"class":76},[67,371,164],{"class":141},[49,373,375],{"id":374},"paymenthistory","paymentHistory",[53,377,378],{},"Top-up orders (paginated, newest first) and the available payment methods.",[57,380,382],{"className":59,"code":381,"language":61,"meta":62,"style":62},"Future\u003CPaymentHistory> paymentHistory({int page = 1})\n",[64,383,384],{"__ignoreMap":62},[67,385,386,388,390,393,395,397,400,402,405,407,411],{"class":69,"line":12},[67,387,73],{"class":72},[67,389,77],{"class":76},[67,391,392],{"class":72},"PaymentHistory",[67,394,83],{"class":76},[67,396,375],{"class":86},[67,398,399],{"class":76},"({",[67,401,296],{"class":72},[67,403,404],{"class":76}," page ",[67,406,142],{"class":141},[67,408,410],{"class":409},"sbssI"," 1",[67,412,413],{"class":76},"})\n",[53,415,416,94,418,293,421,297,424,97,427,97,430,108,433,436,437,440,441,443,444,447,448,451,452,455,456,458,459,97,462,465],{},[64,417,392],{},[64,419,420],{},"orders",[64,422,423],{},"Paginator\u003CPaymentOrder>",[64,425,426],{},"paylist",[64,428,429],{},"domains",[64,431,432],{},"currency",[64,434,435],{},"PaymentOrder.sum"," stays a decimal string (",[64,438,439],{},"\"89.00\"","); ",[64,442,432],{}," and ",[64,445,446],{},"formText"," may be ",[64,449,450],{},"null","; ",[64,453,454],{},"PaymentOrder.raw"," holds every field as sent. ",[64,457,426],{}," maps a group id to its payment methods; when the server sends it as a JSON array (ids 0, 1, 2…) the keys are ",[64,460,461],{},"'0'",[64,463,464],{},"'1'",", …",[57,467,469],{"className":59,"code":468,"language":61,"meta":62,"style":62},"final orders = (await client.user.paymentHistory()).orders;\nprint('${orders.total} orders, page ${orders.currentPage}\u002F${orders.lastPage}');\n",[64,470,471,504],{"__ignoreMap":62},[67,472,473,475,478,480,482,485,487,489,491,493,495,498,500,502],{"class":69,"line":12},[67,474,135],{"class":134},[67,476,477],{"class":76}," orders ",[67,479,142],{"class":141},[67,481,293],{"class":76},[67,483,484],{"class":145},"await",[67,486,149],{"class":76},[67,488,152],{"class":141},[67,490,21],{"class":76},[67,492,152],{"class":141},[67,494,375],{"class":86},[67,496,497],{"class":76},"())",[67,499,152],{"class":141},[67,501,420],{"class":76},[67,503,164],{"class":141},[67,505,506,508,510,512,514,516,518,521,523,526,528,530,532,535,537,539,541,543,545,548,550,552,554],{"class":69,"line":17},[67,507,169],{"class":86},[67,509,172],{"class":76},[67,511,176],{"class":175},[67,513,179],{"class":76},[67,515,420],{"class":182},[67,517,152],{"class":76},[67,519,520],{"class":182},"total",[67,522,189],{"class":76},[67,524,525],{"class":175}," orders, page ",[67,527,179],{"class":76},[67,529,420],{"class":182},[67,531,152],{"class":76},[67,533,534],{"class":182},"currentPage",[67,536,189],{"class":76},[67,538,6],{"class":175},[67,540,179],{"class":76},[67,542,420],{"class":182},[67,544,152],{"class":76},[67,546,547],{"class":182},"lastPage",[67,549,189],{"class":76},[67,551,176],{"class":175},[67,553,208],{"class":76},[67,555,164],{"class":141},[49,557,559],{"id":558},"setwebhookurl","setWebhookUrl",[53,561,562,563,566],{},"Set the URL that receives SMS webhooks (see ",[564,565,29],"a",{"href":30},").",[57,568,570],{"className":59,"code":569,"language":61,"meta":62,"style":62},"Future\u003Cvoid> setWebhookUrl(String url)\n",[64,571,572],{"__ignoreMap":62},[67,573,574,576,578,581,583,585,587,589],{"class":69,"line":12},[67,575,73],{"class":72},[67,577,77],{"class":76},[67,579,580],{"class":134},"void",[67,582,83],{"class":76},[67,584,559],{"class":86},[67,586,172],{"class":76},[67,588,303],{"class":72},[67,590,591],{"class":76}," url)\n",[57,593,595],{"className":59,"code":594,"language":61,"meta":62,"style":62},"await client.user.setWebhookUrl('https:\u002F\u002Fexample.com\u002Fonlinesim-hook');\n",[64,596,597],{"__ignoreMap":62},[67,598,599,601,603,605,607,609,611,613,616,618],{"class":69,"line":12},[67,600,484],{"class":145},[67,602,149],{"class":76},[67,604,152],{"class":141},[67,606,21],{"class":76},[67,608,152],{"class":141},[67,610,559],{"class":86},[67,612,172],{"class":76},[67,614,615],{"class":175},"'https:\u002F\u002Fexample.com\u002Fonlinesim-hook'",[67,617,208],{"class":76},[67,619,164],{"class":141},[53,621,213,622,217,624,627,628,631],{},[64,623,216],{},[64,625,626],{},"VALIDATION_ERROR"," for an invalid URL; ",[64,629,630],{},"message"," holds the server's field messages.",[49,633,635],{"id":634},"clearwebhookurl","clearWebhookUrl",[53,637,638],{},"Remove the webhook URL, also from operations in progress.",[57,640,642],{"className":59,"code":641,"language":61,"meta":62,"style":62},"Future\u003Cvoid> clearWebhookUrl()\n",[64,643,644],{"__ignoreMap":62},[67,645,646,648,650,652,654,656],{"class":69,"line":12},[67,647,73],{"class":72},[67,649,77],{"class":76},[67,651,580],{"class":134},[67,653,83],{"class":76},[67,655,635],{"class":86},[67,657,89],{"class":76},[57,659,661],{"className":59,"code":660,"language":61,"meta":62,"style":62},"await client.user.clearWebhookUrl();\n",[64,662,663],{"__ignoreMap":62},[67,664,665,667,669,671,673,675,677,679],{"class":69,"line":12},[67,666,484],{"class":145},[67,668,149],{"class":76},[67,670,152],{"class":141},[67,672,21],{"class":76},[67,674,152],{"class":141},[67,676,635],{"class":86},[67,678,161],{"class":76},[67,680,164],{"class":141},[49,682,684],{"id":683},"webhooklogs","webhookLogs",[53,686,687],{},"Webhook delivery log, newest first, 10 per page.",[57,689,691],{"className":59,"code":690,"language":61,"meta":62,"style":62},"Future\u003CPaginator\u003CWebhookLog>> webhookLogs({int page = 1})\n",[64,692,693],{"__ignoreMap":62},[67,694,695,697,699,702,704,707,710,712,714,716,718,720,722],{"class":69,"line":12},[67,696,73],{"class":72},[67,698,77],{"class":76},[67,700,701],{"class":72},"Paginator",[67,703,77],{"class":76},[67,705,706],{"class":72},"WebhookLog",[67,708,709],{"class":76},">> ",[67,711,684],{"class":86},[67,713,399],{"class":76},[67,715,296],{"class":72},[67,717,404],{"class":76},[67,719,142],{"class":141},[67,721,410],{"class":409},[67,723,413],{"class":76},[53,725,726,94,728,97,730,97,733,97,735,97,738,97,741,97,744,97,747,97,750,753,754,756,757,760,761,97,764,756,766,97,769,760,772,97,775,777,778,566],{},[64,727,706],{},[64,729,262],{},[64,731,732],{},"userId",[64,734,363],{},[64,736,737],{},"type",[64,739,740],{},"params",[64,742,743],{},"status",[64,745,746],{},"error?",[64,748,749],{},"createdAt",[64,751,752],{},"updatedAt"," — ",[64,755,737],{}," is ",[64,758,759],{},"WebhookType.receivingSms"," or ",[64,762,763],{},"WebhookType.rentSms",[64,765,743],{},[64,767,768],{},"success",[64,770,771],{},"fail",[64,773,774],{},"pending",[64,776,740],{}," the payload that was sent (a ",[64,779,780],{},"WebhookPayload",[57,782,784],{"className":59,"code":783,"language":61,"meta":62,"style":62},"final logs = await client.user.webhookLogs();\nfor (final log in logs.data) {\n  print('${log.createdAt} ${log.status} ${log.error}');\n}\n",[64,785,786,811,834,881],{"__ignoreMap":62},[67,787,788,790,793,795,797,799,801,803,805,807,809],{"class":69,"line":12},[67,789,135],{"class":134},[67,791,792],{"class":76}," logs ",[67,794,142],{"class":141},[67,796,146],{"class":145},[67,798,149],{"class":76},[67,800,152],{"class":141},[67,802,21],{"class":76},[67,804,152],{"class":141},[67,806,684],{"class":86},[67,808,161],{"class":76},[67,810,164],{"class":141},[67,812,813,816,818,820,823,826,829,831],{"class":69,"line":17},[67,814,815],{"class":145},"for",[67,817,293],{"class":76},[67,819,135],{"class":134},[67,821,822],{"class":76}," log ",[67,824,825],{"class":145},"in",[67,827,828],{"class":76}," logs",[67,830,152],{"class":141},[67,832,833],{"class":76},"data) {\n",[67,835,836,839,841,843,845,848,850,852,854,856,858,860,862,864,866,868,870,873,875,877,879],{"class":69,"line":22},[67,837,838],{"class":86},"  print",[67,840,172],{"class":76},[67,842,176],{"class":175},[67,844,179],{"class":76},[67,846,847],{"class":182},"log",[67,849,152],{"class":76},[67,851,749],{"class":182},[67,853,189],{"class":76},[67,855,356],{"class":76},[67,857,847],{"class":182},[67,859,152],{"class":76},[67,861,743],{"class":182},[67,863,189],{"class":76},[67,865,356],{"class":76},[67,867,847],{"class":182},[67,869,152],{"class":76},[67,871,872],{"class":182},"error",[67,874,189],{"class":76},[67,876,176],{"class":175},[67,878,208],{"class":76},[67,880,164],{"class":141},[67,882,883],{"class":69,"line":27},[67,884,885],{"class":76},"}\n",[887,888,889],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":62,"searchDepth":17,"depth":17,"links":891},[892,893,894,895,896,897],{"id":51,"depth":17,"text":51},{"id":232,"depth":17,"text":232},{"id":374,"depth":17,"text":375},{"id":558,"depth":17,"text":559},{"id":634,"depth":17,"text":635},{"id":683,"depth":17,"text":684},"Balance, profile, payments and the webhook URL — client.user.","md",{},{"order":22},{"title":19,"description":898},"YxgzXOvqrqM_AX-JGm2Y0ZDp0ua02GADCQ38zir1NqU",[905,907],{"title":34,"path":35,"stem":36,"description":906,"order":37},"Test your integration offline with MockOnlineSim — no network, key or money.",{"title":29,"path":30,"stem":31,"description":908,"order":32},"Receive SMS as HTTP callbacks and parse them with parseWebhook.",1795164323295]