@fdy/faraday-js - npm Package Compare versions

Comparing version 0.1.205 to 0.1.206

CHANGELOG.md

@@ -13,2 +13,8 @@ # Changelog
 
+## [0.10.42] - 2024-12-17
+
+### Added
+
+- Add `/scopes/{scope_id}/efficacy` to return scope payload resource efficacy metrics
+
 ## [0.10.41] - 2024-12-09
@@ -15,0 +21,0 @@

dist/apis/ScopesApi.d.ts

@@ -13,3 +13,3 @@ /**
 import * as runtime from '../runtime';
-import { ArchiveConfig, Cohort, Dataset, Outcome, PersonaSet, Recommender, Scope, ScopeAnalysis, ScopeMergePatch, ScopePost, Target } from '../models';
+import { ArchiveConfig, Cohort, Dataset, Outcome, PersonaSet, Recommender, Scope, ScopeAnalysis, ScopeEfficacy, ScopeMergePatch, ScopePost, Target } from '../models';
 export interface ArchiveScopeRequest {
@@ -34,2 +34,5 @@ scopeId: string;
 }
+export interface GetScopeEfficacyRequest {
+    scopeId: string;
+}
 export interface GetScopePayloadCohortsRequest {
@@ -127,2 +130,12 @@ scopeId: string;
     /**
+     * Get efficacy for a scope
+     * Get efficacy for a scope
+     */
+    private getScopeEfficacyRaw;
+    /**
+     * Get efficacy for a scope
+     * Get efficacy for a scope
+     */
+    getScopeEfficacy(scopeId: string): Promise<ScopeEfficacy>;
+    /**
      * Get payload cohorts for a scope
@@ -129,0 +142,0 @@ * Get payload cohorts for a scope

dist/apis/ScopesApi.js

@@ -257,2 +257,39 @@ "use strict";
     /**
+     * Get efficacy for a scope
+     * Get efficacy for a scope
+     */
+    getScopeEfficacyRaw(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.scopeId === null || requestParameters.scopeId === undefined) {
+                throw new runtime.RequiredError('scopeId', 'Required parameter requestParameters.scopeId was null or undefined when calling getScopeEfficacy.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearer", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/scopes/{scope_id}/efficacy`.replace(`{${"scope_id"}}`, encodeURIComponent(String(requestParameters.scopeId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            });
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Get efficacy for a scope
+     * Get efficacy for a scope
+     */
+    getScopeEfficacy(scopeId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getScopeEfficacyRaw({ scopeId: scopeId });
+            return yield response.value();
+        });
+    }
+    /**
      * Get payload cohorts for a scope
@@ -259,0 +296,0 @@ * Get payload cohorts for a scope

dist/models/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookEventType = exports.WebhookEndpointPutStatusEnum = exports.WebhookEndpointMergePatchStatusEnum = exports.WebhookEndpointStatusEnum = exports.TraitTier = exports.TraitStatisticalType = exports.TraitPermission = exports.TraitCategory = exports.TargetTransformPresetReferenced = exports.TargetTransformPresetIdentified = exports.TargetTransformPresetHashed = exports.TargetTransformPresetAggregated = exports.TargetStructureTransformationAggregationEnum = exports.TargetLimitRowCountPutDirectionEnum = exports.TargetLimitRowCountPostDirectionEnum = exports.TargetLimitRowCountMergePatchDirectionEnum = exports.TargetLimitRowCountDirectionEnum = exports.TargetAggregateIdentified = exports.TargetAggregateGeographic = exports.ResourceType = exports.ResourceStatus = exports.RecencyOccurrence = exports.PrimitiveDataType = exports.OutcomeBiasMitigationStrategy = exports.OutcomeAnalysisBiasDataGenderProportionLevelEnum = exports.OutcomeAnalysisBiasDataAgeDistributionLevelEnum = exports.ModelingField = exports.LookupMatchType = exports.LookupIdentityProvider = exports.ErrorCode = exports.DatasetPutPrivacyEnum = exports.DatasetPostPrivacyEnum = exports.DatasetMergePatchPrivacyEnum = exports.DatasetPrivacyEnum = exports.DataMapColumnFormat = exports.ConnectionDirectionalityEnum = exports.ComplexDataTypeOneOfLogicalTypeEnum = void 0;
+exports.WebhookEventType = exports.WebhookEndpointPutStatusEnum = exports.WebhookEndpointMergePatchStatusEnum = exports.WebhookEndpointStatusEnum = exports.TraitTier = exports.TraitStatisticalType = exports.TraitPermission = exports.TraitCategory = exports.TargetTransformPresetReferenced = exports.TargetTransformPresetIdentified = exports.TargetTransformPresetHashed = exports.TargetTransformPresetAggregated = exports.TargetStructureTransformationAggregationEnum = exports.TargetLimitRowCountPutDirectionEnum = exports.TargetLimitRowCountPostDirectionEnum = exports.TargetLimitRowCountMergePatchDirectionEnum = exports.TargetLimitRowCountDirectionEnum = exports.TargetAggregateIdentified = exports.TargetAggregateGeographic = exports.ScopeEfficacyOutcomeMonthPerformedEnum = exports.ResourceType = exports.ResourceStatus = exports.RecencyOccurrence = exports.PrimitiveDataType = exports.OutcomeBiasMitigationStrategy = exports.OutcomeAnalysisBiasDataGenderProportionLevelEnum = exports.OutcomeAnalysisBiasDataAgeDistributionLevelEnum = exports.ModelingField = exports.LookupMatchType = exports.LookupIdentityProvider = exports.ErrorCode = exports.DatasetPutPrivacyEnum = exports.DatasetPostPrivacyEnum = exports.DatasetMergePatchPrivacyEnum = exports.DatasetPrivacyEnum = exports.DataMapColumnFormat = exports.ConnectionDirectionalityEnum = exports.ComplexDataTypeOneOfLogicalTypeEnum = void 0;
 /**
@@ -339,2 +339,12 @@ * @export
 /**
+* @export
+* @enum {string}
+*/
+var ScopeEfficacyOutcomeMonthPerformedEnum;
+(function (ScopeEfficacyOutcomeMonthPerformedEnum) {
+    ScopeEfficacyOutcomeMonthPerformedEnum["Equal"] = "equal";
+    ScopeEfficacyOutcomeMonthPerformedEnum["GreaterThan"] = "greater_than";
+    ScopeEfficacyOutcomeMonthPerformedEnum["LessThan"] = "less_than";
+})(ScopeEfficacyOutcomeMonthPerformedEnum = exports.ScopeEfficacyOutcomeMonthPerformedEnum || (exports.ScopeEfficacyOutcomeMonthPerformedEnum = {}));
+/**
  * Available aggregation levels for data exported in `aggregated` targets.
@@ -341,0 +351,0 @@ * @export

package.json

 {
   "name": "@fdy/faraday-js",
-  "version": "0.1.205",
+  "version": "0.1.206",
   "description": "OpenAPI client for @fdy/faraday-js",
@@ -5,0 +5,0 @@ "author": "@hana.kslr",

src/apis/ScopesApi.ts

@@ -26,2 +26,3 @@ /* tslint:disable */
     ScopeAnalysis,
+    ScopeEfficacy,
     ScopeMergePatch,
@@ -57,2 +58,6 @@ ScopePost,
 
+export interface GetScopeEfficacyRequest {
+    scopeId: string;
+}
+
 export interface GetScopePayloadCohortsRequest {
@@ -348,2 +353,42 @@ scopeId: string;
     /**
+     * Get efficacy for a scope
+     * Get efficacy for a scope
+     */
+    private async getScopeEfficacyRaw(requestParameters: GetScopeEfficacyRequest, ): Promise<runtime.ApiResponse<ScopeEfficacy>> {
+        if (requestParameters.scopeId === null || requestParameters.scopeId === undefined) {
+            throw new runtime.RequiredError('scopeId','Required parameter requestParameters.scopeId was null or undefined when calling getScopeEfficacy.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/scopes/{scope_id}/efficacy`.replace(`{${"scope_id"}}`, encodeURIComponent(String(requestParameters.scopeId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        });
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * Get efficacy for a scope
+     * Get efficacy for a scope
+     */
+    async getScopeEfficacy(scopeId: string, ): Promise<ScopeEfficacy> {
+        const response = await this.getScopeEfficacyRaw({ scopeId: scopeId }, );
+        return await response.value();
+    }
+
+    /**
      * Get payload cohorts for a scope
@@ -350,0 +395,0 @@ * Get payload cohorts for a scope

No alert changes

Improved metrics

Total package byte prevSize

1927214

increased by0.58%

Lines of code

58872

increased by0.5%

No dependency changes