Is there a release date for Typescript support?

[cdslxc]

My current project used Typescript, I wasn't able to migrate from SIB to Brevo.

[shubhamUpadhyayInBlue]

Hi @cody-ta
We are still trying to find a way to provide TS support for the same. It is taking us some time to figure that out since our SDKs are auto-generated using swagger-codegen@2.
Thanks.

[NarHakobyan]

Yeah, I think most of NodeJS developers will look for this issue. @shubhamUpadhyayInBlue have you tried https://github.com/acacode/swagger-typescript-api?

[reynolga]

Also looking for typescript support as I'm moving my website from js to typescript at the moment.

[shubhamUpadhyayInBlue]

Hello
I have raised the request and will update you as soon as I have any updates. Thanks.

[matthiasbruns]

Until solved:

swagger-typescript-api -p https://api.brevo.com/v3/swagger_definition.yml -o ./lib/email/brevo

[NarHakobyan]

Until solved:

swagger-typescript-api -p https://api.brevo.com/v3/swagger_definition.yml -o ./lib/email/brevo

Better then lib 😄

[AlexZeitler]

@matthiasbruns How do you set the API key?

[NarHakobyan]

@matthiasbruns How do you set the API key?

new Brevo({
          baseApiParams: {
            headers: {
              'api-key': yourKeyhere,
            },
          },
        })

[AlexZeitler]

@NarHakobyan Thanks!

[shubhamUpadhyayInBlue]

The latest swagger file is here: https://api.brevo.com/v3/swagger_definition_v3.yml

So, @matthiasbruns @NarHakobyan you can try using this latest swagger file instead.

[garysb]

Hi @shubhamUpadhyayInBlue, thanks for the new definition but there is an issue in the swagger file at line 17986. Please remove the double quote.

   try to get swagger by URL "https://api.brevo.com/v3/swagger_definition_v3.yml"
☄️    start generating your typescript api
SyntaxError: ';' expected. (6656:97)
  6654 |    * @example "request"
  6655 |    */
> 6656 |     event: "invalid_parameter" | "missing_parameter" | "hardBounce" | "softBounce" | "delivered"" | "spam" | "request" | "opened" | "click" | "invalid" | "deferred" | "blocked" | "unsubscribed" | "error" | "uniqueOpened" | "loadedByProxy" | "allEvents",
       |                                                                                                 ^
  6657 |   /**
  6658 |    * Webhook URL to receive CSV file link
  6659 |    * @example "https://brevo.com"

[shubhamUpadhyayInBlue]

Hi @garysb
I have fixed the swagger file. Please try and let me know if you face any issue.

[marentdev]

Take me sometimes to get it working (because din't know how swagger-typescript-api was working) but now everything is working and tested!

https://gist.github.com/marentdev/28d49bfee47704ac39fcd55cb4ac8b0e (Brevo Lib)

[higuitadiaz]

Hi @shubhamUpadhyayInBlue
Do you have defined an estimated time for an official documentation of the library under TS?

Developer:

If you do not know how to use the swagger-typescript-api library you can guide yourself with the following steps:

/** npx swagger-typescript-api -p https://api.brevo.com/v3/swagger_definition.yml -o [PATH-OUTPUT] -n [TS-FILENAME (Sample: Brevo.ts)]
**/

// SAMPLE
// console
npx swagger-typescript-api -p https://api.brevo.com/v3/swagger_definition.yml -o /src/utils/email -n Brevo.ts
...

// ts-file.ts
import { Brevo } from './utils/email/Brevo';

...

const brevo = new Brevo({ baseApiParams: { headers: { 'api-key': 'YOUR-KEY' } })