@emilgroup/partner-sdk 1.6.0 → 1.6.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +11 -4
- package/README.md +2 -2
- package/api/{partners-api.ts → partner-api.ts} +82 -82
- package/api/partner-invitation-api.ts +165 -0
- package/api/{partner-relations-api.ts → partner-relation-api.ts} +91 -91
- package/api/{partner-tags-api.ts → partner-tag-api.ts} +66 -66
- package/api/{partner-types-api.ts → partner-type-api.ts} +64 -64
- package/api.ts +10 -8
- package/dist/api/{partners-api.d.ts → partner-api.d.ts} +74 -74
- package/dist/api/{partners-api.js → partner-api.js} +49 -49
- package/dist/api/partner-invitation-api.d.ts +97 -0
- package/dist/api/partner-invitation-api.js +224 -0
- package/dist/api/{partner-relations-api.d.ts → partner-relation-api.d.ts} +82 -82
- package/dist/api/{partner-relations-api.js → partner-relation-api.js} +50 -50
- package/dist/api/{partner-tags-api.d.ts → partner-tag-api.d.ts} +59 -59
- package/dist/api/{partner-tags-api.js → partner-tag-api.js} +42 -42
- package/dist/api/{partner-types-api.d.ts → partner-type-api.d.ts} +57 -57
- package/dist/api/{partner-types-api.js → partner-type-api.js} +39 -39
- package/dist/api.d.ts +5 -4
- package/dist/api.js +5 -4
- package/dist/models/create-partner-request-dto.d.ts +1 -1
- package/dist/models/create-partner-response-class.d.ts +7 -0
- package/dist/models/create-partner-type-request-dto.d.ts +3 -2
- package/dist/models/create-tag-request-dto.d.ts +1 -1
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/invite-class.d.ts +79 -0
- package/dist/models/invite-class.js +15 -0
- package/dist/models/invite-partner-to-eis-response-class.d.ts +25 -0
- package/dist/models/invite-partner-to-eis-response-class.js +15 -0
- package/dist/models/invite-partner-to-eisrequest-dto.d.ts +42 -0
- package/dist/models/invite-partner-to-eisrequest-dto.js +15 -0
- package/dist/models/partner-class.d.ts +6 -0
- package/dist/models/partner-type-custom-schema-dto.d.ts +102 -0
- package/dist/models/partner-type-custom-schema-dto.js +15 -0
- package/dist/models/permission-class.d.ts +72 -0
- package/dist/models/permission-class.js +15 -0
- package/dist/models/role-class.d.ts +73 -0
- package/dist/models/role-class.js +15 -0
- package/dist/models/update-partner-type-request-dto.d.ts +3 -2
- package/models/create-partner-request-dto.ts +1 -1
- package/models/create-partner-response-class.ts +7 -0
- package/models/create-partner-type-request-dto.ts +3 -2
- package/models/create-tag-request-dto.ts +1 -1
- package/models/index.ts +6 -0
- package/models/invite-class.ts +85 -0
- package/models/invite-partner-to-eis-response-class.ts +31 -0
- package/models/invite-partner-to-eisrequest-dto.ts +48 -0
- package/models/partner-class.ts +6 -0
- package/models/partner-type-custom-schema-dto.ts +108 -0
- package/models/permission-class.ts +78 -0
- package/models/role-class.ts +79 -0
- package/models/update-partner-type-request-dto.ts +3 -2
- package/package.json +1 -1
|
@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
78
78
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
79
|
};
|
|
80
80
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
-
exports.
|
|
81
|
+
exports.PartnerRelationApi = exports.PartnerRelationApiFactory = exports.PartnerRelationApiFp = exports.PartnerRelationApiAxiosParamCreator = void 0;
|
|
82
82
|
var axios_1 = __importDefault(require("axios"));
|
|
83
83
|
// Some imports not used depending on template conditions
|
|
84
84
|
// @ts-ignore
|
|
@@ -86,10 +86,10 @@ var common_1 = require("../common");
|
|
|
86
86
|
// @ts-ignore
|
|
87
87
|
var base_1 = require("../base");
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* PartnerRelationApi - axios parameter creator
|
|
90
90
|
* @export
|
|
91
91
|
*/
|
|
92
|
-
var
|
|
92
|
+
var PartnerRelationApiAxiosParamCreator = function (configuration) {
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
@@ -294,7 +294,7 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
294
294
|
* @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</i>
|
|
295
295
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
296
296
|
* @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>
|
|
297
|
-
* @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/>
|
|
297
|
+
* @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/>
|
|
298
298
|
* @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</i>
|
|
299
299
|
* @param {*} [options] Override http request option.
|
|
300
300
|
* @throws {RequiredError}
|
|
@@ -484,13 +484,13 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
484
484
|
},
|
|
485
485
|
};
|
|
486
486
|
};
|
|
487
|
-
exports.
|
|
487
|
+
exports.PartnerRelationApiAxiosParamCreator = PartnerRelationApiAxiosParamCreator;
|
|
488
488
|
/**
|
|
489
|
-
*
|
|
489
|
+
* PartnerRelationApi - functional programming interface
|
|
490
490
|
* @export
|
|
491
491
|
*/
|
|
492
|
-
var
|
|
493
|
-
var localVarAxiosParamCreator = (0, exports.
|
|
492
|
+
var PartnerRelationApiFp = function (configuration) {
|
|
493
|
+
var localVarAxiosParamCreator = (0, exports.PartnerRelationApiAxiosParamCreator)(configuration);
|
|
494
494
|
return {
|
|
495
495
|
/**
|
|
496
496
|
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
@@ -585,7 +585,7 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
585
585
|
* @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</i>
|
|
586
586
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
587
587
|
* @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>
|
|
588
|
-
* @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/>
|
|
588
|
+
* @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/>
|
|
589
589
|
* @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</i>
|
|
590
590
|
* @param {*} [options] Override http request option.
|
|
591
591
|
* @throws {RequiredError}
|
|
@@ -654,13 +654,13 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
654
654
|
},
|
|
655
655
|
};
|
|
656
656
|
};
|
|
657
|
-
exports.
|
|
657
|
+
exports.PartnerRelationApiFp = PartnerRelationApiFp;
|
|
658
658
|
/**
|
|
659
|
-
*
|
|
659
|
+
* PartnerRelationApi - factory interface
|
|
660
660
|
* @export
|
|
661
661
|
*/
|
|
662
|
-
var
|
|
663
|
-
var localVarFp = (0, exports.
|
|
662
|
+
var PartnerRelationApiFactory = function (configuration, basePath, axios) {
|
|
663
|
+
var localVarFp = (0, exports.PartnerRelationApiFp)(configuration);
|
|
664
664
|
return {
|
|
665
665
|
/**
|
|
666
666
|
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
@@ -715,7 +715,7 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
715
715
|
* @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</i>
|
|
716
716
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
717
717
|
* @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>
|
|
718
|
-
* @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/>
|
|
718
|
+
* @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/>
|
|
719
719
|
* @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</i>
|
|
720
720
|
* @param {*} [options] Override http request option.
|
|
721
721
|
* @throws {RequiredError}
|
|
@@ -754,104 +754,104 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
754
754
|
},
|
|
755
755
|
};
|
|
756
756
|
};
|
|
757
|
-
exports.
|
|
757
|
+
exports.PartnerRelationApiFactory = PartnerRelationApiFactory;
|
|
758
758
|
/**
|
|
759
|
-
*
|
|
759
|
+
* PartnerRelationApi - object-oriented interface
|
|
760
760
|
* @export
|
|
761
|
-
* @class
|
|
761
|
+
* @class PartnerRelationApi
|
|
762
762
|
* @extends {BaseAPI}
|
|
763
763
|
*/
|
|
764
|
-
var
|
|
765
|
-
__extends(
|
|
766
|
-
function
|
|
764
|
+
var PartnerRelationApi = /** @class */ (function (_super) {
|
|
765
|
+
__extends(PartnerRelationApi, _super);
|
|
766
|
+
function PartnerRelationApi() {
|
|
767
767
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
768
768
|
}
|
|
769
769
|
/**
|
|
770
770
|
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
771
771
|
* @summary Create the partner relation
|
|
772
|
-
* @param {
|
|
772
|
+
* @param {PartnerRelationApiCreatePartnerRelationRequest} requestParameters Request parameters.
|
|
773
773
|
* @param {*} [options] Override http request option.
|
|
774
774
|
* @throws {RequiredError}
|
|
775
|
-
* @memberof
|
|
775
|
+
* @memberof PartnerRelationApi
|
|
776
776
|
*/
|
|
777
|
-
|
|
777
|
+
PartnerRelationApi.prototype.createPartnerRelation = function (requestParameters, options) {
|
|
778
778
|
var _this = this;
|
|
779
|
-
return (0, exports.
|
|
779
|
+
return (0, exports.PartnerRelationApiFp)(this.configuration).createPartnerRelation(requestParameters.createPartnerRelationRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
780
780
|
};
|
|
781
781
|
/**
|
|
782
782
|
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
783
783
|
* @summary Delete the partner-relation
|
|
784
|
-
* @param {
|
|
784
|
+
* @param {PartnerRelationApiDeletePartnerRelationRequest} requestParameters Request parameters.
|
|
785
785
|
* @param {*} [options] Override http request option.
|
|
786
786
|
* @throws {RequiredError}
|
|
787
|
-
* @memberof
|
|
787
|
+
* @memberof PartnerRelationApi
|
|
788
788
|
*/
|
|
789
|
-
|
|
789
|
+
PartnerRelationApi.prototype.deletePartnerRelation = function (requestParameters, options) {
|
|
790
790
|
var _this = this;
|
|
791
|
-
return (0, exports.
|
|
791
|
+
return (0, exports.PartnerRelationApiFp)(this.configuration).deletePartnerRelation(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
792
792
|
};
|
|
793
793
|
/**
|
|
794
794
|
* Retrieve a single partner relation identified by its id
|
|
795
795
|
* @summary Retrieve the partner relation
|
|
796
|
-
* @param {
|
|
796
|
+
* @param {PartnerRelationApiGetPartnerRelationRequest} requestParameters Request parameters.
|
|
797
797
|
* @param {*} [options] Override http request option.
|
|
798
798
|
* @throws {RequiredError}
|
|
799
|
-
* @memberof
|
|
799
|
+
* @memberof PartnerRelationApi
|
|
800
800
|
*/
|
|
801
|
-
|
|
801
|
+
PartnerRelationApi.prototype.getPartnerRelation = function (requestParameters, options) {
|
|
802
802
|
var _this = this;
|
|
803
|
-
return (0, exports.
|
|
803
|
+
return (0, exports.PartnerRelationApiFp)(this.configuration).getPartnerRelation(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
804
804
|
};
|
|
805
805
|
/**
|
|
806
806
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
807
807
|
* @summary Retrieve the partner relation type
|
|
808
|
-
* @param {
|
|
808
|
+
* @param {PartnerRelationApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
|
|
809
809
|
* @param {*} [options] Override http request option.
|
|
810
810
|
* @throws {RequiredError}
|
|
811
|
-
* @memberof
|
|
811
|
+
* @memberof PartnerRelationApi
|
|
812
812
|
*/
|
|
813
|
-
|
|
813
|
+
PartnerRelationApi.prototype.getPartnerRelationType = function (requestParameters, options) {
|
|
814
814
|
var _this = this;
|
|
815
|
-
return (0, exports.
|
|
815
|
+
return (0, exports.PartnerRelationApiFp)(this.configuration).getPartnerRelationType(requestParameters.slug, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
816
816
|
};
|
|
817
817
|
/**
|
|
818
818
|
* List all partner relation types - is used to create partner relations
|
|
819
819
|
* @summary List partner relation types
|
|
820
|
-
* @param {
|
|
820
|
+
* @param {PartnerRelationApiListPartnerRelationTypesRequest} requestParameters Request parameters.
|
|
821
821
|
* @param {*} [options] Override http request option.
|
|
822
822
|
* @throws {RequiredError}
|
|
823
|
-
* @memberof
|
|
823
|
+
* @memberof PartnerRelationApi
|
|
824
824
|
*/
|
|
825
|
-
|
|
825
|
+
PartnerRelationApi.prototype.listPartnerRelationTypes = function (requestParameters, options) {
|
|
826
826
|
var _this = this;
|
|
827
827
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
828
|
-
return (0, exports.
|
|
828
|
+
return (0, exports.PartnerRelationApiFp)(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); });
|
|
829
829
|
};
|
|
830
830
|
/**
|
|
831
831
|
* List all partner relations
|
|
832
832
|
* @summary List partner relations
|
|
833
|
-
* @param {
|
|
833
|
+
* @param {PartnerRelationApiListPartnerRelationsRequest} requestParameters Request parameters.
|
|
834
834
|
* @param {*} [options] Override http request option.
|
|
835
835
|
* @throws {RequiredError}
|
|
836
|
-
* @memberof
|
|
836
|
+
* @memberof PartnerRelationApi
|
|
837
837
|
*/
|
|
838
|
-
|
|
838
|
+
PartnerRelationApi.prototype.listPartnerRelations = function (requestParameters, options) {
|
|
839
839
|
var _this = this;
|
|
840
840
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
841
|
-
return (0, exports.
|
|
841
|
+
return (0, exports.PartnerRelationApiFp)(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); });
|
|
842
842
|
};
|
|
843
843
|
/**
|
|
844
844
|
* Update a partner relation identified by its id
|
|
845
845
|
* @summary Update the partner relation
|
|
846
|
-
* @param {
|
|
846
|
+
* @param {PartnerRelationApiUpdatePartnerRelationRequest} requestParameters Request parameters.
|
|
847
847
|
* @param {*} [options] Override http request option.
|
|
848
848
|
* @throws {RequiredError}
|
|
849
|
-
* @memberof
|
|
849
|
+
* @memberof PartnerRelationApi
|
|
850
850
|
*/
|
|
851
|
-
|
|
851
|
+
PartnerRelationApi.prototype.updatePartnerRelation = function (requestParameters, options) {
|
|
852
852
|
var _this = this;
|
|
853
|
-
return (0, exports.
|
|
853
|
+
return (0, exports.PartnerRelationApiFp)(this.configuration).updatePartnerRelation(requestParameters.id, requestParameters.updatePartnerRelationRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
854
854
|
};
|
|
855
|
-
return
|
|
855
|
+
return PartnerRelationApi;
|
|
856
856
|
}(base_1.BaseAPI));
|
|
857
|
-
exports.
|
|
857
|
+
exports.PartnerRelationApi = PartnerRelationApi;
|
|
@@ -19,10 +19,10 @@ import { GetTagResponseClass } from '../models';
|
|
|
19
19
|
import { ListTagsResponseClass } from '../models';
|
|
20
20
|
import { UpdateTagResponseClass } from '../models';
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* PartnerTagApi - axios parameter creator
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
|
-
export declare const
|
|
25
|
+
export declare const PartnerTagApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
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.
|
|
28
28
|
* @summary Create the partner tag
|
|
@@ -59,7 +59,7 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
|
|
|
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
60
|
* @param {any} [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
|
-
* @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/>
|
|
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}
|
|
@@ -76,10 +76,10 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
|
|
|
76
76
|
updateTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
77
|
};
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
79
|
+
* PartnerTagApi - functional programming interface
|
|
80
80
|
* @export
|
|
81
81
|
*/
|
|
82
|
-
export declare const
|
|
82
|
+
export declare const PartnerTagApiFp: (configuration?: Configuration) => {
|
|
83
83
|
/**
|
|
84
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.
|
|
85
85
|
* @summary Create the partner tag
|
|
@@ -116,7 +116,7 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
|
|
|
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
117
|
* @param {any} [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
|
-
* @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/>
|
|
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}
|
|
@@ -133,10 +133,10 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
|
|
|
133
133
|
updateTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTagResponseClass>>;
|
|
134
134
|
};
|
|
135
135
|
/**
|
|
136
|
-
*
|
|
136
|
+
* PartnerTagApi - factory interface
|
|
137
137
|
* @export
|
|
138
138
|
*/
|
|
139
|
-
export declare const
|
|
139
|
+
export declare const PartnerTagApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
140
140
|
/**
|
|
141
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.
|
|
142
142
|
* @summary Create the partner tag
|
|
@@ -173,7 +173,7 @@ export declare const PartnerTagsApiFactory: (configuration?: Configuration, base
|
|
|
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
174
|
* @param {any} [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
|
-
* @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/>
|
|
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}
|
|
@@ -190,186 +190,186 @@ export declare const PartnerTagsApiFactory: (configuration?: Configuration, base
|
|
|
190
190
|
updateTag(code: string, authorization?: string, options?: any): AxiosPromise<UpdateTagResponseClass>;
|
|
191
191
|
};
|
|
192
192
|
/**
|
|
193
|
-
* Request parameters for createTag operation in
|
|
193
|
+
* Request parameters for createTag operation in PartnerTagApi.
|
|
194
194
|
* @export
|
|
195
|
-
* @interface
|
|
195
|
+
* @interface PartnerTagApiCreateTagRequest
|
|
196
196
|
*/
|
|
197
|
-
export interface
|
|
197
|
+
export interface PartnerTagApiCreateTagRequest {
|
|
198
198
|
/**
|
|
199
199
|
*
|
|
200
200
|
* @type {CreateTagRequestDto}
|
|
201
|
-
* @memberof
|
|
201
|
+
* @memberof PartnerTagApiCreateTag
|
|
202
202
|
*/
|
|
203
203
|
readonly createTagRequestDto: CreateTagRequestDto;
|
|
204
204
|
/**
|
|
205
205
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
206
206
|
* @type {string}
|
|
207
|
-
* @memberof
|
|
207
|
+
* @memberof PartnerTagApiCreateTag
|
|
208
208
|
*/
|
|
209
209
|
readonly authorization?: string;
|
|
210
210
|
}
|
|
211
211
|
/**
|
|
212
|
-
* Request parameters for deleteTag operation in
|
|
212
|
+
* Request parameters for deleteTag operation in PartnerTagApi.
|
|
213
213
|
* @export
|
|
214
|
-
* @interface
|
|
214
|
+
* @interface PartnerTagApiDeleteTagRequest
|
|
215
215
|
*/
|
|
216
|
-
export interface
|
|
216
|
+
export interface PartnerTagApiDeleteTagRequest {
|
|
217
217
|
/**
|
|
218
218
|
*
|
|
219
219
|
* @type {string}
|
|
220
|
-
* @memberof
|
|
220
|
+
* @memberof PartnerTagApiDeleteTag
|
|
221
221
|
*/
|
|
222
222
|
readonly code: string;
|
|
223
223
|
/**
|
|
224
224
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
225
225
|
* @type {string}
|
|
226
|
-
* @memberof
|
|
226
|
+
* @memberof PartnerTagApiDeleteTag
|
|
227
227
|
*/
|
|
228
228
|
readonly authorization?: string;
|
|
229
229
|
}
|
|
230
230
|
/**
|
|
231
|
-
* Request parameters for getTag operation in
|
|
231
|
+
* Request parameters for getTag operation in PartnerTagApi.
|
|
232
232
|
* @export
|
|
233
|
-
* @interface
|
|
233
|
+
* @interface PartnerTagApiGetTagRequest
|
|
234
234
|
*/
|
|
235
|
-
export interface
|
|
235
|
+
export interface PartnerTagApiGetTagRequest {
|
|
236
236
|
/**
|
|
237
237
|
* Unique identifier for the object.
|
|
238
238
|
* @type {string}
|
|
239
|
-
* @memberof
|
|
239
|
+
* @memberof PartnerTagApiGetTag
|
|
240
240
|
*/
|
|
241
241
|
readonly code: string;
|
|
242
242
|
/**
|
|
243
243
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
244
|
* @type {string}
|
|
245
|
-
* @memberof
|
|
245
|
+
* @memberof PartnerTagApiGetTag
|
|
246
246
|
*/
|
|
247
247
|
readonly authorization?: string;
|
|
248
248
|
}
|
|
249
249
|
/**
|
|
250
|
-
* Request parameters for listTags operation in
|
|
250
|
+
* Request parameters for listTags operation in PartnerTagApi.
|
|
251
251
|
* @export
|
|
252
|
-
* @interface
|
|
252
|
+
* @interface PartnerTagApiListTagsRequest
|
|
253
253
|
*/
|
|
254
|
-
export interface
|
|
254
|
+
export interface PartnerTagApiListTagsRequest {
|
|
255
255
|
/**
|
|
256
256
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
257
257
|
* @type {string}
|
|
258
|
-
* @memberof
|
|
258
|
+
* @memberof PartnerTagApiListTags
|
|
259
259
|
*/
|
|
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
263
|
* @type {any}
|
|
264
|
-
* @memberof
|
|
264
|
+
* @memberof PartnerTagApiListTags
|
|
265
265
|
*/
|
|
266
266
|
readonly pageSize?: any;
|
|
267
267
|
/**
|
|
268
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
269
|
* @type {any}
|
|
270
|
-
* @memberof
|
|
270
|
+
* @memberof PartnerTagApiListTags
|
|
271
271
|
*/
|
|
272
272
|
readonly pageToken?: any;
|
|
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}
|
|
276
|
-
* @memberof
|
|
276
|
+
* @memberof PartnerTagApiListTags
|
|
277
277
|
*/
|
|
278
278
|
readonly filter?: string;
|
|
279
279
|
/**
|
|
280
280
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
281
281
|
* @type {any}
|
|
282
|
-
* @memberof
|
|
282
|
+
* @memberof PartnerTagApiListTags
|
|
283
283
|
*/
|
|
284
284
|
readonly search?: any;
|
|
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}
|
|
288
|
-
* @memberof
|
|
288
|
+
* @memberof PartnerTagApiListTags
|
|
289
289
|
*/
|
|
290
290
|
readonly order?: string;
|
|
291
291
|
/**
|
|
292
|
-
* 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/>
|
|
292
|
+
* 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/>
|
|
293
293
|
* @type {string}
|
|
294
|
-
* @memberof
|
|
294
|
+
* @memberof PartnerTagApiListTags
|
|
295
295
|
*/
|
|
296
296
|
readonly expand?: string;
|
|
297
297
|
/**
|
|
298
298
|
* 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>
|
|
299
299
|
* @type {string}
|
|
300
|
-
* @memberof
|
|
300
|
+
* @memberof PartnerTagApiListTags
|
|
301
301
|
*/
|
|
302
302
|
readonly filters?: string;
|
|
303
303
|
}
|
|
304
304
|
/**
|
|
305
|
-
* Request parameters for updateTag operation in
|
|
305
|
+
* Request parameters for updateTag operation in PartnerTagApi.
|
|
306
306
|
* @export
|
|
307
|
-
* @interface
|
|
307
|
+
* @interface PartnerTagApiUpdateTagRequest
|
|
308
308
|
*/
|
|
309
|
-
export interface
|
|
309
|
+
export interface PartnerTagApiUpdateTagRequest {
|
|
310
310
|
/**
|
|
311
311
|
*
|
|
312
312
|
* @type {string}
|
|
313
|
-
* @memberof
|
|
313
|
+
* @memberof PartnerTagApiUpdateTag
|
|
314
314
|
*/
|
|
315
315
|
readonly code: string;
|
|
316
316
|
/**
|
|
317
317
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
318
318
|
* @type {string}
|
|
319
|
-
* @memberof
|
|
319
|
+
* @memberof PartnerTagApiUpdateTag
|
|
320
320
|
*/
|
|
321
321
|
readonly authorization?: string;
|
|
322
322
|
}
|
|
323
323
|
/**
|
|
324
|
-
*
|
|
324
|
+
* PartnerTagApi - object-oriented interface
|
|
325
325
|
* @export
|
|
326
|
-
* @class
|
|
326
|
+
* @class PartnerTagApi
|
|
327
327
|
* @extends {BaseAPI}
|
|
328
328
|
*/
|
|
329
|
-
export declare class
|
|
329
|
+
export declare class PartnerTagApi extends BaseAPI {
|
|
330
330
|
/**
|
|
331
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.
|
|
332
332
|
* @summary Create the partner tag
|
|
333
|
-
* @param {
|
|
333
|
+
* @param {PartnerTagApiCreateTagRequest} requestParameters Request parameters.
|
|
334
334
|
* @param {*} [options] Override http request option.
|
|
335
335
|
* @throws {RequiredError}
|
|
336
|
-
* @memberof
|
|
336
|
+
* @memberof PartnerTagApi
|
|
337
337
|
*/
|
|
338
|
-
createTag(requestParameters:
|
|
338
|
+
createTag(requestParameters: PartnerTagApiCreateTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTagResponseClass, any>>;
|
|
339
339
|
/**
|
|
340
340
|
* Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
|
|
341
341
|
* @summary Delete the partner tag
|
|
342
|
-
* @param {
|
|
342
|
+
* @param {PartnerTagApiDeleteTagRequest} requestParameters Request parameters.
|
|
343
343
|
* @param {*} [options] Override http request option.
|
|
344
344
|
* @throws {RequiredError}
|
|
345
|
-
* @memberof
|
|
345
|
+
* @memberof PartnerTagApi
|
|
346
346
|
*/
|
|
347
|
-
deleteTag(requestParameters:
|
|
347
|
+
deleteTag(requestParameters: PartnerTagApiDeleteTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
348
348
|
/**
|
|
349
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.
|
|
350
350
|
* @summary Retrieve the partner tag
|
|
351
|
-
* @param {
|
|
351
|
+
* @param {PartnerTagApiGetTagRequest} requestParameters Request parameters.
|
|
352
352
|
* @param {*} [options] Override http request option.
|
|
353
353
|
* @throws {RequiredError}
|
|
354
|
-
* @memberof
|
|
354
|
+
* @memberof PartnerTagApi
|
|
355
355
|
*/
|
|
356
|
-
getTag(requestParameters:
|
|
356
|
+
getTag(requestParameters: PartnerTagApiGetTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTagResponseClass, any>>;
|
|
357
357
|
/**
|
|
358
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.
|
|
359
359
|
* @summary List partner tags
|
|
360
|
-
* @param {
|
|
360
|
+
* @param {PartnerTagApiListTagsRequest} requestParameters Request parameters.
|
|
361
361
|
* @param {*} [options] Override http request option.
|
|
362
362
|
* @throws {RequiredError}
|
|
363
|
-
* @memberof
|
|
363
|
+
* @memberof PartnerTagApi
|
|
364
364
|
*/
|
|
365
|
-
listTags(requestParameters?:
|
|
365
|
+
listTags(requestParameters?: PartnerTagApiListTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTagsResponseClass, any>>;
|
|
366
366
|
/**
|
|
367
367
|
* Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
368
368
|
* @summary Update the partner tag
|
|
369
|
-
* @param {
|
|
369
|
+
* @param {PartnerTagApiUpdateTagRequest} requestParameters Request parameters.
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
|
-
* @memberof
|
|
372
|
+
* @memberof PartnerTagApi
|
|
373
373
|
*/
|
|
374
|
-
updateTag(requestParameters:
|
|
374
|
+
updateTag(requestParameters: PartnerTagApiUpdateTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTagResponseClass, any>>;
|
|
375
375
|
}
|