[{"data":1,"prerenderedAt":933},["ShallowReactive",2],{"navigation":3,"\u002Frent":43,"\u002Frent-surround":928},[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":14,"body":45,"description":922,"extension":923,"meta":924,"navigation":925,"path":15,"seo":926,"stem":16,"__hash__":927},"docs\u002Frent.md",{"type":46,"value":47,"toc":913},"minimark",[48,61,118,122,125,190,278,357,383,386,389,410,494,498,501,521,557,565,567,576,606,656,665,668,671,690,712,726,729,732,763,779,808,812,815,840,901,909],[49,50,51,52,56,57,60],"p",{},"A rent keeps a number for ",[53,54,55],"code",{},"days"," days. Its SMS come in ",[53,58,59],{},"RentItem.messages",", newest first.",[49,62,63,66,67,70,71,74,75,78,79,82,83,86,87,90,91,94,95,98,99,102,103,106,107,110,111,66,114,117],{},[53,64,65],{},"RentItem",": ",[53,68,69],{},"{ tzid, status, number, country, sum, days, hours, time, time_seconds?, extension, extend, messages, start_time, stop_time, day_extend?, … }"," —\n",[53,72,73],{},"sum"," is the price paid in USD (a number; the server sends a decimal string), ",[53,76,77],{},"time"," minutes left, ",[53,80,81],{},"time_seconds"," seconds left,\n",[53,84,85],{},"extension"," ",[53,88,89],{},"0"," not extendable \u002F ",[53,92,93],{},"1"," extendable \u002F ",[53,96,97],{},"2"," auto-extension, ",[53,100,101],{},"extend"," maps days to the extension price (",[53,104,105],{},"{}"," when not extendable),\n",[53,108,109],{},"messages"," is ",[53,112,113],{},"RentSms[]",[53,115,116],{},"{ id, service, text, code, created_at }",".",[119,120,121],"h2",{"id":121},"get",[49,123,124],{},"Rent a number and charge the balance.",[126,127,132],"pre",{"className":128,"code":129,"language":130,"meta":131,"style":131},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","get(country = 7, days = 1, extension = true): Promise\u003CRentItem>\n","ts","",[53,133,134],{"__ignoreMap":131},[135,136,138,141,145,149,153,156,159,161,164,166,169,171,175,178,182,185,187],"span",{"class":137,"line":12},"line",[135,139,121],{"class":140},"s2Zo4",[135,142,144],{"class":143},"sTEyZ","(country ",[135,146,148],{"class":147},"sMK4o","=",[135,150,152],{"class":151},"sbssI"," 7",[135,154,155],{"class":147},",",[135,157,158],{"class":143}," days ",[135,160,148],{"class":147},[135,162,163],{"class":151}," 1",[135,165,155],{"class":147},[135,167,168],{"class":143}," extension ",[135,170,148],{"class":147},[135,172,174],{"class":173},"sfNiH"," true",[135,176,177],{"class":143},"): ",[135,179,181],{"class":180},"sBMFI","Promise",[135,183,184],{"class":147},"\u003C",[135,186,65],{"class":143},[135,188,189],{"class":147},">\n",[191,192,193,212],"table",{},[194,195,196],"thead",{},[197,198,199,203,206,209],"tr",{},[200,201,202],"th",{},"Param",[200,204,205],{},"Type",[200,207,208],{},"Default",[200,210,211],{},"Description",[213,214,215,236,256],"tbody",{},[197,216,217,223,228,233],{},[218,219,220],"td",{},[53,221,222],{},"country",[218,224,225],{},[53,226,227],{},"number",[218,229,230],{},[53,231,232],{},"7",[218,234,235],{},"Country code.",[197,237,238,242,246,250],{},[218,239,240],{},[53,241,55],{},[218,243,244],{},[53,245,227],{},[218,247,248],{},[53,249,93],{},[218,251,252,253,255],{},"One of the tariff's ",[53,254,55],{}," keys.",[197,257,258,262,267,272],{},[218,259,260],{},[53,261,85],{},[218,263,264],{},[53,265,266],{},"boolean",[218,268,269],{},[53,270,271],{},"true",[218,273,274,277],{},[53,275,276],{},"false"," makes the rent non-extendable for good.",[126,279,281],{"className":128,"code":280,"language":130,"meta":131,"style":131},"const rent = await client.rent.get(7, 7)\nconsole.log(rent.tzid, rent.number, rent.sum)\n",[53,282,283,321],{"__ignoreMap":131},[135,284,285,289,292,294,298,301,303,305,307,309,312,314,316,318],{"class":137,"line":12},[135,286,288],{"class":287},"spNyl","const",[135,290,291],{"class":143}," rent ",[135,293,148],{"class":147},[135,295,297],{"class":296},"s7zQu"," await",[135,299,300],{"class":143}," client",[135,302,117],{"class":147},[135,304,16],{"class":143},[135,306,117],{"class":147},[135,308,121],{"class":140},[135,310,311],{"class":143},"(",[135,313,232],{"class":151},[135,315,155],{"class":147},[135,317,152],{"class":151},[135,319,320],{"class":143},")\n",[135,322,323,326,328,331,334,336,339,341,344,346,348,350,352,354],{"class":137,"line":17},[135,324,325],{"class":143},"console",[135,327,117],{"class":147},[135,329,330],{"class":140},"log",[135,332,333],{"class":143},"(rent",[135,335,117],{"class":147},[135,337,338],{"class":143},"tzid",[135,340,155],{"class":147},[135,342,343],{"class":143}," rent",[135,345,117],{"class":147},[135,347,227],{"class":143},[135,349,155],{"class":147},[135,351,343],{"class":143},[135,353,117],{"class":147},[135,355,356],{"class":143},"sum)\n",[49,358,359,360,363,364,86,367,370,371,370,374,370,377,370,380,117],{},"Errors: ",[53,361,362],{},"NoNumberError","; ",[53,365,366],{},"ApiError",[53,368,369],{},"UNDEFINED_DAYS",", ",[53,372,373],{},"UNDEFINED_COUNTRY",[53,375,376],{},"WARNING_LOW_BALANCE",[53,378,379],{},"INTERVAL_CONCURRENT_REQUESTS_ERROR",[53,381,382],{},"TRY_AGAIN_LATER",[119,384,385],{"id":385},"state",[49,387,388],{},"All rents of the account.",[126,390,392],{"className":128,"code":391,"language":130,"meta":131,"style":131},"state(): Promise\u003CRentItem[]>\n",[53,393,394],{"__ignoreMap":131},[135,395,396,398,401,403,405,408],{"class":137,"line":12},[135,397,385],{"class":140},[135,399,400],{"class":143},"(): ",[135,402,181],{"class":180},[135,404,184],{"class":147},[135,406,407],{"class":143},"RentItem[]",[135,409,189],{"class":147},[126,411,413],{"className":128,"code":412,"language":130,"meta":131,"style":131},"for (const rent of await client.rent.state()) {\n  console.log(rent.number, rent.messages[0]?.code)\n}\n",[53,414,415,448,489],{"__ignoreMap":131},[135,416,417,420,423,425,427,430,432,434,436,438,440,442,445],{"class":137,"line":12},[135,418,419],{"class":296},"for",[135,421,422],{"class":143}," (",[135,424,288],{"class":287},[135,426,291],{"class":143},[135,428,429],{"class":147},"of",[135,431,297],{"class":296},[135,433,300],{"class":143},[135,435,117],{"class":147},[135,437,16],{"class":143},[135,439,117],{"class":147},[135,441,385],{"class":140},[135,443,444],{"class":143},"()) ",[135,446,447],{"class":147},"{\n",[135,449,450,453,455,457,460,462,464,466,468,470,472,474,477,479,482,485,487],{"class":137,"line":17},[135,451,452],{"class":143},"  console",[135,454,117],{"class":147},[135,456,330],{"class":140},[135,458,311],{"class":459},"swJcz",[135,461,16],{"class":143},[135,463,117],{"class":147},[135,465,227],{"class":143},[135,467,155],{"class":147},[135,469,343],{"class":143},[135,471,117],{"class":147},[135,473,109],{"class":143},[135,475,476],{"class":459},"[",[135,478,89],{"class":151},[135,480,481],{"class":459},"]",[135,483,484],{"class":147},"?.",[135,486,53],{"class":143},[135,488,320],{"class":459},[135,490,491],{"class":137,"line":22},[135,492,493],{"class":147},"}\n",[119,495,497],{"id":496},"stateone","stateOne",[49,499,500],{},"One rent.",[126,502,504],{"className":128,"code":503,"language":130,"meta":131,"style":131},"stateOne(tzid: number): Promise\u003CRentItem>\n",[53,505,506],{"__ignoreMap":131},[135,507,508,510,513,515,517,519],{"class":137,"line":12},[135,509,497],{"class":140},[135,511,512],{"class":143},"(tzid: number): ",[135,514,181],{"class":180},[135,516,184],{"class":147},[135,518,65],{"class":143},[135,520,189],{"class":147},[126,522,524],{"className":128,"code":523,"language":130,"meta":131,"style":131},"const { messages } = await client.rent.stateOne(tzid)\n",[53,525,526],{"__ignoreMap":131},[135,527,528,530,533,536,539,542,544,546,548,550,552,554],{"class":137,"line":12},[135,529,288],{"class":287},[135,531,532],{"class":147}," {",[135,534,535],{"class":143}," messages ",[135,537,538],{"class":147},"}",[135,540,541],{"class":147}," =",[135,543,297],{"class":296},[135,545,300],{"class":143},[135,547,117],{"class":147},[135,549,16],{"class":143},[135,551,117],{"class":147},[135,553,497],{"class":140},[135,555,556],{"class":143},"(tzid)\n",[49,558,359,559,86,561,564],{},[53,560,366],{},[53,562,563],{},"ERROR_NO_OPERATIONS"," for an unknown tzid.",[119,566,101],{"id":101},[49,568,569,570,572,573,117],{},"Extend a rent by ",[53,571,55],{}," days and charge the balance. Only rents created with ",[53,574,575],{},"extension: true",[126,577,579],{"className":128,"code":578,"language":130,"meta":131,"style":131},"extend(tzid: number, days = 1): Promise\u003CRentItem>\n",[53,580,581],{"__ignoreMap":131},[135,582,583,585,588,590,592,594,596,598,600,602,604],{"class":137,"line":12},[135,584,101],{"class":140},[135,586,587],{"class":143},"(tzid: number",[135,589,155],{"class":147},[135,591,158],{"class":143},[135,593,148],{"class":147},[135,595,163],{"class":151},[135,597,177],{"class":143},[135,599,181],{"class":180},[135,601,184],{"class":147},[135,603,65],{"class":143},[135,605,189],{"class":147},[126,607,609],{"className":128,"code":608,"language":130,"meta":131,"style":131},"const rent = await client.rent.extend(tzid, 3)\nconsole.log(rent.stop_time)\n",[53,610,611,641],{"__ignoreMap":131},[135,612,613,615,617,619,621,623,625,627,629,631,634,636,639],{"class":137,"line":12},[135,614,288],{"class":287},[135,616,291],{"class":143},[135,618,148],{"class":147},[135,620,297],{"class":296},[135,622,300],{"class":143},[135,624,117],{"class":147},[135,626,16],{"class":143},[135,628,117],{"class":147},[135,630,101],{"class":140},[135,632,633],{"class":143},"(tzid",[135,635,155],{"class":147},[135,637,638],{"class":151}," 3",[135,640,320],{"class":143},[135,642,643,645,647,649,651,653],{"class":137,"line":17},[135,644,325],{"class":143},[135,646,117],{"class":147},[135,648,330],{"class":140},[135,650,333],{"class":143},[135,652,117],{"class":147},[135,654,655],{"class":143},"stop_time)\n",[49,657,359,658,86,660,662,663,117],{},[53,659,366],{},[53,661,382],{}," (not extendable, unknown tzid or period, a repeat within 10 s), ",[53,664,376],{},[119,666,667],{"id":667},"close",[49,669,670],{},"Return the number before the period ends. A rent that is not confirmed yet and has no SMS can be closed only after 120 s; US numbers cannot be closed early.",[126,672,674],{"className":128,"code":673,"language":130,"meta":131,"style":131},"close(tzid: number): Promise\u003Ctrue>\n",[53,675,676],{"__ignoreMap":131},[135,677,678,680,682,684,686,688],{"class":137,"line":12},[135,679,667],{"class":140},[135,681,512],{"class":143},[135,683,181],{"class":180},[135,685,184],{"class":147},[135,687,271],{"class":173},[135,689,189],{"class":147},[126,691,693],{"className":128,"code":692,"language":130,"meta":131,"style":131},"await client.rent.close(tzid)\n",[53,694,695],{"__ignoreMap":131},[135,696,697,700,702,704,706,708,710],{"class":137,"line":12},[135,698,699],{"class":296},"await",[135,701,300],{"class":143},[135,703,117],{"class":147},[135,705,16],{"class":143},[135,707,117],{"class":147},[135,709,667],{"class":140},[135,711,556],{"class":143},[49,713,359,714,86,716,370,718,370,721,370,724,117],{},[53,715,366],{},[53,717,563],{},[53,719,720],{},"NO_COMPLETE_TZID",[53,722,723],{},"NO_CLOSE_RENT_US",[53,725,382],{},[119,727,728],{"id":728},"tariffs",[49,730,731],{},"Rent prices of every country, keyed by country code. No API key needed.",[126,733,735],{"className":128,"code":734,"language":130,"meta":131,"style":131},"tariffs(): Promise\u003CRecord\u003Cstring, RentTariff>>\n",[53,736,737],{"__ignoreMap":131},[135,738,739,741,743,745,747,750,752,755,757,760],{"class":137,"line":12},[135,740,728],{"class":140},[135,742,400],{"class":143},[135,744,181],{"class":180},[135,746,184],{"class":147},[135,748,749],{"class":143},"Record",[135,751,184],{"class":147},[135,753,754],{"class":143},"string",[135,756,155],{"class":147},[135,758,759],{"class":143}," RentTariff",[135,761,762],{"class":147},">>\n",[49,764,765,66,768,771,772,774,775,778],{},[53,766,767],{},"RentTariff",[53,769,770],{},"{ code, name, enabled, new, position, extend, confirm?, days, count, ext_counts? }"," — ",[53,773,55],{}," maps rent days to the price in USD, ",[53,776,777],{},"count"," to the numbers available.",[126,780,782],{"className":128,"code":781,"language":130,"meta":131,"style":131},"const tariffs = await client.rent.tariffs()\n",[53,783,784],{"__ignoreMap":131},[135,785,786,788,791,793,795,797,799,801,803,805],{"class":137,"line":12},[135,787,288],{"class":287},[135,789,790],{"class":143}," tariffs ",[135,792,148],{"class":147},[135,794,297],{"class":296},[135,796,300],{"class":143},[135,798,117],{"class":147},[135,800,16],{"class":143},[135,802,117],{"class":147},[135,804,728],{"class":140},[135,806,807],{"class":143},"()\n",[119,809,811],{"id":810},"tariffsone","tariffsOne",[49,813,814],{},"Rent prices of one country.",[126,816,818],{"className":128,"code":817,"language":130,"meta":131,"style":131},"tariffsOne(country = 7): Promise\u003CRentTariff>\n",[53,819,820],{"__ignoreMap":131},[135,821,822,824,826,828,830,832,834,836,838],{"class":137,"line":12},[135,823,811],{"class":140},[135,825,144],{"class":143},[135,827,148],{"class":147},[135,829,152],{"class":151},[135,831,177],{"class":143},[135,833,181],{"class":180},[135,835,184],{"class":147},[135,837,767],{"class":143},[135,839,189],{"class":147},[126,841,843],{"className":128,"code":842,"language":130,"meta":131,"style":131},"const { days } = await client.rent.tariffsOne(7)\nconsole.log(days['7']) \u002F\u002F price of 7 days\n",[53,844,845,875],{"__ignoreMap":131},[135,846,847,849,851,853,855,857,859,861,863,865,867,869,871,873],{"class":137,"line":12},[135,848,288],{"class":287},[135,850,532],{"class":147},[135,852,158],{"class":143},[135,854,538],{"class":147},[135,856,541],{"class":147},[135,858,297],{"class":296},[135,860,300],{"class":143},[135,862,117],{"class":147},[135,864,16],{"class":143},[135,866,117],{"class":147},[135,868,811],{"class":140},[135,870,311],{"class":143},[135,872,232],{"class":151},[135,874,320],{"class":143},[135,876,877,879,881,883,886,889,892,894,897],{"class":137,"line":17},[135,878,325],{"class":143},[135,880,117],{"class":147},[135,882,330],{"class":140},[135,884,885],{"class":143},"(days[",[135,887,888],{"class":147},"'",[135,890,232],{"class":891},"sfazB",[135,893,888],{"class":147},[135,895,896],{"class":143},"]) ",[135,898,900],{"class":899},"sHwdD","\u002F\u002F price of 7 days\n",[49,902,359,903,86,905,908],{},[53,904,366],{},[53,906,907],{},"NO_COUNTRY"," for a country without rent.",[910,911,912],"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 .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}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 .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}",{"title":131,"searchDepth":17,"depth":17,"links":914},[915,916,917,918,919,920,921],{"id":121,"depth":17,"text":121},{"id":385,"depth":17,"text":385},{"id":496,"depth":17,"text":497},{"id":101,"depth":17,"text":101},{"id":667,"depth":17,"text":667},{"id":728,"depth":17,"text":728},{"id":810,"depth":17,"text":811},"Rent a number for days and receive every SMS sent to it — client.rent.","md",{},{"order":17},{"title":14,"description":922},"cuTSRI1T_J_7MfoVjuhow9Wt9mAC_6hS-fd4DIP4js0",[929,931],{"title":9,"path":10,"stem":11,"description":930,"order":12},"Order a number, read its SMS, close it — client.numbers.",{"title":34,"path":35,"stem":36,"description":932,"order":37},"Test your integration offline with MockOnlineSim — no network, key or money.",1795107813730]