btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/inventory/products.js

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for products API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, families: object, domains: object }}
+ */
+
+
 function productsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /products - list products.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +38,16 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /products/:productId - get product by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var productId = _ref3.productId,
         token = _ref3.token,
@@ -35,6 +63,15 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /products - create product.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Product payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var data = _ref4.data,
         token = _ref4.token,
@@ -49,6 +86,16 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /products/:productId - update product.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {Object} opts.data - Product payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var productId = _ref5.productId,
         data = _ref5.data,
@@ -64,7 +111,17 @@ function productsFactory(_ref) {
     });
   }
 
+  /** @type {{ remove: function }} */
   var domains = {
+    /**
+     * DELETE /products/domains/:domain - remove product domain.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.domain - Domain
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: function remove(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -79,7 +136,17 @@ function productsFactory(_ref) {
     }
   };
 
+  /** @type {{ all: function }} */
   var families = {
+    /**
+     * GET /products/families - list product families.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref7) {
       var token = _ref7.token,
           _ref7$query = _ref7.query,

package/lib/endpoints/inventory/promos.js

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for promos endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryPromosQuery
+ */
+
+/**
+ * Factory for promos API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, patch: function, remove: function, addRule: function, updateRule: function }}
+ */
+
+
 function promosFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /promos - list promos.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +43,16 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * GET /promos/:promoId - get promo by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var promoId = _ref3.promoId,
         token = _ref3.token,
@@ -32,6 +66,15 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * POST /promos - create promo.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.promo - Promo payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         promo = _ref4.promo,
@@ -46,6 +89,15 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /promos/:promoId - remove promo.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         promoId = _ref5.promoId,
@@ -59,6 +111,17 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /promos/:promoId - update promo.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.update - Update payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  // eslint-disable-next-line no-shadow
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,
@@ -74,6 +137,16 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /promo/:promoId - patch promo with operations.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.operations - Patch operations
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch(_ref7) {
     var jwtToken = _ref7.jwtToken,
         token = _ref7.token,
@@ -89,6 +162,16 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * POST /promos/:promoId/rules - add promo rule.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.rule - Rule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function addRule(_ref8) {
     var jwtToken = _ref8.jwtToken,
         token = _ref8.token,
@@ -104,6 +187,17 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /promos/:promoId/rules/:ruleId - update promo rule.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {string} opts.ruleId - Rule id
+   * @param {Object} opts.rule - Rule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateRule(_ref9) {
     var jwtToken = _ref9.jwtToken,
         token = _ref9.token,

package/lib/endpoints/inventory/routes.js

@@ -1,12 +1,32 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for routes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, prices: function, all: function, stations: function, create: function, update: function, remove: function, fareTables: object, stops: object, fareRules: object, priceBuckets: object, crossBorderDistances: object, prorationTables: object }}
+ */
+
+
 function routesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /routes/:routeId - get route by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var routeId = _ref2.routeId,
         token = _ref2.token,
@@ -21,6 +41,19 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /routes/prices - get route prices.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {string} opts.originId - Origin id
+   * @param {string} opts.destinationId - Destination id
+   * @param {string} opts.channel - Channel
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function prices(_ref3) {
     var token = _ref3.token,
         productId = _ref3.productId,
@@ -39,6 +72,15 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /routes - list routes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref4) {
     var token = _ref4.token,
         _ref4$query = _ref4.query,
@@ -51,6 +93,15 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /routes/:routeId/stations - get route stations.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function stations(_ref5) {
     var token = _ref5.token,
         routeId = _ref5.routeId,
@@ -62,6 +113,15 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /routes - create route.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Route payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -78,6 +138,16 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /routes/:routeId - update route.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {Object} opts.data - Route payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -95,6 +165,15 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /routes/:routeId - remove route.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -110,7 +189,17 @@ function routesFactory(_ref) {
     });
   }
 
+  /** @type {{ all: function, create: function, update: function }} */
   var fareTables = {
+    /**
+     * GET /routes/fare-tables - list fare tables.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref9) {
       var token = _ref9.token,
           _ref9$query = _ref9.query,
@@ -125,6 +214,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * POST /routes/:routeId/fare-tables - create fare table.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} opts.fareTable - Fare table payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -143,6 +243,18 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * PUT /routes/:routeId/fare-tables/:fareTableId - update fare table.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {string} opts.fareTableId - Fare table id
+     * @param {Object} opts.fareTable - Fare table payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,
@@ -163,7 +275,18 @@ function routesFactory(_ref) {
       });
     }
   };
+  /** @type {{ create: function }} */
   var stops = {
+    /**
+     * POST /routes/:routeId/stops - create stop.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} opts.stop - Stop payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref12) {
       var token = _ref12.token,
           jwtToken = _ref12.jwtToken,
@@ -182,7 +305,17 @@ function routesFactory(_ref) {
     }
   };
 
+  /** @type {{ get: function, create: function, update: function, remove: function }} */
   var fareRules = {
+    /**
+     * GET /routes/:routeId/fare-rules - get fare rules.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref13) {
       var token = _ref13.token,
           jwtToken = _ref13.jwtToken,
@@ -196,6 +329,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * POST /routes/:routeId/fare-rules - create fare rule.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} opts.fareRule - Fare rule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref14) {
       var token = _ref14.token,
           jwtToken = _ref14.jwtToken,
@@ -214,6 +358,18 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * PUT /routes/:routeId/fare-rules/:fareRuleId - update fare rule.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {string} opts.fareRuleId - Fare rule id
+     * @param {Object} opts.fareRule - Fare rule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref15) {
       var token = _ref15.token,
           jwtToken = _ref15.jwtToken,
@@ -233,6 +389,17 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * DELETE /routes/:routeId/fare-rules/:fareRuleId - remove fare rule.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {string} opts.fareRuleId - Fare rule id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: function remove(_ref16) {
       var token = _ref16.token,
           jwtToken = _ref16.jwtToken,
@@ -250,7 +417,17 @@ function routesFactory(_ref) {
     }
   };
 
+  /** @type {{ get: function, create: function, update: function, remove: function }} */
   var priceBuckets = {
+    /**
+     * GET /routes/:routeId/price-buckets - get price buckets.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref17) {
       var token = _ref17.token,
           jwtToken = _ref17.jwtToken,
@@ -264,6 +441,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * POST /routes/:routeId/price-buckets - create price bucket.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} opts.bucket - Bucket payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref18) {
       var token = _ref18.token,
           jwtToken = _ref18.jwtToken,
@@ -282,6 +470,18 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * PUT /routes/:routeId/price-buckets/:bucketId - update price bucket.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {string} opts.bucketId - Bucket id
+     * @param {Object} opts.bucket - Bucket payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref19) {
       var token = _ref19.token,
           jwtToken = _ref19.jwtToken,
@@ -301,6 +501,17 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * DELETE /routes/:routeId/price-buckets/:bucketId - remove price bucket.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {string} opts.bucketId - Bucket id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: function remove(_ref20) {
       var token = _ref20.token,
           jwtToken = _ref20.jwtToken,
@@ -318,7 +529,17 @@ function routesFactory(_ref) {
     }
   };
 
+  /** @type {{ get: function, update: function }} */
   var crossBorderDistances = {
+    /**
+     * GET /routes/:routeId/cross-border-distances - get cross border distances.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref21) {
       var token = _ref21.token,
           jwtToken = _ref21.jwtToken,
@@ -333,6 +554,16 @@ function routesFactory(_ref) {
       });
     },
 
+    /**
+     * PUT /routes/:routeId/cross-border-distances - update cross border distances.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} opts.crossBorderDistances - Cross border distances payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     // eslint-disable-next-line no-shadow
     update: function update(_ref22) {
       var token = _ref22.token,
@@ -354,7 +585,17 @@ function routesFactory(_ref) {
     }
   };
 
+  /** @type {{ all: function, getByRouteId: function, updateByRouteId: function }} */
   var prorationTables = {
+    /**
+     * GET /routes/proration-tables - list proration tables.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref23) {
       var token = _ref23.token,
           jwtToken = _ref23.jwtToken,
@@ -370,6 +611,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * GET /routes/:routeId/proration-tables - get proration tables by route id.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {string} [opts.productId] - Product id (optional query)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     getByRouteId: function getByRouteId(_ref24) {
       var token = _ref24.token,
           jwtToken = _ref24.jwtToken,
@@ -386,6 +638,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * PUT /routes/:routeId/proration-tables - update proration table by route id.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.routeId - Route id
+     * @param {Object} opts.prorationTable - Proration table payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     updateByRouteId: function updateByRouteId(_ref25) {
       var token = _ref25.token,
           jwtToken = _ref25.jwtToken,