[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install [email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AbpApiDefinitionApi | getAbpApiDefinition | GET /api/abp/api-definition | AbpApplicationConfigurationApi | getAbpApplicationConfiguration | GET /api/abp/application-configuration | AbpApplicationLocalizationApi | getAbpApplicationLocalization | GET /api/abp/application-localization | AbpTenantApi | findTenantById | GET /api/abp/multi-tenancy/tenants/by-id/{id} | AbpTenantApi | findTenantByName | GET /api/abp/multi-tenancy/tenants/by-name/{name} | AccountApi | changeAccountPassword | POST /api/app/account/change-password | AccountApi | checkSyncAuth | POST /api/app/account/check-sync-auth | 检查同步认证 AccountApi | destroyAccount | POST /api/app/account/destroy-account | AccountApi | getAccount | GET /api/app/account | AccountApi | register | POST /api/account/register | AccountApi | resetPassword | POST /api/account/reset-password | AccountApi | sendPasswordResetCode | POST /api/account/send-password-reset-code | AccountApi | verifyPasswordResetToken | POST /api/account/verify-password-reset-token | ApiKeysApi | createApiKeys | POST /api/api-keys | ApiKeysApi | deleteApiKeysById | DELETE /api/api-keys/{id} | ApiKeysApi | getApiKeysById | GET /api/api-keys/{id} | ApiKeysApi | getApiKeysList | GET /api/api-keys | ApiKeysApi | updateApiKeys | PUT /api/api-keys/{id} | AppApi | createApp | POST /api/app/app | 创建新应用 AppApi | deleteAppById | DELETE /api/app/app/{id} | 删除应用 AppApi | getAppById | GET /api/app/app/{id} | 获取 APP 详情 AppApi | getAppList | GET /api/app/app | 获取当前用户的应用列表 AppApi | getByName | GET /api/app/app/by-name | 获取 APP 详情 AppApi | getFeatureList | GET /api/app/app/feature-list/{appId} | AppApi | getListByDeveloperAll | GET /api/app/app/by-developer-all | 获取开发者所有 APP 包括未发布的 AppApi | getListPublic | GET /api/app/app/public | 所有开发者已发布 APP 列表 AppApi | getListWithUser | GET /api/app/app/with-user | 获取APP列表包含用户订阅信息 AppApi | getSdksById | GET /api/app/app/sdks-by-id/{appId} | AppApi | getUploadCredentials | GET /api/app/app/upload-credentials | 获取上传凭证 AppApi | getWithUser | GET /api/app/app/{id}/with-user | 获取 APP 详情 AppApi | run | POST /api/app/app/run | AppApi | updateApp | PUT /api/app/app/{id} | 更新 APP 信息 AppApi | updateRunState | PUT /api/app/app/{id}/run-state | AppFeatureApi | createAppFeature | POST /api/app/app-feature | AppFeatureApi | deleteAppFeatureById | DELETE /api/app/app-feature/{id} | AppFeatureApi | getAppFeatureList | GET /api/app/app-feature | AppFeatureApi | updateAppFeature | PUT /api/app/app-feature/{id} | AppFeedbackApi | createAppFeedback | POST /api/app/app-feedback | 创建反馈（允许匿名用户提交） AppFeedbackApi | deleteAppFeedbackById | DELETE /api/app/app-feedback/{id} | AppFeedbackApi | getAppFeedbackById | GET /api/app/app-feedback/{id} | AppFeedbackApi | getAppFeedbackList | GET /api/app/app-feedback | AppFeedbackApi | markAsProcessed | POST /api/app/app-feedback/{id}/mark-as-processed | AppFeedbackApi | reply | POST /api/app/app-feedback/{id}/reply | AppPricingApi | createAppPricing | POST /api/app/app-pricing | AppPricingApi | deleteAppPricingById | DELETE /api/app/app-pricing/{id} | AppPricingApi | getAppPricingById | GET /api/app/app-pricing/{id} | AppPricingApi | getAppPricingList | GET /api/app/app-pricing | AppPricingApi | getListByAppId | GET /api/app/app-pricing/by-app-id/{appId} | AppPricingApi | getPricingItemsByAppId | GET /api/app/app-pricing/pricing-items-by-app-id/{appId} | AppPricingApi | updateAppPricing | PUT /api/app/app-pricing/{id} | AppPricingItemApi | createAppPricingItem | POST /api/app/app-pricing-item | AppPricingItemApi | deleteAppPricingItemById | DELETE /api/app/app-pricing-item/{id} | AppPricingItemApi | getAppPricingItemById | GET /api/app/app-pricing-item/{id} | AppPricingItemApi | getAppPricingItemList | GET /api/app/app-pricing-item | AppPricingItemApi | updateAppPricingItem | PUT /api/app/app-pricing-item/{id} | AppReleaseApi | createAppRelease | POST /api/app/app-release | 创建新版本 AppReleaseApi | deleteAppReleaseById | DELETE /api/app/app-release/{id} | 删除版本 AppReleaseApi | getAppReleaseById | GET /api/app/app-release/{id} | 获取版本 AppReleaseApi | getAppReleaseList | GET /api/app/app-release | 获取版本列表 AppReleaseApi | getLatest | GET /api/app/app-release/latest | 获取最新版本 AppReleaseApi | getListByDeveloper | GET /api/app/app-release/by-developer | 开发者获取版本列表（版本的创建者为当前用户） AppReleaseApi | updateAppRelease | PUT /api/app/app-release/{id} | 更新版本 AppSdkApi | createAppSdk | POST /api/app/app-sdk | AppSdkApi | deleteAppSdkById | DELETE /api/app/app-sdk/{id} | AppSdkApi | getAppSdkList | GET /api/app/app-sdk | AppSdkApi | updateAppSdk | PUT /api/app/app-sdk/{id} | AppTesterApi | checkIsAppTester | POST /api/app/app-tester/check-is-app-tester | 检查用户是否是内测用户 AppTesterApi | createAppTester | POST /api/app/app-tester | 创建内测用户 AppTesterApi | deleteAppTesterById | DELETE /api/app/app-tester/{id} | 删除内测用户 AppTesterApi | getAppTesterById | GET /api/app/app-tester/{id} | 获取内测用户 AppTesterApi | getAppTesterList | GET /api/app/app-tester | 获取内测用户列表 AppTesterApi | updateAppTester | PUT /api/app/app-tester/{id} | 更新内测用户 AppUserScoreApi | createAppUserScore | POST /api/app/app-user-score | AvatarApi | createAvatar | POST /api/app/avatar | AvatarApi | getCredentials | GET /api/app/avatar/credentials | BuildRecordApi | createBuildRecord | POST /api/app/build-record | BuildRecordApi | deleteBuildRecordById | DELETE /api/app/build-record/{id} | BuildRecordApi | getBuildRecordById | GET /api/app/build-record/{id} | BuildRecordApi | getBuildRecordList | GET /api/app/build-record | BuildRecordApi | getByCiBuildId | GET /api/app/build-record/by-ci-build-id/{ciBuildId} | BuildRecordApi | getLatest | GET /api/app/build-record/latest/{appId} | BuildRecordApi | markAsBuilding | POST /api/app/build-record/{id}/mark-as-building | BuildRecordApi | markAsCanceled | POST /api/app/build-record/{id}/mark-as-canceled | BuildRecordApi | markAsFailed | POST /api/app/build-record/{id}/mark-as-failed | BuildRecordApi | markAsSucceeded | POST /api/app/build-record/{id}/mark-as-succeeded | BuildRecordApi | updateBuildRecord | PUT /api/app/build-record/{id} | DeployRecordApi | createDeployRecord | POST /api/app/deploy-record | DeployRecordApi | deleteDeployRecordById | DELETE /api/app/deploy-record/{id} | DeployRecordApi | getByCiDeployId | GET /api/app/deploy-record/by-ci-deploy-id/{ciDeployId} | DeployRecordApi | getDeployRecordById | GET /api/app/deploy-record/{id} | DeployRecordApi | getDeployRecordList | GET /api/app/deploy-record | DeployRecordApi | getLatest | GET /api/app/deploy-record/latest/{appId} | DeployRecordApi | getListByBuildRecordId | GET /api/app/deploy-record/by-build-record-id/{buildRecordId} | DeployRecordApi | markAsCanceled | POST /api/app/deploy-record/{id}/mark-as-canceled | DeployRecordApi | markAsDeploying | POST /api/app/deploy-record/{id}/mark-as-deploying | DeployRecordApi | markAsFailed | POST /api/app/deploy-record/{id}/mark-as-failed | DeployRecordApi | markAsSucceeded | POST /api/app/deploy-record/{id}/mark-as-succeeded | DeployRecordApi | updateDeployRecord | PUT /api/app/deploy-record/{id} | DeviceApi | bind | POST /api/app/device/bind | DeviceApi | getByToken | GET /api/app/device/by-token | DeviceApi | getDeviceById | GET /api/app/device/{id} | DeviceApi | getDeviceList | GET /api/app/device | DeviceApi | refreshDevice | POST /api/app/device/refresh-device | DeviceApi | remove | DELETE /api/app/device | DynamicClaimsApi | refresh | POST /api/account/dynamic-claims/refresh | EmailSettingsApi | getEmailSettings | GET /api/setting-management/emailing | EmailSettingsApi | sendTestEmail | POST /api/setting-management/emailing/send-test-email | EmailSettingsApi | updateEmailSettings | POST /api/setting-management/emailing | FeaturesApi | deleteFeatures | DELETE /api/feature-management/features | FeaturesApi | getFeatures | GET /api/feature-management/features | FeaturesApi | updateFeatures | PUT /api/feature-management/features | MessageApi | publish | POST /api/app/message/publish | MessageApi | recall | POST /api/app/message/recall | MessageApi | subscribe | POST /api/app/message/subscribe | MessageApi | unsubscribe | POST /api/app/message/unsubscribe | MessageSourceApi | createMessageSource | POST /api/app/message-source | MessageSourceApi | deleteMessageSourceById | DELETE /api/app/message-source/{id} | MessageSourceApi | getMessageSourceById | GET /api/app/message-source/{id} | MessageSourceApi | getMessageSourceList | GET /api/app/message-source | MessageSourceApi | updateMessageSource | PUT /api/app/message-source/{id} | MessageSourceCategoryApi | getMessageSourceCategoryList | GET /api/app/message-source-category | MessageSourceRouteApi | createMessageSourceRoute | POST /api/app/message-source-route | MessageSourceRouteApi | deleteMessageSourceRouteById | DELETE /api/app/message-source-route/{id} | MessageSourceRouteApi | getMessageSourceRouteById | GET /api/app/message-source-route/{id} | MessageSourceRouteApi | getMessageSourceRouteList | GET /api/app/message-source-route | MessageSourceRouteApi | updateMessageSourceRoute | PUT /api/app/message-source-route/{id} | MessageSourceRouteSubApi | createMessageSourceRouteSub | POST /api/app/message-source-route-sub | MessageSourceRouteSubApi | deleteMessageSourceRouteSubById | DELETE /api/app/message-source-route-sub/{id} | MessageSourceRouteSubApi | getMessageSourceRouteSubById | GET /api/app/message-source-route-sub/{id} | MessageSourceRouteSubApi | getMessageSourceRouteSubList | GET /api/app/message-source-route-sub | MessageSourceRouteSubApi | updateMessageSourceRouteSub | PUT /api/app/message-source-route-sub/{id} | MessageTemplateApi | createMessageTemplate | POST /api/app/message-template | MessageTemplateApi | deleteMessageTemplateById | DELETE /api/app/message-template/{id} | MessageTemplateApi | getMessageTemplateById | GET /api/app/message-template/{id} | MessageTemplateApi | getMessageTemplateList | GET /api/app/message-template | MessageTemplateApi | updateMessageTemplate | PUT /api/app/message-template/{id} | MessageTemplateReleaseApi | createMessageTemplateRelease | POST /api/app/message-template-release | MessageTemplateReleaseApi | getMessageTemplateReleaseById | GET /api/app/message-template-release/{id} | MessageTemplateReleaseApi | getMessageTemplateReleaseList | GET /api/app/message-template-release | NotificationApi | bark | GET /api/app/notification/bark/{apiKey}/{message} | Bark 推送，兼容 Bark 推送协议 TODO: 验证 API KEY 功能, 添加[个人访问令牌]功能 NotificationApi | getNotificationList | GET /api/app/notification | NotificationApi | push | POST /api/app/notification/push | PermissionsApi | getPermissions | GET /api/permission-management/permissions | PermissionsApi | updatePermissions | PUT /api/permission-management/permissions | ProfileApi | changePassword | POST /api/account/my-profile/change-password | ProfileApi | getProfile | GET /api/account/my-profile | ProfileApi | updateProfile | PUT /api/account/my-profile | RoleApi | createIdentityRole | POST /api/identity/roles | RoleApi | deleteIdentityRoleById | DELETE /api/identity/roles/{id} | RoleApi | getAllList | GET /api/identity/roles/all | RoleApi | getIdentityRoleById | GET /api/identity/roles/{id} | RoleApi | getIdentityRoleList | GET /api/identity/roles | RoleApi | updateIdentityRole | PUT /api/identity/roles/{id} | StorageObjectApi | getCdnDomains | GET /api/app/storage-object/cdn-domains | 获取所有 CDN Domain 配置 StorageObjectApi | getFileCredential | GET /api/app/storage-object/file-credential | StorageObjectApi | getUserStorages | GET /api/app/storage-object/user-storages | StorageObjectApi | preSignUrl | POST /api/app/storage-object/pre-sign-url | SubscriptionApi | appleNotifications | POST /api/app/subscription/apple-notifications | 苹果订阅 Callback 地址 SubscriptionApi | createOrder | POST /api/app/subscription/order | SubscriptionApi | getSubscriptionById | GET /api/app/subscription | SubscriptionApi | verifyReceipt | POST /api/app/subscription/verify-receipt | TenantApi | createTenant | POST /api/multi-tenancy/tenants | TenantApi | deleteDefaultConnectionString | DELETE /api/multi-tenancy/tenants/{id}/default-connection-string | TenantApi | deleteTenantById | DELETE /api/multi-tenancy/tenants/{id} | TenantApi | getDefaultConnectionString | GET /api/multi-tenancy/tenants/{id}/default-connection-string | TenantApi | getTenantById | GET /api/multi-tenancy/tenants/{id} | TenantApi | getTenantList | GET /api/multi-tenancy/tenants | TenantApi | updateDefaultConnectionString | PUT /api/multi-tenancy/tenants/{id}/default-connection-string | TenantApi | updateTenant | PUT /api/multi-tenancy/tenants/{id} | TimeZoneSettingsApi | getTimeZoneSettings | GET /api/setting-management/timezone | TimeZoneSettingsApi | getTimezones | GET /api/setting-management/timezone/timezones | TimeZoneSettingsApi | updateTimeZoneSettings | POST /api/setting-management/timezone | UserApi | createIdentityUser | POST /api/identity/users | UserApi | deleteIdentityUserById | DELETE /api/identity/users/{id} | UserApi | findByEmail | GET /api/identity/users/by-email/{email} | UserApi | findByUsername | GET /api/identity/users/by-username/{userName} | UserApi | getAssignableRoles | GET /api/identity/users/assignable-roles | UserApi | getIdentityUserById | GET /api/identity/users/{id} | UserApi | getIdentityUserList | GET /api/identity/users | UserApi | getRoles | GET /api/identity/users/{id}/roles | UserApi | updateIdentityUser | PUT /api/identity/users/{id} | UserApi | updateRoles | PUT /api/identity/users/{id}/roles | UserLookupApi | findById | GET /api/identity/users/lookup/{id} | UserLookupApi | findByUserName | GET /api/identity/users/lookup/by-username/{userName} | UserLookupApi | getCount | GET /api/identity/users/lookup/count | UserLookupApi | search | GET /api/identity/users/lookup/search | VerificationApi | sendCode | POST /api/app/verification/send-code | VerificationApi | sendCodeAnonymous | POST /api/app/verification/send-code-anonymous |

Documentation For Models

• AccountDeletionDto
• ActionApiDescriptionModel
• ApiKeyCreateDto
• ApiKeyDto
• ApiKeyDtoPagedResultDto
• ApiKeyUpdateDto
• AppDto
• AppDtoPagedResultDto
• AppFeatureDto
• AppFeatureDtoPagedResultDto
• AppFeedbackDto
• AppFeedbackDtoPagedResultDto
• AppFeedbackStatus
• AppFeedbackType
• AppFramework
• AppPlatform
• AppPriceNaming
• AppPricingDto
• AppPricingDtoPagedResultDto
• AppPricingItemDto
• AppPricingItemValueDto
• AppPublisher
• AppReleaseDto
• AppReleaseDtoPagedResultDto
• AppRunDto
• AppRunRecordDto
• AppRunRecordUpdateDto
• AppRunStatus
• AppSdkDto
• AppSdkDtoPagedResultDto
• AppTesterDto
• AppTesterDtoPagedResultDto
• AppType
• AppUserScoreDto
• AppWithUserDto
• AppWithUserDtoPagedResultDto
• AppleNotificaionDto
• AppleVerifyReceiptResult
• ApplicationApiDescriptionModel
• ApplicationAuthConfigurationDto
• ApplicationConfigurationDto
• ApplicationFeatureConfigurationDto
• ApplicationGlobalFeatureConfigurationDto
• ApplicationLocalizationConfigurationDto
• ApplicationLocalizationDto
• ApplicationLocalizationResourceDto
• ApplicationSettingConfigurationDto
• ArtifactType
• AvatarDto
• BindDeviceDto
• BuildRecordDto
• BuildRecordDtoPagedResultDto
• BuildStatus
• BuildTrigger
• CdnDomainDto
• ChangePasswordDto
• ChangePasswordInput
• CheckSyncAuthResultDto
• ClockDto
• ControllerApiDescriptionModel
• ControllerInterfaceApiDescriptionModel
• CreateAppFeedbackDto
• CreateAvatarDto
• CreateBuildRecordDto
• CreateDeployRecordDto
• CreateMessageTemplateReleaseDto
• CreateOpenIddictApplicationDto
• CreateOrGetSubscriptionOrderDto
• CreateOrUpdateAppDto
• CreateOrUpdateAppFeatureDto
• CreateOrUpdateAppPricingDto
• CreateOrUpdateAppPricingItemDto
• CreateOrUpdateAppReleaseDto
• CreateOrUpdateAppSdkDto
• CreateOrUpdateAppUserScoreDto
• CreateOrUpdateMessageTemplateDto
• CreatePushNotificationDto
• CreateUpdateAppTesterDto
• CreateUpdateMessageSourceDto
• CreateUpdateMessageSourceRouteDto
• CreateUpdateMessageSourceRouteSubDto
• CurrentCultureDto
• CurrentTenantDto
• CurrentUserDto
• DateTimeFormatDto
• DeployRecordDto
• DeployRecordDtoPagedResultDto
• DeployStatus
• DeviceDto
• DeviceDtoPagedResultDto
• DeviceStatus
• EmailSettingsDto
• EntityExtensionDto
• ExtensionEnumDto
• ExtensionEnumFieldDto
• ExtensionPropertyApiCreateDto
• ExtensionPropertyApiDto
• ExtensionPropertyApiGetDto
• ExtensionPropertyApiUpdateDto
• ExtensionPropertyAttributeDto
• ExtensionPropertyDto
• ExtensionPropertyUiDto
• ExtensionPropertyUiFormDto
• ExtensionPropertyUiLookupDto
• ExtensionPropertyUiTableDto
• FeatureDto
• FeatureGroupDto
• FeatureProviderDto
• FindTenantResultDto
• GetFeatureListResultDto
• GetPermissionListResultDto
• GitRepositoryType
• IStringValueType
• IValueValidator
• IanaTimeZone
• IdentityRoleCreateDto
• IdentityRoleDto
• IdentityRoleDtoListResultDto
• IdentityRoleDtoPagedResultDto
• IdentityRoleUpdateDto
• IdentityUser
• IdentityUserClaim
• IdentityUserCreateDto
• IdentityUserDto
• IdentityUserDtoPagedResultDto
• IdentityUserLogin
• IdentityUserOrganizationUnit
• IdentityUserRole
• IdentityUserToken
• IdentityUserUpdateDto
• IdentityUserUpdateRolesDto
• InApp
• InterfaceMethodApiDescriptionModel
• LanguageInfo
• LatestReceiptInfo
• LocalizableStringDto
• MessagePublishDto
• MessageRecallDto
• MessageSourceCategoryDto
• MessageSourceDto
• MessageSourceRouteDto
• MessageSourceRouteSubDto
• MessageSubscribeDto
• MessageTemplateDto
• MessageTemplateReleaseDto
• MessageUnsubscribeDto
• MethodParameterApiDescriptionModel
• ModuleApiDescriptionModel
• ModuleExtensionDto
• MultiTenancyInfoDto
• NameValue
• NotificationInfoDto
• NotificationInfoDtoPagedResultDto
• ObjectExtensionsDto
• ParameterApiDescriptionModel
• PendingRenewalInfo
• PermissionGrantInfoDto
• PermissionGroupDto
• ProfileDto
• PropertyApiDescriptionModel
• ProviderInfoDto
• Receipt
• RefreshDeviceStatusDto
• RegisterDto
• ReleaseChannel
• RemoteServiceErrorInfo
• RemoteServiceErrorResponse
• RemoteServiceValidationErrorInfo
• ReplyAppFeedbackDto
• ResetPasswordDto
• ReturnValueApiDescriptionModel
• SendPasswordResetCodeDto
• SendTestEmailInput
• SendVerificationCodeDto
• StorageObjectCredentials
• SubscriptionDto
• SubscriptionOrderDto
• SubscriptionOrderStatus
• SubscriptionOrderType
• TenantCreateDto
• TenantDto
• TenantDtoPagedResultDto
• TenantUpdateDto
• TimeZone
• TimingDto
• TypeApiDescriptionModel
• UpdateBuildRecordDto
• UpdateDeployRecordDto
• UpdateEmailSettingsDto
• UpdateFeatureDto
• UpdateFeaturesDto
• UpdatePermissionDto
• UpdatePermissionsDto
• UpdateProfileDto
• UserData
• UserDataListResultDto
• UserProfileDto
• UserStorageDto
• UserStorageItemDto
• VerifyPasswordResetTokenInput
• VerifyReceiptDto
• VerifyReceiptResult
• WindowsTimeZone

Documentation For Authorization

Authentication schemes defined for the API:

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://dev.auth.puupee.com/connect/authorize
• Scopes:
• Puupees: Puupees API