@coveo/platform-client 35.5.0 → 35.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -4,7 +4,7 @@ import Resource from '../Resource';
|
|
|
4
4
|
import Condition from './Conditions/Condition';
|
|
5
5
|
import FacetStateRules from './FacetStateRules/FacetStateRules';
|
|
6
6
|
import MLAssociations from './MLAssociations/MLAssociations';
|
|
7
|
-
import { ListPipelinesOptions, NewPipelineModel, PipelineBackendVersion, PipelineModel, UpdatePipelineModel } from './PipelinesInterfaces';
|
|
7
|
+
import { ListPipelinesOptions, ListPipelinesReturnVariant, NewPipelineModel, PipelineBackendVersion, PipelineModel, UpdatePipelineModel } from './PipelinesInterfaces';
|
|
8
8
|
import ResultRankings from './ResultRankings/ResultRankings';
|
|
9
9
|
import StatementGroups from './StatementGroups/StatementGroups';
|
|
10
10
|
import Statements from './Statements/Statements';
|
|
@@ -21,7 +21,7 @@ export default class Pipelines extends Resource {
|
|
|
21
21
|
facetRules: FacetStateRules;
|
|
22
22
|
constructor(api: API, serverlessApi: API);
|
|
23
23
|
getMLVersion(): Promise<PipelineBackendVersion>;
|
|
24
|
-
list(options?:
|
|
24
|
+
list<ListPipelinesVariant extends ListPipelinesOptions>(options?: ListPipelinesVariant): Promise<ListPipelinesReturnVariant<ListPipelinesVariant>>;
|
|
25
25
|
get(pipelineId: string): Promise<PipelineModel>;
|
|
26
26
|
delete(pipelineId: string): Promise<Record<string, unknown>>;
|
|
27
27
|
update(pipeline: UpdatePipelineModel): Promise<PipelineModel>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { GranularResource, Paginated } from '../BaseInterfaces';
|
|
1
|
+
import { GranularResource, PageModel, Paginated } from '../BaseInterfaces';
|
|
2
2
|
import { ConditionModel } from './Conditions';
|
|
3
3
|
export interface PipelineBackendVersion {
|
|
4
4
|
version: '1' | '2';
|
|
@@ -174,10 +174,40 @@ export interface NewPipelineModel extends PipelineShared, GranularResource {
|
|
|
174
174
|
export interface UpdatePipelineModel extends PipelineModel, GranularResource {
|
|
175
175
|
}
|
|
176
176
|
export interface ListPipelinesOptions extends Paginated {
|
|
177
|
+
/**
|
|
178
|
+
* Whether to sort the results in ascending order.
|
|
179
|
+
*/
|
|
177
180
|
isOrderAscending?: boolean;
|
|
181
|
+
/**
|
|
182
|
+
* The query filter to match.
|
|
183
|
+
*
|
|
184
|
+
* This allows you to search within query pipeline statement definitions and descriptions.
|
|
185
|
+
*
|
|
186
|
+
* By default, results are not required to match a specific query filter.
|
|
187
|
+
*/
|
|
178
188
|
filter?: string;
|
|
179
|
-
|
|
189
|
+
/**
|
|
190
|
+
* The sort criteria to apply on the results.
|
|
191
|
+
*
|
|
192
|
+
* Allowed values: `definition`, `description`, and `position`.
|
|
193
|
+
*
|
|
194
|
+
* Default: `position`
|
|
195
|
+
*/
|
|
196
|
+
sortby?: 'definition' | 'description' | 'position';
|
|
180
197
|
feature?: string;
|
|
198
|
+
/**
|
|
199
|
+
* The unique identifier of the target Coveo Cloud organization.
|
|
200
|
+
*
|
|
201
|
+
* Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.
|
|
202
|
+
*/
|
|
181
203
|
organizationId?: string;
|
|
204
|
+
/**
|
|
205
|
+
* Whether to enable pagination.
|
|
206
|
+
*/
|
|
207
|
+
enablePagination?: boolean;
|
|
182
208
|
}
|
|
209
|
+
export declare type PaginatedListPipelinesModel = Omit<PageModel<PipelineModel>, 'totalPages'>;
|
|
210
|
+
export declare type ListPipelinesReturnVariant<ListPipelineVariant> = ListPipelineVariant extends {
|
|
211
|
+
enablePagination: true;
|
|
212
|
+
} ? PaginatedListPipelinesModel : PipelineModel[];
|
|
183
213
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Pipelines.js","sourceRoot":"","sources":["../../../src/resources/Pipelines/Pipelines.ts"],"names":[],"mappings":";;;AAEA,iEAAmC;AACnC,6EAA+C;AAC/C,8FAAgE;AAChE,2FAA6D;
|
|
1
|
+
{"version":3,"file":"Pipelines.js","sourceRoot":"","sources":["../../../src/resources/Pipelines/Pipelines.ts"],"names":[],"mappings":";;;AAEA,iEAAmC;AACnC,6EAA+C;AAC/C,8FAAgE;AAChE,2FAA6D;AAS7D,2FAA6D;AAC7D,8FAAgE;AAChE,+EAAiD;AAEjD;IAAuC,qCAAQ;IAW3C,mBAAsB,GAAQ,EAAY,aAAkB;QAA5D,YACI,kBAAM,GAAG,EAAE,aAAa,CAAC,SAQ5B;QATqB,SAAG,GAAH,GAAG,CAAK;QAAY,mBAAa,GAAb,aAAa,CAAK;QAGxD,KAAI,CAAC,YAAY,GAAG,IAAI,wBAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC3D,KAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACrD,KAAI,CAAC,aAAa,GAAG,IAAI,wBAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC5D,KAAI,CAAC,UAAU,GAAG,IAAI,mBAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACpD,KAAI,CAAC,MAAM,GAAG,IAAI,yBAAe,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACtD,KAAI,CAAC,UAAU,GAAG,IAAI,yBAAe,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;;IAC9D,CAAC;IAED,gCAAY,GAAZ;QACI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,iBAAiB,gBAAa,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,CACzG,CAAC;IACN,CAAC;IAED,wBAAI,GAAJ,UAAwD,OAA8B;QAClF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,iBAAiB,qBAAG,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,IAAK,OAAO,EAAE,CACrG,CAAC;IACN,CAAC;IAED,uBAAG,GAAH,UAAI,UAAkB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,iBAAiB,cAAI,UAAU,CAAE,EAAE;YAC3D,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,CACL,CAAC;IACN,CAAC;IAED,0BAAM,GAAN,UAAO,UAAkB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAClB,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,iBAAiB,cAAI,UAAU,CAAE,EAAE;YAC3D,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,CACL,CAAC;IACN,CAAC;IAED,0BAAM,GAAN,UAAO,QAA6B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,iBAAiB,cAAI,QAAQ,CAAC,EAAE,CAAE,EAAE;YAC5D,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,QAAQ,CACX,CAAC;IACN,CAAC;IAED,6BAAS,GAAT,UAAU,UAAkB,EAAE,gBAAmC;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,iBAAiB,cAAI,UAAU,eAAY,EAAE;YACrE,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED,0BAAM,GAAN,UAAO,QAA0B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,iBAAiB,EAAE;YACxC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,QAAQ,CACX,CAAC;IACN,CAAC;IA1EM,2BAAiB,GAAG,iCAAiC,CAAC;IACtD,2BAAiB,GAAG,iCAAiC,CAAC;IA0EjE,gBAAC;CAAA,AA5ED,CAAuC,kBAAQ,GA4E9C;kBA5EoB,SAAS"}
|