lightrail-client - npm Package Compare versions

Comparing version 4.2.2 to 4.3.0

dist/index.js

@@ -97,3 +97,3 @@ "use strict";
         // TODO@Dan Review Previous import of package.json to dynamically set this was breaking publish (dist included src/ & package.json file)
-        r.set("User-Agent", "Lightrail-JavaScript/4.2.2");
+        r.set("User-Agent", "Lightrail-JavaScript/4.3.0");
     }
@@ -100,0 +100,0 @@ if (exports.configuration.isBrowser) {

dist/model/index.d.ts

@@ -10,1 +10,2 @@ export * from "./BalanceRule";
 export * from "./GenericCodeOptions";
+export * from "./DiscountSellerLiabilityRule";

dist/model/Program.d.ts

 import { BalanceRule } from "./BalanceRule";
 import { RedemptionRule } from "./RedemptionRule";
+import { DiscountSellerLiabilityRule } from "./DiscountSellerLiabilityRule";
 export interface Program {
@@ -8,3 +9,5 @@ id: string;
     discount: boolean;
+    /** @deprecated since v4.3.0 - use DiscountSellerLiabilityRule instead. */
     discountSellerLiability: number;
+    discountSellerLiabilityRule: DiscountSellerLiabilityRule;
     pretax: boolean;
@@ -11,0 +14,0 @@ active: boolean;

dist/model/Value.d.ts

 import { BalanceRule } from "./BalanceRule";
 import { RedemptionRule } from "./RedemptionRule";
 import { GenericCodeOptions } from "./GenericCodeOptions";
+import { DiscountSellerLiabilityRule } from "./DiscountSellerLiabilityRule";
 export interface Value {
@@ -22,3 +23,5 @@ id: string;
     discount: boolean;
+    /** @deprecated since v4.3.0 - use DiscountSellerLiabilityRule instead. */
     discountSellerLiability: number;
+    discountSellerLiabilityRule: DiscountSellerLiabilityRule;
     startDate: string;
@@ -25,0 +28,0 @@ endDate: string;

dist/params/programs/CreateProgramParams.d.ts

 import { Program } from "../../model";
 import { LightrailResponse } from "../LightrailResponse";
-import { BalanceRule } from "../../model/BalanceRule";
-import { RedemptionRule } from "../../model/RedemptionRule";
+import { BalanceRule } from "../../model";
+import { RedemptionRule } from "../../model";
+import { DiscountSellerLiabilityRule } from "../../model";
 export interface CreateProgramParams {
@@ -10,3 +11,5 @@ id: string;
     discount?: boolean;
+    /** @deprecated since v4.3.0 - use DiscountSellerLiabilityRule instead. */
     discountSellerLiability?: number;
+    discountSellerLiabilityRule?: DiscountSellerLiabilityRule;
     pretax?: boolean;
@@ -13,0 +16,0 @@ active?: boolean;

dist/params/programs/UpdateProgramParams.d.ts

 import { BalanceRule, Program, RedemptionRule } from "../../model";
 import { LightrailResponse } from "../LightrailResponse";
+import { DiscountSellerLiabilityRule } from "../../model";
 export interface UpdateProgramParams {
     name?: string;
     discount?: boolean;
+    /** @deprecated since v4.3.0 - use DiscountSellerLiabilityRule instead. */
     discountSellerLiability?: number;
+    discountSellerLiabilityRule?: DiscountSellerLiabilityRule;
     pretax?: boolean;
@@ -8,0 +11,0 @@ active?: boolean;

dist/params/values/CreateValueParams.d.ts

@@ -1,6 +0,7 @@
-import { Value } from "../../model/Value";
+import { Value } from "../../model";
 import { LightrailResponse } from "../LightrailResponse";
-import { BalanceRule } from "../../model/BalanceRule";
-import { RedemptionRule } from "../../model/RedemptionRule";
-import { GenericCodeOptions } from "../../model/GenericCodeOptions";
+import { BalanceRule } from "../../model";
+import { RedemptionRule } from "../../model";
+import { GenericCodeOptions } from "../../model";
+import { DiscountSellerLiabilityRule } from "../../model";
 export interface CreateValueParams {
@@ -17,3 +18,5 @@ id: string;
     discount?: boolean;
+    /** @deprecated since v4.3.0 - use DiscountSellerLiabilityRule instead. */
     discountSellerLiability?: number;
+    discountSellerLiabilityRule?: DiscountSellerLiabilityRule;
     genericCodeOptions?: GenericCodeOptions;
@@ -20,0 +23,0 @@ redemptionRule?: RedemptionRule;

dist/params/values/UpdateValueParams.d.ts

 import { LightrailResponse } from "../LightrailResponse";
-import { Value } from "../../model/Value";
-import { BalanceRule } from "../../model/BalanceRule";
-import { RedemptionRule } from "../../model/RedemptionRule";
+import { Value } from "../../model";
+import { BalanceRule } from "../../model";
+import { RedemptionRule } from "../../model";
+import { DiscountSellerLiabilityRule } from "../../model";
 export interface UpdateValueParams {
@@ -14,3 +15,5 @@ contactId?: string;
     discount?: boolean;
+    /** @deprecated since v4.3.0 - use DiscountSellerLiabilityRule instead. */
     discountSellerLiability?: number;
+    discountSellerLiabilityRule?: DiscountSellerLiabilityRule;
     startDate?: string;
@@ -17,0 +20,0 @@ endDate?: string;

package.json

 {
   "name": "lightrail-client",
-  "version": "4.2.2",
+  "version": "4.3.0",
   "description": "A Javascript and Typescript client for Lightrail",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

 # Lightrail Client for JavaScript and TypeScript
 
-Lightrail is a modern platform for digital account credits, gift cards, promotions, and points (to learn more, visit [Lightrail](https://www.lightrail.com/)). This is a basic library for developers to easily connect with the Lightrail API using Javascript or Typescript. If you are looking for specific use cases or other languages, check out the complete list of all [Lightrail libraries and integrations](https://github.com/Giftbit/Lightrail-API-Docs/blob/master/README.md#lightrail-integrations).
+Lightrail is a modern platform for digital account credits, gift cards, promotions, and points (to learn more, visit [Lightrail](https://www.lightrail.com/)). This is a basic library for developers to easily connect with the Lightrail API using Javascript or Typescript.
 
@@ -58,4 +58,10 @@ ## Features
 
+### Releasing (Lightrail team only)
+
+1. Update the version of the project in `package.json` following [semantic versioning](https://docs.npmjs.com/about-semantic-versioning).
+2. Publish to npm with the command `npm publish`.  Tests and linting run as part of this script.
+3. [Create a GitHub release](https://help.github.com/en/articles/creating-releases).   The release name and tag must be `v` followed by the version number (eg: `v1.2.3`).    The description must list changes and highlight any breaking changes.
+
 ## License
 
 This library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

No alert changes

Improved metrics

Total package byte prevSize

84888

1.96%

Number of package files

135

1.5%

Lines of code

1998

1.27%

Number of lines in readme file

67

9.84%

No dependency changes