npm - @equisoft/billing-sdk - Versions diffs - 3.7.1-snapshot.20260629135524 → 3.8.0 - Mend

@equisoft/billing-sdk 3.7.1-snapshot.20260629135524 → 3.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (273) hide show

package/dist/models/V1SetOrganisationDistributorPayload.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1SetOrganisationDistributorPayload.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1SetUserBillingProfilePayload.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1SetUserBillingProfilePayload.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1SetUserNonBillablePayload.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1SetUserNonBillablePayload.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UpdateBillingRulePayload.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UpdateBillingRulePayload.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UpdateBillingRulePriorityPayload.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UpdateBillingRulePriorityPayload.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UpdateDistributorPayload.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UpdateDistributorPayload.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1User.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1User.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UserServiceStatus.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UserServiceStatus.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UserStatus.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/V1UserStatus.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/index.d.ts CHANGED Viewed

@@ -20,6 +20,8 @@ export * from './V1CreateBillingRulePayload';
 export * from './V1CreateChargebeeV1PortalSessionPayload';
 export * from './V1CreateDistributorPayload';
 export * from './V1CreateOrUpdateChargebeeV1SubscriptionPayload';
+export * from './V1DefaultBillingRule';
+export * from './V1DefaultBillingRules';
 export * from './V1Distributor';
 export * from './V1DistributorList';
 export * from './V1Organization';

package/dist/models/index.js CHANGED Viewed

@@ -38,6 +38,8 @@ __exportStar(require("./V1CreateBillingRulePayload"), exports);
 __exportStar(require("./V1CreateChargebeeV1PortalSessionPayload"), exports);
 __exportStar(require("./V1CreateDistributorPayload"), exports);
 __exportStar(require("./V1CreateOrUpdateChargebeeV1SubscriptionPayload"), exports);
+__exportStar(require("./V1DefaultBillingRule"), exports);
+__exportStar(require("./V1DefaultBillingRules"), exports);
 __exportStar(require("./V1Distributor"), exports);
 __exportStar(require("./V1DistributorList"), exports);
 __exportStar(require("./V1Organization"), exports);

package/dist/runtime.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/DistributorV1Api.md CHANGED Viewed

@@ -8,6 +8,7 @@ All URIs are relative to *http://../..*
 | [**createDistributor**](DistributorV1Api.md#createdistributor) | **POST** /v1/distributors | Create a new distributor |
 | [**deleteBillingRule**](DistributorV1Api.md#deletebillingrule) | **DELETE** /v1/distributors/{code}/profiles/{profile}/billingRules/{uuid} | Delete a billing rule |
 | [**deleteDistributor**](DistributorV1Api.md#deletedistributor) | **DELETE** /v1/distributors/{code} | Delete a distributor and its non-shared billing rules |
+| [**getDefaultBillingRules**](DistributorV1Api.md#getdefaultbillingrules) | **GET** /v1/distributors/defaultBillingRules |  |
 | [**getDistributor**](DistributorV1Api.md#getdistributor) | **GET** /v1/distributors/{code} | Get billing information about a distributor |
 | [**listDistributors**](DistributorV1Api.md#listdistributors) | **GET** /v1/distributors | List all available distributors |
 | [**updateBillingRule**](DistributorV1Api.md#updatebillingrule) | **PUT** /v1/distributors/{code}/profiles/{profile}/billingRules/{uuid} | Update a billing rule\&#39;s services and addons |
@@ -309,6 +310,68 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+## getDefaultBillingRules
+> V1DefaultBillingRules getDefaultBillingRules()
+### Example
+```ts
+import {
+  Configuration,
+  DistributorV1Api,
+} from '@equisoft/billing-sdk';
+import type { GetDefaultBillingRulesRequest } from '@equisoft/billing-sdk';
+async function example() {
+  console.log("🚀 Testing @equisoft/billing-sdk SDK...");
+  const config = new Configuration({
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new DistributorV1Api(config);
+  try {
+    const data = await api.getDefaultBillingRules();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+// Run the test
+example().catch(console.error);
+```
+### Parameters
+This endpoint does not need any parameter.
+### Return type
+[**V1DefaultBillingRules**](V1DefaultBillingRules.md)
+### Authorization
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Success |  -  |
+| **500** | An unexpected error happened. |  -  |
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 ## getDistributor
 > V1Distributor getDistributor(code)

package/docs/V1BillingRule.md CHANGED Viewed

@@ -6,7 +6,6 @@
 Name | Type
 ------------ | -------------
-`_default` | boolean
 `uuid` | string
 `priority` | number
 `shared` | boolean
@@ -20,7 +19,6 @@ import type { V1BillingRule } from '@equisoft/billing-sdk'
 // TODO: Update the object below with actual values
 const example = {
-  "_default": null,
   "uuid": null,
   "priority": null,
   "shared": null,

package/docs/V1DefaultBillingRule.md ADDED Viewed

@@ -0,0 +1,38 @@
+# V1DefaultBillingRule
+## Properties
+Name | Type
+------------ | -------------
+`priority` | number
+`services` | Array&lt;string&gt;
+`addons` | [Array&lt;V1Addon&gt;](V1Addon.md)
+## Example
+```typescript
+import type { V1DefaultBillingRule } from '@equisoft/billing-sdk'
+// TODO: Update the object below with actual values
+const example = {
+  "priority": null,
+  "services": null,
+  "addons": null,
+} satisfies V1DefaultBillingRule
+console.log(example)
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V1DefaultBillingRule
+console.log(exampleParsed)
+```
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/V1DefaultBillingRules.md ADDED Viewed

@@ -0,0 +1,34 @@
+# V1DefaultBillingRules
+## Properties
+Name | Type
+------------ | -------------
+`defaultBillingRules` | [Array&lt;V1DefaultBillingRule&gt;](V1DefaultBillingRule.md)
+## Example
+```typescript
+import type { V1DefaultBillingRules } from '@equisoft/billing-sdk'
+// TODO: Update the object below with actual values
+const example = {
+  "defaultBillingRules": null,
+} satisfies V1DefaultBillingRules
+console.log(example)
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V1DefaultBillingRules
+console.log(exampleParsed)
+```
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/V1Distributor.md CHANGED Viewed

@@ -8,7 +8,6 @@ Name | Type
 ------------ | -------------
 `code` | string
 `name` | string
-`billable` | boolean
 `profiles` | [Array&lt;V1Profile&gt;](V1Profile.md)
 ## Example
@@ -20,7 +19,6 @@ import type { V1Distributor } from '@equisoft/billing-sdk'
 const example = {
   "code": null,
   "name": null,
-  "billable": null,
   "profiles": null,
 } satisfies V1Distributor

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@equisoft/billing-sdk",
-  "version": "3.7.1-snapshot.20260629135524",
+  "version": "3.8.0",
   "description": "OpenAPI client for @equisoft/billing-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AddonV1Api.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/ChargebeeV1Api.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/DistributorV1Api.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,6 +18,7 @@ import type {
   ErrorSchema,
   V1CreateBillingRulePayload,
   V1CreateDistributorPayload,
+  V1DefaultBillingRules,
   V1Distributor,
   V1DistributorList,
   V1UpdateBillingRulePayload,
@@ -31,6 +32,8 @@ import {
     V1CreateBillingRulePayloadToJSON,
     V1CreateDistributorPayloadFromJSON,
     V1CreateDistributorPayloadToJSON,
+    V1DefaultBillingRulesFromJSON,
+    V1DefaultBillingRulesToJSON,
     V1DistributorFromJSON,
     V1DistributorToJSON,
     V1DistributorListFromJSON,
@@ -340,6 +343,50 @@ export class DistributorV1Api extends runtime.BaseAPI {
         await this.deleteDistributorRaw(requestParameters, initOverrides);
     }
+    /**
+     * Creates request options for getDefaultBillingRules without sending the request
+     */
+    async getDefaultBillingRulesRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+        const headerParameters: runtime.HTTPHeaders = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            const token = this.configuration.accessToken;
+            const tokenString = await token("OAuth2", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/distributors/defaultBillingRules`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     */
+    async getDefaultBillingRulesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1DefaultBillingRules>> {
+        const requestOptions = await this.getDefaultBillingRulesRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => V1DefaultBillingRulesFromJSON(jsonValue));
+    }
+    /**
+     */
+    async getDefaultBillingRules(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1DefaultBillingRules> {
+        const response = await this.getDefaultBillingRulesRaw(initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for getDistributor without sending the request
      */

package/src/apis/OrganizationV1Api.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/UserV1Api.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/Country.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/ErrorCodes.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/ErrorSchema.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/SubscriptionCreationMode.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/V1Addon.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/V1AddonList.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/V1BillingProfile.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * Billing
  * Micro-Service to handle billing
  *
- * The version of the OpenAPI document: 3.7.1-SNAPSHOT
+ * The version of the OpenAPI document: 3.8.0
  * Contact: customersuccess@equisoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).