btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/inventory/labels.js

@@ -1,6 +1,29 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /labels (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} LabelsQuery
+ * @property {string} [name] - The name of the label to search for; omit to return all
+ * @property {number} [page] - Page number; omit for first page
+ */
+
+/**
+ * Factory for labels 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, remove: function }}
+ */
 function labelsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /labels - list labels.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {LabelsQuery} [opts.query] - Query params (name, page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/labels", {
       params: query,
@@ -8,6 +31,15 @@ function labelsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /labels/:labelId - get label by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.labelId - Label id (ObjectId format)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({labelId, token, jwtToken, query = {}, headers}) {
     return client.get(`/labels/${labelId}`, {
       params: query,
@@ -15,6 +47,15 @@ function labelsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /labels - create label.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.label - Label payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, label, token, headers}) {
     return client({
       url: "/labels",
@@ -24,6 +65,16 @@ function labelsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /labels/:labelId - update label.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.labelId - Label id
+   * @param {Object} opts.label - Label payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, labelId, label, headers}) {
     return client({
       url: `/labels/${labelId}`,
@@ -34,6 +85,15 @@ function labelsFactory({client, internalAuthTokenProvider}) {
   }
 
 
+  /**
+   * DELETE /labels/:labelId - remove label.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.labelId - Label id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, token, labelId, headers}) {
     return client({
       url: `/labels/${labelId}`,

package/src/endpoints/inventory/marital-status.js

@@ -1,6 +1,28 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /marital-status (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} MaritalStatusListQuery
+ * @property {string} [providerIds] - Provider IDs to get marital status for
+ */
+
+/**
+ * Factory for marital-status API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
 function maritalStatusFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /marital-status - list marital statuses.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {MaritalStatusListQuery} [opts.query] - Query params (providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/marital-status",
@@ -10,6 +32,15 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /marital-status/:id - get marital status by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Marital status id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/marital-status/${id}`,
@@ -19,6 +50,16 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /marital-status/:id - update marital status. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Marital status id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
       url: `/marital-status/${id}`,
@@ -29,6 +70,15 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /marital-status/:id - remove marital status. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Marital status id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/marital-status/${id}`,
@@ -38,6 +88,15 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /marital-status - create marital status. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/marital-status",

package/src/endpoints/inventory/marketplace-modifiers.js

@@ -2,7 +2,36 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /marketplace-modifiers (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} MarketplaceModifiersListQuery
+ * @property {string} [externalField1] - Filter by externalField1
+ * @property {string} [externalField2] - Filter by externalField2
+ * @property {string} [externalField3] - Filter by externalField3
+ * @property {string} [createdBy] - Comma-separated user IDs (created by)
+ * @property {string} [updatedBy] - Comma-separated user IDs (updated by)
+ * @property {string} [earliestPurchaseDate] - ISO 8601 datetime (purchase on or after)
+ * @property {string} [latestPurchaseDate] - ISO 8601 datetime (purchase on or before)
+ * @property {string} [earliestTravelDate] - ISO 8601 datetime (trip depart on or after)
+ * @property {string} [latestTravelDate] - ISO 8601 datetime (trip depart on or before)
+ */
+
+/**
+ * Factory for marketplace-modifiers 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, remove: function }}
+ */
 function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /marketplace-modifiers - list marketplace modifiers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {MarketplaceModifiersListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -14,12 +43,29 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({marketplaceModifierId, token, headers}) {
     return client.get(`/marketplace-modifiers/${marketplaceModifierId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /marketplace-modifiers - create marketplace modifier. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, marketplaceModifier, headers}) {
     return client({
       url: "/marketplace-modifiers",
@@ -31,6 +77,15 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, marketplaceModifierId, token, headers}) {
     return client({
       url: `/marketplace-modifiers/${marketplaceModifierId}`,
@@ -39,6 +94,16 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /marketplace-modifiers/:marketplaceModifierId - update marketplace modifier. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, marketplaceModifierId, marketplaceModifier, headers}) {
     return client({
       url: `/marketplace-modifiers/${marketplaceModifierId}`,

package/src/endpoints/inventory/mit-terminal-settings.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for mit-terminals-settings 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, remove: function }}
+ */
 function mitTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /mit-terminals-settings - list MIT terminal settings. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,12 +30,30 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /mit-terminals-settings/:id - get MIT terminal setting by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - MIT terminal setting id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({id, token, jwtToken, headers}) {
     return client.get(`/mit-terminals-settings/${id}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /mit-terminals-settings - create MIT terminal settings. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, mitTerminalSettings, headers}) {
     return client({
       url: "/mit-terminals-settings",
@@ -32,6 +65,15 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /mit-terminals-settings/:id - remove MIT terminal settings. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - MIT terminal setting id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, id, token, headers}) {
     return client({
       url: `/mit-terminals-settings/${id}`,
@@ -40,6 +82,16 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /mit-terminals-settings/:id - update MIT terminal settings. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - MIT terminal setting id
+   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, id, mitTerminalSettings, headers}) {
     return client({
       url: `/mit-terminals-settings/${id}`,

package/src/endpoints/inventory/mit-terminals.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for mit-terminals 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, remove: function }}
+ */
 function mitTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /mit-terminals - list MIT terminals. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -14,12 +29,30 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /mit-terminals/:mitTerminalId - get MIT terminal by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.mitTerminalId - MIT terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({mitTerminalId, token, headers}) {
     return client.get(`/mit-terminals/${mitTerminalId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /mit-terminals - create MIT terminal. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.mitTerminal - MIT terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, mitTerminal, headers}) {
     return client({
       url: "/mit-terminals",
@@ -31,6 +64,15 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /mit-terminals/:mitTerminalId - remove MIT terminal. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.mitTerminalId - MIT terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, mitTerminalId, token, headers}) {
     return client({
       url: `/mit-terminals/${mitTerminalId}`,
@@ -39,6 +81,16 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /mit-terminals/:mitTerminalId - update MIT terminal. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.mitTerminalId - MIT terminal id
+   * @param {Object} opts.mitTerminal - MIT terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, mitTerminalId, mitTerminal, headers}) {
     return client({
       url: `/mit-terminals/${mitTerminalId}`,

package/src/endpoints/inventory/operating-companies.js

@@ -1,42 +1,104 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function operatingCompaniesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /operating-companies (btrz-api-inventory). See get-operating-companies getSpec().
+ * @typedef {Object} OperatingCompaniesListQuery
+ * @property {string} [providerIds] - Provider IDs to get operating companies for
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ * @property {number} [page] - Page number (1-based); null for unpaginated
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for operating-companies API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function, get: function, sequences: object }}
+ */
+function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /operating-companies - list operating companies.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {OperatingCompaniesListQuery} [opts.query] - Query params (providerIds, enabled, page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/operating-companies",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, operatingCompany, headers }) {
+  /**
+   * POST /operating-companies - create operating company. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.operatingCompany - Operating company payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, operatingCompany, headers}) {
     return client({
       url: "/operating-companies",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { operatingCompany }
+      data: {operatingCompany}
     });
   }
 
-  function update({ jwtToken, token, operatingCompanyId, operatingCompany, headers }) {
+  /**
+   * PUT /operating-companies/:operatingCompanyId - update operating company. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.operatingCompanyId - Operating company id
+   * @param {Object} opts.operatingCompany - Operating company payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({jwtToken, token, operatingCompanyId, operatingCompany, headers}) {
     return client({
       url: `/operating-companies/${operatingCompanyId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { operatingCompany }
+      data: {operatingCompany}
     });
   }
 
+  /**
+   * GET /operating-companies/:operatingCompanyId - get operating company by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.operatingCompanyId - Operating company id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, operatingCompanyId, jwtToken, headers}) {
     return client({
       url: `/operating-companies/${operatingCompanyId}`,
       method: "get",
-      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers}),
+      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers})
     });
   }
 
+  /** @type {{ create: function, all: function, get: function, update: function }} */
   const sequences = {
+    /**
+     * POST /operating-companies/:operatingCompanyId/sequences - create sequence. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.operatingCompanyId - Operating company id
+     * @param {Object} opts.sequence - Sequence payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, operatingCompanyId, sequence, headers}) {
       return client({
         url: `/operating-companies/${operatingCompanyId}/sequences`,
@@ -45,6 +107,15 @@ function operatingCompaniesFactory({ client, internalAuthTokenProvider }) {
         data: sequence
       });
     },
+    /**
+     * GET /operating-companies/:operatingCompanyId/sequences - list sequences. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.operatingCompanyId - Operating company id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({jwtToken, token, operatingCompanyId, headers}) {
       return client({
         url: `/operating-companies/${operatingCompanyId}/sequences`,
@@ -52,6 +123,16 @@ function operatingCompaniesFactory({ client, internalAuthTokenProvider }) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * GET /operating-companies/:operatingCompanyId/sequences/:sequenceId - get sequence. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.operatingCompanyId - Operating company id
+     * @param {string} opts.sequenceId - Sequence id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({jwtToken, token, operatingCompanyId, sequenceId, headers}) {
       return client({
         url: `/operating-companies/${operatingCompanyId}/sequences/${sequenceId}`,
@@ -59,6 +140,17 @@ function operatingCompaniesFactory({ client, internalAuthTokenProvider }) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * PUT /operating-companies/:operatingCompanyId/sequences/:sequenceId - update sequence. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.operatingCompanyId - Operating company id
+     * @param {string} opts.sequenceId - Sequence id
+     * @param {Object} opts.sequence - Sequence payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({jwtToken, token, operatingCompanyId, sequenceId, sequence, headers}) {
       return client({
         url: `/operating-companies/${operatingCompanyId}/sequences/${sequenceId}`,