Bug: incorrect type for mediaUrl in MessageListInstanceCreateOptions

[okhomenko]

Version:
"[email protected]"

Code Snippet

/**
 * @param {object} opts
 * @param {object} opts.body
 * @param {string} [opts.mediaUrl]
 * @param {string} opts.recipientNumber
 */
const sendSMS = ({ body, mediaUrl, recipientNumber }) => {
  /** @type {{ twilioClient: import('twilio').Twilio, twilioNumber: string; }} */
  const { twilioClient, twilioNumber } = container.cradle;

  const toNumberE164Format = `+1${recipientNumber}`;

  /**
   * @type {import('twilio/lib/rest/api/v2010/account/message').MessageListInstanceCreateOptions}
   */
  const smsContent = {
    from: twilioNumber,
    to: toNumberE164Format,
    body,
    mediaUrl,
  };

  return twilioClient.messages.create(smsContent);
};

Steps to Reproduce

1. run this snippet against tsc
2. notice it's a javascript code with types in jsdoc annotations

Bug

Type for mediaUrl in import('twilio/lib/rest/api/v2010/account/message').MessageListInstanceCreateOptions is

  mediaUrl?: string[];

I think it should be

  mediaUrl?: string | string[];

[childish-sambino]

A string array is the intended type. See example usage here: https://www.twilio.com/docs/sms/send-messages?code-sample=code-send-an-mms-message&code-language=Node.js&code-sdk-version=3.x}

Are you suggesting the lib should accept either?

[okhomenko]

I think it accepts either string|string[]

twilio-node/lib/rest/api/v2010/account/message.js

Line 83 in 94c28fa

* @param {string|list} [opts.mediaUrl] -

[childish-sambino]

Ah, I see. The JS accepts either and so should the TS. I'll look into a fix.