@isnap/sdk 2.3.0-next.237 → 2.3.0-next.239
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.
|
@@ -927,7 +927,7 @@ export interface paths {
|
|
|
927
927
|
*
|
|
928
928
|
* Without `inbound_first`, the line is a billed line, for wholesale partners only: any other account gets `402 payment_required`. It has no per-line subscription and is billed on the monthly wholesale invoice. Every call creates one more billable line, and the API sets no limit on their number.
|
|
929
929
|
*
|
|
930
|
-
* With `inbound_first: true` the line is an inbound-first line. It answers only contacts who wrote to it first, each from the number that contact wrote to, and never writes first: a send to any other contact gets `403 outbound_first_forbidden`. Inbound-first lines are a private alpha, enabled per account on request: an account they are not enabled on gets `403 inbound_pool_not_enabled
|
|
930
|
+
* With `inbound_first: true` the line is an inbound-first line. It answers only contacts who wrote to it first, each from the number that contact wrote to, and never writes first: a send to any other contact gets `403 outbound_first_forbidden`. Inbound-first lines are a private alpha, enabled per account on request: an account they are not enabled on gets `403 inbound_pool_not_enabled`, and an account they are enabled on creates one whether or not it is a wholesale partner. The numbers its contacts write to come from the iSnap pool, one per invite (`POST /v1/lines/{line_id}/invites`). The line carries `inbound_only: true`. It has no anniversary, so it cannot be canceled at one: end it with `POST /v1/lines/{id}/terminate`.
|
|
931
931
|
*/
|
|
932
932
|
post: {
|
|
933
933
|
parameters: {
|
|
@@ -992,7 +992,7 @@ export interface paths {
|
|
|
992
992
|
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
993
993
|
};
|
|
994
994
|
};
|
|
995
|
-
/** @description Refused. `forbidden`: the request carries neither an API key in its `Authorization` header nor the header `X-Requested-With: XMLHttpRequest`, or the key is line-scoped. A line-scoped key cannot acquire a line. `inbound_pool_not_enabled`: `inbound_first` is `true` and inbound-first lines are not enabled on the account, a private alpha enabled per account on request.
|
|
995
|
+
/** @description Refused. `forbidden`: the request carries neither an API key in its `Authorization` header nor the header `X-Requested-With: XMLHttpRequest`, or the key is line-scoped. A line-scoped key cannot acquire a line. `inbound_pool_not_enabled`: `inbound_first` is `true` and inbound-first lines are not enabled on the account, a private alpha enabled per account on request. No line is created. */
|
|
996
996
|
403: {
|
|
997
997
|
headers: {
|
|
998
998
|
[name: string]: unknown;
|
|
@@ -2979,7 +2979,7 @@ export interface paths {
|
|
|
2979
2979
|
put?: never;
|
|
2980
2980
|
/**
|
|
2981
2981
|
* Create an invite
|
|
2982
|
-
* @description Picks a phone number for one of your inbound-first lines and issues a code for it. Accepts an API key. Put the number and the code in the text you ask a visitor to send, for example in an `sms:` link: the text the visitor sends to that number with the code in it links the visitor to the line, and the line can then answer the visitor from that number. Never show the number without its code.
|
|
2982
|
+
* @description Picks a phone number from the iSnap pool for one of your inbound-first lines and issues a code for it. Accepts an API key. Put the number and the code in the text you ask a visitor to send, for example in an `sms:` link: the text the visitor sends to that number with the code in it links the visitor to the line, and the line can then answer the visitor from that number. Never show the number without its code.
|
|
2983
2983
|
*
|
|
2984
2984
|
* Every call issues a new invite with a new code, even for the same visitor: `Idempotency-Key` is ignored, and a repeated call issues another invite. iSnap spreads the invites over the numbers that can take them; pass in `exclude` the numbers you do not want for this visitor. Inbound-first lines are a private alpha, enabled per account on request: an account they are not enabled on gets `403 inbound_pool_not_enabled`, whatever line it names. The body is optional; when you send one, send it as `application/json`: a body of any other type is refused with `400 validation_failed`. This operation sends no event.
|
|
2985
2985
|
*/
|
|
@@ -8779,7 +8779,7 @@ export interface paths {
|
|
|
8779
8779
|
* Add sandbox numbers to your inbound pool (staging only)
|
|
8780
8780
|
* @description Staging only: in production this operation does not exist and answers `404 not_found`.
|
|
8781
8781
|
*
|
|
8782
|
-
* Adds `count` sandbox numbers to your inbound pool and turns inbound-first lines on for your account. Accepts an API key that is not line-scoped. A sandbox number is a fictional US number (+1 202 555-0100 to 555-0199) with no phone behind it, which stands in on staging for the numbers
|
|
8782
|
+
* Adds `count` sandbox numbers to your inbound pool and turns inbound-first lines on for your account. Accepts an API key that is not line-scoped. A sandbox number is a fictional US number (+1 202 555-0100 to 555-0199) with no phone behind it, which stands in on staging for the numbers of the iSnap pool in production: your invites (`POST /v1/lines/{line_id}/invites`) pick among them, `POST /v1/sandbox/inbound` sends a lead's text to one, and what you send from one is marked sent, then delivered a few seconds later. Your pool holds at most 5 sandbox numbers in all; they stay in it. This operation sends no event, and `Idempotency-Key` is ignored: every call adds numbers.
|
|
8783
8783
|
*/
|
|
8784
8784
|
post: {
|
|
8785
8785
|
parameters: {
|
|
@@ -9156,7 +9156,7 @@ export interface components {
|
|
|
9156
9156
|
metadata?: {
|
|
9157
9157
|
[key: string]: unknown;
|
|
9158
9158
|
};
|
|
9159
|
-
/** @description `true` to create an inbound-first line: it can only message a contact who wrote to it first, from the number that contact wrote to, and it never messages a contact first (`403 outbound_first_forbidden`). Inbound-first lines are a private alpha, enabled per account on request (`403 inbound_pool_not_enabled` otherwise)
|
|
9159
|
+
/** @description `true` to create an inbound-first line: it can only message a contact who wrote to it first, from the number that contact wrote to, and it never messages a contact first (`403 outbound_first_forbidden`). Inbound-first lines are a private alpha, enabled per account on request (`403 inbound_pool_not_enabled` otherwise). The numbers its contacts write to come from the iSnap pool, one per invite (`POST /v1/lines/{line_id}/invites`). Defaults to `false`: an ordinary shared line. */
|
|
9160
9160
|
inbound_first?: boolean;
|
|
9161
9161
|
};
|
|
9162
9162
|
/** @description Optional settings of the activated line: its variant and its billing anchor. */
|