surveymonkey-typescript-sdk
v0.8.5
Published
## Usage
Readme
SurveyMonkey TypeScript SDK
Usage
import {SurveymonkeyConfig, SurveymonkeyApi} from 'surveymonkey-typescript-sdk';
const token: string = 'YOUR_SURVEYMONKEY_TOKEN';
const config: SurveymonkeyConfig = {token};
const api = new SurveymonkeyApi(config);
async function main(): Promise<void> {
const {data} = await api.survey.getSurveyList();
for (const survey of data) {
console.log(survey);
}
process.exit(0);
}
main();Endpoints coverage
- Overall coverage:
26/56 (46%)
Surveys, Pages, and Questions
Coverage: 22/40 (55%)
/surveys- [x]
HEAD /surveys - [ ]
OPTIONS /surveys-- API not available - [x]
GET /surveys - [ ]
POST /surveys
- [x]
/surveys/{id}- [x]
HEAD /surveys/{id} - [x]
OPTIONS /surveys/{id} - [x]
GET /surveys/{id} - [ ]
PATCH /surveys/{id} - [ ]
PUT /surveys/{id} - [ ]
DELETE /surveys/{id}
- [x]
/surveys/{id}/details- [x]
GET /surveys/{id}/details
- [x]
/survey_categories- [x]
HEAD /survey_categories - [ ]
OPTIONS /survey_categories-- API not available - [x]
GET /survey_categories
- [x]
/survey_templates- [x]
HEAD /survey_templates - [ ]
OPTIONS /survey_templates-- API not available - [x]
GET /survey_templates
- [x]
/survey_languages- [x]
HEAD /survey_languages - [ ]
OPTIONS /survey_languages-- API not available - [x]
GET /survey_languages
- [x]
/surveys/{id}/pages- [x]
HEAD /surveys/{id}/pages - [ ]
OPTIONS /surveys/{id}/pages-- API not available - [x]
GET /surveys/{id}/pages - [ ]
POST /surveys/{id}/pages
- [x]
/surveys/{id}/pages/{id}- [x]
HEAD /surveys/{id}/pages/{id} - [x]
OPTIONS /surveys/{id}/pages/{id} - [x]
GET /surveys/{id}/pages/{id} - [ ]
PATCH /surveys/{id}/pages/{id} - [ ]
PUT /surveys/{id}/pages/{id} - [ ]
DELETE /surveys/{id}/pages/{id}
- [x]
/surveys/{id}/pages/{id}/questions- [x]
HEAD /surveys/{id}/pages/{id}/questions - [ ]
OPTIONS /surveys/{id}/pages/{id}/questions-- API not available - [x]
GET /surveys/{id}/pages/{id}/questions - [ ]
POST /surveys/{id}/pages/{id}/questions
- [x]
/surveys/{id}/pages/{id}/questions/{id}- [x]
HEAD /surveys/{id}/pages/{id}/questions/{id} - [x]
OPTIONS /surveys/{id}/pages/{id}/questions/{id} - [x]
GET /surveys/{id}/pages/{id}/questions/{id} - [ ]
PATCH /surveys/{id}/pages/{id}/questions/{id} - [ ]
PUT /surveys/{id}/pages/{id}/questions/{id} - [ ]
DELETE /surveys/{id}/pages/{id}/questions/{id}
- [x]
Survey Responses
Coverage: 4/16 (25%)
/surveys/{id}/responses- [x]
GET /surveys/{id}/responses
- [x]
/collectors/{id}/responses- [ ]
HEAD /collectors/{id}/responses - [ ]
OPTIONS /collectors/{id}/responses - [ ]
GET /collectors/{id}/responses - [ ]
POST /collectors/{id}/responses - [ ]
DELETE /collectors/{id}/responses
- [ ]
/surveys/{id}/responses/bulk- [x]
GET /surveys/{id}/responses/bulk
- [x]
/collectors/{id}/responses/bulk- [ ]
GET /collectors/{id}/responses/bulk
- [ ]
/surveys/{id}/responses/{id}- [ ]
HEAD /surveys/{id}/responses/{id} - [ ]
OPTIONS /surveys/{id}/responses/{id} - [x]
GET /surveys/{id}/responses/{id} - [ ]
PATCH /surveys/{id}/responses/{id} - [ ]
PUT /surveys/{id}/responses/{id} - [ ]
DELETE /surveys/{id}/responses/{id}
- [ ]
/surveys/{id}/responses/{id}/details- [x]
GET /surveys/{id}/responses/{id}/details
- [x]
/collectors/{id}/responses/{id}/details- [ ]
GET /collectors/{id}/responses/{id}/details
- [ ]
