alexa / alexa-skills-kit-sdk-for-nodejs

The Alexa Skills Kit SDK for Node.js helps you get a skill up and running quickly, letting you focus on skill logic instead of boilerplate code.
Apache License 2.0
3.12k stars 736 forks source link

Remove "callX" methods from the SMAPI clients. #680

Open sam-goodwin opened 3 years ago

sam-goodwin commented 3 years ago

The SMAPI client has two methods for each API - one high level one and a generic HTTP one, prefixed with call. For example: importSkillPackageV1 and callImportSkillPackageV1.

This is confusing for users - it took me a while to figure out what was going on. More importantly, the "high level" API is sometimes not functional. In the case of importSkillPackageV1, it return void instead of an object containing the importId. To get that, you have to filter through the headers, which are typed as any. This is all very confusing and time consuming. All I want to do is import a skill package and there are so many hoops to jump through.

Can we remove the callX methods and enrich the type safe API calls with all the relevant information. I think the bar is AWS's SDK.

Idea: if changing this is difficult, perhaps we can kill two birds with one stone by hand writing a higher level SMAPI interface (see #679).

rahulawl commented 1 year ago

Is this issue/feature-request still relevant? We are working on prioritization of relevant issues and cleanup of rest. If we don’t hear back in 2 weeks, we will assume that the issue is not relevant and we will close it.