@emilgroup/partner-sdk 1.11.1-beta.1 → 1.11.1-beta.3
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.
- package/.openapi-generator/FILES +3 -0
- package/README.md +2 -2
- package/api/partners-api.ts +209 -8
- package/dist/api/partners-api.d.ts +127 -8
- package/dist/api/partners-api.js +140 -6
- package/dist/models/grouped-related-partners-class.d.ts +31 -0
- package/dist/models/grouped-related-partners-class.js +15 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/list-related-partners-response-class.d.ts +31 -0
- package/dist/models/list-related-partners-response-class.js +15 -0
- package/dist/models/partner-relation-type-class.d.ts +12 -0
- package/dist/models/related-partner-data-class.d.ts +108 -0
- package/dist/models/related-partner-data-class.js +15 -0
- package/models/grouped-related-partners-class.ts +37 -0
- package/models/index.ts +3 -0
- package/models/list-related-partners-response-class.ts +37 -0
- package/models/partner-relation-type-class.ts +12 -0
- package/models/related-partner-data-class.ts +114 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -30,6 +30,7 @@ models/get-partner-response-class.ts
|
|
|
30
30
|
models/get-partner-type-response-class.ts
|
|
31
31
|
models/get-partner-version-response-class.ts
|
|
32
32
|
models/get-tag-response-class.ts
|
|
33
|
+
models/grouped-related-partners-class.ts
|
|
33
34
|
models/index.ts
|
|
34
35
|
models/inline-response200.ts
|
|
35
36
|
models/inline-response503.ts
|
|
@@ -41,6 +42,7 @@ models/list-partner-relation-types-class.ts
|
|
|
41
42
|
models/list-partner-types-response-class.ts
|
|
42
43
|
models/list-partner-versions-response-class.ts
|
|
43
44
|
models/list-partners-response-class.ts
|
|
45
|
+
models/list-related-partners-response-class.ts
|
|
44
46
|
models/list-tags-response-class.ts
|
|
45
47
|
models/partner-class.ts
|
|
46
48
|
models/partner-relation-class.ts
|
|
@@ -48,6 +50,7 @@ models/partner-relation-type-class.ts
|
|
|
48
50
|
models/partner-type-class.ts
|
|
49
51
|
models/partner-type-custom-schema-dto.ts
|
|
50
52
|
models/permission-class.ts
|
|
53
|
+
models/related-partner-data-class.ts
|
|
51
54
|
models/role-class.ts
|
|
52
55
|
models/tag-class.ts
|
|
53
56
|
models/tag-partner-request-dto-rest.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/partner-sdk@1.11.1-beta.
|
|
20
|
+
npm install @emilgroup/partner-sdk@1.11.1-beta.3 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk@1.11.1-beta.
|
|
24
|
+
yarn add @emilgroup/partner-sdk@1.11.1-beta.3
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
package/api/partners-api.ts
CHANGED
|
@@ -31,6 +31,8 @@ import { GetPartnerResponseClass } from '../models';
|
|
|
31
31
|
// @ts-ignore
|
|
32
32
|
import { ListPartnersResponseClass } from '../models';
|
|
33
33
|
// @ts-ignore
|
|
34
|
+
import { ListRelatedPartnersResponseClass } from '../models';
|
|
35
|
+
// @ts-ignore
|
|
34
36
|
import { TagPartnerRequestDtoRest } from '../models';
|
|
35
37
|
// @ts-ignore
|
|
36
38
|
import { UpdatePartnerRequestDto } from '../models';
|
|
@@ -190,11 +192,11 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
190
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
193
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
192
194
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
195
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
194
196
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
195
197
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
196
198
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
197
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
199
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
198
200
|
* @param {*} [options] Override http request option.
|
|
199
201
|
* @throws {RequiredError}
|
|
200
202
|
*/
|
|
@@ -251,6 +253,86 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
251
253
|
|
|
252
254
|
|
|
253
255
|
|
|
256
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
257
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
258
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
259
|
+
|
|
260
|
+
return {
|
|
261
|
+
url: toPathString(localVarUrlObj),
|
|
262
|
+
options: localVarRequestOptions,
|
|
263
|
+
};
|
|
264
|
+
},
|
|
265
|
+
/**
|
|
266
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
267
|
+
* @summary List grouped relations for partner
|
|
268
|
+
* @param {string} code
|
|
269
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
272
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
273
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
274
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
275
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
276
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
277
|
+
* @param {*} [options] Override http request option.
|
|
278
|
+
* @throws {RequiredError}
|
|
279
|
+
*/
|
|
280
|
+
listRelationsForPartner: async (code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
281
|
+
// verify required parameter 'code' is not null or undefined
|
|
282
|
+
assertParamExists('listRelationsForPartner', 'code', code)
|
|
283
|
+
const localVarPath = `/partnerservice/v1/partners/{code}/relations`
|
|
284
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
285
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
286
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
287
|
+
let baseOptions;
|
|
288
|
+
let baseAccessToken;
|
|
289
|
+
if (configuration) {
|
|
290
|
+
baseOptions = configuration.baseOptions;
|
|
291
|
+
baseAccessToken = configuration.accessToken;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
295
|
+
const localVarHeaderParameter = {} as any;
|
|
296
|
+
const localVarQueryParameter = {} as any;
|
|
297
|
+
|
|
298
|
+
// authentication bearer required
|
|
299
|
+
// http bearer authentication required
|
|
300
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
301
|
+
|
|
302
|
+
if (pageSize !== undefined) {
|
|
303
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
if (pageToken !== undefined) {
|
|
307
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
if (filter !== undefined) {
|
|
311
|
+
localVarQueryParameter['filter'] = filter;
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
if (search !== undefined) {
|
|
315
|
+
localVarQueryParameter['search'] = search;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
if (order !== undefined) {
|
|
319
|
+
localVarQueryParameter['order'] = order;
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
if (expand !== undefined) {
|
|
323
|
+
localVarQueryParameter['expand'] = expand;
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
if (filters !== undefined) {
|
|
327
|
+
localVarQueryParameter['filters'] = filters;
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
331
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
254
336
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
255
337
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
256
338
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -415,11 +497,11 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
415
497
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
416
498
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
417
499
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
418
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
500
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
419
501
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
420
502
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
421
503
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
422
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
504
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
423
505
|
* @param {*} [options] Override http request option.
|
|
424
506
|
* @throws {RequiredError}
|
|
425
507
|
*/
|
|
@@ -427,6 +509,25 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
427
509
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
428
510
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
429
511
|
},
|
|
512
|
+
/**
|
|
513
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
514
|
+
* @summary List grouped relations for partner
|
|
515
|
+
* @param {string} code
|
|
516
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
517
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
518
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
519
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
520
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
521
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
522
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
523
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
524
|
+
* @param {*} [options] Override http request option.
|
|
525
|
+
* @throws {RequiredError}
|
|
526
|
+
*/
|
|
527
|
+
async listRelationsForPartner(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRelatedPartnersResponseClass>> {
|
|
528
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
529
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
530
|
+
},
|
|
430
531
|
/**
|
|
431
532
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
432
533
|
* @summary Update the partner
|
|
@@ -503,17 +604,35 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
503
604
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
504
605
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
505
606
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
506
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
607
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
507
608
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
508
609
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
509
610
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
510
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
611
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
511
612
|
* @param {*} [options] Override http request option.
|
|
512
613
|
* @throws {RequiredError}
|
|
513
614
|
*/
|
|
514
615
|
listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass> {
|
|
515
616
|
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
516
617
|
},
|
|
618
|
+
/**
|
|
619
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
620
|
+
* @summary List grouped relations for partner
|
|
621
|
+
* @param {string} code
|
|
622
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
623
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
624
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
625
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
626
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
627
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
628
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
629
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
630
|
+
* @param {*} [options] Override http request option.
|
|
631
|
+
* @throws {RequiredError}
|
|
632
|
+
*/
|
|
633
|
+
listRelationsForPartner(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRelatedPartnersResponseClass> {
|
|
634
|
+
return localVarFp.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
635
|
+
},
|
|
517
636
|
/**
|
|
518
637
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
519
638
|
* @summary Update the partner
|
|
@@ -639,7 +758,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
639
758
|
readonly pageToken?: any
|
|
640
759
|
|
|
641
760
|
/**
|
|
642
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
761
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
643
762
|
* @type {string}
|
|
644
763
|
* @memberof PartnersApiListPartners
|
|
645
764
|
*/
|
|
@@ -667,13 +786,83 @@ export interface PartnersApiListPartnersRequest {
|
|
|
667
786
|
readonly expand?: string
|
|
668
787
|
|
|
669
788
|
/**
|
|
670
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
789
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
671
790
|
* @type {string}
|
|
672
791
|
* @memberof PartnersApiListPartners
|
|
673
792
|
*/
|
|
674
793
|
readonly filters?: string
|
|
675
794
|
}
|
|
676
795
|
|
|
796
|
+
/**
|
|
797
|
+
* Request parameters for listRelationsForPartner operation in PartnersApi.
|
|
798
|
+
* @export
|
|
799
|
+
* @interface PartnersApiListRelationsForPartnerRequest
|
|
800
|
+
*/
|
|
801
|
+
export interface PartnersApiListRelationsForPartnerRequest {
|
|
802
|
+
/**
|
|
803
|
+
*
|
|
804
|
+
* @type {string}
|
|
805
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
806
|
+
*/
|
|
807
|
+
readonly code: string
|
|
808
|
+
|
|
809
|
+
/**
|
|
810
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
811
|
+
* @type {string}
|
|
812
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
813
|
+
*/
|
|
814
|
+
readonly authorization?: string
|
|
815
|
+
|
|
816
|
+
/**
|
|
817
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
818
|
+
* @type {any}
|
|
819
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
820
|
+
*/
|
|
821
|
+
readonly pageSize?: any
|
|
822
|
+
|
|
823
|
+
/**
|
|
824
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
825
|
+
* @type {any}
|
|
826
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
827
|
+
*/
|
|
828
|
+
readonly pageToken?: any
|
|
829
|
+
|
|
830
|
+
/**
|
|
831
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
832
|
+
* @type {string}
|
|
833
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
834
|
+
*/
|
|
835
|
+
readonly filter?: string
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
839
|
+
* @type {any}
|
|
840
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
841
|
+
*/
|
|
842
|
+
readonly search?: any
|
|
843
|
+
|
|
844
|
+
/**
|
|
845
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
846
|
+
* @type {string}
|
|
847
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
848
|
+
*/
|
|
849
|
+
readonly order?: string
|
|
850
|
+
|
|
851
|
+
/**
|
|
852
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
853
|
+
* @type {string}
|
|
854
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
855
|
+
*/
|
|
856
|
+
readonly expand?: string
|
|
857
|
+
|
|
858
|
+
/**
|
|
859
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
860
|
+
* @type {string}
|
|
861
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
862
|
+
*/
|
|
863
|
+
readonly filters?: string
|
|
864
|
+
}
|
|
865
|
+
|
|
677
866
|
/**
|
|
678
867
|
* Request parameters for tagPartner operation in PartnersApi.
|
|
679
868
|
* @export
|
|
@@ -785,6 +974,18 @@ export class PartnersApi extends BaseAPI {
|
|
|
785
974
|
return PartnersApiFp(this.configuration).listPartners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
786
975
|
}
|
|
787
976
|
|
|
977
|
+
/**
|
|
978
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
979
|
+
* @summary List grouped relations for partner
|
|
980
|
+
* @param {PartnersApiListRelationsForPartnerRequest} requestParameters Request parameters.
|
|
981
|
+
* @param {*} [options] Override http request option.
|
|
982
|
+
* @throws {RequiredError}
|
|
983
|
+
* @memberof PartnersApi
|
|
984
|
+
*/
|
|
985
|
+
public listRelationsForPartner(requestParameters: PartnersApiListRelationsForPartnerRequest, options?: AxiosRequestConfig) {
|
|
986
|
+
return PartnersApiFp(this.configuration).listRelationsForPartner(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
987
|
+
}
|
|
988
|
+
|
|
788
989
|
/**
|
|
789
990
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
790
991
|
* @summary Update the partner
|
|
@@ -17,6 +17,7 @@ import { CreatePartnerResponseClass } from '../models';
|
|
|
17
17
|
import { DeleteResponseClass } from '../models';
|
|
18
18
|
import { GetPartnerResponseClass } from '../models';
|
|
19
19
|
import { ListPartnersResponseClass } from '../models';
|
|
20
|
+
import { ListRelatedPartnersResponseClass } from '../models';
|
|
20
21
|
import { TagPartnerRequestDtoRest } from '../models';
|
|
21
22
|
import { UpdatePartnerRequestDto } from '../models';
|
|
22
23
|
import { UpdatePartnerResponseClass } from '../models';
|
|
@@ -59,15 +60,31 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
59
60
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
61
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
61
62
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
62
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
63
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
63
64
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
64
65
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
65
66
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
66
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
67
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
67
68
|
* @param {*} [options] Override http request option.
|
|
68
69
|
* @throws {RequiredError}
|
|
69
70
|
*/
|
|
70
71
|
listPartners: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
|
+
/**
|
|
73
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
74
|
+
* @summary List grouped relations for partner
|
|
75
|
+
* @param {string} code
|
|
76
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
77
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
78
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
79
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
80
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
81
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
82
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
83
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
listRelationsForPartner: (code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
88
|
/**
|
|
72
89
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
73
90
|
* @summary Update the partner
|
|
@@ -128,15 +145,31 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
128
145
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
146
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
130
147
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
131
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
148
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
132
149
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
133
150
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
134
151
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
135
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
152
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
136
153
|
* @param {*} [options] Override http request option.
|
|
137
154
|
* @throws {RequiredError}
|
|
138
155
|
*/
|
|
139
156
|
listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>>;
|
|
157
|
+
/**
|
|
158
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
159
|
+
* @summary List grouped relations for partner
|
|
160
|
+
* @param {string} code
|
|
161
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
163
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
164
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
165
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
166
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
167
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
168
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
listRelationsForPartner(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRelatedPartnersResponseClass>>;
|
|
140
173
|
/**
|
|
141
174
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
142
175
|
* @summary Update the partner
|
|
@@ -197,15 +230,31 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
197
230
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
198
231
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
199
232
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
200
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
233
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
201
234
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
202
235
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
203
236
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
204
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
237
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
205
238
|
* @param {*} [options] Override http request option.
|
|
206
239
|
* @throws {RequiredError}
|
|
207
240
|
*/
|
|
208
241
|
listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass>;
|
|
242
|
+
/**
|
|
243
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
244
|
+
* @summary List grouped relations for partner
|
|
245
|
+
* @param {string} code
|
|
246
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
247
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
249
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
250
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
251
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
252
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
253
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
listRelationsForPartner(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRelatedPartnersResponseClass>;
|
|
209
258
|
/**
|
|
210
259
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
211
260
|
* @summary Update the partner
|
|
@@ -315,7 +364,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
315
364
|
*/
|
|
316
365
|
readonly pageToken?: any;
|
|
317
366
|
/**
|
|
318
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
367
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
319
368
|
* @type {string}
|
|
320
369
|
* @memberof PartnersApiListPartners
|
|
321
370
|
*/
|
|
@@ -339,12 +388,73 @@ export interface PartnersApiListPartnersRequest {
|
|
|
339
388
|
*/
|
|
340
389
|
readonly expand?: string;
|
|
341
390
|
/**
|
|
342
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
391
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
343
392
|
* @type {string}
|
|
344
393
|
* @memberof PartnersApiListPartners
|
|
345
394
|
*/
|
|
346
395
|
readonly filters?: string;
|
|
347
396
|
}
|
|
397
|
+
/**
|
|
398
|
+
* Request parameters for listRelationsForPartner operation in PartnersApi.
|
|
399
|
+
* @export
|
|
400
|
+
* @interface PartnersApiListRelationsForPartnerRequest
|
|
401
|
+
*/
|
|
402
|
+
export interface PartnersApiListRelationsForPartnerRequest {
|
|
403
|
+
/**
|
|
404
|
+
*
|
|
405
|
+
* @type {string}
|
|
406
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
407
|
+
*/
|
|
408
|
+
readonly code: string;
|
|
409
|
+
/**
|
|
410
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
411
|
+
* @type {string}
|
|
412
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
413
|
+
*/
|
|
414
|
+
readonly authorization?: string;
|
|
415
|
+
/**
|
|
416
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
417
|
+
* @type {any}
|
|
418
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
419
|
+
*/
|
|
420
|
+
readonly pageSize?: any;
|
|
421
|
+
/**
|
|
422
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
423
|
+
* @type {any}
|
|
424
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
425
|
+
*/
|
|
426
|
+
readonly pageToken?: any;
|
|
427
|
+
/**
|
|
428
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
429
|
+
* @type {string}
|
|
430
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
431
|
+
*/
|
|
432
|
+
readonly filter?: string;
|
|
433
|
+
/**
|
|
434
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
435
|
+
* @type {any}
|
|
436
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
437
|
+
*/
|
|
438
|
+
readonly search?: any;
|
|
439
|
+
/**
|
|
440
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
443
|
+
*/
|
|
444
|
+
readonly order?: string;
|
|
445
|
+
/**
|
|
446
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
447
|
+
* @type {string}
|
|
448
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
449
|
+
*/
|
|
450
|
+
readonly expand?: string;
|
|
451
|
+
/**
|
|
452
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
453
|
+
* @type {string}
|
|
454
|
+
* @memberof PartnersApiListRelationsForPartner
|
|
455
|
+
*/
|
|
456
|
+
readonly filters?: string;
|
|
457
|
+
}
|
|
348
458
|
/**
|
|
349
459
|
* Request parameters for tagPartner operation in PartnersApi.
|
|
350
460
|
* @export
|
|
@@ -438,6 +548,15 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
438
548
|
* @memberof PartnersApi
|
|
439
549
|
*/
|
|
440
550
|
listPartners(requestParameters?: PartnersApiListPartnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnersResponseClass, any>>;
|
|
551
|
+
/**
|
|
552
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
553
|
+
* @summary List grouped relations for partner
|
|
554
|
+
* @param {PartnersApiListRelationsForPartnerRequest} requestParameters Request parameters.
|
|
555
|
+
* @param {*} [options] Override http request option.
|
|
556
|
+
* @throws {RequiredError}
|
|
557
|
+
* @memberof PartnersApi
|
|
558
|
+
*/
|
|
559
|
+
listRelationsForPartner(requestParameters: PartnersApiListRelationsForPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRelatedPartnersResponseClass, any>>;
|
|
441
560
|
/**
|
|
442
561
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
443
562
|
* @summary Update the partner
|