core_service (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.10.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.flutter-io.cn

To use the package from pub.flutter-io.cn, please include the following in pubspec.yaml

dependencies:
  core_service: 1.0.0

Github

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

dependencies:
  core_service:
    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:
  core_service:
    path: /path/to/core_service

Getting Started

Please follow the installation procedure and then run the following:

import 'package:core_service/core_service.dart';


final api = CoreService().getAccountsApi();
final AccountRequest accountRequest = ; // AccountRequest | 

try {
    final response = await api.accountsControllerAuthorize(accountRequest);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AccountsApi->accountsControllerAuthorize: $e\n");
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountsApi accountsControllerAuthorize POST /v2/accounts/authorize Authorize Account
AccountsApi accountsControllerAuthorizeNuvemshopAccount POST /v2/accounts/agents/nuvemshop/authorize Authorize Account
AccountsApi accountsControllerAuthorizePrestashopAccount POST /v2/accounts/agents/prestashop/authorize Authorize Account
AccountsApi accountsControllerAuthorizeShopifyAccount POST /v2/accounts/agents/shopify/authorize Authorize Account
AccountsApi accountsControllerAuthorizeTrayAccount POST /v2/accounts/agents/tray/authorize Authorize Account
AccountsApi accountsControllerAuthorizeVtexAccount POST /v2/accounts/agents/vtex/authorize Authorize Account
AccountsApi accountsControllerClaim POST /v2/accounts/claim claim data
AccountsApi accountsControllerCreate POST /v2/accounts Create Account
AccountsApi accountsControllerDisableYampi PUT /v2/accounts/{id}/yampi/disable Update Account to yampi
AccountsApi accountsControllerGet GET /v2/accounts/{id} Get Account
AccountsApi accountsControllerGetByApp GET /v2/accounts Get Account By AppId
AccountsApi accountsControllerGetByExternalId GET /v2/accounts/external-id/{externalId} Get Account By External Id
AccountsApi accountsControllerGetByUrl GET /v2/accounts/url Get Account By Api url
AccountsApi accountsControllerGetDetailsByApp GET /v2/accounts/details Get Account Details By AppId
AccountsApi accountsControllerHookByApp POST /v2/accounts/apps/{appId}/hooks Account Hooks By App
AccountsApi accountsControllerHooksByAgent POST /v2/accounts/agents/{agent}/hooks Account Hooks
AccountsApi accountsControllerUpdateAccountToYampi PUT /v2/accounts/{id}/yampi Update Account to yampi
AppsApi appsControllerCreate POST /v2/apps Create App
AppsApi appsControllerCreateAppWithEnterprise POST /v2/apps/with-enterprise Create App with Enterprise Data
AppsApi appsControllerCreateMagento POST /v2/apps/magento create app and account for magento
AppsApi appsControllerDelete DELETE /v2/apps Delete App
AppsApi appsControllerDisable PUT /v2/apps/disable Disable App
AppsApi appsControllerEnable PUT /v2/apps/enable Enable App
AppsApi appsControllerGenerateUploadSignedUrl POST /v2/apps/signed-urls/upload Generate upload signed urls
AppsApi appsControllerGet GET /v2/apps/{id} Get App
AppsApi appsControllerGetByIdentifier GET /v2/apps/identifier/{identifier} Get App
AppsApi appsControllerGetDetails GET /v2/apps/{id}/details Get App
AppsApi appsControllerList GET /v2/apps Get All Apps
AppsApi appsControllerPropagate POST /v2/apps/propagate propagate existing apps
AppsApi appsControllerUpdate PATCH /v2/apps Update App
BlockedEntriesApi blockedEntriesControllerCreate POST /v2/core/blocked-entries Create BlockedEntry
BlockedEntriesApi blockedEntriesControllerDelete DELETE /v2/core/blocked-entries/{id} Delete BlockedEntry
BlockedEntriesApi blockedEntriesControllerGet GET /v2/core/blocked-entries/{id} Get BlockedEntry
BlockedEntriesApi blockedEntriesControllerList GET /v2/core/blocked-entries List BlockedEntries
BlockingDomainsApi blockingDomainsControllerCreate POST /v2/core/blocking-domains Create BlockingDomain
BlockingDomainsApi blockingDomainsControllerDelete DELETE /v2/core/blocking-domains/{id} Delete BlockingDomain
BlockingDomainsApi blockingDomainsControllerGet GET /v2/core/blocking-domains/{id} Get BlockingDomain
BlockingDomainsApi blockingDomainsControllerList GET /v2/core/blocking-domains List BlockingDomains
CampaignsApi campaignsControllerCreate POST /v2/campaigns Create Campaign
CampaignsApi campaignsControllerDelete DELETE /v2/campaigns/{id} Delete Campaigns
CampaignsApi campaignsControllerGenerateReport GET /v2/campaigns/export/report send Campaign Report
CampaignsApi campaignsControllerGet GET /v2/campaigns/{id} Get Campaign By Id
CampaignsApi campaignsControllerGetHistory GET /v2/campaigns/history/list History Campaigns
CampaignsApi campaignsControllerList GET /v2/campaigns List Campaigns
ConnectionsApi connectionsControllerCreate POST /v2/connections Create Connection
ConnectionsApi connectionsControllerDelete DELETE /v2/connections/{id} Delete Connection
ConnectionsApi connectionsControllerGet GET /v2/connections/{id} Get Connection
ConnectionsApi connectionsControllerList GET /v2/connections List Connections
CoreTeamsUsersApi usersCoreTeamControllerGetPerformanceList GET /v2/users/coreteams/{id}/performanceList
CoreTeamsUsersApi usersCoreTeamControllerGetUsersRankedListByRole GET /v2/users/coreteams/rank
CoreTeamsUsersApi usersCoreTeamControllerInsertUsersRole POST /v2/users/coreteams/upload/{role} Add users role, Managers, supervisors from coreTeams json
DefaultApi alertsControllerIndex GET /metrics
DefaultApi appControllerCreate POST /v2/authorize Authorize
DefaultApi appControllerHealthCheck GET /health-check
DefaultApi usersVerificationsControllerResendOtp PUT /v2/users/validations/phone/resend resend otp to user
DefaultApi usersVerificationsControllerSendOtp POST /v2/users/validations/otp Send otp sms or email
DefaultApi usersVerificationsControllerSpecialRegister POST /v2/users/validations/register Register a user that is logged in via widget
DefaultApi usersVerificationsControllerUpdatePhone PUT /v2/users/validations/phone/assign updates the user phone number and sends an otp in an sms
DefaultApi usersVerificationsControllerVerifyOtp PUT /v2/users/validations/otp/verify Verify OTP from email or sms
DefaultApi usersVerificationsControllerVerifyPhone PUT /v2/users/validations/phone/verify updates the user phone number and sends an otp in an sms
DepartmentsApi departmentsControllerCreate POST /v2/core/departments Create Department
DepartmentsApi departmentsControllerDelete DELETE /v2/core/departments/{id} Delete Department
DepartmentsApi departmentsControllerGet GET /v2/core/departments/{id} Get Department
DepartmentsApi departmentsControllerGetByCode GET /v2/core/departments/code/{code} Get by code
DepartmentsApi departmentsControllerList GET /v2/core/departments List Departments
DepartmentsApi departmentsControllerUpdate PATCH /v2/core/departments/{id} Update Department
DiscountCodesApi discountCodesControllerCreate POST /v2/discount-codes Create Discount Code
DiscountCodesApi discountCodesControllerCreateByService POST /v2/discount-codes/user/{userId}
DiscountCodesApi discountCodesControllerExportData POST /v2/discount-codes/export export discount codes report
DiscountCodesApi discountCodesControllerGet GET /v2/discount-codes/{id} Get Discount Code
DiscountCodesApi discountCodesControllerGetDiscountCodeByCode POST /v2/discount-codes/code
DiscountCodesApi discountCodesControllerList GET /v2/discount-codes List All Discount Code
DiscountCodesApi discountCodesControllerListPerUser GET /v2/discount-codes/user/{userId} List Discount Code for a user
DiscountCodesApi discountCodesControllerUpdate PATCH /v2/discount-codes/{id} Update Discount Code
DiscountsApi discountsControllerCreate POST /v2/discounts Create Discount
DiscountsApi discountsControllerDelete DELETE /v2/discounts/{id} Delete Discount
DiscountsApi discountsControllerGet GET /v2/discounts/{id} Get Discount
DiscountsApi discountsControllerList GET /v2/discounts List Discounts
DiscountsApi discountsControllerUpdate PATCH /v2/discounts/{id} Update Discount
EnterpriseDataApi enterpriseDataControllerCreate POST /v2/enterprise-data
EnterpriseDataApi enterpriseDataControllerGet GET /v2/enterprise-data get enterprise data
EnterpriseDataApi enterpriseDataControllerUpdate PATCH /v2/enterprise-data update enterprise data for app
FaqsApi faqsControllerCreate POST /v2/faqs create faq for app
FaqsApi faqsControllerGetStringsForApp GET /v2/faqs get the faqs
FaqsApi faqsControllerListBulk POST /v2/faqs/bulk creats bulk faqs
FaqsApi faqsControllerUpdate PUT /v2/faqs/{id} update faq for app
GTMApi gtmControllerCreate POST /v2/apps/integrations/gtm Create Gtm details
GTMApi gtmControllerDelete DELETE /v2/apps/integrations/gtm Delete Gtm details
GTMApi gtmControllerGet GET /v2/apps/integrations/gtm Get Gtm details
GTMApi gtmControllerUpdate PUT /v2/apps/integrations/gtm Update Gtm details
LeaderBoardApi leaderBoardControllerGetUserRank GET /v2/core/leaderboard/rank Rank user
LeaderBoardApi leaderBoardControllerStoresLeaderBoard GET /v2/core/leaderboard/stores List stores leaderBoard
LeaderBoardApi leaderBoardControllerUsersLeaderBoard GET /v2/core/leaderboard/users List users leaderBoard
LocationsApi locationsControllerCreate POST /v2/core/locations Create Location
LocationsApi locationsControllerDelete DELETE /v2/core/locations/{id} Delete Location
LocationsApi locationsControllerGet GET /v2/core/locations/{id} Get Location
LocationsApi locationsControllerList GET /v2/core/locations List Locations
LocationsApi locationsControllerUpdate PATCH /v2/core/locations/{id} Update Location
LoyaltyPageApi loyaltyPageControllerCreate POST /v2/loyalty-page create loyalty page config
LoyaltyPageApi loyaltyPageControllerGet GET /v2/loyalty-page get loyalty page fields
LoyaltyPageApi loyaltyPageControllerUpdate PATCH /v2/loyalty-page update loyalty page config
OrganizationsApi organizationsControllerCreate POST /v2/core/organizations Create Organization
OrganizationsApi organizationsControllerDelete DELETE /v2/core/organizations/{id} Delete Organization
OrganizationsApi organizationsControllerGet GET /v2/core/organizations/{id} Get Organization
OrganizationsApi organizationsControllerList GET /v2/core/organizations List Organizations
OrganizationsApi organizationsControllerUpdate PATCH /v2/core/organizations/{id} Update Organization
PointsApi currentPointsControllerActivePointsChart GET /v2/points/active get active points data for chart
PointsApi currentPointsControllerDeletePoint DELETE /v2/points/{id} Change the status of the point to deleted by id
PointsApi currentPointsControllerGainPoints POST /v2/points/{userId}/gain gain points
PointsApi currentPointsControllerGetPointsToExpire GET /v2/points/expire Total points going to be expired during the provided period
PointsApi currentPointsControllerList GET /v2/points/user/{userId} List Points Records
PointsApi currentPointsControllerPointsUsersStats GET /v2/points/users get users points for active points
PointsApi currentPointsControllerRedeemPoints POST /v2/points/{userId}/redeem redeem points
PointsApi currentPointsControllerUsedPointsChart GET /v2/points/used get redeemed points data for chart
PopupsApi popupControllerClick PATCH /v2/popups/{id}/click
PopupsApi popupControllerCreate POST /v2/popups
PopupsApi popupControllerDelete DELETE /v2/popups/{id}
PopupsApi popupControllerGet GET /v2/popups/{id}
PopupsApi popupControllerList GET /v2/popups
PopupsApi popupControllerUpdate PATCH /v2/popups/{id}
PopupsApi popupControllerView PATCH /v2/popups/{id}/view
RedeemAPIsApi redeemControllerCreate POST /v2/rewards/redeem/otp Create OTP redeem request
RedeemAPIsApi redeemControllerResendSMS PUT /v2/rewards/redeem/otp/resend Resend OTP email
RedeemAPIsApi redeemControllerVerify PUT /v2/rewards/redeem/otp/verify Verify OTP redeem request
RolesApi rolesControllerCreate POST /v2/core/roles Create Role
RolesApi rolesControllerDelete DELETE /v2/core/roles/{id} Delete Role
RolesApi rolesControllerGet GET /v2/core/roles/{id} Get Role
RolesApi rolesControllerGetByCode GET /v2/core/roles/code/{code} Get by code
RolesApi rolesControllerList GET /v2/core/roles List Roles
RolesApi rolesControllerUpdate PATCH /v2/core/roles/{id} Update Role
StoresApi storesControllerGetSettings GET /v2/accounts/stores/settings Get app settings
StoresApi storesControllerSetSettings PATCH /v2/accounts/stores/settings Update app settings
ThemesApi themesControllerCreate POST /v2/themes Create Theme
ThemesApi themesControllerDelete DELETE /v2/themes/{id} Delete Theme
ThemesApi themesControllerGet GET /v2/themes/{id} Get Theme
ThemesApi themesControllerGetByApp GET /v2/themes/app Get Theme By App
ThemesApi themesControllerUpdate PATCH /v2/themes/{id} Update Theme
TierConfigApi tierConfigControllerCreate POST /v2/tier-config Create Tier Config
TierConfigApi tierConfigControllerDelete DELETE /v2/tier-config/{id} Delete Tier Config
TierConfigApi tierConfigControllerGet GET /v2/tier-config Get Tier Config
TierConfigApi tierConfigControllerUpdate PATCH /v2/tier-config/{id} Update Tier Config
TiersApi tiersControllerCreate POST /v2/tiers Create Tier
TiersApi tiersControllerDelete DELETE /v2/tiers/{id} Delete Tier
TiersApi tiersControllerGet GET /v2/tiers/{id} Get Tier
TiersApi tiersControllerGetByOrder GET /v2/tiers/order/{order} Get Tier By Order
TiersApi tiersControllerList GET /v2/tiers List Tiers
TiersApi tiersControllerUpdate PATCH /v2/tiers/{id} Update Tier
UserGroupsApi userGroupsControllerCreate POST /v2/user-groups Create User Group
UserGroupsApi userGroupsControllerDelete DELETE /v2/user-groups/{id} Delete User Group By Id
UserGroupsApi userGroupsControllerGet GET /v2/user-groups/{id} Get User Group By Id
UserGroupsApi userGroupsControllerGetByName GET /v2/user-groups/name/excel Get userGroup by name, used for excel import
UserGroupsApi userGroupsControllerList GET /v2/user-groups List User Groups
UserGroupsApi userGroupsControllerUpdate PATCH /v2/user-groups/{id} Update User Group by Id
UserWelcomeGiftsApi userWelcomeGiftControllerGetByUser GET /v2/user-welcome-gifts Get User Welcome Gift
UserWelcomeGiftsApi userWelcomeGiftControllerRedeem POST /v2/user-welcome-gifts/redeem Redeem welcome gift
UsersApi lojaUserControllerGetCustomerData POST /v2/users/loja/customer Get Loja Customer Data
UsersApi nuvemshopUserControllerGetCustomerData GET /v2/users/nuvemshop/{storeId}/customer/{customerId} Get Nuvemshop Customer Data
UsersApi trayUserControllerGetCustomerData GET /v2/users/tray/customer/{customerId} Get Tray Customer Data
UsersApi usersControllerAuthorize GET /v2/users/authorize Get current logged in user
UsersApi usersControllerChangePassword PUT /v2/users/reset-password/{code} change user password in database according to their code
UsersApi usersControllerChangePasswordWithToken PUT /v2/users/change-password change user password in database according to their token
UsersApi usersControllerCountUsersPerTier GET /v2/users/stats/tier Get total members per tier
UsersApi usersControllerDeleteByEmail DELETE /v2/users/email/{email} Delete the user by GDPR - service level
UsersApi usersControllerDeleteById DELETE /v2/users/{id} Delete the user by admins
UsersApi usersControllerEffectedUsersByTierEvaluation GET /v2/users/stat/by-level-reevaluation Get the number of users who may be effecte in the level reevaluation
UsersApi usersControllerExport POST /v2/users/data/export Export User Report
UsersApi usersControllerGenerateCsv POST /v2/users/generate/csv Generat users CSV
UsersApi usersControllerGet GET /v2/users/{id} Get User
UsersApi usersControllerGetByExternalId GET /v2/users/external-id/{id} Get user by external id
UsersApi usersControllerGetChart GET /v2/users/chart Get user charts
UsersApi usersControllerGetMemberAggregatesByPoints GET /v2/users/users-aggregates Get Total Users and Average Points by Points Range
UsersApi usersControllerGetTotalAppPoints GET /v2/users/points/total Get Total App Points
UsersApi usersControllerGetUserByPhone GET /v2/users/phone/{phone} Get user by his phone number
UsersApi usersControllerGetUserDetails GET /v2/users/details/{groupId}/{userId} Get user Details
UsersApi usersControllerGetUserTierProgress GET /v2/users/user-progress/{id} User Tier Progress
UsersApi usersControllerGetUsersRankedList GET /v2/users/group/{groupId}/leaderboard Get user ranked list based on achived points
UsersApi usersControllerImportUsers POST /v2/users/import Import users from CSV
UsersApi usersControllerInsertManyUsers POST /v2/users/json/insert-many Add users from coreteams json
UsersApi usersControllerJoin POST /v2/users/join Join User
UsersApi usersControllerList GET /v2/users List Users
UsersApi usersControllerListBulk POST /v2/users/bulk-get List bulk users
UsersApi usersControllerListByOrganization GET /v2/users/employee/detail List Users By Employee Details
UsersApi usersControllerLogin POST /v2/users/login Login User
UsersApi usersControllerMigrateToCashback POST /v2/users/migrate/{fromAppId}
UsersApi usersControllerRegister POST /v2/users/register Register User
UsersApi usersControllerResetPassword POST /v2/users/reset-password send email with reset password link
UsersApi usersControllerSocial PUT /v2/users/social Connect to Social Media
UsersApi usersControllerSyncUserType POST /v2/users/sync-type change user types
UsersApi usersControllerUpdate PATCH /v2/users Update User
UsersApi usersControllerUpdateByAdmin PATCH /v2/users/{id} Update User By Admin
UsersApi usersControllerUpdatePoints PUT /v2/users/{id}/points Update User Points
UsersApi usersControllerUpgrade PUT /v2/users/upgrade Upgrade User
UsersApi usersControllerUploadCSV POST /v2/users/upload-csv Upload users from CSV as members
UsersApi wakeUserControllerGetCustomerData POST /v2/users/wake/customer Get Wake Customer Data
WelcomeGiftsApi welcomeGiftsControllerCreate POST /v2/welcome-gifts Create Welcome Gift
WelcomeGiftsApi welcomeGiftsControllerDelete DELETE /v2/welcome-gifts/{id} Delete Welcome Gift
WelcomeGiftsApi welcomeGiftsControllerList GET /v2/welcome-gifts List Welcome Gifts
WelcomeGiftsApi welcomeGiftsControllerUpdate PATCH /v2/welcome-gifts/{id} Update Welcome Gift

Documentation For Models

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

Libraries

core_service