@botozap/sdk 0.17.0 → 0.18.0

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/dist/index.d.cts CHANGED
@@ -460,15 +460,24 @@ interface MediaAsset {
460
460
  expires_at: string;
461
461
  }
462
462
  /**
463
- * Link de setup de um cliente (Embedded Signup). Shape do contrato
463
+ * Link de setup de um cliente (Embedded Signup no WhatsApp, login do Instagram
464
+ * no Instagram). Shape do contrato
464
465
  * (ver `/v1/customers/:id/setup_links`): a `url` embute o token opaco; o token
465
466
  * cru nunca é exposto separadamente.
466
467
  */
467
468
  interface SetupLink {
468
469
  id: string;
470
+ /** Canal que o link conecta (cada link conecta um canal só). */
471
+ channel: "whatsapp" | "instagram";
469
472
  status: string;
473
+ /**
474
+ * Andamento da conexão. Apesar do nome, vale para os dois canais: num link do
475
+ * Instagram passa a `completed` quando a conta do Instagram conecta.
476
+ */
470
477
  whatsapp_setup_status: string;
478
+ /** `/whatsapp/setup/<token>` ou `/instagram/setup/<token>`, conforme o canal. */
471
479
  url: string;
480
+ /** Modos do WhatsApp; sempre `[]` em links do Instagram. */
472
481
  allowed_connection_types: string[];
473
482
  /**
474
483
  * Legado: `null` em links novos. A página do link é sempre em português,
@@ -3879,13 +3888,26 @@ interface UpdateCustomerParams {
3879
3888
  * link continua válido. A query string que a sua URL já tiver é preservada e o
3880
3889
  * token do link nunca é enviado. Link expirado ou revogado mostra a página de
3881
3890
  * erro, sem redirecionar.
3891
+ *
3892
+ * Cada link conecta um canal só (`channel`). No do Instagram, o Cliente
3893
+ * confirma que a conta é profissional e que as mensagens estão liberadas e
3894
+ * entra com o Instagram; sucesso vai para `success_redirect_url` com
3895
+ * `status=completed` e, numa falha, a página oferece voltar para
3896
+ * `failure_redirect_url` com `status=cancelled`.
3882
3897
  */
3883
3898
  interface CreateSetupLinkParams {
3884
3899
  /**
3885
- * Tipos de conexão liberados: "dedicated" e/ou "coexistence" (padrão
3886
- * "dedicated"). Uma lista sem nenhum tipo válido responde
3900
+ * Canal que o link conecta: "whatsapp" (padrão) ou "instagram". Outro valor
3901
+ * responde `422 invalid_channel`. O link do Instagram volta com
3902
+ * `allowed_connection_types: []` e `url` em `/instagram/setup/<token>`.
3903
+ */
3904
+ channel?: "whatsapp" | "instagram";
3905
+ /**
3906
+ * Só WhatsApp. Tipos de conexão liberados: "dedicated" e/ou "coexistence"
3907
+ * (padrão "dedicated"). Uma lista sem nenhum tipo válido responde
3887
3908
  * `422 invalid_connection_types`; tipos desconhecidos ao lado de válidos são
3888
- * ignorados.
3909
+ * ignorados. Com `channel: "instagram"`, enviar a lista responde
3910
+ * `422 invalid_connection_types`.
3889
3911
  */
3890
3912
  allowed_connection_types?: string[];
3891
3913
  /**
@@ -3936,7 +3958,8 @@ declare class Customers {
3936
3958
  * Cria um link de setup sob um cliente (expira em 30 dias). Envie a `url`
3937
3959
  * devolvida ao Cliente; veja em {@link CreateSetupLinkParams} como funcionam
3938
3960
  * os redirecionamentos. URL de redirecionamento inválida lança
3939
- * `BotoZapError` com `code: "invalid_redirect_url"` (422).
3961
+ * `BotoZapError` com `code: "invalid_redirect_url"` (422); canal inválido,
3962
+ * `code: "invalid_channel"` (422).
3940
3963
  */
3941
3964
  createSetupLink(customerId: string, params?: CreateSetupLinkParams): Promise<SetupLink>;
3942
3965
  /** Atualiza status/expiração de um link de setup. */
package/dist/index.d.ts CHANGED
@@ -460,15 +460,24 @@ interface MediaAsset {
460
460
  expires_at: string;
461
461
  }
462
462
  /**
463
- * Link de setup de um cliente (Embedded Signup). Shape do contrato
463
+ * Link de setup de um cliente (Embedded Signup no WhatsApp, login do Instagram
464
+ * no Instagram). Shape do contrato
464
465
  * (ver `/v1/customers/:id/setup_links`): a `url` embute o token opaco; o token
465
466
  * cru nunca é exposto separadamente.
466
467
  */
467
468
  interface SetupLink {
468
469
  id: string;
470
+ /** Canal que o link conecta (cada link conecta um canal só). */
471
+ channel: "whatsapp" | "instagram";
469
472
  status: string;
473
+ /**
474
+ * Andamento da conexão. Apesar do nome, vale para os dois canais: num link do
475
+ * Instagram passa a `completed` quando a conta do Instagram conecta.
476
+ */
470
477
  whatsapp_setup_status: string;
478
+ /** `/whatsapp/setup/<token>` ou `/instagram/setup/<token>`, conforme o canal. */
471
479
  url: string;
480
+ /** Modos do WhatsApp; sempre `[]` em links do Instagram. */
472
481
  allowed_connection_types: string[];
473
482
  /**
474
483
  * Legado: `null` em links novos. A página do link é sempre em português,
@@ -3879,13 +3888,26 @@ interface UpdateCustomerParams {
3879
3888
  * link continua válido. A query string que a sua URL já tiver é preservada e o
3880
3889
  * token do link nunca é enviado. Link expirado ou revogado mostra a página de
3881
3890
  * erro, sem redirecionar.
3891
+ *
3892
+ * Cada link conecta um canal só (`channel`). No do Instagram, o Cliente
3893
+ * confirma que a conta é profissional e que as mensagens estão liberadas e
3894
+ * entra com o Instagram; sucesso vai para `success_redirect_url` com
3895
+ * `status=completed` e, numa falha, a página oferece voltar para
3896
+ * `failure_redirect_url` com `status=cancelled`.
3882
3897
  */
3883
3898
  interface CreateSetupLinkParams {
3884
3899
  /**
3885
- * Tipos de conexão liberados: "dedicated" e/ou "coexistence" (padrão
3886
- * "dedicated"). Uma lista sem nenhum tipo válido responde
3900
+ * Canal que o link conecta: "whatsapp" (padrão) ou "instagram". Outro valor
3901
+ * responde `422 invalid_channel`. O link do Instagram volta com
3902
+ * `allowed_connection_types: []` e `url` em `/instagram/setup/<token>`.
3903
+ */
3904
+ channel?: "whatsapp" | "instagram";
3905
+ /**
3906
+ * Só WhatsApp. Tipos de conexão liberados: "dedicated" e/ou "coexistence"
3907
+ * (padrão "dedicated"). Uma lista sem nenhum tipo válido responde
3887
3908
  * `422 invalid_connection_types`; tipos desconhecidos ao lado de válidos são
3888
- * ignorados.
3909
+ * ignorados. Com `channel: "instagram"`, enviar a lista responde
3910
+ * `422 invalid_connection_types`.
3889
3911
  */
3890
3912
  allowed_connection_types?: string[];
3891
3913
  /**
@@ -3936,7 +3958,8 @@ declare class Customers {
3936
3958
  * Cria um link de setup sob um cliente (expira em 30 dias). Envie a `url`
3937
3959
  * devolvida ao Cliente; veja em {@link CreateSetupLinkParams} como funcionam
3938
3960
  * os redirecionamentos. URL de redirecionamento inválida lança
3939
- * `BotoZapError` com `code: "invalid_redirect_url"` (422).
3961
+ * `BotoZapError` com `code: "invalid_redirect_url"` (422); canal inválido,
3962
+ * `code: "invalid_channel"` (422).
3940
3963
  */
3941
3964
  createSetupLink(customerId: string, params?: CreateSetupLinkParams): Promise<SetupLink>;
3942
3965
  /** Atualiza status/expiração de um link de setup. */
package/dist/index.js CHANGED
@@ -5281,7 +5281,8 @@ var Customers = class {
5281
5281
  * Cria um link de setup sob um cliente (expira em 30 dias). Envie a `url`
5282
5282
  * devolvida ao Cliente; veja em {@link CreateSetupLinkParams} como funcionam
5283
5283
  * os redirecionamentos. URL de redirecionamento inválida lança
5284
- * `BotoZapError` com `code: "invalid_redirect_url"` (422).
5284
+ * `BotoZapError` com `code: "invalid_redirect_url"` (422); canal inválido,
5285
+ * `code: "invalid_channel"` (422).
5285
5286
  */
5286
5287
  createSetupLink(customerId, params = {}) {
5287
5288
  return this.client.requestItem(