@veda_labs/vedalabs-angular-client v2.3.0

This is readme for using vedalabs-angular-client angular SDK.

0. Working stackblitz to get started.

1. Follow these quick steps to get started in your angular project.

npm i @veda_labs/vedalabs-angular-client --save

2. Import the module in your app module i.e. app.module.ts

import { BrowserModule } from "@angular/platform-browser";
import { HttpClientModule, HTTP_INTERCEPTORS } from "@angular/common/http";
import { BrowserAnimationsModule } from "@angular/platform-browser/animations";

import { ApiModule } from "@veda_labs/vedalabs-angular-client/src/app/api/api.module";

import { NgModule } from "@angular/core";
import { ReactiveFormsModule } from "@angular/forms";
...

3. Import in ngModules imports as per your environment file variables.

@NgModule({
	declarations: [
        ...
	],
	imports: [
		BrowserModule,
		ApiModule.forRoot({
			rootUrl: `${environment.protocol}://${environment.hostname}${environment.apiVersion}`
		}),

Variables required:

{
    "protocol": "https", // or http depends on your use case.  HTTPS preferred.  Cloud calls will redirect to HTTPS, locally one is allowed to run on HTTP.
    "hostname" : "api.staging.vedalabs.in", // prod: "api.vedalabs.in", put your local IP address for running this over local servers.
    "apiVersion": "/v1/rest"
}

4. Under build/angular-client/src/app/api you can find the models & services to get started.

5. All services are located at build/angular-client/src/app/api/services.ts.

export { BehaviourTypeService } from './services/behaviour-type.service';
export { AppService } from './services/app.service';
export { BehaviourService } from './services/behaviour.service';
export { CameraService } from './services/camera.service';
export { PipelineService } from './services/pipeline.service';
export { NotificationService } from './services/notification.service';
export { ServiceService } from './services/service.service';
export { HeartbeatService } from './services/heartbeat.service';
export { UserService } from './services/user.service';
export { RuleService } from './services/rule.service';
export { DeviceService } from './services/device.service';
export { InviteUsersService } from './services/invite-users.service';
export { AlertService } from './services/alert.service';
export { HubService } from './services/hub.service';
export { ChartService } from './services/chart.service';
export { OrganizationService } from './services/organization.service';
export { TagService } from './services/tag.service';
export { SignupService } from './services/signup.service';
export { FeaturePipelineService } from './services/feature-pipeline.service';
export { RecommendationService } from './services/recommendation.service';
export { ArtefactsService } from './services/artefacts.service';
export { DeviceClaimService } from './services/device-claim.service';
export { RoleService } from './services/role.service';
export { ProductService } from './services/product.service';

6. All models are located at build/angular-client/src/app/api/models.ts.

export { Product__id } from './models/product-__id';
export { User__id } from './models/user-__id';
export { App } from './models/app';
export { Service__id } from './models/service-__id';
export { Hub__id } from './models/hub-__id';
export { Tag } from './models/tag';
export { Recommendation } from './models/recommendation';
export { DeviceClaim } from './models/device-claim';
export { Service } from './models/service';
export { Organization__id } from './models/organization-__id';
export { Notification } from './models/notification';
export { Camera } from './models/camera';
export { Role } from './models/role';
export { BehaviourType__id } from './models/behaviour-type-__id';
export { InviteUsers } from './models/invite-users';
export { Product } from './models/product';
export { Hub } from './models/hub';
export { Signup } from './models/signup';
export { Chart } from './models/chart';
export { Alert } from './models/alert';
export { Behaviour } from './models/behaviour';
export { User } from './models/user';
export { FeaturePipeline } from './models/feature-pipeline';
export { Device } from './models/device';
export { Pipeline } from './models/pipeline';
export { Organization } from './models/organization';
export { Artefacts } from './models/artefacts';
export { Device__id } from './models/device-__id';
export { Behaviour__id } from './models/behaviour-__id';
export { Artefacts__id } from './models/artefacts-__id';
export { Rule } from './models/rule';
export { Camera__id } from './models/camera-__id';
export { Heartbeat } from './models/heartbeat';
export { BehaviourType } from './models/behaviour-type';

7. In build/angular-client/src/app/api/api-configuration.ts the default rootUrl for sdk is as follows:

export class ApiConfiguration {
  rootUrl: string = 'https://api.staging.vedalabs.in/v1/rest';
}

NOTE: Do change this unless you are running the sdk against staging server.