@emilgroup/partner-sdk-node 1.19.0 → 1.19.1-beta.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-node@1.19.0 --save
|
|
20
|
+
npm install @emilgroup/partner-sdk-node@1.19.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk-node@1.19.0
|
|
24
|
+
yarn add @emilgroup/partner-sdk-node@1.19.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -234,11 +234,11 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
234
234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
235
235
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
236
236
|
* @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.
|
|
237
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
237
|
+
* @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>
|
|
238
238
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
239
239
|
* @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>
|
|
240
240
|
* @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/>
|
|
241
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
241
|
+
* @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>
|
|
242
242
|
* @param {*} [options] Override http request option.
|
|
243
243
|
* @throws {RequiredError}
|
|
244
244
|
*/
|
|
@@ -310,11 +310,11 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
310
310
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
311
311
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
312
312
|
* @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.
|
|
313
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
313
|
+
* @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>
|
|
314
314
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
315
315
|
* @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>
|
|
316
316
|
* @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>
|
|
317
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
317
|
+
* @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>
|
|
318
318
|
* @param {*} [options] Override http request option.
|
|
319
319
|
* @throws {RequiredError}
|
|
320
320
|
*/
|
|
@@ -495,11 +495,11 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
495
495
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
496
496
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
497
497
|
* @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.
|
|
498
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
498
|
+
* @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>
|
|
499
499
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
500
500
|
* @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>
|
|
501
501
|
* @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/>
|
|
502
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
502
|
+
* @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>
|
|
503
503
|
* @param {*} [options] Override http request option.
|
|
504
504
|
* @throws {RequiredError}
|
|
505
505
|
*/
|
|
@@ -513,11 +513,11 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
513
513
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
514
514
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
515
515
|
* @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.
|
|
516
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
516
|
+
* @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>
|
|
517
517
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
518
518
|
* @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>
|
|
519
519
|
* @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>
|
|
520
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
520
|
+
* @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>
|
|
521
521
|
* @param {*} [options] Override http request option.
|
|
522
522
|
* @throws {RequiredError}
|
|
523
523
|
*/
|
|
@@ -598,11 +598,11 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
598
598
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
599
599
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
600
600
|
* @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.
|
|
601
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
601
|
+
* @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>
|
|
602
602
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
603
603
|
* @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>
|
|
604
604
|
* @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/>
|
|
605
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
605
|
+
* @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>
|
|
606
606
|
* @param {*} [options] Override http request option.
|
|
607
607
|
* @throws {RequiredError}
|
|
608
608
|
*/
|
|
@@ -615,11 +615,11 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
615
615
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
616
616
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
617
617
|
* @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.
|
|
618
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
618
|
+
* @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>
|
|
619
619
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
620
620
|
* @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>
|
|
621
621
|
* @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>
|
|
622
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
622
|
+
* @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>
|
|
623
623
|
* @param {*} [options] Override http request option.
|
|
624
624
|
* @throws {RequiredError}
|
|
625
625
|
*/
|
|
@@ -753,7 +753,7 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
753
753
|
readonly pageToken?: string
|
|
754
754
|
|
|
755
755
|
/**
|
|
756
|
-
* Filter the response by one or multiple fields.
|
|
756
|
+
* 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>
|
|
757
757
|
* @type {string}
|
|
758
758
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
759
759
|
*/
|
|
@@ -781,7 +781,7 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
781
781
|
readonly expand?: string
|
|
782
782
|
|
|
783
783
|
/**
|
|
784
|
-
* Filters the response by one or multiple fields.
|
|
784
|
+
* 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>
|
|
785
785
|
* @type {string}
|
|
786
786
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
787
787
|
*/
|
|
@@ -816,7 +816,7 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
816
816
|
readonly pageToken?: string
|
|
817
817
|
|
|
818
818
|
/**
|
|
819
|
-
* Filter the response by one or multiple fields.
|
|
819
|
+
* 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>
|
|
820
820
|
* @type {string}
|
|
821
821
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
822
822
|
*/
|
|
@@ -844,7 +844,7 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
844
844
|
readonly expand?: string
|
|
845
845
|
|
|
846
846
|
/**
|
|
847
|
-
* Filters the response by one or multiple fields.
|
|
847
|
+
* 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>
|
|
848
848
|
* @type {string}
|
|
849
849
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
850
850
|
*/
|
package/api/partner-tags-api.ts
CHANGED
|
@@ -180,16 +180,16 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
180
180
|
};
|
|
181
181
|
},
|
|
182
182
|
/**
|
|
183
|
-
* Returns a list of partner tags you have previously created.
|
|
183
|
+
* 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\"
|
|
184
184
|
* @summary List partner tags
|
|
185
185
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
186
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
187
187
|
* @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.
|
|
188
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
188
|
+
* @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>
|
|
189
189
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
190
190
|
* @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>
|
|
191
191
|
* @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/>
|
|
192
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
192
|
+
* @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>
|
|
193
193
|
* @param {*} [options] Override http request option.
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
*/
|
|
@@ -347,16 +347,16 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
|
|
|
347
347
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
348
348
|
},
|
|
349
349
|
/**
|
|
350
|
-
* Returns a list of partner tags you have previously created.
|
|
350
|
+
* 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\"
|
|
351
351
|
* @summary List partner tags
|
|
352
352
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
353
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
354
354
|
* @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.
|
|
355
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
355
|
+
* @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>
|
|
356
356
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
357
357
|
* @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>
|
|
358
358
|
* @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/>
|
|
359
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
359
|
+
* @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>
|
|
360
360
|
* @param {*} [options] Override http request option.
|
|
361
361
|
* @throws {RequiredError}
|
|
362
362
|
*/
|
|
@@ -420,16 +420,16 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
|
|
|
420
420
|
return localVarFp.getTag(code, authorization, options).then((request) => request(axios, basePath));
|
|
421
421
|
},
|
|
422
422
|
/**
|
|
423
|
-
* Returns a list of partner tags you have previously created.
|
|
423
|
+
* 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\"
|
|
424
424
|
* @summary List partner tags
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
426
426
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
427
427
|
* @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.
|
|
428
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
428
|
+
* @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>
|
|
429
429
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
430
430
|
* @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>
|
|
431
431
|
* @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/>
|
|
432
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
432
|
+
* @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>
|
|
433
433
|
* @param {*} [options] Override http request option.
|
|
434
434
|
* @throws {RequiredError}
|
|
435
435
|
*/
|
|
@@ -541,7 +541,7 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
541
541
|
readonly pageToken?: string
|
|
542
542
|
|
|
543
543
|
/**
|
|
544
|
-
* Filter the response by one or multiple fields.
|
|
544
|
+
* 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>
|
|
545
545
|
* @type {string}
|
|
546
546
|
* @memberof PartnerTagsApiListTags
|
|
547
547
|
*/
|
|
@@ -569,7 +569,7 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
569
569
|
readonly expand?: string
|
|
570
570
|
|
|
571
571
|
/**
|
|
572
|
-
* Filters the response by one or multiple fields.
|
|
572
|
+
* 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>
|
|
573
573
|
* @type {string}
|
|
574
574
|
* @memberof PartnerTagsApiListTags
|
|
575
575
|
*/
|
|
@@ -641,7 +641,7 @@ export class PartnerTagsApi extends BaseAPI {
|
|
|
641
641
|
}
|
|
642
642
|
|
|
643
643
|
/**
|
|
644
|
-
* Returns a list of partner tags you have previously created.
|
|
644
|
+
* 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\"
|
|
645
645
|
* @summary List partner tags
|
|
646
646
|
* @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
|
|
647
647
|
* @param {*} [options] Override http request option.
|
|
@@ -84,17 +84,17 @@ export const PartnerVersionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
84
84
|
};
|
|
85
85
|
},
|
|
86
86
|
/**
|
|
87
|
-
* Returns a list of partner versions you have previously created.
|
|
87
|
+
* 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\"
|
|
88
88
|
* @summary List partner versions
|
|
89
89
|
* @param {string} code
|
|
90
90
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
91
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
92
92
|
* @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.
|
|
93
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
93
|
+
* @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>
|
|
94
94
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
95
95
|
* @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>
|
|
96
96
|
* @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>
|
|
97
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
97
|
+
* @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>
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
@@ -187,17 +187,17 @@ export const PartnerVersionsApiFp = function(configuration?: Configuration) {
|
|
|
187
187
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
188
188
|
},
|
|
189
189
|
/**
|
|
190
|
-
* Returns a list of partner versions you have previously created.
|
|
190
|
+
* 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\"
|
|
191
191
|
* @summary List partner versions
|
|
192
192
|
* @param {string} code
|
|
193
193
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
194
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
195
195
|
* @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.
|
|
196
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
196
|
+
* @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>
|
|
197
197
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
198
198
|
* @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>
|
|
199
199
|
* @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>
|
|
200
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
200
|
+
* @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>
|
|
201
201
|
* @param {*} [options] Override http request option.
|
|
202
202
|
* @throws {RequiredError}
|
|
203
203
|
*/
|
|
@@ -228,17 +228,17 @@ export const PartnerVersionsApiFactory = function (configuration?: Configuration
|
|
|
228
228
|
return localVarFp.getPartnerVersion(code, version, authorization, options).then((request) => request(axios, basePath));
|
|
229
229
|
},
|
|
230
230
|
/**
|
|
231
|
-
* Returns a list of partner versions you have previously created.
|
|
231
|
+
* 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\"
|
|
232
232
|
* @summary List partner versions
|
|
233
233
|
* @param {string} code
|
|
234
234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
235
235
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
236
236
|
* @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.
|
|
237
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
237
|
+
* @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>
|
|
238
238
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
239
239
|
* @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>
|
|
240
240
|
* @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>
|
|
241
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
241
|
+
* @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>
|
|
242
242
|
* @param {*} [options] Override http request option.
|
|
243
243
|
* @throws {RequiredError}
|
|
244
244
|
*/
|
|
@@ -311,7 +311,7 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
311
311
|
readonly pageToken?: string
|
|
312
312
|
|
|
313
313
|
/**
|
|
314
|
-
* Filter the response by one or multiple fields.
|
|
314
|
+
* 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>
|
|
315
315
|
* @type {string}
|
|
316
316
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
317
317
|
*/
|
|
@@ -339,7 +339,7 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
339
339
|
readonly expand?: string
|
|
340
340
|
|
|
341
341
|
/**
|
|
342
|
-
* Filters the response by one or multiple fields.
|
|
342
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
343
343
|
* @type {string}
|
|
344
344
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
345
345
|
*/
|
|
@@ -366,7 +366,7 @@ export class PartnerVersionsApi extends BaseAPI {
|
|
|
366
366
|
}
|
|
367
367
|
|
|
368
368
|
/**
|
|
369
|
-
* Returns a list of partner versions you have previously created.
|
|
369
|
+
* 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\"
|
|
370
370
|
* @summary List partner versions
|
|
371
371
|
* @param {PartnerVersionsApiListPartnerVersionRequest} requestParameters Request parameters.
|
|
372
372
|
* @param {*} [options] Override http request option.
|
package/api/partners-api.ts
CHANGED
|
@@ -293,16 +293,16 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
293
293
|
};
|
|
294
294
|
},
|
|
295
295
|
/**
|
|
296
|
-
* Returns a list of partners you have previously created.
|
|
296
|
+
* 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\"
|
|
297
297
|
* @summary List partners
|
|
298
298
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
299
299
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
300
300
|
* @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.
|
|
301
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
301
|
+
* @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>
|
|
302
302
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
303
303
|
* @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>
|
|
304
304
|
* @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>
|
|
305
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
305
|
+
* @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>
|
|
306
306
|
* @param {*} [options] Override http request option.
|
|
307
307
|
* @throws {RequiredError}
|
|
308
308
|
*/
|
|
@@ -369,17 +369,17 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
369
369
|
};
|
|
370
370
|
},
|
|
371
371
|
/**
|
|
372
|
-
* Returns a list of grouped relations for partner you have previously created.
|
|
372
|
+
* 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\"
|
|
373
373
|
* @summary List grouped relations for partner
|
|
374
374
|
* @param {string} code
|
|
375
375
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
376
376
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
377
377
|
* @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.
|
|
378
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
378
|
+
* @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>
|
|
379
379
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
380
380
|
* @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>
|
|
381
381
|
* @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>
|
|
382
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
382
|
+
* @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>
|
|
383
383
|
* @param {*} [options] Override http request option.
|
|
384
384
|
* @throws {RequiredError}
|
|
385
385
|
*/
|
|
@@ -673,16 +673,16 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
673
673
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
674
674
|
},
|
|
675
675
|
/**
|
|
676
|
-
* Returns a list of partners you have previously created.
|
|
676
|
+
* 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\"
|
|
677
677
|
* @summary List partners
|
|
678
678
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
679
679
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
680
680
|
* @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.
|
|
681
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
681
|
+
* @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>
|
|
682
682
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
683
683
|
* @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>
|
|
684
684
|
* @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>
|
|
685
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
685
|
+
* @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>
|
|
686
686
|
* @param {*} [options] Override http request option.
|
|
687
687
|
* @throws {RequiredError}
|
|
688
688
|
*/
|
|
@@ -691,17 +691,17 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
691
691
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
692
692
|
},
|
|
693
693
|
/**
|
|
694
|
-
* Returns a list of grouped relations for partner you have previously created.
|
|
694
|
+
* 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\"
|
|
695
695
|
* @summary List grouped relations for partner
|
|
696
696
|
* @param {string} code
|
|
697
697
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
698
698
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
699
699
|
* @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.
|
|
700
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
700
|
+
* @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>
|
|
701
701
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
702
702
|
* @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>
|
|
703
703
|
* @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>
|
|
704
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
704
|
+
* @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>
|
|
705
705
|
* @param {*} [options] Override http request option.
|
|
706
706
|
* @throws {RequiredError}
|
|
707
707
|
*/
|
|
@@ -815,16 +815,16 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
815
815
|
return localVarFp.getPartnerAccount(code, authorization, options).then((request) => request(axios, basePath));
|
|
816
816
|
},
|
|
817
817
|
/**
|
|
818
|
-
* Returns a list of partners you have previously created.
|
|
818
|
+
* 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\"
|
|
819
819
|
* @summary List partners
|
|
820
820
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
821
821
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
822
822
|
* @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.
|
|
823
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
823
|
+
* @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>
|
|
824
824
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
825
825
|
* @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>
|
|
826
826
|
* @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>
|
|
827
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
827
|
+
* @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>
|
|
828
828
|
* @param {*} [options] Override http request option.
|
|
829
829
|
* @throws {RequiredError}
|
|
830
830
|
*/
|
|
@@ -832,17 +832,17 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
832
832
|
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
833
833
|
},
|
|
834
834
|
/**
|
|
835
|
-
* Returns a list of grouped relations for partner you have previously created.
|
|
835
|
+
* 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\"
|
|
836
836
|
* @summary List grouped relations for partner
|
|
837
837
|
* @param {string} code
|
|
838
838
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
839
839
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
840
840
|
* @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.
|
|
841
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
841
|
+
* @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>
|
|
842
842
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
843
843
|
* @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>
|
|
844
844
|
* @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>
|
|
845
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
845
|
+
* @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>
|
|
846
846
|
* @param {*} [options] Override http request option.
|
|
847
847
|
* @throws {RequiredError}
|
|
848
848
|
*/
|
|
@@ -1028,7 +1028,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
1028
1028
|
readonly pageToken?: string
|
|
1029
1029
|
|
|
1030
1030
|
/**
|
|
1031
|
-
* Filter the response by one or multiple fields.
|
|
1031
|
+
* 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>
|
|
1032
1032
|
* @type {string}
|
|
1033
1033
|
* @memberof PartnersApiListPartners
|
|
1034
1034
|
*/
|
|
@@ -1056,7 +1056,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
1056
1056
|
readonly expand?: string
|
|
1057
1057
|
|
|
1058
1058
|
/**
|
|
1059
|
-
* Filters the response by one or multiple fields.
|
|
1059
|
+
* 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>
|
|
1060
1060
|
* @type {string}
|
|
1061
1061
|
* @memberof PartnersApiListPartners
|
|
1062
1062
|
*/
|
|
@@ -1098,7 +1098,7 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
1098
1098
|
readonly pageToken?: string
|
|
1099
1099
|
|
|
1100
1100
|
/**
|
|
1101
|
-
* Filter the response by one or multiple fields.
|
|
1101
|
+
* 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>
|
|
1102
1102
|
* @type {string}
|
|
1103
1103
|
* @memberof PartnersApiListRelationsForPartner
|
|
1104
1104
|
*/
|
|
@@ -1126,7 +1126,7 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
1126
1126
|
readonly expand?: string
|
|
1127
1127
|
|
|
1128
1128
|
/**
|
|
1129
|
-
* Filters the response by one or multiple fields.
|
|
1129
|
+
* 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>
|
|
1130
1130
|
* @type {string}
|
|
1131
1131
|
* @memberof PartnersApiListRelationsForPartner
|
|
1132
1132
|
*/
|
|
@@ -1285,7 +1285,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
1285
1285
|
}
|
|
1286
1286
|
|
|
1287
1287
|
/**
|
|
1288
|
-
* Returns a list of partners you have previously created.
|
|
1288
|
+
* 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\"
|
|
1289
1289
|
* @summary List partners
|
|
1290
1290
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
1291
1291
|
* @param {*} [options] Override http request option.
|
|
@@ -1297,7 +1297,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
1297
1297
|
}
|
|
1298
1298
|
|
|
1299
1299
|
/**
|
|
1300
|
-
* Returns a list of grouped relations for partner you have previously created.
|
|
1300
|
+
* 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\"
|
|
1301
1301
|
* @summary List grouped relations for partner
|
|
1302
1302
|
* @param {PartnersApiListRelationsForPartnerRequest} requestParameters Request parameters.
|
|
1303
1303
|
* @param {*} [options] Override http request option.
|