1.4.12 • Published 1 year ago
@gener-api-test/apitest v1.4.12
@gener-api-test/apitest@1.4.12
Install
npm install @gener-api-test/apitest@1.4.12 --save
// Or with yarn
yarn add @gener-api-test/apitest@1.4.12Building
To build and compile the typescript sources to javascript use:
npm install
npm run build
// Or with yarn
yarn
yarn buildDocumentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApplicationApi | createApplicationApiV1AppPost | POST /api/v1/app/ | Create Application |
| ApplicationApi | deleteApplicationApiV1AppAppIdDelete | DELETE /api/v1/app/{app_id}/ | Delete Application |
| ApplicationApi | getApplicationApiV1AppAppIdGet | GET /api/v1/app/{app_id}/ | Get Application |
| ApplicationApi | listApplicationsApiV1AppGet | GET /api/v1/app/ | List Applications |
| ApplicationApi | updateApplicationApiV1AppAppIdPut | PUT /api/v1/app/{app_id}/ | Update Application |
| AuthenticationApi | getDashboardAccessApiV1AuthDashboardAccessAppIdPost | POST /api/v1/auth/dashboard-access/{app_id}/ | Get Consumer App Portal Access |
| AuthenticationApi | logoutApiV1AuthLogoutPost | POST /api/v1/auth/logout/ | Logout |
| EndpointApi | createEndpointApiV1AppAppIdEndpointPost | POST /api/v1/app/{app_id}/endpoint/ | Create Endpoint |
| EndpointApi | deleteEndpointApiV1AppAppIdEndpointEndpointIdDelete | DELETE /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Delete Endpoint |
| EndpointApi | getEndpointApiV1AppAppIdEndpointEndpointIdGet | GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Get Endpoint |
| EndpointApi | getEndpointHeadersApiV1AppAppIdEndpointEndpointIdHeadersGet | GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Get Endpoint Headers |
| EndpointApi | getEndpointSecretApiV1AppAppIdEndpointEndpointIdSecretGet | GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/ | Get Endpoint Secret |
| EndpointApi | getEndpointStatsApiV1AppAppIdEndpointEndpointIdStatsGet | GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/stats/ | Get Endpoint Stats |
| EndpointApi | listEndpointsApiV1AppAppIdEndpointGet | GET /api/v1/app/{app_id}/endpoint/ | List Endpoints |
| EndpointApi | patchEndpointHeadersApiV1AppAppIdEndpointEndpointIdHeadersPatch | PATCH /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Patch Endpoint Headers |
| EndpointApi | recoverFailedWebhooksApiV1AppAppIdEndpointEndpointIdRecoverPost | POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/recover/ | Recover Failed Webhooks |
| EndpointApi | replayMissingWebhooksApiV1AppAppIdEndpointEndpointIdReplayMissingPost | POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing/ | Replay Missing Webhooks |
| EndpointApi | rotateEndpointSecretApiV1AppAppIdEndpointEndpointIdSecretRotatePost | POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate/ | Rotate Endpoint Secret |
| EndpointApi | updateEndpointApiV1AppAppIdEndpointEndpointIdPut | PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Update Endpoint |
| EndpointApi | updateEndpointHeadersApiV1AppAppIdEndpointEndpointIdHeadersPut | PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Update Endpoint Headers |
| EventTypeApi | createEventTypeApiV1EventTypePost | POST /api/v1/event-type/ | Create Event Type |
| EventTypeApi | deleteEventTypeApiV1EventTypeEventTypeNameDelete | DELETE /api/v1/event-type/{event_type_name}/ | Archive Event Type |
| EventTypeApi | getEventTypeApiV1EventTypeEventTypeNameGet | GET /api/v1/event-type/{event_type_name}/ | Get Event Type |
| EventTypeApi | listEventTypesApiV1EventTypeGet | GET /api/v1/event-type/ | List Event Types |
| EventTypeApi | updateEventTypeApiV1EventTypeEventTypeNamePut | PUT /api/v1/event-type/{event_type_name}/ | Update Event Type |
| HealthApi | healthApiV1HealthGet | GET /api/v1/health/ | Health |
| IntegrationApi | createIntegrationApiV1AppAppIdIntegrationPost | POST /api/v1/app/{app_id}/integration/ | Create Integration |
| IntegrationApi | deleteIntegrationApiV1AppAppIdIntegrationIntegIdDelete | DELETE /api/v1/app/{app_id}/integration/{integ_id}/ | Delete Integration |
| IntegrationApi | getIntegrationApiV1AppAppIdIntegrationIntegIdGet | GET /api/v1/app/{app_id}/integration/{integ_id}/ | Get Integration |
| IntegrationApi | getIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyGet | GET /api/v1/app/{app_id}/integration/{integ_id}/key/ | Get Integration Key |
| IntegrationApi | listIntegrationsApiV1AppAppIdIntegrationGet | GET /api/v1/app/{app_id}/integration/ | List Integrations |
| IntegrationApi | rotateIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyRotatePost | POST /api/v1/app/{app_id}/integration/{integ_id}/key/rotate/ | Rotate Integration Key |
| IntegrationApi | updateIntegrationApiV1AppAppIdIntegrationIntegIdPut | PUT /api/v1/app/{app_id}/integration/{integ_id}/ | Update Integration |
| MessageApi | createMessageApiV1AppAppIdMsgPost | POST /api/v1/app/{app_id}/msg/ | Create Message |
| MessageApi | getMessageApiV1AppAppIdMsgMsgIdGet | GET /api/v1/app/{app_id}/msg/{msg_id}/ | Get Message |
| MessageApi | listMessagesApiV1AppAppIdMsgGet | GET /api/v1/app/{app_id}/msg/ | List Messages |
| MessageAttemptApi | getAttemptApiV1AppAppIdMsgMsgIdAttemptAttemptIdGet | GET /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/ | Get Attempt |
| MessageAttemptApi | listAttemptedDestinationsApiV1AppAppIdMsgMsgIdEndpointGet | GET /api/v1/app/{app_id}/msg/{msg_id}/endpoint/ | List Attempted Destinations |
| MessageAttemptApi | listAttemptedMessagesApiV1AppAppIdEndpointEndpointIdMsgGet | GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/msg/ | List Attempted Messages |
| MessageAttemptApi | listAttemptsApiV1AppAppIdMsgMsgIdAttemptGet | GET /api/v1/app/{app_id}/msg/{msg_id}/attempt/ | List Attempts |
| MessageAttemptApi | listAttemptsByEndpointApiV1AppAppIdAttemptEndpointEndpointIdGet | GET /api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/ | List Attempts By Endpoint |
| MessageAttemptApi | listAttemptsByMsgApiV1AppAppIdAttemptMsgMsgIdGet | GET /api/v1/app/{app_id}/attempt/msg/{msg_id}/ | List Attempts By Msg |
| MessageAttemptApi | listAttemptsForEndpointApiV1AppAppIdMsgMsgIdEndpointEndpointIdAttemptGet | GET /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/attempt/ | List Attempts For Endpoint |
| MessageAttemptApi | resendWebhookApiV1AppAppIdMsgMsgIdEndpointEndpointIdResendPost | POST /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend/ | Resend Webhook |