@isnap/sdk 2.3.0-next.234 → 2.3.0-next.235
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`. The right to create one comes from an inbound pool on your account, whether or not you are a wholesale partner: without one the call gets `403 inbound_pool_required`. 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`.
|
|
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`. The right to create one then comes from an inbound pool on your account, whether or not you are a wholesale partner: without one the call gets `403 inbound_pool_required`. 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_required`: `inbound_first` is `true` and the account has no inbound pool. No line is created. */
|
|
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. `inbound_pool_required`: `inbound_first` is `true` and the account has no inbound pool. No line is created. */
|
|
996
996
|
403: {
|
|
997
997
|
headers: {
|
|
998
998
|
[name: string]: unknown;
|
|
@@ -2981,7 +2981,7 @@ export interface paths {
|
|
|
2981
2981
|
* Create an invite
|
|
2982
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.
|
|
2983
2983
|
*
|
|
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. 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.
|
|
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
|
*/
|
|
2986
2986
|
post: {
|
|
2987
2987
|
parameters: {
|
|
@@ -3037,7 +3037,7 @@ export interface paths {
|
|
|
3037
3037
|
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
3038
3038
|
};
|
|
3039
3039
|
};
|
|
3040
|
-
/** @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 and this line is outside its list. */
|
|
3040
|
+
/** @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 and this line is outside its list. `inbound_pool_not_enabled`: inbound-first lines are not enabled on the account, a private alpha enabled per account on request. No invite is issued. */
|
|
3041
3041
|
403: {
|
|
3042
3042
|
headers: {
|
|
3043
3043
|
[name: string]: unknown;
|
|
@@ -8927,7 +8927,7 @@ export interface components {
|
|
|
8927
8927
|
metadata?: {
|
|
8928
8928
|
[key: string]: unknown;
|
|
8929
8929
|
};
|
|
8930
|
-
/** @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`).
|
|
8930
|
+
/** @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), and require an inbound pool on your account (`403 inbound_pool_required` otherwise). Defaults to `false`: an ordinary shared line. */
|
|
8931
8931
|
inbound_first?: boolean;
|
|
8932
8932
|
};
|
|
8933
8933
|
/** @description Optional settings of the activated line: its variant and its billing anchor. */
|