Merge pull request #364 from prezly/feature/dev-19743-support-search_term-inside-the-json-query

[DEV-19743] Declare `search` param support to Coverage & Campaigns APIs

Author: e1himself

src/endpoints/Campaigns/Client.ts

@@ -19,23 +19,25 @@ export type Client = ReturnType<typeof createClient>;
 
 export function createClient(api: DeferredJobsApiClient) {
     async function list(options: SearchOptions): Promise<ListResponse> {
-        const { query, limit, offset, sortOrder } = options;
+        const { search, query, limit, offset, sortOrder } = options;
         return api.get<ListResponse>(routing.campaignsUrl, {
             query: {
                 limit,
                 offset,
+                search,
                 query: Query.stringify(query),
                 sort: SortOrder.stringify(sortOrder),
             },
         });
     }
 
     async function search(options: SearchOptions): Promise<ListResponse> {
-        const { query, limit, offset, sortOrder } = options;
+        const { search, query, limit, offset, sortOrder } = options;
         return api.post<ListResponse>(routing.campaignsUrl, {
             payload: {
                 limit,
                 offset,
+                search,
                 query,
                 sort: SortOrder.stringify(sortOrder),
             },

src/endpoints/Campaigns/types.ts

@@ -50,6 +50,7 @@ export interface CampaignResponse {
 export interface ListOptions {
     limit?: number;
     offset?: number;
+    search?: string;
     sortOrder?: SortOrder | string;
 }
 

src/endpoints/Coverage/Client.ts

@@ -21,7 +21,7 @@ export type Client = ReturnType<typeof createClient>;
 
 export function createClient(api: DeferredJobsApiClient) {
     async function list(options: ListOptions = {}, scope?: Scope): Promise<ListResponse> {
-        const { includeDeleted, limit, offset, sortOrder } = options;
+        const { includeDeleted, limit, offset, search, sortOrder } = options;
         // TODO: Switch to `scope` API parameter
         const url = scope?.story
             ? routing.storyCoverageUrl.replace(':story_id', String(scope.story))
@@ -31,13 +31,14 @@ export function createClient(api: DeferredJobsApiClient) {
                 include_deleted: includeDeleted ? 'on' : undefined,
                 limit,
                 offset,
+                search,
                 sort: SortOrder.stringify(sortOrder),
             },
         });
     }
 
     async function search(options: SearchOptions = {}, scope?: Scope): Promise<ListResponse> {
-        const { includeDeleted, query, limit, offset, sortOrder } = options;
+        const { includeDeleted, search, query, limit, offset, sortOrder } = options;
         // TODO: Switch to `scope` API parameter
         const url = scope?.story
             ? routing.storyCoverageUrl.replace(':story_id', String(scope.story))
@@ -46,6 +47,7 @@ export function createClient(api: DeferredJobsApiClient) {
         return api.get<ListResponse>(url, {
             query: {
                 include_deleted: includeDeleted ? 'on' : undefined,
+                search,
                 query: Query.stringify(query),
                 limit,
                 offset,

src/endpoints/Coverage/types.ts

@@ -77,6 +77,7 @@ export interface ListOptions {
     includeDeleted?: boolean;
     limit?: number;
     offset?: number;
+    search?: string;
     sortOrder?: SortOrder | string;
 }