{"_id":"@cysec/ot-risk-assessment-api-client","name":"@cysec/ot-risk-assessment-api-client","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@cysec/ot-risk-assessment-api-client","version":"1.0.0","description":"OpenAPI client for @cysec/ot-risk-assessment-api-client","author":{"name":"OpenAPI-Generator Contributors"},"repository":{"type":"git","url":"git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git"},"keywords":["openapi-client","openapi-generator"],"license":"Unlicense","peerDependencies":{"@angular/core":"^12.2.15","rxjs":"^6.6.0"},"main":"bundles/cysec-ot-risk-assessment-api-client.umd.js","module":"fesm2015/cysec-ot-risk-assessment-api-client.js","es2015":"fesm2015/cysec-ot-risk-assessment-api-client.js","esm2015":"esm2015/cysec-ot-risk-assessment-api-client.js","fesm2015":"fesm2015/cysec-ot-risk-assessment-api-client.js","typings":"cysec-ot-risk-assessment-api-client.d.ts","metadata":"cysec-ot-risk-assessment-api-client.metadata.json","sideEffects":false,"dependencies":{"tslib":"^2.2.0"},"gitHead":"c84e2c5ee901d279794235fd8bb466d0404b3b17","bugs":{"url":"https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"},"homepage":"https://github.com/GIT_USER_ID/GIT_REPO_ID#readme","_id":"@cysec/ot-risk-assessment-api-client@1.0.0","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-aKvvtWA/ZYHOIbZ45vj54KRM+Qc9cNhfnaSNk2YRHHWdEdbvK8KYNtFTu/HH9C49bY/SS3UxS62anCD0QOgxPg==","shasum":"1bd3d16cb440140b24d182dc1b0c57e980224b86","tarball":"https://registry.npmjs.org/@cysec/ot-risk-assessment-api-client/-/ot-risk-assessment-api-client-1.0.0.tgz","fileCount":91,"unpackedSize":2312674,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBloM5e8AWjTbZNo/PsbmHU815VQPUElGrNzjoYfVOzxAiAykztjGOt1B4dq+0ZReWdMdZjBDrzHq9awcAFRreowvQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjc8SnACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqxTw//TDV+RPJasIU2DzkkxIhQ+mu0SSXdJRHhE03LTM3uQZfgR6LK\r\ndxUEjnPeAjkST+6Cuk9EPZj8hMWwBXcEjmEF1A3PsQhhjrLihnFOAtTMAd9t\r\nJDfW/eeNwcLic56+RXc+jxK2n5rwECnjPG6DI4+bBP0X/u/B25ACKBfX732h\r\nRa+d/RwDw4kl9ablAOdb6UE2OfMs/OesjuRewhwqgi++2/hbpdtyO5Py1mcx\r\nQyC77JGL7X7xtW7t4M7JQ0mZJh3m/TyDXpT+vBua7mHB1et+8AsDYZc/xWBT\r\nrs79bK5EnPbWBO7RD9qZAZlOV1mWExuRgmE6Sqdht/2Qh9p2F+owRxcZ7ZdI\r\n52JdWGY5lyW550Kks/PxcXY1Zm1dZuNpknVY3PXX4Yo+EHKiITJ5iBg1L6S1\r\nZESyI4GlyAa/yD+XFPyQtuiBGSk9szM3s8qJmKvr9tQbm+M6wKbM9GnxJx5a\r\ni5DuWVXCWVfJ0jMhCqP4HTjMR/CaPLzdcwiRtDq14+N6kHYguQR2uXMTGk4g\r\n114l8ke1lq0CCmZyCbupUpPyEqGdYUCbaL/GRDiwQHkJCaAqe1YPqAcZLhWl\r\n+fA15TfVNcd+d7JdJ7NDXq198oJr8Y2OfrWr/J1//MeBG/Xhq14de6Y9/FRl\r\nfDE+/nTa0sNG95QWSAmS8oH6mVX//FcRlKY=\r\n=s3h6\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"cysec-npm","email":"ci.cysec.eng@gmail.com"},"directories":{},"maintainers":[{"name":"cysec-npm","email":"ci.cysec.eng@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ot-risk-assessment-api-client_1.0.0_1668531367507_0.32393504181410915"},"_hasShrinkwrap":false}},"time":{"created":"2022-11-15T16:56:07.455Z","1.0.0":"2022-11-15T16:56:07.720Z","modified":"2022-11-15T16:56:07.840Z"},"maintainers":[{"name":"cysec-npm","email":"ci.cysec.eng@gmail.com"}],"description":"OpenAPI client for @cysec/ot-risk-assessment-api-client","homepage":"https://github.com/GIT_USER_ID/GIT_REPO_ID#readme","keywords":["openapi-client","openapi-generator"],"repository":{"type":"git","url":"git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git"},"author":{"name":"OpenAPI-Generator Contributors"},"bugs":{"url":"https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"},"license":"Unlicense","readme":"## @cysec/ot-risk-assessment-api-client@1.0.0\n\n### Building\n\nTo install the required dependencies and to build the typescript sources run:\n```\nnpm install\nnpm run build\n```\n\n### publishing\n\nFirst build the package then run ```npm publish dist``` (don't forget to specify the `dist` folder!)\n\n### consuming\n\nNavigate to the folder of your consuming project and run one of next commands.\n\n_published:_\n\n```\nnpm install @cysec/ot-risk-assessment-api-client@1.0.0 --save\n```\n\n_without publishing (not recommended):_\n\n```\nnpm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save\n```\n\n_It's important to take the tgz file, otherwise you'll get trouble with links on windows_\n\n_using `npm link`:_\n\nIn PATH_TO_GENERATED_PACKAGE/dist:\n```\nnpm link\n```\n\nIn your project:\n```\nnpm link @cysec/ot-risk-assessment-api-client\n```\n\n__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.\nPlease refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround.\nPublished packages are not effected by this issue.\n\n\n#### General usage\n\nIn your Angular project:\n\n\n```\n// without configuring providers\nimport { OTRiskAssessmentApiModule } from '@cysec/ot-risk-assessment-api-client';\nimport { HttpClientModule } from '@angular/common/http';\n\n@NgModule({\n    imports: [\n        OTRiskAssessmentApiModule,\n        // make sure to import the HttpClientModule in the AppModule only,\n        // see https://github.com/angular/angular/issues/20575\n        HttpClientModule\n    ],\n    declarations: [ AppComponent ],\n    providers: [],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n```\n// configuring providers\nimport { OTRiskAssessmentApiModule, Configuration, ConfigurationParameters } from '@cysec/ot-risk-assessment-api-client';\n\nexport function apiConfigFactory (): Configuration {\n  const params: ConfigurationParameters = {\n    // set configuration parameters here.\n  }\n  return new Configuration(params);\n}\n\n@NgModule({\n    imports: [ OTRiskAssessmentApiModule.forRoot(apiConfigFactory) ],\n    declarations: [ AppComponent ],\n    providers: [],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n```\n// configuring providers with an authentication service that manages your access tokens\nimport { OTRiskAssessmentApiModule, Configuration } from '@cysec/ot-risk-assessment-api-client';\n\n@NgModule({\n    imports: [ OTRiskAssessmentApiModule ],\n    declarations: [ AppComponent ],\n    providers: [\n      {\n        provide: Configuration,\n        useFactory: (authService: AuthService) => new Configuration(\n          {\n            basePath: environment.apiUrl,\n            accessToken: authService.getAccessToken.bind(authService)\n          }\n        ),\n        deps: [AuthService],\n        multi: false\n      }\n    ],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n```\nimport { DefaultApi } from '@cysec/ot-risk-assessment-api-client';\n\nexport class AppComponent {\n    constructor(private apiGateway: DefaultApi) { }\n}\n```\n\nNote: The OTRiskAssessmentApiModule is restricted to being instantiated once app wide.\nThis is to ensure that all services are treated as singletons.\n\n#### Using multiple OpenAPI files / APIs / OTRiskAssessmentApiModules\nIn order to use multiple `OTRiskAssessmentApiModules` generated from different OpenAPI files,\nyou can create an alias name when importing the modules\nin order to avoid naming conflicts:\n```\nimport { OTRiskAssessmentApiModule } from 'my-api-path';\nimport { OTRiskAssessmentApiModule as OtherApiModule } from 'my-other-api-path';\nimport { HttpClientModule } from '@angular/common/http';\n\n@NgModule({\n  imports: [\n    OTRiskAssessmentApiModule,\n    OtherApiModule,\n    // make sure to import the HttpClientModule in the AppModule only,\n    // see https://github.com/angular/angular/issues/20575\n    HttpClientModule\n  ]\n})\nexport class AppModule {\n\n}\n```\n\n\n### Set service base path\nIf different than the generated base path, during app bootstrap, you can provide the base path to your service.\n\n```\nimport { BASE_PATH } from '@cysec/ot-risk-assessment-api-client';\n\nbootstrap(AppComponent, [\n    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },\n]);\n```\nor\n\n```\nimport { BASE_PATH } from '@cysec/ot-risk-assessment-api-client';\n\n@NgModule({\n    imports: [],\n    declarations: [ AppComponent ],\n    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n\n#### Using @angular/cli\nFirst extend your `src/environments/*.ts` files by adding the corresponding base path:\n\n```\nexport const environment = {\n  production: false,\n  API_BASE_PATH: 'http://127.0.0.1:8080'\n};\n```\n\nIn the src/app/app.module.ts:\n```\nimport { BASE_PATH } from '@cysec/ot-risk-assessment-api-client';\nimport { environment } from '../environments/environment';\n\n@NgModule({\n  declarations: [\n    AppComponent\n  ],\n  imports: [ ],\n  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],\n  bootstrap: [ AppComponent ]\n})\nexport class AppModule { }\n```\n\n### Customizing path parameter encoding\n\nWithout further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple'\nand Dates for format 'date-time' are encoded correctly.\n\nOther styles (e.g. \"matrix\") are not that easy to encode\nand thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]).\n\nTo implement your own parameter encoding (or call another library),\npass an arrow-function or method-reference to the `encodeParam` property of the Configuration-object\n(see [General Usage](#general-usage) above).\n\nExample value for use in your Configuration-Provider:\n```typescript\nnew Configuration({\n    encodeParam: (param: Param) => myFancyParamEncoder(param),\n})\n```\n\n[parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations\n[style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values\n[@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander\n","readmeFilename":"README.md"}