@emilgroup/partner-sdk 1.19.0 → 1.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/partner-relations-api.ts +16 -16
- package/api/partner-tags-api.ts +12 -12
- package/api/partner-versions-api.ts +12 -12
- package/api/partners-api.ts +24 -24
- package/dist/api/partner-relations-api.d.ts +16 -16
- package/dist/api/partner-relations-api.js +12 -12
- package/dist/api/partner-tags-api.d.ts +12 -12
- package/dist/api/partner-tags-api.js +10 -10
- package/dist/api/partner-versions-api.d.ts +12 -12
- package/dist/api/partner-versions-api.js +10 -10
- package/dist/api/partners-api.d.ts +24 -24
- package/dist/api/partners-api.js +20 -20
- package/package.json +1 -1
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.
|
|
20
|
+
npm install @emilgroup/partner-sdk@1.20.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk@1.
|
|
24
|
+
yarn add @emilgroup/partner-sdk@1.20.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -230,11 +230,11 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
230
230
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
231
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
232
|
* @param {string} [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.
|
|
233
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
234
234
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
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, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
236
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/>
|
|
237
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
240
|
*/
|
|
@@ -306,11 +306,11 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
306
306
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
307
307
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
308
308
|
* @param {string} [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.
|
|
309
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
309
|
+
* @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>
|
|
310
310
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
311
311
|
* @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>
|
|
312
312
|
* @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>
|
|
313
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
313
|
+
* @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>
|
|
314
314
|
* @param {*} [options] Override http request option.
|
|
315
315
|
* @throws {RequiredError}
|
|
316
316
|
*/
|
|
@@ -491,11 +491,11 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
491
491
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
492
492
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
493
493
|
* @param {string} [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.
|
|
494
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
494
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
495
495
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
496
496
|
* @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, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
497
497
|
* @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/>
|
|
498
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
498
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
499
499
|
* @param {*} [options] Override http request option.
|
|
500
500
|
* @throws {RequiredError}
|
|
501
501
|
*/
|
|
@@ -509,11 +509,11 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
509
509
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
510
510
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
511
511
|
* @param {string} [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.
|
|
512
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
512
|
+
* @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>
|
|
513
513
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
514
514
|
* @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>
|
|
515
515
|
* @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>
|
|
516
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
516
|
+
* @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>
|
|
517
517
|
* @param {*} [options] Override http request option.
|
|
518
518
|
* @throws {RequiredError}
|
|
519
519
|
*/
|
|
@@ -594,11 +594,11 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
594
594
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
595
595
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
596
596
|
* @param {string} [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.
|
|
597
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
597
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
598
598
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
599
599
|
* @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, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
600
600
|
* @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/>
|
|
601
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
601
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
603
603
|
* @throws {RequiredError}
|
|
604
604
|
*/
|
|
@@ -611,11 +611,11 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
611
611
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
612
612
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
613
613
|
* @param {string} [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.
|
|
614
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
614
|
+
* @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>
|
|
615
615
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
616
616
|
* @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>
|
|
617
617
|
* @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>
|
|
618
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
618
|
+
* @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>
|
|
619
619
|
* @param {*} [options] Override http request option.
|
|
620
620
|
* @throws {RequiredError}
|
|
621
621
|
*/
|
|
@@ -749,7 +749,7 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
749
749
|
readonly pageToken?: string
|
|
750
750
|
|
|
751
751
|
/**
|
|
752
|
-
* Filter the response by one or multiple fields.
|
|
752
|
+
* 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, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
753
753
|
* @type {string}
|
|
754
754
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
755
755
|
*/
|
|
@@ -777,7 +777,7 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
777
777
|
readonly expand?: string
|
|
778
778
|
|
|
779
779
|
/**
|
|
780
|
-
* Filters the response by one or multiple fields.
|
|
780
|
+
* 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, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
781
781
|
* @type {string}
|
|
782
782
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
783
783
|
*/
|
|
@@ -812,7 +812,7 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
812
812
|
readonly pageToken?: string
|
|
813
813
|
|
|
814
814
|
/**
|
|
815
|
-
* Filter the response by one or multiple fields.
|
|
815
|
+
* 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>
|
|
816
816
|
* @type {string}
|
|
817
817
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
818
818
|
*/
|
|
@@ -840,7 +840,7 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
840
840
|
readonly expand?: string
|
|
841
841
|
|
|
842
842
|
/**
|
|
843
|
-
* Filters the response by one or multiple fields.
|
|
843
|
+
* 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>
|
|
844
844
|
* @type {string}
|
|
845
845
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
846
846
|
*/
|
package/api/partner-tags-api.ts
CHANGED
|
@@ -176,16 +176,16 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
176
176
|
};
|
|
177
177
|
},
|
|
178
178
|
/**
|
|
179
|
-
* Returns a list of partner tags you have previously created.
|
|
179
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
180
180
|
* @summary List partner tags
|
|
181
181
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
182
182
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
183
183
|
* @param {string} [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.
|
|
184
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
184
|
+
* @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: code, slug, label</i>
|
|
185
185
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
186
186
|
* @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: code, slug, label, createdAt, updatedAt</i>
|
|
187
187
|
* @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/>
|
|
188
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
188
|
+
* @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: code, slug, label</i>
|
|
189
189
|
* @param {*} [options] Override http request option.
|
|
190
190
|
* @throws {RequiredError}
|
|
191
191
|
*/
|
|
@@ -343,16 +343,16 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
|
|
|
343
343
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
344
344
|
},
|
|
345
345
|
/**
|
|
346
|
-
* Returns a list of partner tags you have previously created.
|
|
346
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
347
347
|
* @summary List partner tags
|
|
348
348
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
349
349
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
350
350
|
* @param {string} [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.
|
|
351
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
351
|
+
* @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: code, slug, label</i>
|
|
352
352
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
353
353
|
* @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: code, slug, label, createdAt, updatedAt</i>
|
|
354
354
|
* @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/>
|
|
355
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
355
|
+
* @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: code, slug, label</i>
|
|
356
356
|
* @param {*} [options] Override http request option.
|
|
357
357
|
* @throws {RequiredError}
|
|
358
358
|
*/
|
|
@@ -416,16 +416,16 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
|
|
|
416
416
|
return localVarFp.getTag(code, authorization, options).then((request) => request(axios, basePath));
|
|
417
417
|
},
|
|
418
418
|
/**
|
|
419
|
-
* Returns a list of partner tags you have previously created.
|
|
419
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
420
420
|
* @summary List partner tags
|
|
421
421
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
422
422
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
423
423
|
* @param {string} [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.
|
|
424
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
424
|
+
* @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: code, slug, label</i>
|
|
425
425
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
426
426
|
* @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: code, slug, label, createdAt, updatedAt</i>
|
|
427
427
|
* @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/>
|
|
428
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
428
|
+
* @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: code, slug, label</i>
|
|
429
429
|
* @param {*} [options] Override http request option.
|
|
430
430
|
* @throws {RequiredError}
|
|
431
431
|
*/
|
|
@@ -537,7 +537,7 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
537
537
|
readonly pageToken?: string
|
|
538
538
|
|
|
539
539
|
/**
|
|
540
|
-
* Filter the response by one or multiple fields.
|
|
540
|
+
* 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: code, slug, label</i>
|
|
541
541
|
* @type {string}
|
|
542
542
|
* @memberof PartnerTagsApiListTags
|
|
543
543
|
*/
|
|
@@ -565,7 +565,7 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
565
565
|
readonly expand?: string
|
|
566
566
|
|
|
567
567
|
/**
|
|
568
|
-
* Filters the response by one or multiple fields.
|
|
568
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
569
569
|
* @type {string}
|
|
570
570
|
* @memberof PartnerTagsApiListTags
|
|
571
571
|
*/
|
|
@@ -637,7 +637,7 @@ export class PartnerTagsApi extends BaseAPI {
|
|
|
637
637
|
}
|
|
638
638
|
|
|
639
639
|
/**
|
|
640
|
-
* Returns a list of partner tags you have previously created.
|
|
640
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
641
641
|
* @summary List partner tags
|
|
642
642
|
* @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
|
|
643
643
|
* @param {*} [options] Override http request option.
|
|
@@ -80,17 +80,17 @@ export const PartnerVersionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
80
80
|
};
|
|
81
81
|
},
|
|
82
82
|
/**
|
|
83
|
-
* Returns a list of partner versions you have previously created.
|
|
83
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
84
84
|
* @summary List partner versions
|
|
85
85
|
* @param {string} code
|
|
86
86
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
87
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
88
88
|
* @param {string} [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.
|
|
89
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
89
|
+
* @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: code, version, displayName, updatedAt, updatedBy</i>
|
|
90
90
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
91
91
|
* @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: displayName, createdAt, updatedAt, version</i>
|
|
92
92
|
* @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<i>
|
|
93
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
93
|
+
* @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: code, version, displayName, updatedAt, updatedBy</i>
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
96
96
|
*/
|
|
@@ -183,17 +183,17 @@ export const PartnerVersionsApiFp = function(configuration?: Configuration) {
|
|
|
183
183
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* Returns a list of partner versions you have previously created.
|
|
186
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
187
187
|
* @summary List partner versions
|
|
188
188
|
* @param {string} code
|
|
189
189
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
190
190
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
191
191
|
* @param {string} [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.
|
|
192
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
192
|
+
* @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: code, version, displayName, updatedAt, updatedBy</i>
|
|
193
193
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
194
|
* @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: displayName, createdAt, updatedAt, version</i>
|
|
195
195
|
* @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<i>
|
|
196
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
196
|
+
* @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: code, version, displayName, updatedAt, updatedBy</i>
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
198
198
|
* @throws {RequiredError}
|
|
199
199
|
*/
|
|
@@ -224,17 +224,17 @@ export const PartnerVersionsApiFactory = function (configuration?: Configuration
|
|
|
224
224
|
return localVarFp.getPartnerVersion(code, version, authorization, options).then((request) => request(axios, basePath));
|
|
225
225
|
},
|
|
226
226
|
/**
|
|
227
|
-
* Returns a list of partner versions you have previously created.
|
|
227
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
228
228
|
* @summary List partner versions
|
|
229
229
|
* @param {string} code
|
|
230
230
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
231
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
232
|
* @param {string} [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.
|
|
233
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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: code, version, displayName, updatedAt, updatedBy</i>
|
|
234
234
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
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: displayName, createdAt, updatedAt, version</i>
|
|
236
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<i>
|
|
237
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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: code, version, displayName, updatedAt, updatedBy</i>
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
240
|
*/
|
|
@@ -307,7 +307,7 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
307
307
|
readonly pageToken?: string
|
|
308
308
|
|
|
309
309
|
/**
|
|
310
|
-
* Filter the response by one or multiple fields.
|
|
310
|
+
* 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: code, version, displayName, updatedAt, updatedBy</i>
|
|
311
311
|
* @type {string}
|
|
312
312
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
313
313
|
*/
|
|
@@ -335,7 +335,7 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
335
335
|
readonly expand?: string
|
|
336
336
|
|
|
337
337
|
/**
|
|
338
|
-
* Filters the response by one or multiple fields.
|
|
338
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
339
339
|
* @type {string}
|
|
340
340
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
341
341
|
*/
|
|
@@ -362,7 +362,7 @@ export class PartnerVersionsApi extends BaseAPI {
|
|
|
362
362
|
}
|
|
363
363
|
|
|
364
364
|
/**
|
|
365
|
-
* Returns a list of partner versions you have previously created.
|
|
365
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
366
366
|
* @summary List partner versions
|
|
367
367
|
* @param {PartnerVersionsApiListPartnerVersionRequest} requestParameters Request parameters.
|
|
368
368
|
* @param {*} [options] Override http request option.
|
package/api/partners-api.ts
CHANGED
|
@@ -289,16 +289,16 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
289
289
|
};
|
|
290
290
|
},
|
|
291
291
|
/**
|
|
292
|
-
* Returns a list of partners you have previously created.
|
|
292
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
293
293
|
* @summary List partners
|
|
294
294
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
295
295
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
296
296
|
* @param {string} [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.
|
|
297
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
297
|
+
* @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, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
298
298
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
299
299
|
* @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, partnerNumber, partnerType.name, partnerTagLabels.tagLabels</i>
|
|
300
300
|
* @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, partnerTagLabels<i>
|
|
301
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
301
|
+
* @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, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
302
302
|
* @param {*} [options] Override http request option.
|
|
303
303
|
* @throws {RequiredError}
|
|
304
304
|
*/
|
|
@@ -365,17 +365,17 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
365
365
|
};
|
|
366
366
|
},
|
|
367
367
|
/**
|
|
368
|
-
* Returns a list of grouped relations for partner you have previously created.
|
|
368
|
+
* 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. **Required Permissions** \"partner-management.partners.view\"
|
|
369
369
|
* @summary List grouped relations for partner
|
|
370
370
|
* @param {string} code
|
|
371
371
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
372
372
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
373
373
|
* @param {string} [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.
|
|
374
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
374
|
+
* @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>
|
|
375
375
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
376
376
|
* @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>
|
|
377
377
|
* @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>
|
|
378
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
378
|
+
* @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>
|
|
379
379
|
* @param {*} [options] Override http request option.
|
|
380
380
|
* @throws {RequiredError}
|
|
381
381
|
*/
|
|
@@ -669,16 +669,16 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
669
669
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
670
670
|
},
|
|
671
671
|
/**
|
|
672
|
-
* Returns a list of partners you have previously created.
|
|
672
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
673
673
|
* @summary List partners
|
|
674
674
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
675
675
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
676
676
|
* @param {string} [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.
|
|
677
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
677
|
+
* @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, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
678
678
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
679
679
|
* @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, partnerNumber, partnerType.name, partnerTagLabels.tagLabels</i>
|
|
680
680
|
* @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, partnerTagLabels<i>
|
|
681
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
681
|
+
* @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, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
682
682
|
* @param {*} [options] Override http request option.
|
|
683
683
|
* @throws {RequiredError}
|
|
684
684
|
*/
|
|
@@ -687,17 +687,17 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
687
687
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
688
688
|
},
|
|
689
689
|
/**
|
|
690
|
-
* Returns a list of grouped relations for partner you have previously created.
|
|
690
|
+
* 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. **Required Permissions** \"partner-management.partners.view\"
|
|
691
691
|
* @summary List grouped relations for partner
|
|
692
692
|
* @param {string} code
|
|
693
693
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
694
694
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
695
695
|
* @param {string} [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.
|
|
696
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
696
|
+
* @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>
|
|
697
697
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
698
698
|
* @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>
|
|
699
699
|
* @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>
|
|
700
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
700
|
+
* @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>
|
|
701
701
|
* @param {*} [options] Override http request option.
|
|
702
702
|
* @throws {RequiredError}
|
|
703
703
|
*/
|
|
@@ -811,16 +811,16 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
811
811
|
return localVarFp.getPartnerAccount(code, authorization, options).then((request) => request(axios, basePath));
|
|
812
812
|
},
|
|
813
813
|
/**
|
|
814
|
-
* Returns a list of partners you have previously created.
|
|
814
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
815
815
|
* @summary List partners
|
|
816
816
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
817
817
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
818
818
|
* @param {string} [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.
|
|
819
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
819
|
+
* @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, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
820
820
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
821
821
|
* @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, partnerNumber, partnerType.name, partnerTagLabels.tagLabels</i>
|
|
822
822
|
* @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, partnerTagLabels<i>
|
|
823
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
823
|
+
* @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, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
824
824
|
* @param {*} [options] Override http request option.
|
|
825
825
|
* @throws {RequiredError}
|
|
826
826
|
*/
|
|
@@ -828,17 +828,17 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
828
828
|
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
829
829
|
},
|
|
830
830
|
/**
|
|
831
|
-
* Returns a list of grouped relations for partner you have previously created.
|
|
831
|
+
* 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. **Required Permissions** \"partner-management.partners.view\"
|
|
832
832
|
* @summary List grouped relations for partner
|
|
833
833
|
* @param {string} code
|
|
834
834
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
835
835
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
836
836
|
* @param {string} [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.
|
|
837
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
837
|
+
* @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>
|
|
838
838
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
839
839
|
* @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>
|
|
840
840
|
* @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>
|
|
841
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
841
|
+
* @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>
|
|
842
842
|
* @param {*} [options] Override http request option.
|
|
843
843
|
* @throws {RequiredError}
|
|
844
844
|
*/
|
|
@@ -1024,7 +1024,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
1024
1024
|
readonly pageToken?: string
|
|
1025
1025
|
|
|
1026
1026
|
/**
|
|
1027
|
-
* Filter the response by one or multiple fields.
|
|
1027
|
+
* 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, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
1028
1028
|
* @type {string}
|
|
1029
1029
|
* @memberof PartnersApiListPartners
|
|
1030
1030
|
*/
|
|
@@ -1052,7 +1052,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
1052
1052
|
readonly expand?: string
|
|
1053
1053
|
|
|
1054
1054
|
/**
|
|
1055
|
-
* Filters the response by one or multiple fields.
|
|
1055
|
+
* 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, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
1056
1056
|
* @type {string}
|
|
1057
1057
|
* @memberof PartnersApiListPartners
|
|
1058
1058
|
*/
|
|
@@ -1094,7 +1094,7 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
1094
1094
|
readonly pageToken?: string
|
|
1095
1095
|
|
|
1096
1096
|
/**
|
|
1097
|
-
* Filter the response by one or multiple fields.
|
|
1097
|
+
* 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>
|
|
1098
1098
|
* @type {string}
|
|
1099
1099
|
* @memberof PartnersApiListRelationsForPartner
|
|
1100
1100
|
*/
|
|
@@ -1122,7 +1122,7 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
1122
1122
|
readonly expand?: string
|
|
1123
1123
|
|
|
1124
1124
|
/**
|
|
1125
|
-
* Filters the response by one or multiple fields.
|
|
1125
|
+
* 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>
|
|
1126
1126
|
* @type {string}
|
|
1127
1127
|
* @memberof PartnersApiListRelationsForPartner
|
|
1128
1128
|
*/
|
|
@@ -1281,7 +1281,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
1281
1281
|
}
|
|
1282
1282
|
|
|
1283
1283
|
/**
|
|
1284
|
-
* Returns a list of partners you have previously created.
|
|
1284
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
1285
1285
|
* @summary List partners
|
|
1286
1286
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
1287
1287
|
* @param {*} [options] Override http request option.
|
|
@@ -1293,7 +1293,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
1293
1293
|
}
|
|
1294
1294
|
|
|
1295
1295
|
/**
|
|
1296
|
-
* Returns a list of grouped relations for partner you have previously created.
|
|
1296
|
+
* 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. **Required Permissions** \"partner-management.partners.view\"
|
|
1297
1297
|
* @summary List grouped relations for partner
|
|
1298
1298
|
* @param {PartnersApiListRelationsForPartnerRequest} requestParameters Request parameters.
|
|
1299
1299
|
* @param {*} [options] Override http request option.
|