@emilgroup/partner-sdk-node 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.
@@ -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-node@1.11.1-beta.1 --save
20
+ npm install @emilgroup/partner-sdk-node@1.11.1-beta.3 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/partner-sdk-node@1.11.1-beta.1
24
+ yarn add @emilgroup/partner-sdk-node@1.11.1-beta.3
25
25
  ```
26
26
 
27
27
  And then you can import `PartnersApi`.
@@ -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';
@@ -194,11 +196,11 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
194
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
195
197
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
196
198
  * @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.
197
- * @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>
199
+ * @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>
198
200
  * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
199
201
  * @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>
200
202
  * @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>
201
- * @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>
203
+ * @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>
202
204
  * @param {*} [options] Override http request option.
203
205
  * @throws {RequiredError}
204
206
  */
@@ -255,6 +257,86 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
255
257
 
256
258
 
257
259
 
260
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
261
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
262
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
263
+
264
+ return {
265
+ url: toPathString(localVarUrlObj),
266
+ options: localVarRequestOptions,
267
+ };
268
+ },
269
+ /**
270
+ * 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.
271
+ * @summary List grouped relations for partner
272
+ * @param {string} code
273
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
274
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
275
+ * @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.
276
+ * @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>
277
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
278
+ * @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>
279
+ * @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>
280
+ * @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>
281
+ * @param {*} [options] Override http request option.
282
+ * @throws {RequiredError}
283
+ */
284
+ listRelationsForPartner: async (code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
285
+ // verify required parameter 'code' is not null or undefined
286
+ assertParamExists('listRelationsForPartner', 'code', code)
287
+ const localVarPath = `/partnerservice/v1/partners/{code}/relations`
288
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
289
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
290
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
291
+ let baseOptions;
292
+ let baseAccessToken;
293
+ if (configuration) {
294
+ baseOptions = configuration.baseOptions;
295
+ baseAccessToken = configuration.accessToken;
296
+ }
297
+
298
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
299
+ const localVarHeaderParameter = {} as any;
300
+ const localVarQueryParameter = {} as any;
301
+
302
+ // authentication bearer required
303
+ // http bearer authentication required
304
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
305
+
306
+ if (pageSize !== undefined) {
307
+ localVarQueryParameter['pageSize'] = pageSize;
308
+ }
309
+
310
+ if (pageToken !== undefined) {
311
+ localVarQueryParameter['pageToken'] = pageToken;
312
+ }
313
+
314
+ if (filter !== undefined) {
315
+ localVarQueryParameter['filter'] = filter;
316
+ }
317
+
318
+ if (search !== undefined) {
319
+ localVarQueryParameter['search'] = search;
320
+ }
321
+
322
+ if (order !== undefined) {
323
+ localVarQueryParameter['order'] = order;
324
+ }
325
+
326
+ if (expand !== undefined) {
327
+ localVarQueryParameter['expand'] = expand;
328
+ }
329
+
330
+ if (filters !== undefined) {
331
+ localVarQueryParameter['filters'] = filters;
332
+ }
333
+
334
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
335
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
336
+ }
337
+
338
+
339
+
258
340
  setSearchParams(localVarUrlObj, localVarQueryParameter);
259
341
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
260
342
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -419,11 +501,11 @@ export const PartnersApiFp = function(configuration?: Configuration) {
419
501
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
420
502
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
421
503
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
422
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
504
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
423
505
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
424
506
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs&lt;/i&gt;
425
507
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType, tags&lt;i&gt;
426
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
508
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
427
509
  * @param {*} [options] Override http request option.
428
510
  * @throws {RequiredError}
429
511
  */
@@ -431,6 +513,25 @@ export const PartnersApiFp = function(configuration?: Configuration) {
431
513
  const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
432
514
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
433
515
  },
516
+ /**
517
+ * 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.
518
+ * @summary List grouped relations for partner
519
+ * @param {string} code
520
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
521
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
522
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
523
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
524
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
525
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
526
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partner1, partner2, partnerRelationType&lt;i&gt;
527
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
528
+ * @param {*} [options] Override http request option.
529
+ * @throws {RequiredError}
530
+ */
531
+ 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>> {
532
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
533
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
534
+ },
434
535
  /**
435
536
  * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
436
537
  * @summary Update the partner
@@ -507,17 +608,35 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
507
608
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
508
609
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
509
610
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
510
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
611
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
511
612
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
512
613
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs&lt;/i&gt;
513
614
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType, tags&lt;i&gt;
514
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
615
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
515
616
  * @param {*} [options] Override http request option.
516
617
  * @throws {RequiredError}
517
618
  */
518
619
  listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass> {
519
620
  return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
520
621
  },
622
+ /**
623
+ * 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.
624
+ * @summary List grouped relations for partner
625
+ * @param {string} code
626
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
627
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
628
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
629
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
630
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
631
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
632
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partner1, partner2, partnerRelationType&lt;i&gt;
633
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
634
+ * @param {*} [options] Override http request option.
635
+ * @throws {RequiredError}
636
+ */
637
+ listRelationsForPartner(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRelatedPartnersResponseClass> {
638
+ return localVarFp.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
639
+ },
521
640
  /**
522
641
  * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
523
642
  * @summary Update the partner
@@ -643,7 +762,7 @@ export interface PartnersApiListPartnersRequest {
643
762
  readonly pageToken?: any
644
763
 
645
764
  /**
646
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
765
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
647
766
  * @type {string}
648
767
  * @memberof PartnersApiListPartners
649
768
  */
@@ -671,13 +790,83 @@ export interface PartnersApiListPartnersRequest {
671
790
  readonly expand?: string
672
791
 
673
792
  /**
674
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
793
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
675
794
  * @type {string}
676
795
  * @memberof PartnersApiListPartners
677
796
  */
678
797
  readonly filters?: string
679
798
  }
680
799
 
800
+ /**
801
+ * Request parameters for listRelationsForPartner operation in PartnersApi.
802
+ * @export
803
+ * @interface PartnersApiListRelationsForPartnerRequest
804
+ */
805
+ export interface PartnersApiListRelationsForPartnerRequest {
806
+ /**
807
+ *
808
+ * @type {string}
809
+ * @memberof PartnersApiListRelationsForPartner
810
+ */
811
+ readonly code: string
812
+
813
+ /**
814
+ * Bearer Token: provided by the login endpoint under the name accessToken.
815
+ * @type {string}
816
+ * @memberof PartnersApiListRelationsForPartner
817
+ */
818
+ readonly authorization?: string
819
+
820
+ /**
821
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
822
+ * @type {any}
823
+ * @memberof PartnersApiListRelationsForPartner
824
+ */
825
+ readonly pageSize?: any
826
+
827
+ /**
828
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
829
+ * @type {any}
830
+ * @memberof PartnersApiListRelationsForPartner
831
+ */
832
+ readonly pageToken?: any
833
+
834
+ /**
835
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
836
+ * @type {string}
837
+ * @memberof PartnersApiListRelationsForPartner
838
+ */
839
+ readonly filter?: string
840
+
841
+ /**
842
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
843
+ * @type {any}
844
+ * @memberof PartnersApiListRelationsForPartner
845
+ */
846
+ readonly search?: any
847
+
848
+ /**
849
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
850
+ * @type {string}
851
+ * @memberof PartnersApiListRelationsForPartner
852
+ */
853
+ readonly order?: string
854
+
855
+ /**
856
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partner1, partner2, partnerRelationType&lt;i&gt;
857
+ * @type {string}
858
+ * @memberof PartnersApiListRelationsForPartner
859
+ */
860
+ readonly expand?: string
861
+
862
+ /**
863
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
864
+ * @type {string}
865
+ * @memberof PartnersApiListRelationsForPartner
866
+ */
867
+ readonly filters?: string
868
+ }
869
+
681
870
  /**
682
871
  * Request parameters for tagPartner operation in PartnersApi.
683
872
  * @export
@@ -789,6 +978,18 @@ export class PartnersApi extends BaseAPI {
789
978
  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));
790
979
  }
791
980
 
981
+ /**
982
+ * 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.
983
+ * @summary List grouped relations for partner
984
+ * @param {PartnersApiListRelationsForPartnerRequest} requestParameters Request parameters.
985
+ * @param {*} [options] Override http request option.
986
+ * @throws {RequiredError}
987
+ * @memberof PartnersApi
988
+ */
989
+ public listRelationsForPartner(requestParameters: PartnersApiListRelationsForPartnerRequest, options?: AxiosRequestConfig) {
990
+ 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));
991
+ }
992
+
792
993
  /**
793
994
  * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
794
995
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
63
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
63
64
  * @param {any} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType, tags&lt;i&gt;
66
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
67
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
80
+ * @param {any} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partner1, partner2, partnerRelationType&lt;i&gt;
83
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
148
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
132
149
  * @param {any} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType, tags&lt;i&gt;
135
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
152
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
165
+ * @param {any} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partner1, partner2, partnerRelationType&lt;i&gt;
168
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
233
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
201
234
  * @param {any} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType, tags&lt;i&gt;
204
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
237
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
250
+ * @param {any} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partner1, partner2, partnerRelationType&lt;i&gt;
253
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
367
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode&lt;/i&gt;
391
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber&lt;/i&gt;
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
429
+ * @type {string}
430
+ * @memberof PartnersApiListRelationsForPartner
431
+ */
432
+ readonly filter?: string;
433
+ /**
434
+ * To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partner1, partner2, partnerRelationType&lt;i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
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