@otr-app/shared-backend-generated-client 1.0.8 → 1.0.9

package/README.md

@@ -1,61 +1,61 @@
-# Import
-In your app.js, inject the otrBackendService module
-
-```js
-angular.module("otr-console", [
-    'ngAnimate',
-    'ngCookies',
-    'ngStorage',
-    'ngRetina',
-    ...
-    'otrBackendService'
-]);
-```
-
-## Instantiation
-
-- Inject OtrService into your controller/bizLogic
-- Create an OtrService variable in the scope of the controller/bizLogic
-- You can inject the domain via constructor injection.
-
-```js
-...
-var otrService = new OtrService({domain: ENV.apiEndpoint})
-...
-```
-
-## Usage
-
-- The methods generated in the OtrService component are the java methodName + "Using" + httpMethod
-- E.g. getCaseUsingGET, confirmBookingUsingPOST, and etc...
-
-```js
-let responseSuccess = await otrService.getCaseUsingGET({caseId: caseId});
-```
-
-## Error Handling
-
-- Sample Code
-
-```typescript
-try {
-    await otrService.getCaseUsingGET({caseId: caseId})
-} catch(error) {
-    const uiErrorMsg = error.body.error.uiErrorMsg;
-}
-```
-
-## How to upgrade the generated AngularJS client
-1. 
-   Generate the JSON models and endpoints from devo
-   ``` npm run generate:devo```
-   1. OR generate the JSON models and endpoints from local server
-   ``` npm run generate:local```
-2. Optional: Sanity check the differences in otrBackendService.js
-3. Commit the changes and push to github
-4. Update the version number in package.json
-5. Execute ```npm publish```
-   1. Make sure you are authenticated with npm under the @otr-app organization
-      1. ```npm login --scope=@otr-app```
-      2. Run step 5 again
+# Import
+In your app.js, inject the otrBackendService module
+
+```js
+angular.module("otr-console", [
+    'ngAnimate',
+    'ngCookies',
+    'ngStorage',
+    'ngRetina',
+    ...
+    'otrBackendService'
+]);
+```
+
+## Instantiation
+
+- Inject OtrService into your controller/bizLogic
+- Create an OtrService variable in the scope of the controller/bizLogic
+- You can inject the domain via constructor injection.
+
+```js
+...
+var otrService = new OtrService({domain: ENV.apiEndpoint})
+...
+```
+
+## Usage
+
+- The methods generated in the OtrService component are the java methodName + "Using" + httpMethod
+- E.g. getCaseUsingGET, confirmBookingUsingPOST, and etc...
+
+```js
+let responseSuccess = await otrService.getCaseUsingGET({caseId: caseId});
+```
+
+## Error Handling
+
+- Sample Code
+
+```typescript
+try {
+    await otrService.getCaseUsingGET({caseId: caseId})
+} catch(error) {
+    const uiErrorMsg = error.body.error.uiErrorMsg;
+}
+```
+
+## How to upgrade the generated AngularJS client
+1. 
+   Generate the JSON models and endpoints from devo
+   ``` npm run generate:devo```
+   1. OR generate the JSON models and endpoints from local server
+   ``` npm run generate:local```
+2. Optional: Sanity check the differences in otrBackendService.js
+3. Commit the changes and push to github
+4. Update the version number in package.json
+5. Execute ```npm publish```
+   1. Make sure you are authenticated with npm under the @otr-app organization
+      1. ```npm login --scope=@otr-app```
+      2. Run step 5 again
 6. Done.

package/dist/otr-ts-client/.openapi-generator-ignore

@@ -1,23 +1,23 @@
-# Swagger Codegen Ignore
-# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
-
-# Use this file to prevent files from being overwritten by the generator.
-# The patterns follow closely to .gitignore or .dockerignore.
-
-# As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
-#ApiClient.cs
-
-# You can match any string of characters against a directory, file or extension with a single asterisk (*):
-#foo/*/qux
-# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
-
-# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
-#foo/**/qux
-# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
-
-# You can also negate patterns with an exclamation (!).
-# For example, you can ignore all files in a docs folder with the file extension .md:
-#docs/*.md
-# Then explicitly reverse the ignore rule for a single file:
-#!docs/README.md
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/dist/otr-ts-client/api/ActionRequiredControllerApi.ts

@@ -1,58 +1,58 @@
-/**
- * OffTheRecord Rest Service API - Devo
- * A service to handle your traffic tickets
- *
- * The version of the OpenAPI document: 1.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import * as models from '../model/models';
-
-/* tslint:disable:no-unused-variable member-ordering */
-
-export class ActionRequiredControllerApi {
-    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com:443';
-    public defaultHeaders : any = {};
-
-    static $inject: string[] = ['$http', '$httpParamSerializer', 'basePath'];
-
-    constructor(protected $http: ng.IHttpService, protected $httpParamSerializer?: (d: any) => any, basePath?: string) {
-        if (basePath !== undefined) {
-            this.basePath = basePath;
-        }
-    }
-
-    /**
-     * 
-     * @summary notifyClientActionRequirement
-     * @param request request
-     */
-    public notifyClientActionRequirementUsingPOST (request: models.ClientActionRequiredRequest, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
-        const localVarPath = this.basePath + '/api/v1/notifications/action-required';
-
-        let queryParameters: any = {};
-        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
-        // verify required parameter 'request' is not null or undefined
-        if (request === null || request === undefined) {
-            throw new Error('Required parameter request was null or undefined when calling notifyClientActionRequirementUsingPOST.');
-        }
-
-        let httpRequestParams: ng.IRequestConfig = {
-            method: 'POST',
-            url: localVarPath,
-            data: request,
-            params: queryParameters,
-            headers: headerParams
-        };
-
-        if (extraHttpRequestParams) {
-            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
-        }
-
-        return this.$http(httpRequestParams);
-    }
-}
+/**
+ * OffTheRecord Rest Service API - Devo
+ * A service to handle your traffic tickets
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as models from '../model/models';
+
+/* tslint:disable:no-unused-variable member-ordering */
+
+export class ActionRequiredControllerApi {
+    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com:443';
+    public defaultHeaders : any = {};
+
+    static $inject: string[] = ['$http', '$httpParamSerializer', 'basePath'];
+
+    constructor(protected $http: ng.IHttpService, protected $httpParamSerializer?: (d: any) => any, basePath?: string) {
+        if (basePath !== undefined) {
+            this.basePath = basePath;
+        }
+    }
+
+    /**
+     * 
+     * @summary notifyClientActionRequirement
+     * @param request request
+     */
+    public notifyClientActionRequirementUsingPOST (request: models.ClientActionRequiredRequest, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
+        const localVarPath = this.basePath + '/api/v1/notifications/action-required';
+
+        let queryParameters: any = {};
+        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        // verify required parameter 'request' is not null or undefined
+        if (request === null || request === undefined) {
+            throw new Error('Required parameter request was null or undefined when calling notifyClientActionRequirementUsingPOST.');
+        }
+
+        let httpRequestParams: ng.IRequestConfig = {
+            method: 'POST',
+            url: localVarPath,
+            data: request,
+            params: queryParameters,
+            headers: headerParams
+        };
+
+        if (extraHttpRequestParams) {
+            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
+        }
+
+        return this.$http(httpRequestParams);
+    }
+}

package/dist/otr-ts-client/api/AddressControllerApi.ts

@@ -1,80 +1,80 @@
-/**
- * OffTheRecord Rest Service API - Devo
- * A service to handle your traffic tickets
- *
- * The version of the OpenAPI document: 1.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import * as models from '../model/models';
-
-/* tslint:disable:no-unused-variable member-ordering */
-
-export class AddressControllerApi {
-    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com:443';
-    public defaultHeaders : any = {};
-
-    static $inject: string[] = ['$http', '$httpParamSerializer', 'basePath'];
-
-    constructor(protected $http: ng.IHttpService, protected $httpParamSerializer?: (d: any) => any, basePath?: string) {
-        if (basePath !== undefined) {
-            this.basePath = basePath;
-        }
-    }
-
-    /**
-     * 
-     * @summary getCountryList
-     */
-    public getCountryListUsingGET (extraHttpRequestParams?: any ) : ng.IHttpPromise<models.GetCountryListResponse> {
-        const localVarPath = this.basePath + '/api/v1/countries';
-
-        let queryParameters: any = {};
-        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
-        let httpRequestParams: ng.IRequestConfig = {
-            method: 'GET',
-            url: localVarPath,
-            params: queryParameters,
-            headers: headerParams
-        };
-
-        if (extraHttpRequestParams) {
-            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
-        }
-
-        return this.$http(httpRequestParams);
-    }
-    /**
-     * 
-     * @summary getCountryRegions
-     * @param countryCode countryCode
-     */
-    public getCountryRegionsUsingGET (countryCode: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.GetCountryRegionsResponse> {
-        const localVarPath = this.basePath + '/api/v1/countries/{countryCode}/regions'
-            .replace('{' + 'countryCode' + '}', encodeURIComponent(String(countryCode)));
-
-        let queryParameters: any = {};
-        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
-        // verify required parameter 'countryCode' is not null or undefined
-        if (countryCode === null || countryCode === undefined) {
-            throw new Error('Required parameter countryCode was null or undefined when calling getCountryRegionsUsingGET.');
-        }
-
-        let httpRequestParams: ng.IRequestConfig = {
-            method: 'GET',
-            url: localVarPath,
-            params: queryParameters,
-            headers: headerParams
-        };
-
-        if (extraHttpRequestParams) {
-            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
-        }
-
-        return this.$http(httpRequestParams);
-    }
-}
+/**
+ * OffTheRecord Rest Service API - Devo
+ * A service to handle your traffic tickets
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as models from '../model/models';
+
+/* tslint:disable:no-unused-variable member-ordering */
+
+export class AddressControllerApi {
+    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com:443';
+    public defaultHeaders : any = {};
+
+    static $inject: string[] = ['$http', '$httpParamSerializer', 'basePath'];
+
+    constructor(protected $http: ng.IHttpService, protected $httpParamSerializer?: (d: any) => any, basePath?: string) {
+        if (basePath !== undefined) {
+            this.basePath = basePath;
+        }
+    }
+
+    /**
+     * 
+     * @summary getCountryList
+     */
+    public getCountryListUsingGET (extraHttpRequestParams?: any ) : ng.IHttpPromise<models.GetCountryListResponse> {
+        const localVarPath = this.basePath + '/api/v1/countries';
+
+        let queryParameters: any = {};
+        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        let httpRequestParams: ng.IRequestConfig = {
+            method: 'GET',
+            url: localVarPath,
+            params: queryParameters,
+            headers: headerParams
+        };
+
+        if (extraHttpRequestParams) {
+            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
+        }
+
+        return this.$http(httpRequestParams);
+    }
+    /**
+     * 
+     * @summary getCountryRegions
+     * @param countryCode countryCode
+     */
+    public getCountryRegionsUsingGET (countryCode: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.GetCountryRegionsResponse> {
+        const localVarPath = this.basePath + '/api/v1/countries/{countryCode}/regions'
+            .replace('{' + 'countryCode' + '}', encodeURIComponent(String(countryCode)));
+
+        let queryParameters: any = {};
+        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        // verify required parameter 'countryCode' is not null or undefined
+        if (countryCode === null || countryCode === undefined) {
+            throw new Error('Required parameter countryCode was null or undefined when calling getCountryRegionsUsingGET.');
+        }
+
+        let httpRequestParams: ng.IRequestConfig = {
+            method: 'GET',
+            url: localVarPath,
+            params: queryParameters,
+            headers: headerParams
+        };
+
+        if (extraHttpRequestParams) {
+            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
+        }
+
+        return this.$http(httpRequestParams);
+    }
+}

package/dist/otr-ts-client/api/AlertNotificationControllerApi.ts

@@ -1,87 +1,87 @@
-/**
- * OffTheRecord Rest Service API - Devo
- * A service to handle your traffic tickets
- *
- * The version of the OpenAPI document: 1.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import * as models from '../model/models';
-
-/* tslint:disable:no-unused-variable member-ordering */
-
-export class AlertNotificationControllerApi {
-    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com:443';
-    public defaultHeaders : any = {};
-
-    static $inject: string[] = ['$http', '$httpParamSerializer', 'basePath'];
-
-    constructor(protected $http: ng.IHttpService, protected $httpParamSerializer?: (d: any) => any, basePath?: string) {
-        if (basePath !== undefined) {
-            this.basePath = basePath;
-        }
-    }
-
-    /**
-     * 
-     * @summary getAlerts
-     * @param userId userId
-     */
-    public getAlertsUsingGET (userId: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.AlertNotificationResponse> {
-        const localVarPath = this.basePath + '/api/v1/alerts/{userId}'
-            .replace('{' + 'userId' + '}', encodeURIComponent(String(userId)));
-
-        let queryParameters: any = {};
-        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
-        // verify required parameter 'userId' is not null or undefined
-        if (userId === null || userId === undefined) {
-            throw new Error('Required parameter userId was null or undefined when calling getAlertsUsingGET.');
-        }
-
-        let httpRequestParams: ng.IRequestConfig = {
-            method: 'GET',
-            url: localVarPath,
-            params: queryParameters,
-            headers: headerParams
-        };
-
-        if (extraHttpRequestParams) {
-            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
-        }
-
-        return this.$http(httpRequestParams);
-    }
-    /**
-     * 
-     * @summary markAlertAsRead
-     * @param alertId userId
-     */
-    public markAlertAsReadUsingDELETE (alertId: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.AlertNotificationResponse> {
-        const localVarPath = this.basePath + '/api/v1/alerts/{alertId}'
-            .replace('{' + 'alertId' + '}', encodeURIComponent(String(alertId)));
-
-        let queryParameters: any = {};
-        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
-        // verify required parameter 'alertId' is not null or undefined
-        if (alertId === null || alertId === undefined) {
-            throw new Error('Required parameter alertId was null or undefined when calling markAlertAsReadUsingDELETE.');
-        }
-
-        let httpRequestParams: ng.IRequestConfig = {
-            method: 'DELETE',
-            url: localVarPath,
-            params: queryParameters,
-            headers: headerParams
-        };
-
-        if (extraHttpRequestParams) {
-            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
-        }
-
-        return this.$http(httpRequestParams);
-    }
-}
+/**
+ * OffTheRecord Rest Service API - Devo
+ * A service to handle your traffic tickets
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as models from '../model/models';
+
+/* tslint:disable:no-unused-variable member-ordering */
+
+export class AlertNotificationControllerApi {
+    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com:443';
+    public defaultHeaders : any = {};
+
+    static $inject: string[] = ['$http', '$httpParamSerializer', 'basePath'];
+
+    constructor(protected $http: ng.IHttpService, protected $httpParamSerializer?: (d: any) => any, basePath?: string) {
+        if (basePath !== undefined) {
+            this.basePath = basePath;
+        }
+    }
+
+    /**
+     * 
+     * @summary getAlerts
+     * @param userId userId
+     */
+    public getAlertsUsingGET (userId: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.AlertNotificationResponse> {
+        const localVarPath = this.basePath + '/api/v1/alerts/{userId}'
+            .replace('{' + 'userId' + '}', encodeURIComponent(String(userId)));
+
+        let queryParameters: any = {};
+        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        // verify required parameter 'userId' is not null or undefined
+        if (userId === null || userId === undefined) {
+            throw new Error('Required parameter userId was null or undefined when calling getAlertsUsingGET.');
+        }
+
+        let httpRequestParams: ng.IRequestConfig = {
+            method: 'GET',
+            url: localVarPath,
+            params: queryParameters,
+            headers: headerParams
+        };
+
+        if (extraHttpRequestParams) {
+            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
+        }
+
+        return this.$http(httpRequestParams);
+    }
+    /**
+     * 
+     * @summary markAlertAsRead
+     * @param alertId userId
+     */
+    public markAlertAsReadUsingDELETE (alertId: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.AlertNotificationResponse> {
+        const localVarPath = this.basePath + '/api/v1/alerts/{alertId}'
+            .replace('{' + 'alertId' + '}', encodeURIComponent(String(alertId)));
+
+        let queryParameters: any = {};
+        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        // verify required parameter 'alertId' is not null or undefined
+        if (alertId === null || alertId === undefined) {
+            throw new Error('Required parameter alertId was null or undefined when calling markAlertAsReadUsingDELETE.');
+        }
+
+        let httpRequestParams: ng.IRequestConfig = {
+            method: 'DELETE',
+            url: localVarPath,
+            params: queryParameters,
+            headers: headerParams
+        };
+
+        if (extraHttpRequestParams) {
+            httpRequestParams = (<any>Object).assign(httpRequestParams, extraHttpRequestParams);
+        }
+
+        return this.$http(httpRequestParams);
+    }
+}