@otr-app/shared-backend-generated-client 1.1.6 → 2.0.0

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. Make sure you are authenticated with npm under the @otr-app organization
-   1. ```npm login --scope=@otr-app```
-2. 
-   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```
-3. Optional: Sanity check the differences in otrBackendService.js
-   1. ```git diff HEAD dist/otrBackendService.js```
-4. Commit the changes and push to github
-5. Update the version number in package.json
-6. Execute ```npm publish```
+# 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. Make sure you are authenticated with npm under the @otr-app organization
+   1. ```npm login --scope=@otr-app```
+2. 
+   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```
+3. Optional: Sanity check the differences in otrBackendService.js
+   1. ```git diff HEAD dist/otrBackendService.js```
+4. Commit the changes and push to github
+5. Update the version number in package.json
+6. Execute ```npm publish```
 7. Done.

package/dist/typescript-angularjs/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# 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 OpenAPI Generator 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/typescript-angularjs/api/ActionRequiredControllerApi.ts

@@ -0,0 +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';
+    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/typescript-angularjs/api/ActivityFeedControllerApi.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 ActivityFeedControllerApi {
+    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com';
+    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 listActivityFeed
+     * @param limit limit
+     * @param nextPageToken nextPageToken
+     * @param previousPageToken previousPageToken
+     */
+    public listActivityFeedUsingGET (limit: number, nextPageToken?: string, previousPageToken?: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.GetActivityFeedResponse> {
+        const localVarPath = this.basePath + '/api/v1/activity-feed';
+
+        let queryParameters: any = {};
+        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        // verify required parameter 'limit' is not null or undefined
+        if (limit === null || limit === undefined) {
+            throw new Error('Required parameter limit was null or undefined when calling listActivityFeedUsingGET.');
+        }
+
+        if (limit !== undefined) {
+            queryParameters['limit'] = limit;
+        }
+
+        if (nextPageToken !== undefined) {
+            queryParameters['nextPageToken'] = nextPageToken;
+        }
+
+        if (previousPageToken !== undefined) {
+            queryParameters['previousPageToken'] = previousPageToken;
+        }
+
+        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/typescript-angularjs/api/AddressControllerApi.ts

@@ -0,0 +1,117 @@
+/**
+ * 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';
+    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);
+    }
+    /**
+     * 
+     * @summary getLocation
+     * @param zipCode zipCode
+     * @param countryCode countryCode
+     */
+    public getLocationUsingGET (zipCode: string, countryCode?: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.GetLocationResponse> {
+        const localVarPath = this.basePath + '/api/v1/locations';
+
+        let queryParameters: any = {};
+        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        // verify required parameter 'zipCode' is not null or undefined
+        if (zipCode === null || zipCode === undefined) {
+            throw new Error('Required parameter zipCode was null or undefined when calling getLocationUsingGET.');
+        }
+
+        if (countryCode !== undefined) {
+            queryParameters['countryCode'] = countryCode;
+        }
+
+        if (zipCode !== undefined) {
+            queryParameters['zipCode'] = zipCode;
+        }
+
+        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/typescript-angularjs/api/AlertNotificationControllerApi.ts

@@ -0,0 +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';
+    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 alertId
+     */
+    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);
+    }
+}

package/dist/typescript-angularjs/api/AppEventsControllerApi.ts

@@ -0,0 +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 AppEventsControllerApi {
+    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com';
+    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 addAppEvent
+     * @param request request
+     */
+    public addAppEventUsingPOST (request: models.AppEventCreateRequest, extraHttpRequestParams?: any ) : ng.IHttpPromise<object> {
+        const localVarPath = this.basePath + '/api/v1/app-events';
+
+        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 addAppEventUsingPOST.');
+        }
+
+        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/typescript-angularjs/api/AuditLawfirmEventsControllerApi.ts

@@ -0,0 +1,78 @@
+/**
+ * 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 AuditLawfirmEventsControllerApi {
+    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com';
+    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 listLawfirmAuditEventsByCursor
+     * @param lawfirmId lawfirmId
+     * @param excludeTypes excludeTypes
+     * @param includeTypes includeTypes
+     * @param limit limit
+     * @param nextPageToken nextPageToken
+     */
+    public listLawfirmAuditEventsByCursorUsingGET (lawfirmId: number, excludeTypes?: Array<'CASE_BOOKING' | 'CASE_MATCH' | 'CITATION_UPLOAD' | 'LAWFIRM_ACCOUNT_PRIORITY' | 'LAWFIRM_ACCOUNT_STATUS' | 'LAWFIRM_DAILY_CAPACITY' | 'LAWFIRM_TOTAL_CAPACITY' | 'SAVE_VACATION_MODE_END_DATE' | 'SAVE_VACATION_MODE_REASON' | 'VACATION_MODE_TOGGLE'>, includeTypes?: Array<'CASE_BOOKING' | 'CASE_MATCH' | 'CITATION_UPLOAD' | 'LAWFIRM_ACCOUNT_PRIORITY' | 'LAWFIRM_ACCOUNT_STATUS' | 'LAWFIRM_DAILY_CAPACITY' | 'LAWFIRM_TOTAL_CAPACITY' | 'SAVE_VACATION_MODE_END_DATE' | 'SAVE_VACATION_MODE_REASON' | 'VACATION_MODE_TOGGLE'>, limit?: number, nextPageToken?: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.ListLawfirmAuditEventsByCursorResponse> {
+        const localVarPath = this.basePath + '/api/v1/lawfirms/{lawfirmId}/audit-events'
+            .replace('{' + 'lawfirmId' + '}', encodeURIComponent(String(lawfirmId)));
+
+        let queryParameters: any = {};
+        let headerParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        // verify required parameter 'lawfirmId' is not null or undefined
+        if (lawfirmId === null || lawfirmId === undefined) {
+            throw new Error('Required parameter lawfirmId was null or undefined when calling listLawfirmAuditEventsByCursorUsingGET.');
+        }
+
+        if (excludeTypes !== undefined) {
+            queryParameters['excludeTypes'] = excludeTypes;
+        }
+
+        if (includeTypes !== undefined) {
+            queryParameters['includeTypes'] = includeTypes;
+        }
+
+        if (limit !== undefined) {
+            queryParameters['limit'] = limit;
+        }
+
+        if (nextPageToken !== undefined) {
+            queryParameters['nextPageToken'] = nextPageToken;
+        }
+
+        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/typescript-angularjs/api/AuthenticationControllerApi.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 AuthenticationControllerApi {
+    protected basePath = 'http://otr-backend-service-us-devo.offtherecord.com';
+    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 getUserInfo
+     */
+    public getUserInfoUsingGET (extraHttpRequestParams?: any ) : ng.IHttpPromise<models.GetCurrentUserResponse> {
+        const localVarPath = this.basePath + '/api/v1/authentication/user';
+
+        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);
+    }
+}