@llmpulse/sdk 1.62.0 → 1.63.0

package/src/apis/RecommendationsApi.ts

@@ -4,7 +4,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.62.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,11 +23,21 @@ import {
     LaunchRecommendationsRequestFromJSON,
     LaunchRecommendationsRequestToJSON,
 } from '../models/LaunchRecommendationsRequest';
+import {
+    type RecommendationItemUpdateResponse,
+    RecommendationItemUpdateResponseFromJSON,
+    RecommendationItemUpdateResponseToJSON,
+} from '../models/RecommendationItemUpdateResponse';
 import {
     type RecommendationsResponse,
     RecommendationsResponseFromJSON,
     RecommendationsResponseToJSON,
 } from '../models/RecommendationsResponse';
+import {
+    type UpdateRecommendationItemRequest,
+    UpdateRecommendationItemRequestFromJSON,
+    UpdateRecommendationItemRequestToJSON,
+} from '../models/UpdateRecommendationItemRequest';
 
 export interface GetRecommendationRequest {
     projectId: number;
@@ -48,6 +58,12 @@ export interface ListRecommendationsRequest {
     perPage?: number;
 }
 
+export interface UpdateRecommendationItemOperationRequest {
+    id: number;
+    itemId: number;
+    updateRecommendationItemRequest: UpdateRecommendationItemRequest;
+}
+
 /**
  * RecommendationsApi - interface
  * 
@@ -139,6 +155,34 @@ export interface RecommendationsApiInterface {
      */
     listRecommendations(requestParameters: ListRecommendationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendationsResponse>;
 
+    /**
+     * Creates request options for updateRecommendationItem without sending the request
+     * @param {number} id Recommendation run id
+     * @param {number} itemId Item id, from the items of GET /recommendations/{id}
+     * @param {UpdateRecommendationItemRequest} updateRecommendationItemRequest 
+     * @throws {RequiredError}
+     * @memberof RecommendationsApiInterface
+     */
+    updateRecommendationItemRequestOpts(requestParameters: UpdateRecommendationItemOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Moves one item of a recommendation run between `active`, `completed` and `archived`, exactly like the complete, archive and restore buttons on the Recommendations page, and stamps `status_changed_at`. Returns the item in the shape `GET /recommendations/{id}` lists items. Requires a `read_write` scope API key and, for team members, create permission on Recommendations (the permission the page uses for these buttons).
+     * @summary Complete, archive or restore a recommendation item
+     * @param {number} id Recommendation run id
+     * @param {number} itemId Item id, from the items of GET /recommendations/{id}
+     * @param {UpdateRecommendationItemRequest} updateRecommendationItemRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RecommendationsApiInterface
+     */
+    updateRecommendationItemRaw(requestParameters: UpdateRecommendationItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecommendationItemUpdateResponse>>;
+
+    /**
+     * Moves one item of a recommendation run between `active`, `completed` and `archived`, exactly like the complete, archive and restore buttons on the Recommendations page, and stamps `status_changed_at`. Returns the item in the shape `GET /recommendations/{id}` lists items. Requires a `read_write` scope API key and, for team members, create permission on Recommendations (the permission the page uses for these buttons).
+     * Complete, archive or restore a recommendation item
+     */
+    updateRecommendationItem(requestParameters: UpdateRecommendationItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendationItemUpdateResponse>;
+
 }
 
 /**
@@ -345,6 +389,79 @@ export class RecommendationsApi extends runtime.BaseAPI implements Recommendatio
         return await response.value();
     }
 
+    /**
+     * Creates request options for updateRecommendationItem without sending the request
+     */
+    async updateRecommendationItemRequestOpts(requestParameters: UpdateRecommendationItemOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling updateRecommendationItem().'
+            );
+        }
+
+        if (requestParameters['itemId'] == null) {
+            throw new runtime.RequiredError(
+                'itemId',
+                'Required parameter "itemId" was null or undefined when calling updateRecommendationItem().'
+            );
+        }
+
+        if (requestParameters['updateRecommendationItemRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateRecommendationItemRequest',
+                'Required parameter "updateRecommendationItemRequest" was null or undefined when calling updateRecommendationItem().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/recommendations/{id}/items/{item_id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+        urlPath = urlPath.replace('{item_id}', encodeURIComponent(String(requestParameters['itemId'])));
+
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateRecommendationItemRequestToJSON(requestParameters['updateRecommendationItemRequest']),
+        };
+    }
+
+    /**
+     * Moves one item of a recommendation run between `active`, `completed` and `archived`, exactly like the complete, archive and restore buttons on the Recommendations page, and stamps `status_changed_at`. Returns the item in the shape `GET /recommendations/{id}` lists items. Requires a `read_write` scope API key and, for team members, create permission on Recommendations (the permission the page uses for these buttons).
+     * Complete, archive or restore a recommendation item
+     */
+    async updateRecommendationItemRaw(requestParameters: UpdateRecommendationItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecommendationItemUpdateResponse>> {
+        const requestOptions = await this.updateRecommendationItemRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RecommendationItemUpdateResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Moves one item of a recommendation run between `active`, `completed` and `archived`, exactly like the complete, archive and restore buttons on the Recommendations page, and stamps `status_changed_at`. Returns the item in the shape `GET /recommendations/{id}` lists items. Requires a `read_write` scope API key and, for team members, create permission on Recommendations (the permission the page uses for these buttons).
+     * Complete, archive or restore a recommendation item
+     */
+    async updateRecommendationItem(requestParameters: UpdateRecommendationItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendationItemUpdateResponse> {
+        const response = await this.updateRecommendationItemRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }
 
 /**

package/src/apis/ReputationStudiesApi.ts

@@ -4,7 +4,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.62.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/SearchConsoleApi.ts

@@ -4,7 +4,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.62.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).