@3wks/sargon-api-node-client - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6

dist/api.d.ts

@@ -508,2 +508,15 @@ /**
  * @export
+ * @interface InlineResponse2001
+ */
+export interface InlineResponse2001 {
+    /**
+     *
+     * @type {Array<MemberReport>}
+     * @memberof InlineResponse2001
+     */
+    balances?: Array<MemberReport>;
+}
+/**
+ *
+ * @export
  * @interface Member
@@ -723,2 +736,34 @@ */
  * @export
+ * @interface MemberReport
+ */
+export interface MemberReport extends ReportItem {
+    /**
+     *
+     * @type {MemberReportMembers}
+     * @memberof MemberReport
+     */
+    members: MemberReportMembers;
+}
+/**
+ *
+ * @export
+ * @interface MemberReportMembers
+ */
+export interface MemberReportMembers {
+    /**
+     *
+     * @type {number}
+     * @memberof MemberReportMembers
+     */
+    active?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof MemberReportMembers
+     */
+    inactive?: number;
+}
+/**
+ *
+ * @export
  * @interface MemberStatus
@@ -829,2 +874,15 @@ */
  * @export
+ * @interface ReportItem
+ */
+export interface ReportItem {
+    /**
+     * Date Time
+     * @type {Date}
+     * @memberof ReportItem
+     */
+    effectiveDate: Date;
+}
+/**
+ *
+ * @export
  * @interface StandardCreate
@@ -1235,2 +1293,20 @@ */
 }
+interface GetMembersParams {
+    /**
+    * Return results for the specified date (or date range).  Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.  A Range can be specified separated by a comma in the form of date&#x3D;start_date,end_date  If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59  Examples:  * &#x60;2016-01-01&#x60; - Single day date range covering the date 2016-01-01 only * &#x60;2016-01-01,&#x60; - All dates from 2016-01-01, including 2016-01-01 * &#x60;,2016-01-01&#x60; - All dates up to and including 2016-01-01 * &#x60;2016-01-01,2016-02-28&#x60; - All dates from 2016-01-01 to 2016-02-28 inclusive * &#x60;,today&#x60; - All dates up to and including todays date * &#x60;today,&#x60; - All dates from and including todays date
+    */
+    date?: string;
+    /**
+    * Pagination Page Number
+    */
+    p?: number;
+    /**
+    * Pagination Page Size (number of entries per page)
+    */
+    i?: number;
+    /**
+    * Pagination Starting Offset
+    */
+    o?: number;
+}
 /**
@@ -1248,2 +1324,9 @@ * ReportsApi - fetch parameter creator
     getBalance(params?: GetBalanceParams, options?: Partial<Options>): Promise<FetchArgs>;
+    /**
+     * Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.  A date range may be specified to return two or more totals.
+     * @summary Get Members
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMembers(params?: GetMembersParams, options?: Partial<Options>): Promise<FetchArgs>;
 };
@@ -1262,2 +1345,9 @@ /**
     getBalance(params?: GetBalanceParams, options?: Partial<Options>): (fetch?: FetchAPI, basePath?: string) => Promise<InlineResponse200>;
+    /**
+     * Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.  A date range may be specified to return two or more totals.
+     * @summary Get Members
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMembers(params?: GetMembersParams, options?: Partial<Options>): (fetch?: FetchAPI, basePath?: string) => Promise<InlineResponse2001>;
 };
@@ -1276,2 +1366,9 @@ /**
     getBalance(params?: GetBalanceParams, options?: Partial<Options>): Promise<InlineResponse200>;
+    /**
+     * Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.  A date range may be specified to return two or more totals.
+     * @summary Get Members
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMembers(params?: GetMembersParams, options?: Partial<Options>): Promise<InlineResponse2001>;
 };
@@ -1293,3 +1390,11 @@ /**
     getBalance(params?: GetBalanceParams, options?: Partial<Options>): Promise<InlineResponse200>;
+    /**
+     * Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.  A date range may be specified to return two or more totals.
+     * @summary Get Members
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApi
+     */
+    getMembers(params?: GetMembersParams, options?: Partial<Options>): Promise<InlineResponse2001>;
 }
 export {};

dist/api.js

@@ -768,2 +768,49 @@ "use strict";
         },
+        /**
+         * Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.  A date range may be specified to return two or more totals.
+         * @summary Get Members
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMembers(params = {}, options = {}) {
+            return tslib_1.__awaiter(this, void 0, void 0, function* () {
+                const date = params.date;
+                const p = params.p;
+                const i = params.i;
+                const o = params.o;
+                const localVarPath = `/reports/members`;
+                const localVarUrlObj = url_1.default.parse(localVarPath, true);
+                const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+                const localVarHeaderParameter = {};
+                const localVarQueryParameter = {};
+                // authentication Integration required
+                // oauth required
+                if (configuration && configuration.accessToken) {
+                    const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                        ? yield configuration.accessToken("Integration", ["integration", "member"])
+                        : yield configuration.accessToken;
+                    localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+                }
+                if (date !== undefined) {
+                    localVarQueryParameter['date'] = date;
+                }
+                if (p !== undefined) {
+                    localVarQueryParameter['p'] = p;
+                }
+                if (i !== undefined) {
+                    localVarQueryParameter['i'] = i;
+                }
+                if (o !== undefined) {
+                    localVarQueryParameter['o'] = o;
+                }
+                localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+                // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+                delete localVarUrlObj.search;
+                localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+                return {
+                    url: url_1.default.format(localVarUrlObj),
+                    options: localVarRequestOptions,
+                };
+            });
+        },
     };
@@ -796,2 +843,21 @@ };
         },
+        /**
+         * Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.  A date range may be specified to return two or more totals.
+         * @summary Get Members
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMembers(params = {}, options) {
+            return (fetch = portable_fetch_1.default, basePath = BASE_PATH) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                const localVarFetchArgs = yield exports.ReportsApiFetchParamCreator(configuration).getMembers(params, options);
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            });
+        },
     };
@@ -816,2 +882,13 @@ };
         },
+        /**
+         * Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.  A date range may be specified to return two or more totals.
+         * @summary Get Members
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMembers(params = {}, options) {
+            return tslib_1.__awaiter(this, void 0, void 0, function* () {
+                return exports.ReportsApiFp(configuration).getMembers(params, options)(fetch, basePath);
+            });
+        },
     };
@@ -838,3 +915,15 @@ };
     }
+    /**
+     * Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.  A date range may be specified to return two or more totals.
+     * @summary Get Members
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApi
+     */
+    getMembers(params = {}, options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return exports.ReportsApiFp(this.configuration).getMembers(params, options)(this.fetch, this.basePath);
+        });
+    }
 }
 exports.ReportsApi = ReportsApi;

package.json

 {
   "name": "@3wks/sargon-api-node-client",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "OpenAPI client for @3wks/sargon-api-node-client",
@@ -5,0 +5,0 @@ "author": "OpenAPI-Generator Contributors",

README.md

@@ -1,2 +0,2 @@
-## @3wks/sargon-api-node-client@0.1.5
+## @3wks/sargon-api-node-client@0.1.6
 
@@ -39,3 +39,3 @@ This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 ```
-npm install @3wks/sargon-api-node-client@0.1.5 --save
+npm install @3wks/sargon-api-node-client@0.1.6 --save
 ```
@@ -42,0 +42,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

174596

increased by9.77%

Lines of code

4513

increased by8.62%

Worsened metrics

Number of medium supply chain risk alerts

15

increased by15.38%

No dependency changes