btrz-api-client 9.9.0 → 9.10.0

package/lib/endpoints/accounts/market-pricing-settings.js

@@ -20,7 +20,7 @@ function marketPricingSettingsFactory({
    * @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<{ marketPricingSettings: { useOnlySpecificFareTable: boolean, displayExpiredSchedulesInUI: boolean } }>>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketPricingSettings: { useOnlySpecificFareTable: boolean, allowEachTripSegmentToBePricedIndividually: boolean } }>>}
    */
   function get({
     token,
@@ -39,11 +39,12 @@ function marketPricingSettingsFactory({
   }
 
   /**
-   * PUT /market-pricing-settings – Update market pricing settings. Body: MarketPricingSettings at root (useOnlySpecificFareTable and displayExpiredSchedulesInUI required).
+   * PUT /market-pricing-settings – Update market pricing settings. Body: MarketPricingSettings at root (useOnlySpecificFareTable required).
+   * Optional: allowEachTripSegmentToBePricedIndividually.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.marketPricingSettings - { useOnlySpecificFareTable: boolean, displayExpiredSchedulesInUI: boolean }
+   * @param {Object} opts.marketPricingSettings - { useOnlySpecificFareTable: boolean, allowEachTripSegmentToBePricedIndividually?: boolean }
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ marketPricingSettings: object }>>}
    */

package/lib/endpoints/invoices/infileJson.js

@@ -14,7 +14,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ create: function, validateCreate: function }}
+ * @returns {{ create: function, validateCreate: function, validateVoid: function }}
  */
 function infileJsonFactory({
   client,
@@ -83,9 +83,38 @@ function infileJsonFactory({
       data
     });
   }
+
+  /**
+   * GET /infile-json/validate-void - validate void for an original sale transaction.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {{ originalTransactionId: string, invoiceProviderId?: string }} opts.query
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function validateVoid({
+    token,
+    jwtToken,
+    query,
+    headers
+  }) {
+    return client({
+      url: "/infile-json/validate-void",
+      method: "get",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      params: query
+    });
+  }
   return {
     create,
-    validateCreate
+    validateCreate,
+    validateVoid
   };
 }
 module.exports = infileJsonFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "9.9.0",
+  "version": "9.10.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/endpoints/accounts/market-pricing-settings.js

@@ -17,7 +17,7 @@ function marketPricingSettingsFactory({client, internalAuthTokenProvider}) {
    * @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<{ marketPricingSettings: { useOnlySpecificFareTable: boolean, displayExpiredSchedulesInUI: boolean } }>>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketPricingSettings: { useOnlySpecificFareTable: boolean, allowEachTripSegmentToBePricedIndividually: boolean } }>>}
    */
   function get({token, jwtToken, headers}) {
     return client({
@@ -27,11 +27,12 @@ function marketPricingSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /market-pricing-settings – Update market pricing settings. Body: MarketPricingSettings at root (useOnlySpecificFareTable and displayExpiredSchedulesInUI required).
+   * PUT /market-pricing-settings – Update market pricing settings. Body: MarketPricingSettings at root (useOnlySpecificFareTable required).
+   * Optional: allowEachTripSegmentToBePricedIndividually.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.marketPricingSettings - { useOnlySpecificFareTable: boolean, displayExpiredSchedulesInUI: boolean }
+   * @param {Object} opts.marketPricingSettings - { useOnlySpecificFareTable: boolean, allowEachTripSegmentToBePricedIndividually?: boolean }
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ marketPricingSettings: object }>>}
    */

package/src/endpoints/invoices/infileJson.js

@@ -12,7 +12,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ create: function, validateCreate: function }}
+ * @returns {{ create: function, validateCreate: function, validateVoid: function }}
  */
 function infileJsonFactory({client, internalAuthTokenProvider}) {
   /**
@@ -57,9 +57,28 @@ function infileJsonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /infile-json/validate-void - validate void for an original sale transaction.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {{ originalTransactionId: string, invoiceProviderId?: string }} opts.query
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function validateVoid({token, jwtToken, query, headers}) {
+    return client({
+      url: "/infile-json/validate-void",
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query
+    });
+  }
+
   return {
     create,
-    validateCreate
+    validateCreate,
+    validateVoid
   };
 }
 

package/test/endpoints/invoices/infileJson.test.js

@@ -30,4 +30,16 @@ describe("invoices/infileJson", () => {
       data: {}
     });
   });
+
+  it("should validate void for an original sale transaction", () => {
+    axiosMock.onGet("/infile-json/validate-void").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.invoices.infileJson.validateVoid({
+      jwtToken,
+      token,
+      query: {
+        originalTransactionId: "original-trx-id",
+        invoiceProviderId: "provider1"
+      }
+    });
+  });
 });

package/types/endpoints/invoices/infileJson.d.ts

@@ -9,7 +9,7 @@ export = infileJsonFactory;
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ create: function, validateCreate: function }}
+ * @returns {{ create: function, validateCreate: function, validateVoid: function }}
  */
 declare function infileJsonFactory({ client, internalAuthTokenProvider }: {
     client: import("axios").AxiosInstance;
@@ -19,10 +19,24 @@ declare function infileJsonFactory({ client, internalAuthTokenProvider }: {
 }): {
     create: Function;
     validateCreate: Function;
+    validateVoid: Function;
 };
 declare namespace infileJsonFactory {
-    export { InvoiceInfileJsonPostQuery };
+    export { InvoiceInfileJsonPostQuery, InvoiceInfileJsonValidateVoidQuery };
 }
+/**
+ * Query params for GET /infile-json/validate-void (btrz-api-invoices).
+ */
+type InvoiceInfileJsonValidateVoidQuery = {
+    /**
+     * - Original sale transaction `_id` (24-character hex ObjectId)
+     */
+    originalTransactionId: string;
+    /**
+     * - Optional infileJson invoice provider id
+     */
+    invoiceProviderId?: string;
+};
 /**
  * Query params for POST /infile-json (btrz-api-invoices). onlyValidateRequest optional.
  */