autoinspector 1.1.1 → 1.1.2

package/.env

@@ -0,0 +1,6 @@
+AUTOINSPECTOR_API_BASE_URL=http://localhost:9001/api
+AUTOINSPECTOR_API_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MTQ3ODQzYmI5YTcwODAwNTUxODc4YmQiLCJpYXQiOjE2NDAyODI5NjcsImV4cCI6MzMxNjYzMjUzNjd9.Ikc2kIZRja8WBQ3QzWo7ztMAgFk-EFNyifjw_58sg3g
+CI_CAR_TEMPLATE_ID=627157f565b79931f3d1dbac
+CI_MACHINERY_TEMPLATE_ID=6274475b1996d60ec2803218
+CI_PEOPLE_TEMPLATE_ID=6274475b1996d60ec2803218
+CI_MOTO_TEMPLATE_ID=6274475b1996d60ec2803218

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { Autoinspector } from './resources/Autoinspector';
+export default Autoinspector;

package/dist/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Autoinspector_1 = require("./resources/Autoinspector");
+exports.default = Autoinspector_1.Autoinspector;

package/dist/package.json

@@ -0,0 +1,58 @@
+{
+    "name": "autoinspector",
+    "version": "1.1.2",
+    "description": "Autoinspector API wrapper",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "test": "jest --config ./jest.config.js",
+        "build": "tsc",
+        "semantic-release": "semantic-release",
+        "commit": "git-cz"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/autoinspector-global/autoinspector-node.git"
+    },
+    "keywords": [
+        "inspections",
+        "machine",
+        "learning"
+    ],
+    "author": "Autoinspector <support@autoinspector.com.ar> (https://autoinspector.com.ar)",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/autoinspector-global/autoinspector-node/issues"
+    },
+    "homepage": "https://github.com/autoinspector-global/autoinspector-node#readme",
+    "dependencies": {
+        "axios": "^0.25.0",
+        "form-data": "^4.0.0",
+        "isomorphic-form-data": "^2.0.0",
+        "typescript": "^4.5.4"
+    },
+    "devDependencies": {
+        "@types/jest": "^27.5.0",
+        "@types/node": "^17.0.10",
+        "@typescript-eslint/eslint-plugin": "^5.10.0",
+        "@typescript-eslint/parser": "^5.10.0",
+        "cz-conventional-changelog": "^3.3.0",
+        "eslint": "^8.7.0",
+        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-config-prettier": "^8.3.0",
+        "eslint-plugin-import": "^2.25.4",
+        "eslint-plugin-prettier": "^4.0.0",
+        "jest": "^27.5.1",
+        "prettier": "^2.5.1",
+        "semantic-release": "^19.0.2",
+        "ts-jest": "^28.0.0"
+    },
+    "config": {
+        "commitizen": {
+            "path": "./node_modules/cz-conventional-changelog"
+        }
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    }
+}

package/dist/resources/Autoinspector.d.ts

@@ -0,0 +1,20 @@
+import { IAutoinspector } from '../types/autoinspector';
+import { Image } from './Image';
+import { Inspections } from './Inspections';
+import { OAuth } from './OAuth';
+/**
+ * @classdesc Represents the Autoinspector SDK. It allows the user to make every call to the API with a single function.
+ * @class
+ */
+export declare class Autoinspector {
+    oauth: OAuth;
+    images: Image;
+    inspections: Inspections;
+    /**
+     * Create Autoinspector SDK.
+     * @constructor
+     * @see {@link https://autoinspector.com.ar/docs/api/start}
+     * @param input - An object with credentials and configuration.
+     */
+    constructor(input: IAutoinspector);
+}

package/dist/resources/Autoinspector.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Autoinspector = void 0;
+const package_json_1 = __importDefault(require("../package.json"));
+const HTTPClient_1 = require("./HTTPClient");
+const Image_1 = require("./Image");
+const Inspections_1 = require("./Inspections");
+const OAuth_1 = require("./OAuth");
+/**
+ * @classdesc Represents the Autoinspector SDK. It allows the user to make every call to the API with a single function.
+ * @class
+ */
+class Autoinspector {
+    /**
+     * Create Autoinspector SDK.
+     * @constructor
+     * @see {@link https://autoinspector.com.ar/docs/api/start}
+     * @param input - An object with credentials and configuration.
+     */
+    constructor(input) {
+        if (typeof input.apikey !== 'string') {
+            throw new Error('apikey should be a string.');
+        }
+        const httpClient = new HTTPClient_1.HTTPClient({
+            baseURL: process.env.AUTOINSPECTOR_API_BASE_URL || 'https://api.autoinspector.com.ar',
+            headers: {
+                'x-api-key': input.apikey,
+                'User-Agent': 'autoinspector-node-sdk/' + package_json_1.default.version,
+            },
+            timeout: input.timeout || 80000,
+            pathPrefix: '/v1',
+        });
+        this.oauth = new OAuth_1.OAuth(httpClient, input.oauthCredentials || {});
+        this.inspections = new Inspections_1.Inspections(httpClient);
+        this.images = new Image_1.Image(httpClient);
+    }
+}
+exports.Autoinspector = Autoinspector;

package/dist/resources/Car.d.ts

@@ -0,0 +1,8 @@
+import { ICreateCarInspection } from '../types/car';
+import { ICreateInspectionOutput } from '../types/inspection';
+import { HTTPClient } from './HTTPClient';
+export declare class Car {
+    private readonly httpClient;
+    constructor(httpClient: HTTPClient);
+    create(input: ICreateCarInspection): Promise<ICreateInspectionOutput>;
+}

package/dist/resources/Car.js

@@ -0,0 +1,56 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Car = void 0;
+const form_data_1 = __importDefault(require("form-data"));
+const Helper_1 = require("./Helper");
+class Car {
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    create(input) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const form = new form_data_1.default();
+            const { inputValues } = input, rest = __rest(input, ["inputValues"]);
+            const inputValuesNonFiles = [];
+            for (const inputValue of inputValues) {
+                const isFile = inputValue.value instanceof Buffer || Helper_1.Helper.isFile(inputValue.value);
+                if (isFile) {
+                    form.append(inputValue.label, inputValue.value instanceof Buffer ? inputValue.value : Helper_1.Helper.readFile(inputValue.value));
+                    continue;
+                }
+                inputValuesNonFiles.push(inputValue);
+            }
+            form.append('data', JSON.stringify(Object.assign(Object.assign({}, rest), { inputValues: inputValuesNonFiles })));
+            return yield this.httpClient.makeRequest({
+                method: 'POST',
+                path: `/inspection/car`,
+                body: input,
+                headers: form.getHeaders(),
+            });
+        });
+    }
+}
+exports.Car = Car;

package/dist/resources/Goods.d.ts

@@ -0,0 +1,34 @@
+import { IUpdateResourceResponse } from '../types/api';
+import { ICreateGoodsInspection, IUpdateGoodsInspection } from '../types/goods';
+import { ICreateInspectionGoodsOutput } from '../types/inspection';
+import { IProductService } from '../types/productMethods';
+import { HTTPClient } from './HTTPClient';
+export declare class Goods implements IProductService {
+    private readonly httpClient;
+    constructor(httpClient: HTTPClient);
+    /**
+     * Create an inspection that will contains goods.
+     * @param input - An object that contains the essential information for create an inspection.
+     * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+     * @param {Object} input.goods - Represents the goods to be attached to the inspection.
+     * @param {String} input.mode - Represents the mode of the inspection. See more details: {@link https://www.autoinspector.com.ar/docs/api/start#inspection_mode}
+     * @param {String} input.kindOf - Represents the template that inspection will have. This only matters if the input.mode is normal.
+     * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+     * @param {Object} input.producer - Represents the entity that has the ownership of the inspection to be created.
+     * @param {Object} input.access_token - Represents the token that belongs to some user into Autoinspector and was generated thanks to OAuth 2.0. When pass this argument, the apikey will not being send.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    create(input: ICreateGoodsInspection): Promise<ICreateInspectionGoodsOutput>;
+    /**
+     * Update a specific product.
+     * @param input - An object that contains information that .
+     * @param {String} input.productId - Represents the product unique identifier.
+     * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+     * @param {Object} input.good - The information to update of the product.
+     * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    update(input: IUpdateGoodsInspection): Promise<IUpdateResourceResponse>;
+}

package/dist/resources/Goods.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Goods = void 0;
+const Helper_1 = require("./Helper");
+class Goods {
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Create an inspection that will contains goods.
+     * @param input - An object that contains the essential information for create an inspection.
+     * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+     * @param {Object} input.goods - Represents the goods to be attached to the inspection.
+     * @param {String} input.mode - Represents the mode of the inspection. See more details: {@link https://www.autoinspector.com.ar/docs/api/start#inspection_mode}
+     * @param {String} input.kindOf - Represents the template that inspection will have. This only matters if the input.mode is normal.
+     * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+     * @param {Object} input.producer - Represents the entity that has the ownership of the inspection to be created.
+     * @param {Object} input.access_token - Represents the token that belongs to some user into Autoinspector and was generated thanks to OAuth 2.0. When pass this argument, the apikey will not being send.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    create(input) {
+        return this.httpClient.makeRequest({
+            method: 'POST',
+            path: `/inspection/goods`,
+            body: input,
+            headers: Helper_1.Helper.buildOptionalHeaders(input.access_token),
+        });
+    }
+    /**
+     * Update a specific product.
+     * @param input - An object that contains information that .
+     * @param {String} input.productId - Represents the product unique identifier.
+     * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+     * @param {Object} input.good - The information to update of the product.
+     * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    update(input) {
+        return this.httpClient.makeRequest({
+            method: 'PUT',
+            path: `/inspection/goods/${input.productId}`,
+            body: input,
+        });
+    }
+}
+exports.Goods = Goods;

package/dist/resources/HTTPClient.d.ts

@@ -0,0 +1,32 @@
+import { IHTTPClient, IMakeRequest } from '../types/http';
+/**
+ * @classdesc Represents the class that implements some HTTP client third library. It's an extra layer for in case if we need to change the implementation be one hundred percent sure we can do it without problems.
+ * @class
+ */
+export declare class HTTPClient {
+    private headers;
+    private timeout;
+    private baseURL;
+    private pathPrefix;
+    /**
+     * Create HTTPClient instance to start making request in another class.
+     * @constructor
+     * @param input - An object with common parameters that we need to set in the http client third party library.
+     * @param {Object} input.headers - An object with the headers to send in each makeRequest() call.
+     * @param {Object} input.timeout - The timeout that each request will have. That means, the time in milliseconds maximum that request will wait until cancel it.
+     * @param {Object} input.baseURL - The baseURL to make the requests.
+     */
+    constructor(input: IHTTPClient);
+    /**
+     * Make a request to a specific endpoint.
+     * @param input - An object that contains the essential information make the request.
+     * @param {Object} input.method - Represents the method of the http request.
+     * @param {Object} input.path - Represents the path where the request will take place.
+     * @param {String} input.body - Represents the body to send. It only will be sended if input.method is not `GET`.
+     * @param {String} input.params - Represents the query parameters to send in the request. It only will be sended if input.method is `GET`.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    makeRequest<F = any>(input: IMakeRequest): Promise<F>;
+    private handleError;
+}

package/dist/resources/HTTPClient.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTPClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+/**
+ * @classdesc Represents the class that implements some HTTP client third library. It's an extra layer for in case if we need to change the implementation be one hundred percent sure we can do it without problems.
+ * @class
+ */
+class HTTPClient {
+    /**
+     * Create HTTPClient instance to start making request in another class.
+     * @constructor
+     * @param input - An object with common parameters that we need to set in the http client third party library.
+     * @param {Object} input.headers - An object with the headers to send in each makeRequest() call.
+     * @param {Object} input.timeout - The timeout that each request will have. That means, the time in milliseconds maximum that request will wait until cancel it.
+     * @param {Object} input.baseURL - The baseURL to make the requests.
+     */
+    constructor(input) {
+        this.headers = {};
+        this.headers = input.headers;
+        this.timeout = input.timeout;
+        this.baseURL = input.baseURL;
+        this.pathPrefix = input.pathPrefix;
+    }
+    /**
+     * Make a request to a specific endpoint.
+     * @param input - An object that contains the essential information make the request.
+     * @param {Object} input.method - Represents the method of the http request.
+     * @param {Object} input.path - Represents the path where the request will take place.
+     * @param {String} input.body - Represents the body to send. It only will be sended if input.method is not `GET`.
+     * @param {String} input.params - Represents the query parameters to send in the request. It only will be sended if input.method is `GET`.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    makeRequest(input) {
+        const path = `${this.baseURL}${this.pathPrefix}${input.path}`;
+        const options = {
+            headers: Object.assign(Object.assign({}, input.headers), (!input.withoutPredefinedHeaders ? this.headers : {})),
+            params: input.params,
+            timeout: this.timeout,
+        };
+        switch (input.method) {
+            case 'GET':
+                return axios_1.default
+                    .get(path, options)
+                    .then((res) => {
+                    return res.data;
+                })
+                    .catch((err) => this.handleError(err));
+            case 'PUT':
+                return axios_1.default
+                    .put(path, input.body, options)
+                    .then((res) => {
+                    return res.data;
+                })
+                    .catch((err) => this.handleError(err));
+            case 'POST':
+                return axios_1.default
+                    .post(path, input.body, options)
+                    .then((res) => {
+                    return res.data;
+                })
+                    .catch((err) => this.handleError(err));
+            case 'DELETE':
+                return axios_1.default
+                    .post(path, input.body, options)
+                    .then((res) => {
+                    return res.data;
+                })
+                    .catch((err) => this.handleError(err));
+        }
+    }
+    handleError(err) {
+        var _a;
+        const isAxiosError = axios_1.default.isAxiosError(err);
+        if (isAxiosError) {
+            return Promise.reject((_a = err.response) === null || _a === void 0 ? void 0 : _a.data);
+        }
+        if (!isAxiosError) {
+            return Promise.reject(err);
+        }
+    }
+}
+exports.HTTPClient = HTTPClient;

package/dist/resources/Helper.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { IHeaders } from '../types/http';
+export declare class Helper {
+    static buildOptionalHeaders(access_token?: string): IHeaders | undefined;
+    static isNode(): boolean;
+    static isFile(path: string): boolean;
+    static readFile(path: string): Buffer;
+}

package/dist/resources/Helper.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Helper = void 0;
+const fs_1 = require("fs");
+class Helper {
+    static buildOptionalHeaders(access_token) {
+        if (access_token) {
+            return {
+                Authorization: `Bearer ${access_token}`,
+            };
+        }
+        return;
+    }
+    static isNode() {
+        return typeof window === 'undefined';
+    }
+    static isFile(path) {
+        try {
+            var stat = (0, fs_1.lstatSync)(path);
+            return stat.isFile();
+        }
+        catch (e) {
+            return false;
+        }
+    }
+    static readFile(path) {
+        return (0, fs_1.readFileSync)(path);
+    }
+}
+exports.Helper = Helper;

package/dist/resources/Image.d.ts

@@ -0,0 +1,26 @@
+import { IAPISucessResponse } from '../types/api';
+import { IUploadImage } from '../types/image';
+import { HTTPClient } from './HTTPClient';
+import { IImageToken } from '../types/inspection';
+export declare class Image {
+    private readonly httpRef;
+    constructor(httpRef: HTTPClient);
+    /**
+     * Generates an image token.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    generateToken(): Promise<IImageToken>;
+    /**
+     * Upload an image for specific product inspection item. For the moment, this method is only available for the inspection with mode full_control.
+     * @param input - An object that contains the essential information for upload the image.
+     * @param {String} input.productId - Represents the id of the product that you would like to attach a new photo.
+     * @param {ReadStream} input.image - Represents the image to upload.
+     * @param {String} input.side - Represents the side of the image/photo to upload.
+     * @param {String} input.date - Represents the date when the photo was taken. If you can extract this information from the EXIF data, it's better because it's more reliable.
+     * @param {Object} input.coordinates - Represents the coordinates of the image/photo.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    uploadImage(input: IUploadImage): Promise<IAPISucessResponse>;
+}

package/dist/resources/Image.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Image = void 0;
+const form_data_1 = __importDefault(require("form-data"));
+class Image {
+    constructor(httpRef) {
+        this.httpRef = httpRef;
+    }
+    /**
+     * Generates an image token.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    generateToken() {
+        return this.httpRef.makeRequest({
+            method: 'POST',
+            path: `/inspection/image/token`,
+        });
+    }
+    /**
+     * Upload an image for specific product inspection item. For the moment, this method is only available for the inspection with mode full_control.
+     * @param input - An object that contains the essential information for upload the image.
+     * @param {String} input.productId - Represents the id of the product that you would like to attach a new photo.
+     * @param {ReadStream} input.image - Represents the image to upload.
+     * @param {String} input.side - Represents the side of the image/photo to upload.
+     * @param {String} input.date - Represents the date when the photo was taken. If you can extract this information from the EXIF data, it's better because it's more reliable.
+     * @param {Object} input.coordinates - Represents the coordinates of the image/photo.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    uploadImage(input) {
+        const form = new form_data_1.default();
+        form.append('side', input.side);
+        form.append('image', input.image);
+        if (input.coordinates) {
+            form.append('coordinates', JSON.stringify(input.coordinates));
+        }
+        if (input.date) {
+            form.append('date', input.date.toISOString());
+        }
+        return this.httpRef.makeRequest({
+            method: 'POST',
+            path: `/inspection/image/${input.productId}`,
+            body: form,
+            headers: Object.assign(Object.assign({}, form.getHeaders()), (input.imageToken ? { 'x-image-token': input.imageToken } : {})),
+            withoutPredefinedHeaders: !!input.imageToken,
+        });
+    }
+}
+exports.Image = Image;

package/dist/resources/Inspections.d.ts

@@ -0,0 +1,40 @@
+import { IAPISucessResponse } from '../types/api';
+import { IFinishInspection, IGetInspection, IInspection } from '../types/inspection';
+import { IPagination, IPaginationResponse } from '../types/pagination';
+import { HTTPClient } from './HTTPClient';
+import { Products } from './Products';
+/**
+ * @classdesc Represents the class that contains the methods or actions that somebody can do using apikey and access_token.
+ * @class
+ */
+export declare class Inspections extends Products {
+    private readonly httpClient;
+    constructor(httpClient: HTTPClient);
+    /**
+     * Finish the inspection to indicate that it will not receive more photos/images.
+     * @param input - An object that contains the essential information for upload the image.
+     * @param {String} input.inspectionId - Represents the id of the inspection.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    finish(input: IFinishInspection): Promise<IAPISucessResponse>;
+    /**
+     * Get a specific inspection object.
+     * @param input - An object that contains the essential information for upload the image.
+     * @param {String} input.inspectionId - Represents the id of the inspection that you want to retrieve.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    retrieve(input: IGetInspection): Promise<IInspection>;
+    /**
+     * Get a list of n inspections with pagination.
+     * @param input - An object that contains filters for list the inspections.
+     * @param {Number} input.page - Represents the specific page that you want to retrieve the inspections.
+     * @param {Number} input.limit - Represents the limit of the quantity of records that you want to retrieve for page.
+     * @param {String} input.status - Represents the status that inspections retrieved should have.
+     * @param {String} input.type - Represents the type of the inspection.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    list(input?: Partial<IPagination>): Promise<IPaginationResponse<IInspection[]>>;
+}

package/dist/resources/Inspections.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Inspections = void 0;
+const Products_1 = require("./Products");
+/**
+ * @classdesc Represents the class that contains the methods or actions that somebody can do using apikey and access_token.
+ * @class
+ */
+class Inspections extends Products_1.Products {
+    constructor(httpClient) {
+        super(httpClient);
+        this.httpClient = httpClient;
+    }
+    /**
+     * Finish the inspection to indicate that it will not receive more photos/images.
+     * @param input - An object that contains the essential information for upload the image.
+     * @param {String} input.inspectionId - Represents the id of the inspection.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    finish(input) {
+        return this.httpClient.makeRequest({
+            method: 'POST',
+            path: `/inspection/finish/${input.inspectionId}`,
+            body: {},
+        });
+    }
+    /**
+     * Get a specific inspection object.
+     * @param input - An object that contains the essential information for upload the image.
+     * @param {String} input.inspectionId - Represents the id of the inspection that you want to retrieve.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    retrieve(input) {
+        return this.httpClient.makeRequest({
+            method: 'GET',
+            path: `/inspection/${input.inspectionId}`,
+        });
+    }
+    /**
+     * Get a list of n inspections with pagination.
+     * @param input - An object that contains filters for list the inspections.
+     * @param {Number} input.page - Represents the specific page that you want to retrieve the inspections.
+     * @param {Number} input.limit - Represents the limit of the quantity of records that you want to retrieve for page.
+     * @param {String} input.status - Represents the status that inspections retrieved should have.
+     * @param {String} input.type - Represents the type of the inspection.
+     * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+     * data or an Error with the problem.
+     */
+    list(input = {}) {
+        return this.httpClient.makeRequest({
+            method: 'GET',
+            path: `/inspection`,
+            params: input,
+        });
+    }
+}
+exports.Inspections = Inspections;