coretava_events_apis 1.0.2

Coretava Events Apis

coretava_events_apis (EXPERIMENTAL)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Generator version: 7.12.0
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  coretava_events_apis: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  coretava_events_apis:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  coretava_events_apis:
    path: /path/to/coretava_events_apis

Getting Started

Please follow the installation procedure and then run the following:

import 'package:coretava_events_apis/coretava_events_apis.dart';


final api = CoretavaEventsApis().getDefaultApi();

try {
    api.appControllerHealthCheck();
} catch on DioException (e) {
    print("Exception when calling DefaultApi->appControllerHealthCheck: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.coretava.com

Class	Method	HTTP request	Description
DefaultApi	appControllerHealthCheck	GET /health-check
EventsApi	eventsControllerCreate	POST /v2/events	Create user event
FiltersApi	filtersControllerCreate	POST /v2/events/flows/filters	Create a new filter
FiltersApi	filtersControllerGet	GET /v2/events/flows/filters/{id}	Get filter by id
FiltersApi	filtersControllerList	GET /v2/events/flows/filters	Get all filters
FiltersApi	filtersControllerUpdate	PUT /v2/events/flows/filters/{id}	Update a filter
FlowActionsApi	actionsControllerCreate	POST /v2/events/flows/actions	create Flow Action
FlowActionsApi	actionsControllerGet	GET /v2/events/flows/actions/{id}	get Flow Action
FlowActionsApi	actionsControllerListPerFlow	GET /v2/events/flows/actions/flow/{flow}	list Flow Actions
FlowsApi	flowsControllerCreate	POST /v2/events/flows	Create flow
FlowsApi	flowsControllerDelete	DELETE /v2/events/flows/{id}	Delete flow
FlowsApi	flowsControllerGet	GET /v2/events/flows/{id}	Get flow
FlowsApi	flowsControllerUpdate	PATCH /v2/events/flows/{id}	Update flow
LegacyEventsApi	legacyEventsControllerCreate	POST /v2/legacy-events	Create Restricted User Event
LegacyEventsApi	legacyEventsControllerCreatePublicEvent	POST /v2/legacy-events/user	Create User Event
LegacyEventsApi	legacyEventsControllerGet	GET /v2/legacy-events/{id}	Get Event
LegacyEventsApi	legacyEventsControllerList	GET /v2/legacy-events	List Events
LinkReferralsApi	linkReferralsControllerGet	GET /v2/link-referrals/{appReferral}	Get User Link Referral
ReferralsApi	referralsControllerCreate	POST /v2/referrals	Create Referral
ReferralsApi	referralsControllerDelete	DELETE /v2/referrals/{id}	Delete Referral
ReferralsApi	referralsControllerGet	GET /v2/referrals/{id}	Get Referral
ReferralsApi	referralsControllerList	GET /v2/referrals	List Referrals
ReferralsApi	referralsControllerUpdate	PATCH /v2/referrals/{id}	Update Referral
SpinTheWheelApi	wheelSpinsControllerCreate	POST /v2/events-svc/spin	Spin the wheel
SpinTheWheelApi	wheelSpinsControllerGetByUser	GET /v2/events-svc/spin	Get spins
SurveysApi	appSurveysControllerCreate	POST /v2/surveys	Create Survey
SurveysApi	appSurveysControllerDelete	DELETE /v2/surveys/{id}	Delete Survey
SurveysApi	appSurveysControllerGet	GET /v2/surveys/{id}	Get Survey
SurveysApi	appSurveysControllerList	GET /v2/surveys	List Surveys
SurveysApi	appSurveysControllerUpdate	PATCH /v2/surveys/{id}	Update Survey
UserReferralsApi	userReferralsControllerGet	GET /v2/user-referrals/{id}	Get User Referral
UserReferralsApi	userReferralsControllerGetByRefereeId	GET /v2/user-referrals/referee/{refereeId}	Get User Referral By Referee
UserReferralsApi	userReferralsControllerInvite	POST /v2/user-referrals/{appReferral}/invite	Invite User
UserReferralsApi	userReferralsControllerInviteByCashback	POST /v2/user-referrals/invite	Invite User
UserReferralsApi	userReferralsControllerList	GET /v2/user-referrals	List User Referrals
UserSurveysApi	userSurveysControllerExportUserSurveys	POST /v2/user-surveys/export/userSurveys	export userSurveys data
UserSurveysApi	userSurveysControllerGetBySurvey	GET /v2/user-surveys/surveys/{surveyId}	Get User Survey By Survey
UserSurveysApi	userSurveysControllerListAppUserSurveys	GET /v2/user-surveys/app/list	List all app userSurveys paginated
UserSurveysApi	userSurveysControllerSubmit	POST /v2/user-surveys/submit/{id}	Submit User Survey
UserSurveysApi	userSurveysControllerSubmitByUserToken	PUT /v2/user-surveys/submit	Submit User Survey by User token
UserSurveysApi	userSurveysControllerUpdate	PATCH /v2/user-surveys/{id}	Update User Survey
WheelConfigurationApi	wheelsControllerCreate	POST /v2/events/wheel	Create Wheel
WheelConfigurationApi	wheelsControllerDelete	DELETE /v2/events/wheel/{id}	update wheel By Id
WheelConfigurationApi	wheelsControllerGet	GET /v2/events/wheel/{id}	Get wheel By id
WheelConfigurationApi	wheelsControllerUpdate	PATCH /v2/events/wheel/{id}	update wheel By Id

Documentation For Models

• ActionConnectionDto
• ActionCreateRequest
• ActionCreateRequestAction
• ActionDiscountCreateRequest
• ActionDto
• ActionResponse
• ActionsResponse
• AppSurveyCreateRequest
• AppSurveyDto
• AppSurveyResponse
• AppSurveyUpdateRequest
• AppSurveysResponse
• BranchConnectionCreateRequest
• CartData
• CommunicationActionCreateRequest
• CommunicationActionCreateRequestConnection
• CommunicationCreateRequest
• CommunicationDto
• ConditionActionCreateRequest
• CreateAddedToCartEvent
• CreateCheckoutStartedEvent
• CreateEventItemsRequest
• CreateEventRequest
• CreateEventRequestEvent
• CreateFlowRequest
• CreateOrderPlacedEvent
• CreateProductViewedEvent
• DelayActionCreateRequest
• DelayCreateRequest
• DelayDto
• DiscountActionCreateRequest
• EmployeeDetailDto
• FilterDto
• FilterResponse
• FiltersResponse
• FirebaseCreateRequest
• FirebaseDto
• FlowDto
• FlowFilterDto
• FlowResponse
• GenericConnectionCreateRequest
• GenericConnectionDto
• LegacyEventResponse
• LegacyEventsResponse
• LinkReferralDto
• LinkReferralResponse
• MultipleChoiceQuestionCreateRequest
• MultipleChoiceQuestionDto
• NonRestrictedEventCreateRequest
• OrderData
• PointsCreateRequest
• PointsDto
• PointsUpdateRequest
• ProductViewedData
• QuestionRulesDto
• QuestionRulesRequest
• QuestionsCreateRequest
• ReferralCreateEnabledSharingOptions
• ReferralCreateRequest
• ReferralDto
• ReferralPointsCreateRequest
• ReferralPointsDto
• ReferralPointsUpdateRequest
• ReferralResponse
• ReferralUpdateEnabledSharingOptions
• ReferralUpdateRequest
• ReferralsResponse
• RestrictedEventCreateRequest
• SimpleDateDto
• StandardConnectionCreateRequest
• SurveyQuestionDto
• SurveySectionDto
• SurveySectionsRequest
• TotalsDto
• UpdateFlowRequest
• UserDto
• UserEventRequest
• UserPointsDto
• UserPropertiesDTO
• UserReferralDto
• UserReferralInvitation
• UserReferralResponse
• UserReferralsDto
• UserReferralsResponse
• UserSocialDto
• UserSurveyAnswerCreateRequest
• UserSurveyAnswerDto
• UserSurveyAnswerDtoAnswer
• UserSurveyAnswerUpdateRequest
• UserSurveyAnswerUpdateRequestAnswer
• UserSurveyAppListResponse
• UserSurveyDto
• UserSurveyResponse
• UserSurveySubmitRequest
• UserSurveyUpdateRequest
• UserSurveyWithAnswersPopulatedUser
• UserSurveysExportRequest
• WheelCreateRequest
• WheelDtlResponse
• WheelDto
• WheelOptionCreateRequest
• WheelOptionDto
• WheelOptionUpdateRequest
• WheelSpinDto
• WheelSpinPopualtedResponse
• WheelSpinPopulatedDto
• WheelSpinRequest
• WheelSpinResponse
• WheelUpdateRequest

Documentation For Authorization

Authentication schemes defined for the API:

serviceAccountHeader

• Type: API key
• API key parameter name: x-coretava-access-token
• Location: HTTP header

totvsHeader

• Type: API key
• API key parameter name: authorizationcode
• Location: HTTP header

adminToken

• Type: HTTP Bearer Token authentication (Bearer)

userToken

• Type: HTTP Bearer Token authentication (Bearer)

serviceToken

• Type: HTTP Bearer Token authentication (Bearer)

Author