@emilgroup/partner-sdk 1.13.1-beta.2 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/partner-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
|
@@ -20,7 +20,7 @@ import { InvitePartnerToEisResponseClass } from '../models';
|
|
|
20
20
|
*/
|
|
21
21
|
export declare const PartnerInvitationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
22
|
/**
|
|
23
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
23
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
24
24
|
* @summary Create the Partner Invitation
|
|
25
25
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
26
26
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -35,7 +35,7 @@ export declare const PartnerInvitationsApiAxiosParamCreator: (configuration?: Co
|
|
|
35
35
|
*/
|
|
36
36
|
export declare const PartnerInvitationsApiFp: (configuration?: Configuration) => {
|
|
37
37
|
/**
|
|
38
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
38
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
39
39
|
* @summary Create the Partner Invitation
|
|
40
40
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -50,7 +50,7 @@ export declare const PartnerInvitationsApiFp: (configuration?: Configuration) =>
|
|
|
50
50
|
*/
|
|
51
51
|
export declare const PartnerInvitationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
52
52
|
/**
|
|
53
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
53
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
54
54
|
* @summary Create the Partner Invitation
|
|
55
55
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
56
56
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -86,7 +86,7 @@ export interface PartnerInvitationsApiInvitePartnerToEISRequest {
|
|
|
86
86
|
*/
|
|
87
87
|
export declare class PartnerInvitationsApi extends BaseAPI {
|
|
88
88
|
/**
|
|
89
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
89
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
90
90
|
* @summary Create the Partner Invitation
|
|
91
91
|
* @param {PartnerInvitationsApiInvitePartnerToEISRequest} requestParameters Request parameters.
|
|
92
92
|
* @param {*} [options] Override http request option.
|
|
@@ -93,7 +93,7 @@ var PartnerInvitationsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
96
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
97
97
|
* @summary Create the Partner Invitation
|
|
98
98
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -152,7 +152,7 @@ var PartnerInvitationsApiFp = function (configuration) {
|
|
|
152
152
|
var localVarAxiosParamCreator = (0, exports.PartnerInvitationsApiAxiosParamCreator)(configuration);
|
|
153
153
|
return {
|
|
154
154
|
/**
|
|
155
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
155
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
156
156
|
* @summary Create the Partner Invitation
|
|
157
157
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
158
158
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -183,7 +183,7 @@ var PartnerInvitationsApiFactory = function (configuration, basePath, axios) {
|
|
|
183
183
|
var localVarFp = (0, exports.PartnerInvitationsApiFp)(configuration);
|
|
184
184
|
return {
|
|
185
185
|
/**
|
|
186
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
186
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
187
187
|
* @summary Create the Partner Invitation
|
|
188
188
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
189
189
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -208,7 +208,7 @@ var PartnerInvitationsApi = /** @class */ (function (_super) {
|
|
|
208
208
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
209
209
|
}
|
|
210
210
|
/**
|
|
211
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
211
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
212
212
|
* @summary Create the Partner Invitation
|
|
213
213
|
* @param {PartnerInvitationsApiInvitePartnerToEISRequest} requestParameters Request parameters.
|
|
214
214
|
* @param {*} [options] Override http request option.
|
|
@@ -26,7 +26,7 @@ import { UpdatePartnerRelationRequestDtoRest } from '../models';
|
|
|
26
26
|
*/
|
|
27
27
|
export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
28
|
/**
|
|
29
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
29
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
30
30
|
* @summary Create the partner relation
|
|
31
31
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
32
32
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -35,7 +35,7 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
35
35
|
*/
|
|
36
36
|
createPartnerRelation: (createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
38
|
+
* 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\"
|
|
39
39
|
* @summary Delete the partner-relation
|
|
40
40
|
* @param {number} id
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -44,7 +44,7 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
44
44
|
*/
|
|
45
45
|
deletePartnerRelation: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
* Retrieve a single partner relation identified by its id
|
|
47
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
48
48
|
* @summary Retrieve the partner relation
|
|
49
49
|
* @param {number} id Id of the partner relation
|
|
50
50
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -53,7 +53,7 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
53
53
|
*/
|
|
54
54
|
getPartnerRelation: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
56
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
57
57
|
* @summary Retrieve the partner relation type
|
|
58
58
|
* @param {string} slug Identifying slug of the partner relation type
|
|
59
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -62,37 +62,37 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
62
62
|
*/
|
|
63
63
|
getPartnerRelationType: (slug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
64
|
/**
|
|
65
|
-
* List all partner relation types - is used to create partner relations
|
|
65
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
66
66
|
* @summary List partner relation types
|
|
67
67
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
68
|
-
* @param {
|
|
69
|
-
* @param {
|
|
68
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
69
|
+
* @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.
|
|
70
70
|
* @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>
|
|
71
|
-
* @param {
|
|
71
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
72
|
* @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>
|
|
73
73
|
* @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/>
|
|
74
74
|
* @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>
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
77
77
|
*/
|
|
78
|
-
listPartnerRelationTypes: (authorization?: string, pageSize?:
|
|
78
|
+
listPartnerRelationTypes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
79
|
/**
|
|
80
|
-
* List all partner relations
|
|
80
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
81
81
|
* @summary List partner relations
|
|
82
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
|
-
* @param {
|
|
84
|
-
* @param {
|
|
83
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
84
|
+
* @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.
|
|
85
85
|
* @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>
|
|
86
|
-
* @param {
|
|
86
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
87
87
|
* @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>
|
|
88
88
|
* @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>
|
|
89
89
|
* @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>
|
|
90
90
|
* @param {*} [options] Override http request option.
|
|
91
91
|
* @throws {RequiredError}
|
|
92
92
|
*/
|
|
93
|
-
listPartnerRelations: (authorization?: string, pageSize?:
|
|
93
|
+
listPartnerRelations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
94
|
/**
|
|
95
|
-
* Update a partner relation identified by its id
|
|
95
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
96
96
|
* @summary Update the partner relation
|
|
97
97
|
* @param {number} id Id of the partner relation
|
|
98
98
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -108,7 +108,7 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
108
108
|
*/
|
|
109
109
|
export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
110
110
|
/**
|
|
111
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
111
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
112
112
|
* @summary Create the partner relation
|
|
113
113
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
114
114
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -117,7 +117,7 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
117
117
|
*/
|
|
118
118
|
createPartnerRelation(createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerRelationResponseClass>>;
|
|
119
119
|
/**
|
|
120
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
120
|
+
* 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\"
|
|
121
121
|
* @summary Delete the partner-relation
|
|
122
122
|
* @param {number} id
|
|
123
123
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -126,7 +126,7 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
126
126
|
*/
|
|
127
127
|
deletePartnerRelation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
128
128
|
/**
|
|
129
|
-
* Retrieve a single partner relation identified by its id
|
|
129
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
130
130
|
* @summary Retrieve the partner relation
|
|
131
131
|
* @param {number} id Id of the partner relation
|
|
132
132
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -135,7 +135,7 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
135
135
|
*/
|
|
136
136
|
getPartnerRelation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationClass>>;
|
|
137
137
|
/**
|
|
138
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
138
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
139
139
|
* @summary Retrieve the partner relation type
|
|
140
140
|
* @param {string} slug Identifying slug of the partner relation type
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -144,37 +144,37 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
144
144
|
*/
|
|
145
145
|
getPartnerRelationType(slug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationTypeClass>>;
|
|
146
146
|
/**
|
|
147
|
-
* List all partner relation types - is used to create partner relations
|
|
147
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
148
148
|
* @summary List partner relation types
|
|
149
149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
|
-
* @param {
|
|
151
|
-
* @param {
|
|
150
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
151
|
+
* @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.
|
|
152
152
|
* @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>
|
|
153
|
-
* @param {
|
|
153
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
154
154
|
* @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>
|
|
155
155
|
* @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/>
|
|
156
156
|
* @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>
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
159
159
|
*/
|
|
160
|
-
listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
160
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>>;
|
|
161
161
|
/**
|
|
162
|
-
* List all partner relations
|
|
162
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
163
163
|
* @summary List partner relations
|
|
164
164
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
165
|
-
* @param {
|
|
166
|
-
* @param {
|
|
165
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
166
|
+
* @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.
|
|
167
167
|
* @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>
|
|
168
|
-
* @param {
|
|
168
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
169
169
|
* @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>
|
|
170
170
|
* @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>
|
|
171
171
|
* @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>
|
|
172
172
|
* @param {*} [options] Override http request option.
|
|
173
173
|
* @throws {RequiredError}
|
|
174
174
|
*/
|
|
175
|
-
listPartnerRelations(authorization?: string, pageSize?:
|
|
175
|
+
listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationClass>>;
|
|
176
176
|
/**
|
|
177
|
-
* Update a partner relation identified by its id
|
|
177
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
178
178
|
* @summary Update the partner relation
|
|
179
179
|
* @param {number} id Id of the partner relation
|
|
180
180
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -190,7 +190,7 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
190
190
|
*/
|
|
191
191
|
export declare const PartnerRelationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
192
192
|
/**
|
|
193
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
193
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
194
194
|
* @summary Create the partner relation
|
|
195
195
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
196
196
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -199,7 +199,7 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
199
199
|
*/
|
|
200
200
|
createPartnerRelation(createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: any): AxiosPromise<CreatePartnerRelationResponseClass>;
|
|
201
201
|
/**
|
|
202
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
202
|
+
* 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\"
|
|
203
203
|
* @summary Delete the partner-relation
|
|
204
204
|
* @param {number} id
|
|
205
205
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -208,7 +208,7 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
208
208
|
*/
|
|
209
209
|
deletePartnerRelation(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
210
210
|
/**
|
|
211
|
-
* Retrieve a single partner relation identified by its id
|
|
211
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
212
212
|
* @summary Retrieve the partner relation
|
|
213
213
|
* @param {number} id Id of the partner relation
|
|
214
214
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -217,7 +217,7 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
217
217
|
*/
|
|
218
218
|
getPartnerRelation(id: number, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationClass>;
|
|
219
219
|
/**
|
|
220
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
220
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
221
221
|
* @summary Retrieve the partner relation type
|
|
222
222
|
* @param {string} slug Identifying slug of the partner relation type
|
|
223
223
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -226,37 +226,37 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
226
226
|
*/
|
|
227
227
|
getPartnerRelationType(slug: string, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationTypeClass>;
|
|
228
228
|
/**
|
|
229
|
-
* List all partner relation types - is used to create partner relations
|
|
229
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
230
230
|
* @summary List partner relation types
|
|
231
231
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
232
|
-
* @param {
|
|
233
|
-
* @param {
|
|
232
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
233
|
+
* @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.
|
|
234
234
|
* @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>
|
|
235
|
-
* @param {
|
|
235
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
236
236
|
* @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>
|
|
237
237
|
* @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/>
|
|
238
238
|
* @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>
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
240
240
|
* @throws {RequiredError}
|
|
241
241
|
*/
|
|
242
|
-
listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
242
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass>;
|
|
243
243
|
/**
|
|
244
|
-
* List all partner relations
|
|
244
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
245
245
|
* @summary List partner relations
|
|
246
246
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
247
|
-
* @param {
|
|
248
|
-
* @param {
|
|
247
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
|
+
* @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.
|
|
249
249
|
* @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>
|
|
250
|
-
* @param {
|
|
250
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
251
251
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
252
252
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
253
253
|
* @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>
|
|
254
254
|
* @param {*} [options] Override http request option.
|
|
255
255
|
* @throws {RequiredError}
|
|
256
256
|
*/
|
|
257
|
-
listPartnerRelations(authorization?: string, pageSize?:
|
|
257
|
+
listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass>;
|
|
258
258
|
/**
|
|
259
|
-
* Update a partner relation identified by its id
|
|
259
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
260
260
|
* @summary Update the partner relation
|
|
261
261
|
* @param {number} id Id of the partner relation
|
|
262
262
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -356,16 +356,16 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
356
356
|
readonly authorization?: string;
|
|
357
357
|
/**
|
|
358
358
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
359
|
-
* @type {
|
|
359
|
+
* @type {number}
|
|
360
360
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
361
361
|
*/
|
|
362
|
-
readonly pageSize?:
|
|
362
|
+
readonly pageSize?: number;
|
|
363
363
|
/**
|
|
364
|
-
* 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,
|
|
365
|
-
* @type {
|
|
364
|
+
* 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.
|
|
365
|
+
* @type {string}
|
|
366
366
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
367
367
|
*/
|
|
368
|
-
readonly pageToken?:
|
|
368
|
+
readonly pageToken?: string;
|
|
369
369
|
/**
|
|
370
370
|
* 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>
|
|
371
371
|
* @type {string}
|
|
@@ -374,10 +374,10 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
374
374
|
readonly filter?: string;
|
|
375
375
|
/**
|
|
376
376
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
377
|
-
* @type {
|
|
377
|
+
* @type {string}
|
|
378
378
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
379
379
|
*/
|
|
380
|
-
readonly search?:
|
|
380
|
+
readonly search?: string;
|
|
381
381
|
/**
|
|
382
382
|
* 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>
|
|
383
383
|
* @type {string}
|
|
@@ -411,16 +411,16 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
411
411
|
readonly authorization?: string;
|
|
412
412
|
/**
|
|
413
413
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
414
|
-
* @type {
|
|
414
|
+
* @type {number}
|
|
415
415
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
416
416
|
*/
|
|
417
|
-
readonly pageSize?:
|
|
417
|
+
readonly pageSize?: number;
|
|
418
418
|
/**
|
|
419
|
-
* 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,
|
|
420
|
-
* @type {
|
|
419
|
+
* 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.
|
|
420
|
+
* @type {string}
|
|
421
421
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
422
422
|
*/
|
|
423
|
-
readonly pageToken?:
|
|
423
|
+
readonly pageToken?: string;
|
|
424
424
|
/**
|
|
425
425
|
* 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>
|
|
426
426
|
* @type {string}
|
|
@@ -429,10 +429,10 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
429
429
|
readonly filter?: string;
|
|
430
430
|
/**
|
|
431
431
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
432
|
-
* @type {
|
|
432
|
+
* @type {string}
|
|
433
433
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
434
434
|
*/
|
|
435
|
-
readonly search?:
|
|
435
|
+
readonly search?: string;
|
|
436
436
|
/**
|
|
437
437
|
* 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>
|
|
438
438
|
* @type {string}
|
|
@@ -485,7 +485,7 @@ export interface PartnerRelationsApiUpdatePartnerRelationRequest {
|
|
|
485
485
|
*/
|
|
486
486
|
export declare class PartnerRelationsApi extends BaseAPI {
|
|
487
487
|
/**
|
|
488
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
488
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
489
489
|
* @summary Create the partner relation
|
|
490
490
|
* @param {PartnerRelationsApiCreatePartnerRelationRequest} requestParameters Request parameters.
|
|
491
491
|
* @param {*} [options] Override http request option.
|
|
@@ -494,7 +494,7 @@ export declare class PartnerRelationsApi extends BaseAPI {
|
|
|
494
494
|
*/
|
|
495
495
|
createPartnerRelation(requestParameters: PartnerRelationsApiCreatePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerRelationResponseClass, any>>;
|
|
496
496
|
/**
|
|
497
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
497
|
+
* 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\"
|
|
498
498
|
* @summary Delete the partner-relation
|
|
499
499
|
* @param {PartnerRelationsApiDeletePartnerRelationRequest} requestParameters Request parameters.
|
|
500
500
|
* @param {*} [options] Override http request option.
|
|
@@ -503,7 +503,7 @@ export declare class PartnerRelationsApi extends BaseAPI {
|
|
|
503
503
|
*/
|
|
504
504
|
deletePartnerRelation(requestParameters: PartnerRelationsApiDeletePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
505
505
|
/**
|
|
506
|
-
* Retrieve a single partner relation identified by its id
|
|
506
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
507
507
|
* @summary Retrieve the partner relation
|
|
508
508
|
* @param {PartnerRelationsApiGetPartnerRelationRequest} requestParameters Request parameters.
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
@@ -512,7 +512,7 @@ export declare class PartnerRelationsApi extends BaseAPI {
|
|
|
512
512
|
*/
|
|
513
513
|
getPartnerRelation(requestParameters: PartnerRelationsApiGetPartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationClass, any>>;
|
|
514
514
|
/**
|
|
515
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
515
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
516
516
|
* @summary Retrieve the partner relation type
|
|
517
517
|
* @param {PartnerRelationsApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
|
|
518
518
|
* @param {*} [options] Override http request option.
|
|
@@ -521,7 +521,7 @@ export declare class PartnerRelationsApi extends BaseAPI {
|
|
|
521
521
|
*/
|
|
522
522
|
getPartnerRelationType(requestParameters: PartnerRelationsApiGetPartnerRelationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationTypeClass, any>>;
|
|
523
523
|
/**
|
|
524
|
-
* List all partner relation types - is used to create partner relations
|
|
524
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
525
525
|
* @summary List partner relation types
|
|
526
526
|
* @param {PartnerRelationsApiListPartnerRelationTypesRequest} requestParameters Request parameters.
|
|
527
527
|
* @param {*} [options] Override http request option.
|
|
@@ -530,7 +530,7 @@ export declare class PartnerRelationsApi extends BaseAPI {
|
|
|
530
530
|
*/
|
|
531
531
|
listPartnerRelationTypes(requestParameters?: PartnerRelationsApiListPartnerRelationTypesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRelationTypesClass, any>>;
|
|
532
532
|
/**
|
|
533
|
-
* List all partner relations
|
|
533
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
534
534
|
* @summary List partner relations
|
|
535
535
|
* @param {PartnerRelationsApiListPartnerRelationsRequest} requestParameters Request parameters.
|
|
536
536
|
* @param {*} [options] Override http request option.
|
|
@@ -539,7 +539,7 @@ export declare class PartnerRelationsApi extends BaseAPI {
|
|
|
539
539
|
*/
|
|
540
540
|
listPartnerRelations(requestParameters?: PartnerRelationsApiListPartnerRelationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRelationClass, any>>;
|
|
541
541
|
/**
|
|
542
|
-
* Update a partner relation identified by its id
|
|
542
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
543
543
|
* @summary Update the partner relation
|
|
544
544
|
* @param {PartnerRelationsApiUpdatePartnerRelationRequest} requestParameters Request parameters.
|
|
545
545
|
* @param {*} [options] Override http request option.
|