@madewithremy/admin 0.1.52 → 0.1.53
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/dist/index.d.ts +18 -13
- package/dist/index.js.map +1 -1
- package/dist/prod.js +6 -4
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,16 @@ What changed in `@madewithremy/admin`, newest first, each version under its own
|
|
|
4
4
|
|
|
5
5
|
Versions before 0.1.44 aren't recorded here.
|
|
6
6
|
|
|
7
|
+
## 0.1.53
|
|
8
|
+
|
|
9
|
+
### Changed behavior
|
|
10
|
+
|
|
11
|
+
- `remy-admin voice numbers buy` (`admin.voice.numbersBuy`) buys a number for an app that already has one: an app can hold several, one per tenant say, and app code can buy, list and release them through `createAdminClient`. The limit is the workspace's, 10 numbers across its apps unless support raised it, and a buy past it is refused with `phone_number_limit_reached` (422). `number_already_assigned` is gone, so code that branched on it should branch on `phone_number_limit_reached` instead.
|
|
12
|
+
|
|
13
|
+
### Fixed
|
|
14
|
+
|
|
15
|
+
- The voice ops' docs give `number_unavailable`, `telnyx_not_configured`, `order_in_progress` and `number_not_active` their real status, 412.
|
|
16
|
+
|
|
7
17
|
## 0.1.52
|
|
8
18
|
|
|
9
19
|
### New
|
package/dist/index.d.ts
CHANGED
|
@@ -8888,7 +8888,7 @@ interface NumbersSearchParams {
|
|
|
8888
8888
|
*
|
|
8889
8889
|
* @throws AdminApiError `missing_search_filter` (400) — neither areaCode nor
|
|
8890
8890
|
* locality provided; `invalid_area_code` (400) — area code is not 3 digits;
|
|
8891
|
-
* `telnyx_not_configured` (
|
|
8891
|
+
* `telnyx_not_configured` (412) — phone numbers are not available on this
|
|
8892
8892
|
* platform host.
|
|
8893
8893
|
* @example
|
|
8894
8894
|
* const { results } = await admin.voice.numbersSearch({ areaCode: '310', limit: 5 });
|
|
@@ -8906,17 +8906,21 @@ interface NumbersBuyParams {
|
|
|
8906
8906
|
}
|
|
8907
8907
|
/**
|
|
8908
8908
|
* Buy and attach a dedicated phone number to the app ($1/month billed to the
|
|
8909
|
-
* workspace starting immediately —
|
|
8909
|
+
* workspace starting immediately — an agent acting for the user always
|
|
8910
|
+
* confirms with them first).
|
|
8910
8911
|
*
|
|
8911
|
-
* The number is
|
|
8912
|
-
*
|
|
8913
|
-
*
|
|
8912
|
+
* The number is an inbound line to the app's voice agent and a caller ID for
|
|
8913
|
+
* `voice.call()`. An app can hold several, one per tenant say, up to its
|
|
8914
|
+
* workspace's limit (10 unless support raised it), and app code can buy and
|
|
8915
|
+
* release them with this client. A `pending` status usually activates within
|
|
8916
|
+
* seconds; poll `numbersList` to confirm.
|
|
8914
8917
|
*
|
|
8915
8918
|
* @throws AdminApiError `invalid_phone_number` (400) — not a valid +1 E.164
|
|
8916
|
-
* US number; `
|
|
8917
|
-
*
|
|
8918
|
-
* `insufficient_credits/*` (402) — the workspace can't
|
|
8919
|
-
* `telnyx_not_configured` (
|
|
8919
|
+
* US number; `phone_number_limit_reached` (422) — the workspace holds as
|
|
8920
|
+
* many numbers as it may; `number_unavailable` (412) — the number is no
|
|
8921
|
+
* longer available; `insufficient_credits/*` (402) — the workspace can't
|
|
8922
|
+
* cover it; `telnyx_not_configured` (412) — phone numbers unavailable on
|
|
8923
|
+
* this host.
|
|
8920
8924
|
* @example
|
|
8921
8925
|
* const { number } = await admin.voice.numbersBuy({
|
|
8922
8926
|
* phoneNumber: '+13105551234',
|
|
@@ -8930,13 +8934,14 @@ declare function numbersBuy(ctx: AdminContext, params: NumbersBuyParams): Promis
|
|
|
8930
8934
|
* Release a dedicated phone number from the app (permanent).
|
|
8931
8935
|
*
|
|
8932
8936
|
* The monthly rental stops immediately (no refund for the current month),
|
|
8933
|
-
* the carrier quarantines the number for ~15 days, and
|
|
8934
|
-
* and
|
|
8937
|
+
* the carrier quarantines the number for ~15 days, and the number stops
|
|
8938
|
+
* ringing the app and can't be a `voice.call()` caller ID. The app's other
|
|
8939
|
+
* numbers are unaffected.
|
|
8935
8940
|
*
|
|
8936
8941
|
* @param e164 The phone number in E.164 or bare 10-digit US format.
|
|
8937
8942
|
* @throws Error `No phone number "${e164}" on this app` when not found;
|
|
8938
8943
|
* AdminApiError `number_not_found` (404) if the resolved id has gone stale;
|
|
8939
|
-
* `order_in_progress` (
|
|
8944
|
+
* `order_in_progress` (412) — the purchase is still settling, try again in
|
|
8940
8945
|
* a minute.
|
|
8941
8946
|
* @example
|
|
8942
8947
|
* await admin.voice.numbersRelease('+13105551234');
|
|
@@ -8953,7 +8958,7 @@ declare function numbersRelease(ctx: AdminContext, e164: string): Promise<VoiceN
|
|
|
8953
8958
|
* @param displayName 1–15 character CNAM string, or `""` to remove the listing.
|
|
8954
8959
|
* @throws Error `No phone number "${e164}" on this app` when not found;
|
|
8955
8960
|
* AdminApiError `number_not_found` (404) if the resolved id has gone stale;
|
|
8956
|
-
* `number_not_active` (
|
|
8961
|
+
* `number_not_active` (412) — the number must be active before setting a
|
|
8957
8962
|
* display name; `invalid_display_name` (400) — value is not 1–15 letters,
|
|
8958
8963
|
* numbers, or spaces.
|
|
8959
8964
|
* @example
|