@emilgroup/partner-sdk-node 1.13.1-beta.2 → 1.13.1-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/partner-invitations-api.ts +4 -4
- package/api/partner-relations-api.ts +66 -66
- package/api/partner-tags-api.ts +43 -43
- package/api/partner-types-api.ts +60 -60
- package/api/partner-versions-api.ts +27 -27
- package/api/partners-api.ts +66 -66
- package/dist/api/partner-invitations-api.d.ts +4 -4
- package/dist/api/partner-invitations-api.js +4 -4
- package/dist/api/partner-relations-api.d.ts +66 -66
- package/dist/api/partner-relations-api.js +46 -46
- package/dist/api/partner-tags-api.d.ts +43 -43
- package/dist/api/partner-tags-api.js +32 -32
- package/dist/api/partner-types-api.d.ts +60 -60
- package/dist/api/partner-types-api.js +41 -41
- package/dist/api/partner-versions-api.d.ts +27 -27
- package/dist/api/partner-versions-api.js +17 -17
- package/dist/api/partners-api.d.ts +66 -66
- package/dist/api/partners-api.js +46 -46
- package/package.json +1 -1
|
@@ -97,7 +97,7 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
100
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
101
101
|
* @summary Create the partner relation
|
|
102
102
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
103
103
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -146,7 +146,7 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
149
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
150
150
|
* @summary Delete the partner-relation
|
|
151
151
|
* @param {number} id
|
|
152
152
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -194,7 +194,7 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
194
194
|
});
|
|
195
195
|
},
|
|
196
196
|
/**
|
|
197
|
-
* Retrieve a single partner relation identified by its id
|
|
197
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
198
198
|
* @summary Retrieve the partner relation
|
|
199
199
|
* @param {number} id Id of the partner relation
|
|
200
200
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -242,7 +242,7 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
242
242
|
});
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
245
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
245
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
246
246
|
* @summary Retrieve the partner relation type
|
|
247
247
|
* @param {string} slug Identifying slug of the partner relation type
|
|
248
248
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -290,13 +290,13 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
290
290
|
});
|
|
291
291
|
},
|
|
292
292
|
/**
|
|
293
|
-
* List all partner relation types - is used to create partner relations
|
|
293
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
294
294
|
* @summary List partner relation types
|
|
295
295
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
296
|
-
* @param {
|
|
297
|
-
* @param {
|
|
296
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
297
|
+
* @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.
|
|
298
298
|
* @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>
|
|
299
|
-
* @param {
|
|
299
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
300
300
|
* @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>
|
|
301
301
|
* @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/>
|
|
302
302
|
* @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>
|
|
@@ -362,13 +362,13 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
362
362
|
});
|
|
363
363
|
},
|
|
364
364
|
/**
|
|
365
|
-
* List all partner relations
|
|
365
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
366
366
|
* @summary List partner relations
|
|
367
367
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
368
|
-
* @param {
|
|
369
|
-
* @param {
|
|
368
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
369
|
+
* @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.
|
|
370
370
|
* @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>
|
|
371
|
-
* @param {
|
|
371
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
372
372
|
* @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>
|
|
373
373
|
* @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>
|
|
374
374
|
* @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>
|
|
@@ -434,7 +434,7 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
434
434
|
});
|
|
435
435
|
},
|
|
436
436
|
/**
|
|
437
|
-
* Update a partner relation identified by its id
|
|
437
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
438
438
|
* @summary Update the partner relation
|
|
439
439
|
* @param {number} id Id of the partner relation
|
|
440
440
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -497,7 +497,7 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
497
497
|
var localVarAxiosParamCreator = (0, exports.PartnerRelationsApiAxiosParamCreator)(configuration);
|
|
498
498
|
return {
|
|
499
499
|
/**
|
|
500
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
500
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
501
501
|
* @summary Create the partner relation
|
|
502
502
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
503
503
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -518,7 +518,7 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
518
518
|
});
|
|
519
519
|
},
|
|
520
520
|
/**
|
|
521
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
521
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
522
522
|
* @summary Delete the partner-relation
|
|
523
523
|
* @param {number} id
|
|
524
524
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -539,7 +539,7 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
539
539
|
});
|
|
540
540
|
},
|
|
541
541
|
/**
|
|
542
|
-
* Retrieve a single partner relation identified by its id
|
|
542
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
543
543
|
* @summary Retrieve the partner relation
|
|
544
544
|
* @param {number} id Id of the partner relation
|
|
545
545
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -560,7 +560,7 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
560
560
|
});
|
|
561
561
|
},
|
|
562
562
|
/**
|
|
563
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
563
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
564
564
|
* @summary Retrieve the partner relation type
|
|
565
565
|
* @param {string} slug Identifying slug of the partner relation type
|
|
566
566
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -581,13 +581,13 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
581
581
|
});
|
|
582
582
|
},
|
|
583
583
|
/**
|
|
584
|
-
* List all partner relation types - is used to create partner relations
|
|
584
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
585
585
|
* @summary List partner relation types
|
|
586
586
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
587
|
-
* @param {
|
|
588
|
-
* @param {
|
|
587
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
588
|
+
* @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.
|
|
589
589
|
* @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>
|
|
590
|
-
* @param {
|
|
590
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
591
591
|
* @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>
|
|
592
592
|
* @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/>
|
|
593
593
|
* @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>
|
|
@@ -608,13 +608,13 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
608
608
|
});
|
|
609
609
|
},
|
|
610
610
|
/**
|
|
611
|
-
* List all partner relations
|
|
611
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
612
612
|
* @summary List partner relations
|
|
613
613
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
614
|
-
* @param {
|
|
615
|
-
* @param {
|
|
614
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
615
|
+
* @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.
|
|
616
616
|
* @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>
|
|
617
|
-
* @param {
|
|
617
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
618
618
|
* @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>
|
|
619
619
|
* @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>
|
|
620
620
|
* @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>
|
|
@@ -635,7 +635,7 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
635
635
|
});
|
|
636
636
|
},
|
|
637
637
|
/**
|
|
638
|
-
* Update a partner relation identified by its id
|
|
638
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
639
639
|
* @summary Update the partner relation
|
|
640
640
|
* @param {number} id Id of the partner relation
|
|
641
641
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -667,7 +667,7 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
667
667
|
var localVarFp = (0, exports.PartnerRelationsApiFp)(configuration);
|
|
668
668
|
return {
|
|
669
669
|
/**
|
|
670
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
670
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
671
671
|
* @summary Create the partner relation
|
|
672
672
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
673
673
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -678,7 +678,7 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
678
678
|
return localVarFp.createPartnerRelation(createPartnerRelationRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
679
679
|
},
|
|
680
680
|
/**
|
|
681
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
681
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
682
682
|
* @summary Delete the partner-relation
|
|
683
683
|
* @param {number} id
|
|
684
684
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -689,7 +689,7 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
689
689
|
return localVarFp.deletePartnerRelation(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
690
690
|
},
|
|
691
691
|
/**
|
|
692
|
-
* Retrieve a single partner relation identified by its id
|
|
692
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
693
693
|
* @summary Retrieve the partner relation
|
|
694
694
|
* @param {number} id Id of the partner relation
|
|
695
695
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -700,7 +700,7 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
700
700
|
return localVarFp.getPartnerRelation(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
701
701
|
},
|
|
702
702
|
/**
|
|
703
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
703
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
704
704
|
* @summary Retrieve the partner relation type
|
|
705
705
|
* @param {string} slug Identifying slug of the partner relation type
|
|
706
706
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -711,13 +711,13 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
711
711
|
return localVarFp.getPartnerRelationType(slug, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
712
712
|
},
|
|
713
713
|
/**
|
|
714
|
-
* List all partner relation types - is used to create partner relations
|
|
714
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
715
715
|
* @summary List partner relation types
|
|
716
716
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
717
|
-
* @param {
|
|
718
|
-
* @param {
|
|
717
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
718
|
+
* @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.
|
|
719
719
|
* @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>
|
|
720
|
-
* @param {
|
|
720
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
721
721
|
* @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>
|
|
722
722
|
* @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/>
|
|
723
723
|
* @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>
|
|
@@ -728,13 +728,13 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
728
728
|
return localVarFp.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
729
729
|
},
|
|
730
730
|
/**
|
|
731
|
-
* List all partner relations
|
|
731
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
732
732
|
* @summary List partner relations
|
|
733
733
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
734
|
-
* @param {
|
|
735
|
-
* @param {
|
|
734
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
735
|
+
* @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.
|
|
736
736
|
* @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>
|
|
737
|
-
* @param {
|
|
737
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
738
738
|
* @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>
|
|
739
739
|
* @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>
|
|
740
740
|
* @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>
|
|
@@ -745,7 +745,7 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
745
745
|
return localVarFp.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
746
746
|
},
|
|
747
747
|
/**
|
|
748
|
-
* Update a partner relation identified by its id
|
|
748
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
749
749
|
* @summary Update the partner relation
|
|
750
750
|
* @param {number} id Id of the partner relation
|
|
751
751
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -771,7 +771,7 @@ var PartnerRelationsApi = /** @class */ (function (_super) {
|
|
|
771
771
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
772
772
|
}
|
|
773
773
|
/**
|
|
774
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
774
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
775
775
|
* @summary Create the partner relation
|
|
776
776
|
* @param {PartnerRelationsApiCreatePartnerRelationRequest} requestParameters Request parameters.
|
|
777
777
|
* @param {*} [options] Override http request option.
|
|
@@ -783,7 +783,7 @@ var PartnerRelationsApi = /** @class */ (function (_super) {
|
|
|
783
783
|
return (0, exports.PartnerRelationsApiFp)(this.configuration).createPartnerRelation(requestParameters.createPartnerRelationRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
784
784
|
};
|
|
785
785
|
/**
|
|
786
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
786
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
787
787
|
* @summary Delete the partner-relation
|
|
788
788
|
* @param {PartnerRelationsApiDeletePartnerRelationRequest} requestParameters Request parameters.
|
|
789
789
|
* @param {*} [options] Override http request option.
|
|
@@ -795,7 +795,7 @@ var PartnerRelationsApi = /** @class */ (function (_super) {
|
|
|
795
795
|
return (0, exports.PartnerRelationsApiFp)(this.configuration).deletePartnerRelation(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
796
796
|
};
|
|
797
797
|
/**
|
|
798
|
-
* Retrieve a single partner relation identified by its id
|
|
798
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
799
799
|
* @summary Retrieve the partner relation
|
|
800
800
|
* @param {PartnerRelationsApiGetPartnerRelationRequest} requestParameters Request parameters.
|
|
801
801
|
* @param {*} [options] Override http request option.
|
|
@@ -807,7 +807,7 @@ var PartnerRelationsApi = /** @class */ (function (_super) {
|
|
|
807
807
|
return (0, exports.PartnerRelationsApiFp)(this.configuration).getPartnerRelation(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
808
808
|
};
|
|
809
809
|
/**
|
|
810
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
810
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
811
811
|
* @summary Retrieve the partner relation type
|
|
812
812
|
* @param {PartnerRelationsApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
|
|
813
813
|
* @param {*} [options] Override http request option.
|
|
@@ -819,7 +819,7 @@ var PartnerRelationsApi = /** @class */ (function (_super) {
|
|
|
819
819
|
return (0, exports.PartnerRelationsApiFp)(this.configuration).getPartnerRelationType(requestParameters.slug, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
820
820
|
};
|
|
821
821
|
/**
|
|
822
|
-
* List all partner relation types - is used to create partner relations
|
|
822
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
823
823
|
* @summary List partner relation types
|
|
824
824
|
* @param {PartnerRelationsApiListPartnerRelationTypesRequest} requestParameters Request parameters.
|
|
825
825
|
* @param {*} [options] Override http request option.
|
|
@@ -832,7 +832,7 @@ var PartnerRelationsApi = /** @class */ (function (_super) {
|
|
|
832
832
|
return (0, exports.PartnerRelationsApiFp)(this.configuration).listPartnerRelationTypes(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
833
833
|
};
|
|
834
834
|
/**
|
|
835
|
-
* List all partner relations
|
|
835
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
836
836
|
* @summary List partner relations
|
|
837
837
|
* @param {PartnerRelationsApiListPartnerRelationsRequest} requestParameters Request parameters.
|
|
838
838
|
* @param {*} [options] Override http request option.
|
|
@@ -845,7 +845,7 @@ var PartnerRelationsApi = /** @class */ (function (_super) {
|
|
|
845
845
|
return (0, exports.PartnerRelationsApiFp)(this.configuration).listPartnerRelations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
846
846
|
};
|
|
847
847
|
/**
|
|
848
|
-
* Update a partner relation identified by its id
|
|
848
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
849
849
|
* @summary Update the partner relation
|
|
850
850
|
* @param {PartnerRelationsApiUpdatePartnerRelationRequest} requestParameters Request parameters.
|
|
851
851
|
* @param {*} [options] Override http request option.
|
|
@@ -24,7 +24,7 @@ import { UpdateTagResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
* This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
|
|
27
|
+
* This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them. **Required Permissions** \"partner-management.partners.create\"
|
|
28
28
|
* @summary Create the partner tag
|
|
29
29
|
* @param {CreateTagRequestDto} createTagRequestDto
|
|
30
30
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -33,16 +33,16 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
|
|
|
33
33
|
*/
|
|
34
34
|
createTag: (createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
|
|
36
|
+
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
37
37
|
* @summary Delete the partner tag
|
|
38
|
-
* @param {string} code
|
|
38
|
+
* @param {string} code Unique identifier for the object.
|
|
39
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
40
40
|
* @param {*} [options] Override http request option.
|
|
41
41
|
* @throws {RequiredError}
|
|
42
42
|
*/
|
|
43
43
|
deleteTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
|
-
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
|
|
45
|
+
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information. **Required Permissions** \"partner-management.partners.view\"
|
|
46
46
|
* @summary Retrieve the partner tag
|
|
47
47
|
* @param {string} code Unique identifier for the object.
|
|
48
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -51,22 +51,22 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
|
|
|
51
51
|
*/
|
|
52
52
|
getTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
* 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.
|
|
54
|
+
* 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\"
|
|
55
55
|
* @summary List partner tags
|
|
56
56
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
57
|
-
* @param {
|
|
58
|
-
* @param {
|
|
57
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
58
|
+
* @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.
|
|
59
59
|
* @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>
|
|
60
|
-
* @param {
|
|
60
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
61
61
|
* @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>
|
|
62
62
|
* @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/>
|
|
63
63
|
* @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>
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
67
|
-
listTags: (authorization?: string, pageSize?:
|
|
67
|
+
listTags: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
|
-
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
69
|
+
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
70
70
|
* @summary Update the partner tag
|
|
71
71
|
* @param {string} code
|
|
72
72
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -81,7 +81,7 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
|
|
|
81
81
|
*/
|
|
82
82
|
export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
|
|
83
83
|
/**
|
|
84
|
-
* This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
|
|
84
|
+
* This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them. **Required Permissions** \"partner-management.partners.create\"
|
|
85
85
|
* @summary Create the partner tag
|
|
86
86
|
* @param {CreateTagRequestDto} createTagRequestDto
|
|
87
87
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -90,16 +90,16 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
|
|
|
90
90
|
*/
|
|
91
91
|
createTag(createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTagResponseClass>>;
|
|
92
92
|
/**
|
|
93
|
-
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
|
|
93
|
+
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
94
94
|
* @summary Delete the partner tag
|
|
95
|
-
* @param {string} code
|
|
95
|
+
* @param {string} code Unique identifier for the object.
|
|
96
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
97
97
|
* @param {*} [options] Override http request option.
|
|
98
98
|
* @throws {RequiredError}
|
|
99
99
|
*/
|
|
100
100
|
deleteTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
101
101
|
/**
|
|
102
|
-
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
|
|
102
|
+
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information. **Required Permissions** \"partner-management.partners.view\"
|
|
103
103
|
* @summary Retrieve the partner tag
|
|
104
104
|
* @param {string} code Unique identifier for the object.
|
|
105
105
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -108,22 +108,22 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
|
|
|
108
108
|
*/
|
|
109
109
|
getTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTagResponseClass>>;
|
|
110
110
|
/**
|
|
111
|
-
* 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.
|
|
111
|
+
* 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\"
|
|
112
112
|
* @summary List partner tags
|
|
113
113
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
114
|
-
* @param {
|
|
115
|
-
* @param {
|
|
114
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
115
|
+
* @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.
|
|
116
116
|
* @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>
|
|
117
|
-
* @param {
|
|
117
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
118
118
|
* @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>
|
|
119
119
|
* @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/>
|
|
120
120
|
* @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>
|
|
121
121
|
* @param {*} [options] Override http request option.
|
|
122
122
|
* @throws {RequiredError}
|
|
123
123
|
*/
|
|
124
|
-
listTags(authorization?: string, pageSize?:
|
|
124
|
+
listTags(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTagsResponseClass>>;
|
|
125
125
|
/**
|
|
126
|
-
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
126
|
+
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
127
127
|
* @summary Update the partner tag
|
|
128
128
|
* @param {string} code
|
|
129
129
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -138,7 +138,7 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
|
|
|
138
138
|
*/
|
|
139
139
|
export declare const PartnerTagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
140
140
|
/**
|
|
141
|
-
* This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
|
|
141
|
+
* This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them. **Required Permissions** \"partner-management.partners.create\"
|
|
142
142
|
* @summary Create the partner tag
|
|
143
143
|
* @param {CreateTagRequestDto} createTagRequestDto
|
|
144
144
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -147,16 +147,16 @@ export declare const PartnerTagsApiFactory: (configuration?: Configuration, base
|
|
|
147
147
|
*/
|
|
148
148
|
createTag(createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTagResponseClass>;
|
|
149
149
|
/**
|
|
150
|
-
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
|
|
150
|
+
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
151
151
|
* @summary Delete the partner tag
|
|
152
|
-
* @param {string} code
|
|
152
|
+
* @param {string} code Unique identifier for the object.
|
|
153
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
154
|
* @param {*} [options] Override http request option.
|
|
155
155
|
* @throws {RequiredError}
|
|
156
156
|
*/
|
|
157
157
|
deleteTag(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
158
158
|
/**
|
|
159
|
-
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
|
|
159
|
+
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information. **Required Permissions** \"partner-management.partners.view\"
|
|
160
160
|
* @summary Retrieve the partner tag
|
|
161
161
|
* @param {string} code Unique identifier for the object.
|
|
162
162
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -165,22 +165,22 @@ export declare const PartnerTagsApiFactory: (configuration?: Configuration, base
|
|
|
165
165
|
*/
|
|
166
166
|
getTag(code: string, authorization?: string, options?: any): AxiosPromise<GetTagResponseClass>;
|
|
167
167
|
/**
|
|
168
|
-
* 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.
|
|
168
|
+
* 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\"
|
|
169
169
|
* @summary List partner tags
|
|
170
170
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
171
|
-
* @param {
|
|
172
|
-
* @param {
|
|
171
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
172
|
+
* @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.
|
|
173
173
|
* @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>
|
|
174
|
-
* @param {
|
|
174
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
175
175
|
* @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>
|
|
176
176
|
* @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/>
|
|
177
177
|
* @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>
|
|
178
178
|
* @param {*} [options] Override http request option.
|
|
179
179
|
* @throws {RequiredError}
|
|
180
180
|
*/
|
|
181
|
-
listTags(authorization?: string, pageSize?:
|
|
181
|
+
listTags(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTagsResponseClass>;
|
|
182
182
|
/**
|
|
183
|
-
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
183
|
+
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
184
184
|
* @summary Update the partner tag
|
|
185
185
|
* @param {string} code
|
|
186
186
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -215,7 +215,7 @@ export interface PartnerTagsApiCreateTagRequest {
|
|
|
215
215
|
*/
|
|
216
216
|
export interface PartnerTagsApiDeleteTagRequest {
|
|
217
217
|
/**
|
|
218
|
-
*
|
|
218
|
+
* Unique identifier for the object.
|
|
219
219
|
* @type {string}
|
|
220
220
|
* @memberof PartnerTagsApiDeleteTag
|
|
221
221
|
*/
|
|
@@ -260,16 +260,16 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
260
260
|
readonly authorization?: string;
|
|
261
261
|
/**
|
|
262
262
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
263
|
-
* @type {
|
|
263
|
+
* @type {number}
|
|
264
264
|
* @memberof PartnerTagsApiListTags
|
|
265
265
|
*/
|
|
266
|
-
readonly pageSize?:
|
|
266
|
+
readonly pageSize?: number;
|
|
267
267
|
/**
|
|
268
|
-
* 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,
|
|
269
|
-
* @type {
|
|
268
|
+
* 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.
|
|
269
|
+
* @type {string}
|
|
270
270
|
* @memberof PartnerTagsApiListTags
|
|
271
271
|
*/
|
|
272
|
-
readonly pageToken?:
|
|
272
|
+
readonly pageToken?: string;
|
|
273
273
|
/**
|
|
274
274
|
* 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>
|
|
275
275
|
* @type {string}
|
|
@@ -278,10 +278,10 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
278
278
|
readonly filter?: string;
|
|
279
279
|
/**
|
|
280
280
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
281
|
-
* @type {
|
|
281
|
+
* @type {string}
|
|
282
282
|
* @memberof PartnerTagsApiListTags
|
|
283
283
|
*/
|
|
284
|
-
readonly search?:
|
|
284
|
+
readonly search?: string;
|
|
285
285
|
/**
|
|
286
286
|
* 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>
|
|
287
287
|
* @type {string}
|
|
@@ -328,7 +328,7 @@ export interface PartnerTagsApiUpdateTagRequest {
|
|
|
328
328
|
*/
|
|
329
329
|
export declare class PartnerTagsApi extends BaseAPI {
|
|
330
330
|
/**
|
|
331
|
-
* This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
|
|
331
|
+
* This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them. **Required Permissions** \"partner-management.partners.create\"
|
|
332
332
|
* @summary Create the partner tag
|
|
333
333
|
* @param {PartnerTagsApiCreateTagRequest} requestParameters Request parameters.
|
|
334
334
|
* @param {*} [options] Override http request option.
|
|
@@ -337,7 +337,7 @@ export declare class PartnerTagsApi extends BaseAPI {
|
|
|
337
337
|
*/
|
|
338
338
|
createTag(requestParameters: PartnerTagsApiCreateTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTagResponseClass, any>>;
|
|
339
339
|
/**
|
|
340
|
-
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
|
|
340
|
+
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
341
341
|
* @summary Delete the partner tag
|
|
342
342
|
* @param {PartnerTagsApiDeleteTagRequest} requestParameters Request parameters.
|
|
343
343
|
* @param {*} [options] Override http request option.
|
|
@@ -346,7 +346,7 @@ export declare class PartnerTagsApi extends BaseAPI {
|
|
|
346
346
|
*/
|
|
347
347
|
deleteTag(requestParameters: PartnerTagsApiDeleteTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
348
348
|
/**
|
|
349
|
-
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
|
|
349
|
+
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information. **Required Permissions** \"partner-management.partners.view\"
|
|
350
350
|
* @summary Retrieve the partner tag
|
|
351
351
|
* @param {PartnerTagsApiGetTagRequest} requestParameters Request parameters.
|
|
352
352
|
* @param {*} [options] Override http request option.
|
|
@@ -355,7 +355,7 @@ export declare class PartnerTagsApi extends BaseAPI {
|
|
|
355
355
|
*/
|
|
356
356
|
getTag(requestParameters: PartnerTagsApiGetTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTagResponseClass, any>>;
|
|
357
357
|
/**
|
|
358
|
-
* 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.
|
|
358
|
+
* 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\"
|
|
359
359
|
* @summary List partner tags
|
|
360
360
|
* @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
|
|
361
361
|
* @param {*} [options] Override http request option.
|
|
@@ -364,7 +364,7 @@ export declare class PartnerTagsApi extends BaseAPI {
|
|
|
364
364
|
*/
|
|
365
365
|
listTags(requestParameters?: PartnerTagsApiListTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTagsResponseClass, any>>;
|
|
366
366
|
/**
|
|
367
|
-
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
367
|
+
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
368
368
|
* @summary Update the partner tag
|
|
369
369
|
* @param {PartnerTagsApiUpdateTagRequest} requestParameters Request parameters.
|
|
370
370
|
* @param {*} [options] Override http request option.
|