@emilgroup/partner-sdk 1.0.1-beta.1 → 1.1.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/.openapi-generator/FILES +7 -0
- package/README.md +2 -2
- package/api/partner-relations-api.ts +349 -0
- package/api/partner-types-api.ts +36 -22
- package/api/partner-version-api.ts +375 -0
- package/api/partners-api.ts +36 -22
- package/api.ts +4 -0
- package/dist/api/partner-relations-api.d.ts +206 -0
- package/dist/api/partner-relations-api.js +352 -0
- package/dist/api/partner-types-api.d.ts +28 -19
- package/dist/api/partner-types-api.js +26 -20
- package/dist/api/partner-version-api.d.ts +224 -0
- package/dist/api/partner-version-api.js +363 -0
- package/dist/api/partners-api.d.ts +28 -19
- package/dist/api/partners-api.js +26 -20
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/get-partner-relation-type-class.d.ts +25 -0
- package/dist/models/get-partner-relation-type-class.js +15 -0
- package/dist/models/get-partner-version-response-class.d.ts +25 -0
- package/dist/models/get-partner-version-response-class.js +15 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/models/list-partner-relation-types-class.d.ts +31 -0
- package/dist/models/list-partner-relation-types-class.js +15 -0
- package/dist/models/list-partner-versions-response-class.d.ts +25 -0
- package/dist/models/list-partner-versions-response-class.js +15 -0
- package/dist/models/partner-class.d.ts +12 -0
- package/dist/models/partner-relation-type-class.d.ts +66 -0
- package/dist/models/partner-relation-type-class.js +15 -0
- package/dist/models/update-partner-type-request-dto.d.ts +6 -0
- package/models/get-partner-relation-type-class.ts +31 -0
- package/models/get-partner-version-response-class.ts +31 -0
- package/models/index.ts +5 -0
- package/models/list-partner-relation-types-class.ts +37 -0
- package/models/list-partner-versions-response-class.ts +31 -0
- package/models/partner-class.ts +12 -0
- package/models/partner-relation-type-class.ts +72 -0
- package/models/update-partner-type-request-dto.ts +6 -0
- package/package.json +1 -2
|
@@ -0,0 +1,375 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL PartnerService
|
|
5
|
+
* The EMIL PartnerService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { GetPartnerVersionResponseClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { ListPartnerVersionsResponseClass } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* PartnerVersionApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export const PartnerVersionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
* Retrieve a partner version by providing partner code and version number
|
|
35
|
+
* @summary Retrieve the partner version
|
|
36
|
+
* @param {string} code Unique identifier for the object.
|
|
37
|
+
* @param {number} version
|
|
38
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
getPartnerVersion: async (code: string, version: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43
|
+
// verify required parameter 'code' is not null or undefined
|
|
44
|
+
assertParamExists('getPartnerVersion', 'code', code)
|
|
45
|
+
// verify required parameter 'version' is not null or undefined
|
|
46
|
+
assertParamExists('getPartnerVersion', 'version', version)
|
|
47
|
+
const localVarPath = `/partnerservice/v1/partners/{code}/versions/{version}`
|
|
48
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
49
|
+
.replace(`{${"version"}}`, encodeURIComponent(String(version)));
|
|
50
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
52
|
+
let baseOptions;
|
|
53
|
+
let baseAccessToken;
|
|
54
|
+
if (configuration) {
|
|
55
|
+
baseOptions = configuration.baseOptions;
|
|
56
|
+
baseAccessToken = configuration.accessToken;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
60
|
+
const localVarHeaderParameter = {} as any;
|
|
61
|
+
const localVarQueryParameter = {} as any;
|
|
62
|
+
|
|
63
|
+
// authentication bearer required
|
|
64
|
+
// http bearer authentication required
|
|
65
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
66
|
+
|
|
67
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
68
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
74
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
75
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
76
|
+
|
|
77
|
+
return {
|
|
78
|
+
url: toPathString(localVarUrlObj),
|
|
79
|
+
options: localVarRequestOptions,
|
|
80
|
+
};
|
|
81
|
+
},
|
|
82
|
+
/**
|
|
83
|
+
* List all partner versions by providing partner code
|
|
84
|
+
* @summary List partner versions
|
|
85
|
+
* @param {string} code
|
|
86
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
88
|
+
* @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.
|
|
89
|
+
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
90
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
91
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
92
|
+
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
93
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
listPartnerVersion: async (code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'partnerType', filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
98
|
+
// verify required parameter 'code' is not null or undefined
|
|
99
|
+
assertParamExists('listPartnerVersion', 'code', code)
|
|
100
|
+
const localVarPath = `/partnerservice/v1/partners/{code}/versions`
|
|
101
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
102
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
103
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
104
|
+
let baseOptions;
|
|
105
|
+
let baseAccessToken;
|
|
106
|
+
if (configuration) {
|
|
107
|
+
baseOptions = configuration.baseOptions;
|
|
108
|
+
baseAccessToken = configuration.accessToken;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
112
|
+
const localVarHeaderParameter = {} as any;
|
|
113
|
+
const localVarQueryParameter = {} as any;
|
|
114
|
+
|
|
115
|
+
// authentication bearer required
|
|
116
|
+
// http bearer authentication required
|
|
117
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
118
|
+
|
|
119
|
+
if (pageSize !== undefined) {
|
|
120
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
if (pageToken !== undefined) {
|
|
124
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
if (filter !== undefined) {
|
|
128
|
+
localVarQueryParameter['filter'] = filter;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
if (search !== undefined) {
|
|
132
|
+
localVarQueryParameter['search'] = search;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
if (order !== undefined) {
|
|
136
|
+
localVarQueryParameter['order'] = order;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
if (expand !== undefined) {
|
|
140
|
+
localVarQueryParameter['expand'] = expand;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
if (filters !== undefined) {
|
|
144
|
+
localVarQueryParameter['filters'] = filters;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
148
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
154
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
155
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
156
|
+
|
|
157
|
+
return {
|
|
158
|
+
url: toPathString(localVarUrlObj),
|
|
159
|
+
options: localVarRequestOptions,
|
|
160
|
+
};
|
|
161
|
+
},
|
|
162
|
+
}
|
|
163
|
+
};
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* PartnerVersionApi - functional programming interface
|
|
167
|
+
* @export
|
|
168
|
+
*/
|
|
169
|
+
export const PartnerVersionApiFp = function(configuration?: Configuration) {
|
|
170
|
+
const localVarAxiosParamCreator = PartnerVersionApiAxiosParamCreator(configuration)
|
|
171
|
+
return {
|
|
172
|
+
/**
|
|
173
|
+
* Retrieve a partner version by providing partner code and version number
|
|
174
|
+
* @summary Retrieve the partner version
|
|
175
|
+
* @param {string} code Unique identifier for the object.
|
|
176
|
+
* @param {number} version
|
|
177
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
178
|
+
* @param {*} [options] Override http request option.
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
*/
|
|
181
|
+
async getPartnerVersion(code: string, version: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerVersionResponseClass>> {
|
|
182
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerVersion(code, version, authorization, options);
|
|
183
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
184
|
+
},
|
|
185
|
+
/**
|
|
186
|
+
* List all partner versions by providing partner code
|
|
187
|
+
* @summary List partner versions
|
|
188
|
+
* @param {string} code
|
|
189
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
190
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
191
|
+
* @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.
|
|
192
|
+
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
193
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
195
|
+
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
196
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
197
|
+
* @param {*} [options] Override http request option.
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
*/
|
|
200
|
+
async listPartnerVersion(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'partnerType', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerVersionsResponseClass>> {
|
|
201
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
202
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
203
|
+
},
|
|
204
|
+
}
|
|
205
|
+
};
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* PartnerVersionApi - factory interface
|
|
209
|
+
* @export
|
|
210
|
+
*/
|
|
211
|
+
export const PartnerVersionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
212
|
+
const localVarFp = PartnerVersionApiFp(configuration)
|
|
213
|
+
return {
|
|
214
|
+
/**
|
|
215
|
+
* Retrieve a partner version by providing partner code and version number
|
|
216
|
+
* @summary Retrieve the partner version
|
|
217
|
+
* @param {string} code Unique identifier for the object.
|
|
218
|
+
* @param {number} version
|
|
219
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
*/
|
|
223
|
+
getPartnerVersion(code: string, version: number, authorization?: string, options?: any): AxiosPromise<GetPartnerVersionResponseClass> {
|
|
224
|
+
return localVarFp.getPartnerVersion(code, version, authorization, options).then((request) => request(axios, basePath));
|
|
225
|
+
},
|
|
226
|
+
/**
|
|
227
|
+
* List all partner versions by providing partner code
|
|
228
|
+
* @summary List partner versions
|
|
229
|
+
* @param {string} code
|
|
230
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
|
+
* @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.
|
|
233
|
+
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
234
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
236
|
+
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
237
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
238
|
+
* @param {*} [options] Override http request option.
|
|
239
|
+
* @throws {RequiredError}
|
|
240
|
+
*/
|
|
241
|
+
listPartnerVersion(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'partnerType', filters?: any, options?: any): AxiosPromise<ListPartnerVersionsResponseClass> {
|
|
242
|
+
return localVarFp.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
243
|
+
},
|
|
244
|
+
};
|
|
245
|
+
};
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Request parameters for getPartnerVersion operation in PartnerVersionApi.
|
|
249
|
+
* @export
|
|
250
|
+
* @interface PartnerVersionApiGetPartnerVersionRequest
|
|
251
|
+
*/
|
|
252
|
+
export interface PartnerVersionApiGetPartnerVersionRequest {
|
|
253
|
+
/**
|
|
254
|
+
* Unique identifier for the object.
|
|
255
|
+
* @type {string}
|
|
256
|
+
* @memberof PartnerVersionApiGetPartnerVersion
|
|
257
|
+
*/
|
|
258
|
+
readonly code: string
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
*
|
|
262
|
+
* @type {number}
|
|
263
|
+
* @memberof PartnerVersionApiGetPartnerVersion
|
|
264
|
+
*/
|
|
265
|
+
readonly version: number
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
269
|
+
* @type {string}
|
|
270
|
+
* @memberof PartnerVersionApiGetPartnerVersion
|
|
271
|
+
*/
|
|
272
|
+
readonly authorization?: string
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Request parameters for listPartnerVersion operation in PartnerVersionApi.
|
|
277
|
+
* @export
|
|
278
|
+
* @interface PartnerVersionApiListPartnerVersionRequest
|
|
279
|
+
*/
|
|
280
|
+
export interface PartnerVersionApiListPartnerVersionRequest {
|
|
281
|
+
/**
|
|
282
|
+
*
|
|
283
|
+
* @type {string}
|
|
284
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
285
|
+
*/
|
|
286
|
+
readonly code: string
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
290
|
+
* @type {string}
|
|
291
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
292
|
+
*/
|
|
293
|
+
readonly authorization?: string
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
297
|
+
* @type {any}
|
|
298
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
299
|
+
*/
|
|
300
|
+
readonly pageSize?: any
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* 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.
|
|
304
|
+
* @type {any}
|
|
305
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
306
|
+
*/
|
|
307
|
+
readonly pageToken?: any
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
311
|
+
* @type {any}
|
|
312
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
313
|
+
*/
|
|
314
|
+
readonly filter?: any
|
|
315
|
+
|
|
316
|
+
/**
|
|
317
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
318
|
+
* @type {any}
|
|
319
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
320
|
+
*/
|
|
321
|
+
readonly search?: any
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
325
|
+
* @type {any}
|
|
326
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
327
|
+
*/
|
|
328
|
+
readonly order?: any
|
|
329
|
+
|
|
330
|
+
/**
|
|
331
|
+
* Allowed expands for the partner version
|
|
332
|
+
* @type {'partnerType'}
|
|
333
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
334
|
+
*/
|
|
335
|
+
readonly expand?: 'partnerType'
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
339
|
+
* @type {any}
|
|
340
|
+
* @memberof PartnerVersionApiListPartnerVersion
|
|
341
|
+
*/
|
|
342
|
+
readonly filters?: any
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* PartnerVersionApi - object-oriented interface
|
|
347
|
+
* @export
|
|
348
|
+
* @class PartnerVersionApi
|
|
349
|
+
* @extends {BaseAPI}
|
|
350
|
+
*/
|
|
351
|
+
export class PartnerVersionApi extends BaseAPI {
|
|
352
|
+
/**
|
|
353
|
+
* Retrieve a partner version by providing partner code and version number
|
|
354
|
+
* @summary Retrieve the partner version
|
|
355
|
+
* @param {PartnerVersionApiGetPartnerVersionRequest} requestParameters Request parameters.
|
|
356
|
+
* @param {*} [options] Override http request option.
|
|
357
|
+
* @throws {RequiredError}
|
|
358
|
+
* @memberof PartnerVersionApi
|
|
359
|
+
*/
|
|
360
|
+
public getPartnerVersion(requestParameters: PartnerVersionApiGetPartnerVersionRequest, options?: AxiosRequestConfig) {
|
|
361
|
+
return PartnerVersionApiFp(this.configuration).getPartnerVersion(requestParameters.code, requestParameters.version, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* List all partner versions by providing partner code
|
|
366
|
+
* @summary List partner versions
|
|
367
|
+
* @param {PartnerVersionApiListPartnerVersionRequest} requestParameters Request parameters.
|
|
368
|
+
* @param {*} [options] Override http request option.
|
|
369
|
+
* @throws {RequiredError}
|
|
370
|
+
* @memberof PartnerVersionApi
|
|
371
|
+
*/
|
|
372
|
+
public listPartnerVersion(requestParameters: PartnerVersionApiListPartnerVersionRequest, options?: AxiosRequestConfig) {
|
|
373
|
+
return PartnerVersionApiFp(this.configuration).listPartnerVersion(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
374
|
+
}
|
|
375
|
+
}
|
package/api/partners-api.ts
CHANGED
|
@@ -133,7 +133,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
133
133
|
};
|
|
134
134
|
},
|
|
135
135
|
/**
|
|
136
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
136
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
137
137
|
* @summary Retrieve the partner
|
|
138
138
|
* @param {string} code Unique identifier for the object.
|
|
139
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -183,19 +183,20 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
183
183
|
};
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* Returns a list of partners you have previously created.
|
|
186
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
187
187
|
* @summary List partners
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
189
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
190
|
* @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.
|
|
191
191
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
192
|
-
* @param {any} [search]
|
|
192
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
193
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
194
194
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
195
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
195
196
|
* @param {*} [options] Override http request option.
|
|
196
197
|
* @throws {RequiredError}
|
|
197
198
|
*/
|
|
198
|
-
listPartners: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
199
|
+
listPartners: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
199
200
|
const localVarPath = `/partnerservice/v1/partners`;
|
|
200
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
201
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -238,6 +239,10 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
238
239
|
localVarQueryParameter['expand'] = expand;
|
|
239
240
|
}
|
|
240
241
|
|
|
242
|
+
if (filters !== undefined) {
|
|
243
|
+
localVarQueryParameter['filters'] = filters;
|
|
244
|
+
}
|
|
245
|
+
|
|
241
246
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
242
247
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
243
248
|
}
|
|
@@ -339,7 +344,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
339
344
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
340
345
|
},
|
|
341
346
|
/**
|
|
342
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
347
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
343
348
|
* @summary Retrieve the partner
|
|
344
349
|
* @param {string} code Unique identifier for the object.
|
|
345
350
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -352,20 +357,21 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
352
357
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
353
358
|
},
|
|
354
359
|
/**
|
|
355
|
-
* Returns a list of partners you have previously created.
|
|
360
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
356
361
|
* @summary List partners
|
|
357
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
358
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
363
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
359
364
|
* @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.
|
|
360
365
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
361
|
-
* @param {any} [search]
|
|
366
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
362
367
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
363
368
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
369
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
364
370
|
* @param {*} [options] Override http request option.
|
|
365
371
|
* @throws {RequiredError}
|
|
366
372
|
*/
|
|
367
|
-
async listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>> {
|
|
368
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
373
|
+
async listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>> {
|
|
374
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
369
375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
370
376
|
},
|
|
371
377
|
/**
|
|
@@ -414,7 +420,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
414
420
|
return localVarFp.deletePartner(code, authorization, options).then((request) => request(axios, basePath));
|
|
415
421
|
},
|
|
416
422
|
/**
|
|
417
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
423
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
418
424
|
* @summary Retrieve the partner
|
|
419
425
|
* @param {string} code Unique identifier for the object.
|
|
420
426
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -426,20 +432,21 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
426
432
|
return localVarFp.getPartner(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
427
433
|
},
|
|
428
434
|
/**
|
|
429
|
-
* Returns a list of partners you have previously created.
|
|
435
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
430
436
|
* @summary List partners
|
|
431
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
432
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
438
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
433
439
|
* @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.
|
|
434
440
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
435
|
-
* @param {any} [search]
|
|
441
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
436
442
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
437
443
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
444
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
438
445
|
* @param {*} [options] Override http request option.
|
|
439
446
|
* @throws {RequiredError}
|
|
440
447
|
*/
|
|
441
|
-
listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPartnersResponseClass> {
|
|
442
|
-
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
448
|
+
listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPartnersResponseClass> {
|
|
449
|
+
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
443
450
|
},
|
|
444
451
|
/**
|
|
445
452
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -540,7 +547,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
540
547
|
readonly authorization?: string
|
|
541
548
|
|
|
542
549
|
/**
|
|
543
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
550
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
544
551
|
* @type {any}
|
|
545
552
|
* @memberof PartnersApiListPartners
|
|
546
553
|
*/
|
|
@@ -561,7 +568,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
561
568
|
readonly filter?: any
|
|
562
569
|
|
|
563
570
|
/**
|
|
564
|
-
*
|
|
571
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
565
572
|
* @type {any}
|
|
566
573
|
* @memberof PartnersApiListPartners
|
|
567
574
|
*/
|
|
@@ -580,6 +587,13 @@ export interface PartnersApiListPartnersRequest {
|
|
|
580
587
|
* @memberof PartnersApiListPartners
|
|
581
588
|
*/
|
|
582
589
|
readonly expand?: any
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
593
|
+
* @type {any}
|
|
594
|
+
* @memberof PartnersApiListPartners
|
|
595
|
+
*/
|
|
596
|
+
readonly filters?: any
|
|
583
597
|
}
|
|
584
598
|
|
|
585
599
|
/**
|
|
@@ -642,7 +656,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
642
656
|
}
|
|
643
657
|
|
|
644
658
|
/**
|
|
645
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
659
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
646
660
|
* @summary Retrieve the partner
|
|
647
661
|
* @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
|
|
648
662
|
* @param {*} [options] Override http request option.
|
|
@@ -654,7 +668,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
654
668
|
}
|
|
655
669
|
|
|
656
670
|
/**
|
|
657
|
-
* Returns a list of partners you have previously created.
|
|
671
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
658
672
|
* @summary List partners
|
|
659
673
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
660
674
|
* @param {*} [options] Override http request option.
|
|
@@ -662,7 +676,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
662
676
|
* @memberof PartnersApi
|
|
663
677
|
*/
|
|
664
678
|
public listPartners(requestParameters: PartnersApiListPartnersRequest = {}, options?: AxiosRequestConfig) {
|
|
665
|
-
return PartnersApiFp(this.configuration).listPartners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
679
|
+
return PartnersApiFp(this.configuration).listPartners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
666
680
|
}
|
|
667
681
|
|
|
668
682
|
/**
|
package/api.ts
CHANGED
|
@@ -21,11 +21,15 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
23
23
|
import { DefaultApi } from './api';
|
|
24
|
+
import { PartnerRelationsApi } from './api';
|
|
24
25
|
import { PartnerTypesApi } from './api';
|
|
26
|
+
import { PartnerVersionApi } from './api';
|
|
25
27
|
import { PartnersApi } from './api';
|
|
26
28
|
|
|
27
29
|
|
|
28
30
|
export * from './api/default-api';
|
|
31
|
+
export * from './api/partner-relations-api';
|
|
29
32
|
export * from './api/partner-types-api';
|
|
33
|
+
export * from './api/partner-version-api';
|
|
30
34
|
export * from './api/partners-api';
|
|
31
35
|
|