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