Release 9.0.0 (#103)

Author: lucassus

LICENSE

@@ -3,7 +3,7 @@ License:
 The MIT License (MIT)
 http://opensource.org/licenses/MIT
 
-Copyright (c) 2014 - 2025 APIMATIC Limited
+Copyright (c) 2014 - 2026 APIMATIC Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -29,28 +29,30 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json
 Run the following command from your project directory to install the package from npm:
 
 ```bash
-npm install @maxio-com/advanced-billing-sdk@8.0.0
+npm install @maxio-com/advanced-billing-sdk@9.0.0
 ```
 
-For additional package details, see the [Npm page for the @maxio-com/advanced-billing-sdk@8.0.0 npm](https://www.npmjs.com/package/@maxio-com/advanced-billing-sdk/v/8.0.0).
+For additional package details, see the [Npm page for the @maxio-com/advanced-billing-sdk@9.0.0 npm](https://www.npmjs.com/package/@maxio-com/advanced-billing-sdk/v/9.0.0).
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
 | site | `string` | The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'` |
-| environment | `Environment` | The API environment. <br> **Default: `Environment.US`** |
+| environment | [`Environment`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.US`** |
 | timeout | `number` | Timeout for API calls.<br>*Default*: `120000` |
-| httpClientOptions | [`Partial<HttpClientOptions>`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/http-client-options.md) | Stable configurable http client options. |
+| httpClientOptions | [`Partial<HttpClientOptions>`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/http-client-options.md) | Stable configurable http client options. |
 | unstableHttpClientOptions | `any` | Unstable configurable http client options. |
-| basicAuthCredentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/auth/basic-authentication.md) | The credential object for basicAuth |
+| basicAuthCredentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/auth/basic-authentication.md) | The credential object for basicAuth |
 
 The API client can be initialized as follows:
 
+### Code-Based Client Initialization
+
 ```ts
 import { Client, Environment } from '@maxio-com/advanced-billing-sdk';
 
@@ -65,6 +67,47 @@ const client = new Client({
 });
 ```
 
+### Configuration-Based Client Initialization
+
+```ts
+import * as path from 'path';
+import * as fs from 'fs';
+import { Client } from '@maxio-com/advanced-billing-sdk';
+
+// Provide absolute path for the configuration file
+const absolutePath = path.resolve('./config.json');
+
+// Read the configuration file content
+const fileContent = fs.readFileSync(absolutePath, 'utf-8');
+
+// Initialize client from JSON configuration content
+const client = Client.fromJsonConfig(fileContent);
+```
+
+See the [Configuration-Based Client Initialization](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/configuration-based-client-initialization.md) section for details.
+
+### Environment-Based Client Initialization
+
+```ts
+import * as dotenv from 'dotenv';
+import * as path from 'path';
+import * as fs from 'fs';
+import { Client } from '@maxio-com/advanced-billing-sdk';
+
+// Optional - Provide absolute path for the .env file
+const absolutePath = path.resolve('./.env');
+
+if (fs.existsSync(absolutePath)) {
+  // Load environment variables from .env file
+  dotenv.config({ path: absolutePath, override: true });
+}
+
+// Initialize client using environment variables
+const client = Client.fromEnvironment(process.env);
+```
+
+See the [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/environment-based-client-initialization.md) section for details.
+
 ## Environments
 
 The SDK can be configured to use a different environment for making API calls. Available environments are:
@@ -80,57 +123,60 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/auth/basic-authentication.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/auth/basic-authentication.md)
 
 ## List of APIs
 
-* [API Exports](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/billing-portal.md)
-* [Component Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/component-price-points.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscription-products.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/controllers/webhooks.md)
+* [API Exports](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/billing-portal.md)
+* [Component Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/component-price-points.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-products.md)
+* [Subscription Renewals](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-renewals.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/controllers/webhooks.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [HttpClientOptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/http-client-options.md)
-* [RetryConfiguration](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/retry-configuration.md)
-* [ProxySettings](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/proxy-settings.md)
+* [HttpClientOptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/http-client-options.md)
+* [RetryConfiguration](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/retry-configuration.md)
+* [ProxySettings](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/proxy-settings.md)
+* [Configuration-Based Client Initialization](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/configuration-based-client-initialization.md)
+* [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/environment-based-client-initialization.md)
 
 ### HTTP
 
-* [HttpRequest](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/http-request.md)
+* [HttpRequest](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/http-request.md)
 
 ### Utilities
 
-* [ApiResponse](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/api-response.md)
-* [ApiError](https://www.github.com/maxio-com/ab-typescript-sdk/tree/8.0.0/doc/api-error.md)
+* [ApiResponse](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/api-response.md)
+* [ApiError](https://www.github.com/maxio-com/ab-typescript-sdk/tree/9.0.0/doc/api-error.md)
 

doc/auth/basic-authentication.md

@@ -9,8 +9,8 @@ Documentation for accessing and setting credentials for BasicAuth.
 
 | Name | Type | Description | Setter |
 |  --- | --- | --- | --- |
-| BasicAuthUserName | `string` | The username to use with basic authentication | `username` |
-| BasicAuthPassword | `string` | The password to use with basic authentication | `password` |
+| basicAuthUserName | `string` | The username to use with basic authentication | `username` |
+| basicAuthPassword | `string` | The password to use with basic authentication | `password` |
 
 
 

doc/client.md

@@ -6,14 +6,16 @@ The following parameters are configurable for the API Client:
 | Parameter | Type | Description |
 |  --- | --- | --- |
 | site | `string` | The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'` |
-| environment | `Environment` | The API environment. <br> **Default: `Environment.US`** |
+| environment | [`Environment`](../README.md#environments) | The API environment. <br> **Default: `Environment.US`** |
 | timeout | `number` | Timeout for API calls.<br>*Default*: `120000` |
 | httpClientOptions | [`Partial<HttpClientOptions>`](../doc/http-client-options.md) | Stable configurable http client options. |
 | unstableHttpClientOptions | `any` | Unstable configurable http client options. |
 | basicAuthCredentials | [`BasicAuthCredentials`](auth/basic-authentication.md) | The credential object for basicAuth |
 
 The API client can be initialized as follows:
 
+## Code-Based Client Initialization
+
 ```ts
 import { Client, Environment } from '@maxio-com/advanced-billing-sdk';
 
@@ -28,3 +30,44 @@ const client = new Client({
 });
 ```
 
+## Configuration-Based Client Initialization
+
+```ts
+import * as path from 'path';
+import * as fs from 'fs';
+import { Client } from '@maxio-com/advanced-billing-sdk';
+
+// Provide absolute path for the configuration file
+const absolutePath = path.resolve('./config.json');
+
+// Read the configuration file content
+const fileContent = fs.readFileSync(absolutePath, 'utf-8');
+
+// Initialize client from JSON configuration content
+const client = Client.fromJsonConfig(fileContent);
+```
+
+See the [Configuration-Based Client Initialization](../doc/configuration-based-client-initialization.md) section for details.
+
+## Environment-Based Client Initialization
+
+```ts
+import * as dotenv from 'dotenv';
+import * as path from 'path';
+import * as fs from 'fs';
+import { Client } from '@maxio-com/advanced-billing-sdk';
+
+// Optional - Provide absolute path for the .env file
+const absolutePath = path.resolve('./.env');
+
+if (fs.existsSync(absolutePath)) {
+  // Load environment variables from .env file
+  dotenv.config({ path: absolutePath, override: true });
+}
+
+// Initialize client using environment variables
+const client = Client.fromEnvironment(process.env);
+```
+
+See the [Environment-Based Client Initialization](../doc/environment-based-client-initialization.md) section for details.
+

doc/configuration-based-client-initialization.md

@@ -0,0 +1,72 @@
+
+# Configuration-Based Client Initialization
+
+The SDK client can be initialized directly from a JSON configuration file using the `fromJsonConfig` static method available on the `Client` class.` This allows you to store and load configuration settings from JSON files, making it easier to organize and manage different configurations across environments.
+
+## Node.js Environment
+
+In Node.js environments, you can use the `fs` module to read the configuration file from the file system.
+
+```ts
+import * as path from 'path';
+import * as fs from 'fs';
+import { Client } from '@maxio-com/advanced-billing-sdk';
+
+// Provide absolute path for the .env file
+const absolutePath = path.resolve('./config.json');
+
+// Read the configuration file content
+const fileContent = fs.readFileSync(absolutePath, 'utf-8');
+
+// Initialize client from JSON configuration content
+const client = Client.fromJsonConfig(fileContent);
+```
+
+## Browser Environment
+
+In browser environments, you can use the `import` function to load the configuration file.
+
+```ts
+import { Client } from '@maxio-com/advanced-billing-sdk';
+
+// Load configuration using dynamic import
+const configModule = await import('./config.json', { assert: { type: 'json' } });
+
+// Initialize client from JSON configuration content
+const client = Client.fromJsonConfig(JSON.stringify(configModule.default));
+```
+
+## Example Configuration File
+
+```json
+{
+  "timeout": 30000,
+  "environment": "US",
+  "site": "subdomain",
+  "basicAuthCredentials": {
+    "username": "username",
+    "password": "password"
+  },
+  "httpClientOptions": {
+    "timeout": 30000,
+    "retryConfig": {
+      "maxNumberOfRetries": 3,
+      "retryOnTimeout": true,
+      "retryInterval": 10,
+      "maximumRetryWaitTime": 120,
+      "backoffFactor": 2,
+      "httpStatusCodesToRetry": [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      "httpMethodsToRetry": ["GET", "PUT", "DELETE"]
+    },
+    "proxySettings": {
+      "address": "http://localhost:3000",
+      "port": 8080,
+      "auth": {
+        "username": "username",
+        "password": "password"
+      }
+    }
+  }
+}
+```
+