@corsa-labs/sdk 4.17.0 → 4.19.0

package/dist/services/RulesService.d.ts

@@ -0,0 +1,223 @@
+import type { ActivateRuleDto } from '../models/ActivateRuleDto';
+import type { CreateRuleDto } from '../models/CreateRuleDto';
+import type { DisableRuleDto } from '../models/DisableRuleDto';
+import type { RuleResponseDto } from '../models/RuleResponseDto';
+import type { UpdateRuleDto } from '../models/UpdateRuleDto';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+export declare class RulesService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Create a new rule (draft)
+     * Create a new rule (draft)
+     * @param requestBody
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    createRule(requestBody: CreateRuleDto): CancelablePromise<RuleResponseDto>;
+    /**
+     * List rules with pagination
+     * List rules with pagination
+     * @param page Page number to retrieve. If you provide invalid value the default page number will applied
+     *
+     * **Example:** 1
+     *
+     *
+     * **Default Value:** 1
+     *
+     *
+     * @param limit Number of records per page.
+     *
+     *
+     * **Example:** 20
+     *
+     *
+     *
+     * **Default Value:** 20
+     *
+     *
+     *
+     * **Max Value:** 100
+     *
+     *
+     * If provided value is greater than max value, max value will be applied.
+     *
+     * @param filterId Filter by id query param.
+     *
+     * **Format:** filter.id={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.id=$eq:John Doe&filter.id=$in:John Doe
+     *
+     * **Available Operations**
+     * - $eq
+     *
+     * - $in
+     *
+     * - $and
+     *
+     * - $or
+     * @param filterName Filter by name query param.
+     *
+     * **Format:** filter.name={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.name=$eq:John Doe&filter.name=$ilike:John Doe
+     *
+     * **Available Operations**
+     * - $eq
+     *
+     * - $ilike
+     *
+     * - $in
+     *
+     * - $and
+     *
+     * - $or
+     * @param filterStatus Filter by status query param.
+     *
+     * **Format:** filter.status={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.status=$eq:John Doe&filter.status=$in:John Doe
+     *
+     * **Available Operations**
+     * - $eq
+     *
+     * - $in
+     *
+     * - $and
+     *
+     * - $or
+     * @param filterUpdatedAt Filter by updatedAt query param.
+     *
+     * **Format:** filter.updatedAt={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.updatedAt=$btw:John Doe&filter.updatedAt=$gte:John Doe
+     *
+     * **Available Operations**
+     * - $gte
+     *
+     * - $lte
+     *
+     * - $btw
+     *
+     * - $and
+     *
+     * - $or
+     * @param filterCreatedAt Filter by createdAt query param.
+     *
+     * **Format:** filter.createdAt={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.createdAt=$btw:John Doe&filter.createdAt=$gte:John Doe
+     *
+     * **Available Operations**
+     * - $gte
+     *
+     * - $lte
+     *
+     * - $btw
+     *
+     * - $and
+     *
+     * - $or
+     * @param sortBy Parameter to sort by.
+     * To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
+     *
+     * **Format:** {fieldName}:{DIRECTION}
+     *
+     *
+     * **Example:** sortBy=id:DESC&sortBy=name:DESC
+     *
+     *
+     * **Default Value:** updatedAt:DESC
+     *
+     * **Available Fields**
+     * - id
+     *
+     * - name
+     *
+     * - updatedAt
+     *
+     * - createdAt
+     *
+     * - status
+     *
+     * @param search Search term to filter result values
+     *
+     * **Example:** John
+     *
+     *
+     * **Default Value:** No default value
+     *
+     *
+     * @param searchBy List of fields to search by term to filter result values
+     *
+     * **Example:** name,description
+     *
+     *
+     * **Default Value:** By default all fields mentioned below will be used to search by term
+     *
+     * **Available Fields**
+     * - name
+     *
+     * - description
+     *
+     * @returns any
+     * @throws ApiError
+     */
+    listRules(page?: number, limit?: number, filterId?: Array<string>, filterName?: Array<string>, filterStatus?: Array<string>, filterUpdatedAt?: Array<string>, filterCreatedAt?: Array<string>, sortBy?: Array<'id:ASC' | 'id:DESC' | 'name:ASC' | 'name:DESC' | 'updatedAt:ASC' | 'updatedAt:DESC' | 'createdAt:ASC' | 'createdAt:DESC' | 'status:ASC' | 'status:DESC'>, search?: string, searchBy?: Array<string>): CancelablePromise<any>;
+    /**
+     * Update a rule
+     * Update a rule
+     * @param id
+     * @param requestBody
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    updateRule(id: string, requestBody: UpdateRuleDto): CancelablePromise<RuleResponseDto>;
+    /**
+     * Delete a non-active rule (soft delete)
+     * Delete a non-active rule (soft delete)
+     * @param id
+     * @param reason
+     * @returns any
+     * @throws ApiError
+     */
+    deleteRule(id: string, reason?: string): CancelablePromise<any>;
+    /**
+     * Get a rule by ID
+     * Get a rule by ID
+     * @param id
+     * @param version
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    getRule(id: string, version?: number): CancelablePromise<RuleResponseDto>;
+    /**
+     * Activate a rule
+     * Activate a rule
+     * @param id
+     * @param requestBody
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    activateRule(id: string, requestBody?: ActivateRuleDto): CancelablePromise<RuleResponseDto>;
+    /**
+     * Disable an active rule
+     * Disable an active rule
+     * @param id
+     * @param requestBody
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    disableRule(id: string, requestBody?: DisableRuleDto): CancelablePromise<RuleResponseDto>;
+}

package/dist/services/RulesService.js

@@ -0,0 +1,299 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RulesService = void 0;
+class RulesService {
+    httpRequest;
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /**
+     * Create a new rule (draft)
+     * Create a new rule (draft)
+     * @param requestBody
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    createRule(requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/v1/rules',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * List rules with pagination
+     * List rules with pagination
+     * @param page Page number to retrieve. If you provide invalid value the default page number will applied
+     *
+     * **Example:** 1
+     *
+     *
+     * **Default Value:** 1
+     *
+     *
+     * @param limit Number of records per page.
+     *
+     *
+     * **Example:** 20
+     *
+     *
+     *
+     * **Default Value:** 20
+     *
+     *
+     *
+     * **Max Value:** 100
+     *
+     *
+     * If provided value is greater than max value, max value will be applied.
+     *
+     * @param filterId Filter by id query param.
+     *
+     * **Format:** filter.id={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.id=$eq:John Doe&filter.id=$in:John Doe
+     *
+     * **Available Operations**
+     * - $eq
+     *
+     * - $in
+     *
+     * - $and
+     *
+     * - $or
+     * @param filterName Filter by name query param.
+     *
+     * **Format:** filter.name={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.name=$eq:John Doe&filter.name=$ilike:John Doe
+     *
+     * **Available Operations**
+     * - $eq
+     *
+     * - $ilike
+     *
+     * - $in
+     *
+     * - $and
+     *
+     * - $or
+     * @param filterStatus Filter by status query param.
+     *
+     * **Format:** filter.status={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.status=$eq:John Doe&filter.status=$in:John Doe
+     *
+     * **Available Operations**
+     * - $eq
+     *
+     * - $in
+     *
+     * - $and
+     *
+     * - $or
+     * @param filterUpdatedAt Filter by updatedAt query param.
+     *
+     * **Format:** filter.updatedAt={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.updatedAt=$btw:John Doe&filter.updatedAt=$gte:John Doe
+     *
+     * **Available Operations**
+     * - $gte
+     *
+     * - $lte
+     *
+     * - $btw
+     *
+     * - $and
+     *
+     * - $or
+     * @param filterCreatedAt Filter by createdAt query param.
+     *
+     * **Format:** filter.createdAt={$not}:OPERATION:VALUE
+     *
+     *
+     *
+     * **Example:** filter.createdAt=$btw:John Doe&filter.createdAt=$gte:John Doe
+     *
+     * **Available Operations**
+     * - $gte
+     *
+     * - $lte
+     *
+     * - $btw
+     *
+     * - $and
+     *
+     * - $or
+     * @param sortBy Parameter to sort by.
+     * To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
+     *
+     * **Format:** {fieldName}:{DIRECTION}
+     *
+     *
+     * **Example:** sortBy=id:DESC&sortBy=name:DESC
+     *
+     *
+     * **Default Value:** updatedAt:DESC
+     *
+     * **Available Fields**
+     * - id
+     *
+     * - name
+     *
+     * - updatedAt
+     *
+     * - createdAt
+     *
+     * - status
+     *
+     * @param search Search term to filter result values
+     *
+     * **Example:** John
+     *
+     *
+     * **Default Value:** No default value
+     *
+     *
+     * @param searchBy List of fields to search by term to filter result values
+     *
+     * **Example:** name,description
+     *
+     *
+     * **Default Value:** By default all fields mentioned below will be used to search by term
+     *
+     * **Available Fields**
+     * - name
+     *
+     * - description
+     *
+     * @returns any
+     * @throws ApiError
+     */
+    listRules(page, limit, filterId, filterName, filterStatus, filterUpdatedAt, filterCreatedAt, sortBy, search, searchBy) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/v1/rules',
+            query: {
+                'page': page,
+                'limit': limit,
+                'filter.id': filterId,
+                'filter.name': filterName,
+                'filter.status': filterStatus,
+                'filter.updatedAt': filterUpdatedAt,
+                'filter.createdAt': filterCreatedAt,
+                'sortBy': sortBy,
+                'search': search,
+                'searchBy': searchBy,
+            },
+        });
+    }
+    /**
+     * Update a rule
+     * Update a rule
+     * @param id
+     * @param requestBody
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    updateRule(id, requestBody) {
+        return this.httpRequest.request({
+            method: 'PUT',
+            url: '/v1/rules/{id}',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete a non-active rule (soft delete)
+     * Delete a non-active rule (soft delete)
+     * @param id
+     * @param reason
+     * @returns any
+     * @throws ApiError
+     */
+    deleteRule(id, reason) {
+        return this.httpRequest.request({
+            method: 'DELETE',
+            url: '/v1/rules/{id}',
+            path: {
+                'id': id,
+            },
+            query: {
+                'reason': reason,
+            },
+        });
+    }
+    /**
+     * Get a rule by ID
+     * Get a rule by ID
+     * @param id
+     * @param version
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    getRule(id, version) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/v1/rules/{id}',
+            path: {
+                'id': id,
+            },
+            query: {
+                'version': version,
+            },
+        });
+    }
+    /**
+     * Activate a rule
+     * Activate a rule
+     * @param id
+     * @param requestBody
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    activateRule(id, requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/v1/rules/{id}/activate',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Disable an active rule
+     * Disable an active rule
+     * @param id
+     * @param requestBody
+     * @returns RuleResponseDto
+     * @throws ApiError
+     */
+    disableRule(id, requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/v1/rules/{id}/disable',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.RulesService = RulesService;
+//# sourceMappingURL=RulesService.js.map

package/dist/services/RulesService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RulesService.js","sourceRoot":"","sources":["../../services/RulesService.ts"],"names":[],"mappings":";;;AAWA,MAAa,YAAY;IACO;IAA5B,YAA4B,WAA4B;QAA5B,gBAAW,GAAX,WAAW,CAAiB;IAAG,CAAC;IAC5D;;;;;;OAMG;IACI,UAAU,CACb,WAA0B;QAE1B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,WAAW;YAChB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6JG;IACI,SAAS,CACZ,IAAa,EACb,KAAc,EACd,QAAwB,EACxB,UAA0B,EAC1B,YAA4B,EAC5B,eAA+B,EAC/B,eAA+B,EAC/B,MAAwK,EACxK,MAAe,EACf,QAAwB;QAExB,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,WAAW;YAChB,KAAK,EAAE;gBACH,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,QAAQ;gBACrB,aAAa,EAAE,UAAU;gBACzB,eAAe,EAAE,YAAY;gBAC7B,kBAAkB,EAAE,eAAe;gBACnC,kBAAkB,EAAE,eAAe;gBACnC,QAAQ,EAAE,MAAM;gBAChB,QAAQ,EAAE,MAAM;gBAChB,UAAU,EAAE,QAAQ;aACvB;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,UAAU,CACb,EAAU,EACV,WAA0B;QAE1B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,gBAAgB;YACrB,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,UAAU,CACb,EAAU,EACV,MAAe;QAEf,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,gBAAgB;YACrB,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,KAAK,EAAE;gBACH,QAAQ,EAAE,MAAM;aACnB;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,OAAO,CACV,EAAU,EACV,OAAgB;QAEhB,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,gBAAgB;YACrB,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,KAAK,EAAE;gBACH,SAAS,EAAE,OAAO;aACrB;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,YAAY,CACf,EAAU,EACV,WAA6B;QAE7B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,yBAAyB;YAC9B,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,WAAW,CACd,EAAU,EACV,WAA4B;QAE5B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,wBAAwB;YAC7B,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;CACJ;AA9TD,oCA8TC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@corsa-labs/sdk",
-  "version": "4.17.0",
+  "version": "4.19.0",
   "description": "SDK for Corsa API",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",