stream-chat-js icon indicating copy to clipboard operation
stream-chat-js copied to clipboard

fix: add missing properties to ExportChannelStatusResponse

Open rchl opened this issue 2 years ago • 1 comments

CLA

  • [x] I have signed the Stream CLA (required).
  • [x] Code changes are tested

Description of the changes, What, Why and How?

Those properties were missing in the type returned from getExportChannelStatus API.

Some references:

  • Node.js API - https://getstream.io/chat/docs/node/exporting_channels/?language=javascript#requesting-a-channel-export
  • REST API - https://getstream.io/chat/docs/rest/#channels-getexportchannelsstatus

Unfortunately there is no documentation as to what exact values the status can have so it's just typed as string.

The error and result objects could also have better types but apart from REST documentation having some info on those, it's not 100% clear on which properties are optional.

EDIT: Added types for result also, making best effort with available information.

Changelog

  • fix: add missing properties to ExportChannelStatusResponse

rchl avatar Jun 20 '23 20:06 rchl