{"_id":"@azgeb/allergy-ally-api","name":"@azgeb/allergy-ally-api","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@azgeb/allergy-ally-api","version":"0.0.1","description":"OpenAPI client for @azgeb/allergy-ally-api","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":"^17.0.0","rxjs":"^7.4.0"},"module":"fesm2022/azgeb-allergy-ally-api.mjs","typings":"index.d.ts","exports":{"./package.json":{"default":"./package.json"},".":{"types":"./index.d.ts","esm2022":"./esm2022/azgeb-allergy-ally-api.mjs","esm":"./esm2022/azgeb-allergy-ally-api.mjs","default":"./fesm2022/azgeb-allergy-ally-api.mjs"}},"sideEffects":false,"dependencies":{"tslib":"^2.3.0"},"_id":"@azgeb/allergy-ally-api@0.0.1","gitHead":"1181130d807216ddf96dd5bb6194f6e1bf802ef9","bugs":{"url":"https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"},"homepage":"https://github.com/GIT_USER_ID/GIT_REPO_ID#readme","_nodeVersion":"18.18.0","_npmVersion":"9.8.1","dist":{"integrity":"sha512-3Eq081JABw1Ss3Sg9AdfVtKZl9Hs+mNYktudFqDBPrrg4HMx5At7WF3+IIk4XDkc1Uc2VQS8X1/Xmv8GAteeTw==","shasum":"60348253d83d009ef9001f3c4ab4c29b8e2a59f2","tarball":"https://registry.npmjs.org/@azgeb/allergy-ally-api/-/allergy-ally-api-0.0.1.tgz","fileCount":41,"unpackedSize":174557,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDrnm3bxnoE3Od6ca23ZMnyDB/WvwsWY6qemmpKMiUjvwIgUGMfp1ln+fW3pKpNLoa7j1oz7rtm2FOc27l9kZhk1GI="}]},"_npmUser":{"name":"azgeb","email":"joseph.juri@gmail.com"},"directories":{},"maintainers":[{"name":"azgeb","email":"joseph.juri@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/allergy-ally-api_0.0.1_1711617905164_0.7789193263265894"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-28T09:25:05.040Z","0.0.1":"2024-03-28T09:25:05.332Z","modified":"2024-03-28T09:25:05.655Z"},"maintainers":[{"name":"azgeb","email":"joseph.juri@gmail.com"}],"description":"OpenAPI client for @azgeb/allergy-ally-api","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":"## @azgeb/allergy-ally-api@0.0.1\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 @azgeb/allergy-ally-api@0.0.1 --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 @azgeb/allergy-ally-api\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 { ApiModule } from '@azgeb/allergy-ally-api';\nimport { HttpClientModule } from '@angular/common/http';\n\n@NgModule({\n    imports: [\n        ApiModule,\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 { ApiModule, Configuration, ConfigurationParameters } from '@azgeb/allergy-ally-api';\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: [ ApiModule.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 { ApiModule, Configuration } from '@azgeb/allergy-ally-api';\n\n@NgModule({\n    imports: [ ApiModule ],\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 '@azgeb/allergy-ally-api';\n\nexport class AppComponent {\n    constructor(private apiGateway: DefaultApi) { }\n}\n```\n\nNote: The ApiModule 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 / ApiModules\nIn order to use multiple `ApiModules` generated from different OpenAPI files,\nyou can create an alias name when importing the modules\nin order to avoid naming conflicts:\n```\nimport { ApiModule } from 'my-api-path';\nimport { ApiModule as OtherApiModule } from 'my-other-api-path';\nimport { HttpClientModule } from '@angular/common/http';\n\n@NgModule({\n  imports: [\n    ApiModule,\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 '@azgeb/allergy-ally-api';\n\nbootstrap(AppComponent, [\n    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },\n]);\n```\nor\n\n```\nimport { BASE_PATH } from '@azgeb/allergy-ally-api';\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 '@azgeb/allergy-ally-api';\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"}