@emilgroup/partner-sdk 1.1.0 → 1.2.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 +14 -1
- package/README.md +2 -2
- package/api/default-api.ts +8 -4
- package/api/partner-relations-api.ts +638 -19
- package/api/partner-tags-api.ts +662 -0
- package/api/partner-version-api.ts +31 -31
- package/api/partners-api.ts +118 -0
- package/api.ts +2 -0
- package/base.ts +5 -1
- package/dist/api/default-api.d.ts +8 -4
- package/dist/api/default-api.js +8 -4
- package/dist/api/partner-relations-api.d.ts +360 -16
- package/dist/api/partner-relations-api.js +513 -8
- package/dist/api/partner-tags-api.d.ts +375 -0
- package/dist/api/partner-tags-api.js +629 -0
- package/dist/api/partner-version-api.d.ts +31 -31
- package/dist/api/partner-version-api.js +16 -16
- package/dist/api/partners-api.d.ts +65 -0
- package/dist/api/partners-api.js +99 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +1 -0
- package/dist/base.js +4 -1
- package/dist/models/create-partner-relation-request-dto-rest.d.ts +65 -0
- package/dist/models/create-partner-relation-request-dto-rest.js +26 -0
- package/dist/models/create-partner-relation-response-class.d.ts +25 -0
- package/dist/models/create-partner-type-request-dto.d.ts +13 -3
- package/dist/models/create-partner-type-request-dto.js +5 -0
- package/dist/models/create-tag-request-dto.d.ts +36 -0
- package/dist/models/create-tag-request-dto.js +15 -0
- package/dist/models/create-tag-response-class.d.ts +25 -0
- package/dist/models/create-tag-response-class.js +15 -0
- package/dist/models/get-partner-relation-class.d.ts +25 -0
- package/dist/models/get-partner-relation-class.js +15 -0
- package/dist/models/get-tag-response-class.d.ts +25 -0
- package/dist/models/get-tag-response-class.js +15 -0
- package/dist/models/index.d.ts +13 -1
- package/dist/models/index.js +13 -1
- package/dist/models/list-partner-relation-class.d.ts +31 -0
- package/dist/models/list-partner-relation-class.js +15 -0
- package/dist/models/list-tags-response-class.d.ts +31 -0
- package/dist/models/list-tags-response-class.js +15 -0
- package/dist/models/partner-class.d.ts +6 -0
- package/dist/models/partner-relation-class.d.ts +72 -0
- package/dist/models/partner-relation-class.js +15 -0
- package/dist/models/partner-type-class.d.ts +11 -0
- package/dist/models/partner-type-class.js +5 -0
- package/dist/models/tag-class.d.ts +54 -0
- package/dist/models/tag-class.js +15 -0
- package/dist/models/tag-partner-request-dto-rest.d.ts +24 -0
- package/dist/models/tag-partner-request-dto-rest.js +15 -0
- package/dist/models/update-partner-relation-request-dto-rest.d.ts +36 -0
- package/dist/models/update-partner-relation-request-dto-rest.js +15 -0
- package/dist/models/update-partner-type-request-dto.d.ts +14 -4
- package/dist/models/update-partner-type-request-dto.js +5 -0
- package/dist/models/update-tag-response-class.d.ts +25 -0
- package/dist/models/update-tag-response-class.js +15 -0
- package/models/create-partner-relation-request-dto-rest.ts +74 -0
- package/models/create-partner-relation-response-class.ts +31 -0
- package/models/create-partner-type-request-dto.ts +16 -3
- package/models/create-tag-request-dto.ts +42 -0
- package/models/create-tag-response-class.ts +31 -0
- package/models/get-partner-relation-class.ts +31 -0
- package/models/get-tag-response-class.ts +31 -0
- package/models/index.ts +13 -1
- package/models/list-partner-relation-class.ts +37 -0
- package/models/list-tags-response-class.ts +37 -0
- package/models/partner-class.ts +6 -0
- package/models/partner-relation-class.ts +78 -0
- package/models/partner-type-class.ts +14 -0
- package/models/tag-class.ts +60 -0
- package/models/tag-partner-request-dto-rest.ts +30 -0
- package/models/update-partner-relation-request-dto-rest.ts +42 -0
- package/models/update-partner-type-request-dto.ts +17 -4
- package/models/update-tag-response-class.ts +31 -0
- package/package.json +1 -1
- package/dist/models/partner-type-custom-schema-dto.d.ts +0 -66
- package/models/partner-type-custom-schema-dto.ts +0 -72
- /package/dist/models/{partner-type-custom-schema-dto.js → create-partner-relation-response-class.js} +0 -0
|
@@ -12,13 +12,46 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePartnerRelationRequestDtoRest } from '../models';
|
|
16
|
+
import { CreatePartnerRelationResponseClass } from '../models';
|
|
17
|
+
import { DeleteResponseClass } from '../models';
|
|
18
|
+
import { GetPartnerRelationClass } from '../models';
|
|
15
19
|
import { GetPartnerRelationTypeClass } from '../models';
|
|
20
|
+
import { ListPartnerRelationClass } from '../models';
|
|
16
21
|
import { ListPartnerRelationTypesClass } from '../models';
|
|
22
|
+
import { UpdatePartnerRelationRequestDtoRest } from '../models';
|
|
17
23
|
/**
|
|
18
24
|
* PartnerRelationsApi - axios parameter creator
|
|
19
25
|
* @export
|
|
20
26
|
*/
|
|
21
27
|
export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
+
/**
|
|
29
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
30
|
+
* @summary Create the partner relation
|
|
31
|
+
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
32
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
createPartnerRelation: (createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
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.
|
|
39
|
+
* @summary Delete the partner-relation
|
|
40
|
+
* @param {number} id
|
|
41
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
deletePartnerRelation: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
+
/**
|
|
47
|
+
* Retrieve a single partner relation identified by its id
|
|
48
|
+
* @summary Retrieve the partner relation
|
|
49
|
+
* @param {number} id Id of the partner relation
|
|
50
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
getPartnerRelation: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22
55
|
/**
|
|
23
56
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
24
57
|
* @summary Retrieve the partner relation type
|
|
@@ -42,13 +75,65 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
42
75
|
* @param {*} [options] Override http request option.
|
|
43
76
|
* @throws {RequiredError}
|
|
44
77
|
*/
|
|
45
|
-
|
|
78
|
+
listPartnerRelationTypes: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
/**
|
|
80
|
+
* List all partner relations
|
|
81
|
+
* @summary List partner relations
|
|
82
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
84
|
+
* @param {any} [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
|
+
* @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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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: partnerRelationType.<i>
|
|
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
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
listPartnerRelations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
|
+
/**
|
|
95
|
+
* Update a partner relation identified by its id
|
|
96
|
+
* @summary Update the partner relation
|
|
97
|
+
* @param {number} id Id of the partner relation
|
|
98
|
+
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
99
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
updatePartnerRelation: (id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
104
|
};
|
|
47
105
|
/**
|
|
48
106
|
* PartnerRelationsApi - functional programming interface
|
|
49
107
|
* @export
|
|
50
108
|
*/
|
|
51
109
|
export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
110
|
+
/**
|
|
111
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
112
|
+
* @summary Create the partner relation
|
|
113
|
+
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
114
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
createPartnerRelation(createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerRelationResponseClass>>;
|
|
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.
|
|
121
|
+
* @summary Delete the partner-relation
|
|
122
|
+
* @param {number} id
|
|
123
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
deletePartnerRelation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
128
|
+
/**
|
|
129
|
+
* Retrieve a single partner relation identified by its id
|
|
130
|
+
* @summary Retrieve the partner relation
|
|
131
|
+
* @param {number} id Id of the partner relation
|
|
132
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
getPartnerRelation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationClass>>;
|
|
52
137
|
/**
|
|
53
138
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
54
139
|
* @summary Retrieve the partner relation type
|
|
@@ -72,13 +157,65 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
72
157
|
* @param {*} [options] Override http request option.
|
|
73
158
|
* @throws {RequiredError}
|
|
74
159
|
*/
|
|
75
|
-
|
|
160
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>>;
|
|
161
|
+
/**
|
|
162
|
+
* List all partner relations
|
|
163
|
+
* @summary List partner relations
|
|
164
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
165
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
166
|
+
* @param {any} [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
|
+
* @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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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: partnerRelationType.<i>
|
|
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
|
+
* @param {*} [options] Override http request option.
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
*/
|
|
175
|
+
listPartnerRelations(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationClass>>;
|
|
176
|
+
/**
|
|
177
|
+
* Update a partner relation identified by its id
|
|
178
|
+
* @summary Update the partner relation
|
|
179
|
+
* @param {number} id Id of the partner relation
|
|
180
|
+
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
181
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
182
|
+
* @param {*} [options] Override http request option.
|
|
183
|
+
* @throws {RequiredError}
|
|
184
|
+
*/
|
|
185
|
+
updatePartnerRelation(id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationClass>>;
|
|
76
186
|
};
|
|
77
187
|
/**
|
|
78
188
|
* PartnerRelationsApi - factory interface
|
|
79
189
|
* @export
|
|
80
190
|
*/
|
|
81
191
|
export declare const PartnerRelationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
192
|
+
/**
|
|
193
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
194
|
+
* @summary Create the partner relation
|
|
195
|
+
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
196
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
|
+
* @param {*} [options] Override http request option.
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
*/
|
|
200
|
+
createPartnerRelation(createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: any): AxiosPromise<CreatePartnerRelationResponseClass>;
|
|
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.
|
|
203
|
+
* @summary Delete the partner-relation
|
|
204
|
+
* @param {number} id
|
|
205
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
206
|
+
* @param {*} [options] Override http request option.
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
deletePartnerRelation(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
210
|
+
/**
|
|
211
|
+
* Retrieve a single partner relation identified by its id
|
|
212
|
+
* @summary Retrieve the partner relation
|
|
213
|
+
* @param {number} id Id of the partner relation
|
|
214
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
*/
|
|
218
|
+
getPartnerRelation(id: number, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationClass>;
|
|
82
219
|
/**
|
|
83
220
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
84
221
|
* @summary Retrieve the partner relation type
|
|
@@ -102,8 +239,90 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
102
239
|
* @param {*} [options] Override http request option.
|
|
103
240
|
* @throws {RequiredError}
|
|
104
241
|
*/
|
|
105
|
-
|
|
242
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass>;
|
|
243
|
+
/**
|
|
244
|
+
* List all partner relations
|
|
245
|
+
* @summary List partner relations
|
|
246
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
247
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
|
+
* @param {any} [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
|
+
* @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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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: partnerRelationType.<i>
|
|
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
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
listPartnerRelations(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass>;
|
|
258
|
+
/**
|
|
259
|
+
* Update a partner relation identified by its id
|
|
260
|
+
* @summary Update the partner relation
|
|
261
|
+
* @param {number} id Id of the partner relation
|
|
262
|
+
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
263
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
*/
|
|
267
|
+
updatePartnerRelation(id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationClass>;
|
|
106
268
|
};
|
|
269
|
+
/**
|
|
270
|
+
* Request parameters for createPartnerRelation operation in PartnerRelationsApi.
|
|
271
|
+
* @export
|
|
272
|
+
* @interface PartnerRelationsApiCreatePartnerRelationRequest
|
|
273
|
+
*/
|
|
274
|
+
export interface PartnerRelationsApiCreatePartnerRelationRequest {
|
|
275
|
+
/**
|
|
276
|
+
*
|
|
277
|
+
* @type {CreatePartnerRelationRequestDtoRest}
|
|
278
|
+
* @memberof PartnerRelationsApiCreatePartnerRelation
|
|
279
|
+
*/
|
|
280
|
+
readonly createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest;
|
|
281
|
+
/**
|
|
282
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
283
|
+
* @type {string}
|
|
284
|
+
* @memberof PartnerRelationsApiCreatePartnerRelation
|
|
285
|
+
*/
|
|
286
|
+
readonly authorization?: string;
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* Request parameters for deletePartnerRelation operation in PartnerRelationsApi.
|
|
290
|
+
* @export
|
|
291
|
+
* @interface PartnerRelationsApiDeletePartnerRelationRequest
|
|
292
|
+
*/
|
|
293
|
+
export interface PartnerRelationsApiDeletePartnerRelationRequest {
|
|
294
|
+
/**
|
|
295
|
+
*
|
|
296
|
+
* @type {number}
|
|
297
|
+
* @memberof PartnerRelationsApiDeletePartnerRelation
|
|
298
|
+
*/
|
|
299
|
+
readonly id: number;
|
|
300
|
+
/**
|
|
301
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
302
|
+
* @type {string}
|
|
303
|
+
* @memberof PartnerRelationsApiDeletePartnerRelation
|
|
304
|
+
*/
|
|
305
|
+
readonly authorization?: string;
|
|
306
|
+
}
|
|
307
|
+
/**
|
|
308
|
+
* Request parameters for getPartnerRelation operation in PartnerRelationsApi.
|
|
309
|
+
* @export
|
|
310
|
+
* @interface PartnerRelationsApiGetPartnerRelationRequest
|
|
311
|
+
*/
|
|
312
|
+
export interface PartnerRelationsApiGetPartnerRelationRequest {
|
|
313
|
+
/**
|
|
314
|
+
* Id of the partner relation
|
|
315
|
+
* @type {number}
|
|
316
|
+
* @memberof PartnerRelationsApiGetPartnerRelation
|
|
317
|
+
*/
|
|
318
|
+
readonly id: number;
|
|
319
|
+
/**
|
|
320
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
321
|
+
* @type {string}
|
|
322
|
+
* @memberof PartnerRelationsApiGetPartnerRelation
|
|
323
|
+
*/
|
|
324
|
+
readonly authorization?: string;
|
|
325
|
+
}
|
|
107
326
|
/**
|
|
108
327
|
* Request parameters for getPartnerRelationType operation in PartnerRelationsApi.
|
|
109
328
|
* @export
|
|
@@ -124,60 +343,140 @@ export interface PartnerRelationsApiGetPartnerRelationTypeRequest {
|
|
|
124
343
|
readonly authorization?: string;
|
|
125
344
|
}
|
|
126
345
|
/**
|
|
127
|
-
* Request parameters for
|
|
346
|
+
* Request parameters for listPartnerRelationTypes operation in PartnerRelationsApi.
|
|
128
347
|
* @export
|
|
129
|
-
* @interface
|
|
348
|
+
* @interface PartnerRelationsApiListPartnerRelationTypesRequest
|
|
130
349
|
*/
|
|
131
|
-
export interface
|
|
350
|
+
export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
132
351
|
/**
|
|
133
352
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
353
|
* @type {string}
|
|
135
|
-
* @memberof
|
|
354
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
136
355
|
*/
|
|
137
356
|
readonly authorization?: string;
|
|
138
357
|
/**
|
|
139
358
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
140
359
|
* @type {any}
|
|
141
|
-
* @memberof
|
|
360
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
142
361
|
*/
|
|
143
362
|
readonly pageSize?: any;
|
|
144
363
|
/**
|
|
145
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.
|
|
146
365
|
* @type {any}
|
|
147
|
-
* @memberof
|
|
366
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
148
367
|
*/
|
|
149
368
|
readonly pageToken?: any;
|
|
150
369
|
/**
|
|
151
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</i>
|
|
152
371
|
* @type {string}
|
|
153
|
-
* @memberof
|
|
372
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
154
373
|
*/
|
|
155
374
|
readonly filter?: string;
|
|
156
375
|
/**
|
|
157
376
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
158
377
|
* @type {any}
|
|
159
|
-
* @memberof
|
|
378
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
160
379
|
*/
|
|
161
380
|
readonly search?: any;
|
|
162
381
|
/**
|
|
163
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>
|
|
164
383
|
* @type {string}
|
|
165
|
-
* @memberof
|
|
384
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
166
385
|
*/
|
|
167
386
|
readonly order?: string;
|
|
168
387
|
/**
|
|
169
388
|
* 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: .<i>
|
|
170
389
|
* @type {string}
|
|
171
|
-
* @memberof
|
|
390
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
172
391
|
*/
|
|
173
392
|
readonly expand?: string;
|
|
174
393
|
/**
|
|
175
394
|
* 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>
|
|
176
395
|
* @type {string}
|
|
177
|
-
* @memberof
|
|
396
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
178
397
|
*/
|
|
179
398
|
readonly filters?: string;
|
|
180
399
|
}
|
|
400
|
+
/**
|
|
401
|
+
* Request parameters for listPartnerRelations operation in PartnerRelationsApi.
|
|
402
|
+
* @export
|
|
403
|
+
* @interface PartnerRelationsApiListPartnerRelationsRequest
|
|
404
|
+
*/
|
|
405
|
+
export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
406
|
+
/**
|
|
407
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
408
|
+
* @type {string}
|
|
409
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
410
|
+
*/
|
|
411
|
+
readonly authorization?: string;
|
|
412
|
+
/**
|
|
413
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
414
|
+
* @type {any}
|
|
415
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
416
|
+
*/
|
|
417
|
+
readonly pageSize?: any;
|
|
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, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
420
|
+
* @type {any}
|
|
421
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
422
|
+
*/
|
|
423
|
+
readonly pageToken?: any;
|
|
424
|
+
/**
|
|
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
|
+
* @type {string}
|
|
427
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
428
|
+
*/
|
|
429
|
+
readonly filter?: string;
|
|
430
|
+
/**
|
|
431
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
432
|
+
* @type {any}
|
|
433
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
434
|
+
*/
|
|
435
|
+
readonly search?: any;
|
|
436
|
+
/**
|
|
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
|
+
* @type {string}
|
|
439
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
440
|
+
*/
|
|
441
|
+
readonly order?: string;
|
|
442
|
+
/**
|
|
443
|
+
* 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: partnerRelationType.<i>
|
|
444
|
+
* @type {string}
|
|
445
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
446
|
+
*/
|
|
447
|
+
readonly expand?: string;
|
|
448
|
+
/**
|
|
449
|
+
* 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>
|
|
450
|
+
* @type {string}
|
|
451
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
452
|
+
*/
|
|
453
|
+
readonly filters?: string;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* Request parameters for updatePartnerRelation operation in PartnerRelationsApi.
|
|
457
|
+
* @export
|
|
458
|
+
* @interface PartnerRelationsApiUpdatePartnerRelationRequest
|
|
459
|
+
*/
|
|
460
|
+
export interface PartnerRelationsApiUpdatePartnerRelationRequest {
|
|
461
|
+
/**
|
|
462
|
+
* Id of the partner relation
|
|
463
|
+
* @type {number}
|
|
464
|
+
* @memberof PartnerRelationsApiUpdatePartnerRelation
|
|
465
|
+
*/
|
|
466
|
+
readonly id: number;
|
|
467
|
+
/**
|
|
468
|
+
*
|
|
469
|
+
* @type {UpdatePartnerRelationRequestDtoRest}
|
|
470
|
+
* @memberof PartnerRelationsApiUpdatePartnerRelation
|
|
471
|
+
*/
|
|
472
|
+
readonly updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest;
|
|
473
|
+
/**
|
|
474
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
475
|
+
* @type {string}
|
|
476
|
+
* @memberof PartnerRelationsApiUpdatePartnerRelation
|
|
477
|
+
*/
|
|
478
|
+
readonly authorization?: string;
|
|
479
|
+
}
|
|
181
480
|
/**
|
|
182
481
|
* PartnerRelationsApi - object-oriented interface
|
|
183
482
|
* @export
|
|
@@ -185,6 +484,33 @@ export interface PartnerRelationsApiListPartnerVersionRequest {
|
|
|
185
484
|
* @extends {BaseAPI}
|
|
186
485
|
*/
|
|
187
486
|
export declare class PartnerRelationsApi extends BaseAPI {
|
|
487
|
+
/**
|
|
488
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
489
|
+
* @summary Create the partner relation
|
|
490
|
+
* @param {PartnerRelationsApiCreatePartnerRelationRequest} requestParameters Request parameters.
|
|
491
|
+
* @param {*} [options] Override http request option.
|
|
492
|
+
* @throws {RequiredError}
|
|
493
|
+
* @memberof PartnerRelationsApi
|
|
494
|
+
*/
|
|
495
|
+
createPartnerRelation(requestParameters: PartnerRelationsApiCreatePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerRelationResponseClass, any>>;
|
|
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.
|
|
498
|
+
* @summary Delete the partner-relation
|
|
499
|
+
* @param {PartnerRelationsApiDeletePartnerRelationRequest} requestParameters Request parameters.
|
|
500
|
+
* @param {*} [options] Override http request option.
|
|
501
|
+
* @throws {RequiredError}
|
|
502
|
+
* @memberof PartnerRelationsApi
|
|
503
|
+
*/
|
|
504
|
+
deletePartnerRelation(requestParameters: PartnerRelationsApiDeletePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
505
|
+
/**
|
|
506
|
+
* Retrieve a single partner relation identified by its id
|
|
507
|
+
* @summary Retrieve the partner relation
|
|
508
|
+
* @param {PartnerRelationsApiGetPartnerRelationRequest} requestParameters Request parameters.
|
|
509
|
+
* @param {*} [options] Override http request option.
|
|
510
|
+
* @throws {RequiredError}
|
|
511
|
+
* @memberof PartnerRelationsApi
|
|
512
|
+
*/
|
|
513
|
+
getPartnerRelation(requestParameters: PartnerRelationsApiGetPartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationClass, any>>;
|
|
188
514
|
/**
|
|
189
515
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
190
516
|
* @summary Retrieve the partner relation type
|
|
@@ -197,10 +523,28 @@ export declare class PartnerRelationsApi extends BaseAPI {
|
|
|
197
523
|
/**
|
|
198
524
|
* List all partner relation types - is used to create partner relations
|
|
199
525
|
* @summary List partner relation types
|
|
200
|
-
* @param {
|
|
526
|
+
* @param {PartnerRelationsApiListPartnerRelationTypesRequest} requestParameters Request parameters.
|
|
527
|
+
* @param {*} [options] Override http request option.
|
|
528
|
+
* @throws {RequiredError}
|
|
529
|
+
* @memberof PartnerRelationsApi
|
|
530
|
+
*/
|
|
531
|
+
listPartnerRelationTypes(requestParameters?: PartnerRelationsApiListPartnerRelationTypesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRelationTypesClass, any>>;
|
|
532
|
+
/**
|
|
533
|
+
* List all partner relations
|
|
534
|
+
* @summary List partner relations
|
|
535
|
+
* @param {PartnerRelationsApiListPartnerRelationsRequest} requestParameters Request parameters.
|
|
536
|
+
* @param {*} [options] Override http request option.
|
|
537
|
+
* @throws {RequiredError}
|
|
538
|
+
* @memberof PartnerRelationsApi
|
|
539
|
+
*/
|
|
540
|
+
listPartnerRelations(requestParameters?: PartnerRelationsApiListPartnerRelationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRelationClass, any>>;
|
|
541
|
+
/**
|
|
542
|
+
* Update a partner relation identified by its id
|
|
543
|
+
* @summary Update the partner relation
|
|
544
|
+
* @param {PartnerRelationsApiUpdatePartnerRelationRequest} requestParameters Request parameters.
|
|
201
545
|
* @param {*} [options] Override http request option.
|
|
202
546
|
* @throws {RequiredError}
|
|
203
547
|
* @memberof PartnerRelationsApi
|
|
204
548
|
*/
|
|
205
|
-
|
|
549
|
+
updatePartnerRelation(requestParameters: PartnerRelationsApiUpdatePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationClass, any>>;
|
|
206
550
|
}
|