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