@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
|
@@ -21,15 +21,164 @@ 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
|
// @ts-ignore
|
|
24
|
+
import { CreatePartnerRelationRequestDtoRest } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { CreatePartnerRelationResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { DeleteResponseClass } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import { GetPartnerRelationClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
24
32
|
import { GetPartnerRelationTypeClass } from '../models';
|
|
25
33
|
// @ts-ignore
|
|
34
|
+
import { ListPartnerRelationClass } from '../models';
|
|
35
|
+
// @ts-ignore
|
|
26
36
|
import { ListPartnerRelationTypesClass } from '../models';
|
|
37
|
+
// @ts-ignore
|
|
38
|
+
import { UpdatePartnerRelationRequestDtoRest } from '../models';
|
|
27
39
|
/**
|
|
28
40
|
* PartnerRelationsApi - axios parameter creator
|
|
29
41
|
* @export
|
|
30
42
|
*/
|
|
31
43
|
export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
44
|
return {
|
|
45
|
+
/**
|
|
46
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
47
|
+
* @summary Create the partner relation
|
|
48
|
+
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
49
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
createPartnerRelation: async (createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54
|
+
// verify required parameter 'createPartnerRelationRequestDtoRest' is not null or undefined
|
|
55
|
+
assertParamExists('createPartnerRelation', 'createPartnerRelationRequestDtoRest', createPartnerRelationRequestDtoRest)
|
|
56
|
+
const localVarPath = `/partnerservice/v1/partners/relations`;
|
|
57
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
58
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59
|
+
let baseOptions;
|
|
60
|
+
let baseAccessToken;
|
|
61
|
+
if (configuration) {
|
|
62
|
+
baseOptions = configuration.baseOptions;
|
|
63
|
+
baseAccessToken = configuration.accessToken;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
67
|
+
const localVarHeaderParameter = {} as any;
|
|
68
|
+
const localVarQueryParameter = {} as any;
|
|
69
|
+
|
|
70
|
+
// authentication bearer required
|
|
71
|
+
// http bearer authentication required
|
|
72
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
73
|
+
|
|
74
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
75
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
81
|
+
|
|
82
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
83
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
84
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
85
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createPartnerRelationRequestDtoRest, localVarRequestOptions, configuration)
|
|
86
|
+
|
|
87
|
+
return {
|
|
88
|
+
url: toPathString(localVarUrlObj),
|
|
89
|
+
options: localVarRequestOptions,
|
|
90
|
+
};
|
|
91
|
+
},
|
|
92
|
+
/**
|
|
93
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
94
|
+
* @summary Delete the partner-relation
|
|
95
|
+
* @param {number} id
|
|
96
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
deletePartnerRelation: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
101
|
+
// verify required parameter 'id' is not null or undefined
|
|
102
|
+
assertParamExists('deletePartnerRelation', 'id', id)
|
|
103
|
+
const localVarPath = `/partnerservice/v1/partners/relations/{id}`
|
|
104
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
105
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107
|
+
let baseOptions;
|
|
108
|
+
let baseAccessToken;
|
|
109
|
+
if (configuration) {
|
|
110
|
+
baseOptions = configuration.baseOptions;
|
|
111
|
+
baseAccessToken = configuration.accessToken;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
115
|
+
const localVarHeaderParameter = {} as any;
|
|
116
|
+
const localVarQueryParameter = {} as any;
|
|
117
|
+
|
|
118
|
+
// authentication bearer required
|
|
119
|
+
// http bearer authentication required
|
|
120
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
121
|
+
|
|
122
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
123
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
129
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
131
|
+
|
|
132
|
+
return {
|
|
133
|
+
url: toPathString(localVarUrlObj),
|
|
134
|
+
options: localVarRequestOptions,
|
|
135
|
+
};
|
|
136
|
+
},
|
|
137
|
+
/**
|
|
138
|
+
* Retrieve a single partner relation identified by its id
|
|
139
|
+
* @summary Retrieve the partner relation
|
|
140
|
+
* @param {number} id Id of the partner relation
|
|
141
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
getPartnerRelation: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
146
|
+
// verify required parameter 'id' is not null or undefined
|
|
147
|
+
assertParamExists('getPartnerRelation', 'id', id)
|
|
148
|
+
const localVarPath = `/partnerservice/v1/partners/relations/{id}`
|
|
149
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
150
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
151
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152
|
+
let baseOptions;
|
|
153
|
+
let baseAccessToken;
|
|
154
|
+
if (configuration) {
|
|
155
|
+
baseOptions = configuration.baseOptions;
|
|
156
|
+
baseAccessToken = configuration.accessToken;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
160
|
+
const localVarHeaderParameter = {} as any;
|
|
161
|
+
const localVarQueryParameter = {} as any;
|
|
162
|
+
|
|
163
|
+
// authentication bearer required
|
|
164
|
+
// http bearer authentication required
|
|
165
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
166
|
+
|
|
167
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
168
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
174
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
175
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
176
|
+
|
|
177
|
+
return {
|
|
178
|
+
url: toPathString(localVarUrlObj),
|
|
179
|
+
options: localVarRequestOptions,
|
|
180
|
+
};
|
|
181
|
+
},
|
|
33
182
|
/**
|
|
34
183
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
35
184
|
* @summary Retrieve the partner relation type
|
|
@@ -89,7 +238,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
89
238
|
* @param {*} [options] Override http request option.
|
|
90
239
|
* @throws {RequiredError}
|
|
91
240
|
*/
|
|
92
|
-
|
|
241
|
+
listPartnerRelationTypes: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
242
|
const localVarPath = `/partnerservice/v1/partners/relations/types`;
|
|
94
243
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
95
244
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -146,6 +295,133 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
146
295
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
147
296
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
148
297
|
|
|
298
|
+
return {
|
|
299
|
+
url: toPathString(localVarUrlObj),
|
|
300
|
+
options: localVarRequestOptions,
|
|
301
|
+
};
|
|
302
|
+
},
|
|
303
|
+
/**
|
|
304
|
+
* List all partner relations
|
|
305
|
+
* @summary List partner relations
|
|
306
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
307
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
308
|
+
* @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.
|
|
309
|
+
* @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>
|
|
310
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
311
|
+
* @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>
|
|
312
|
+
* @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>
|
|
313
|
+
* @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>
|
|
314
|
+
* @param {*} [options] Override http request option.
|
|
315
|
+
* @throws {RequiredError}
|
|
316
|
+
*/
|
|
317
|
+
listPartnerRelations: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
318
|
+
const localVarPath = `/partnerservice/v1/partners/relations`;
|
|
319
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
320
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
321
|
+
let baseOptions;
|
|
322
|
+
let baseAccessToken;
|
|
323
|
+
if (configuration) {
|
|
324
|
+
baseOptions = configuration.baseOptions;
|
|
325
|
+
baseAccessToken = configuration.accessToken;
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
329
|
+
const localVarHeaderParameter = {} as any;
|
|
330
|
+
const localVarQueryParameter = {} as any;
|
|
331
|
+
|
|
332
|
+
// authentication bearer required
|
|
333
|
+
// http bearer authentication required
|
|
334
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
335
|
+
|
|
336
|
+
if (pageSize !== undefined) {
|
|
337
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
if (pageToken !== undefined) {
|
|
341
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
if (filter !== undefined) {
|
|
345
|
+
localVarQueryParameter['filter'] = filter;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
if (search !== undefined) {
|
|
349
|
+
localVarQueryParameter['search'] = search;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
if (order !== undefined) {
|
|
353
|
+
localVarQueryParameter['order'] = order;
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
if (expand !== undefined) {
|
|
357
|
+
localVarQueryParameter['expand'] = expand;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
if (filters !== undefined) {
|
|
361
|
+
localVarQueryParameter['filters'] = filters;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
365
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
371
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
372
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
373
|
+
|
|
374
|
+
return {
|
|
375
|
+
url: toPathString(localVarUrlObj),
|
|
376
|
+
options: localVarRequestOptions,
|
|
377
|
+
};
|
|
378
|
+
},
|
|
379
|
+
/**
|
|
380
|
+
* Update a partner relation identified by its id
|
|
381
|
+
* @summary Update the partner relation
|
|
382
|
+
* @param {number} id Id of the partner relation
|
|
383
|
+
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
384
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
385
|
+
* @param {*} [options] Override http request option.
|
|
386
|
+
* @throws {RequiredError}
|
|
387
|
+
*/
|
|
388
|
+
updatePartnerRelation: async (id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
389
|
+
// verify required parameter 'id' is not null or undefined
|
|
390
|
+
assertParamExists('updatePartnerRelation', 'id', id)
|
|
391
|
+
// verify required parameter 'updatePartnerRelationRequestDtoRest' is not null or undefined
|
|
392
|
+
assertParamExists('updatePartnerRelation', 'updatePartnerRelationRequestDtoRest', updatePartnerRelationRequestDtoRest)
|
|
393
|
+
const localVarPath = `/partnerservice/v1/partners/relations/{id}`
|
|
394
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
395
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
396
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
397
|
+
let baseOptions;
|
|
398
|
+
let baseAccessToken;
|
|
399
|
+
if (configuration) {
|
|
400
|
+
baseOptions = configuration.baseOptions;
|
|
401
|
+
baseAccessToken = configuration.accessToken;
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
405
|
+
const localVarHeaderParameter = {} as any;
|
|
406
|
+
const localVarQueryParameter = {} as any;
|
|
407
|
+
|
|
408
|
+
// authentication bearer required
|
|
409
|
+
// http bearer authentication required
|
|
410
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
411
|
+
|
|
412
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
413
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
419
|
+
|
|
420
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
421
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
422
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
423
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updatePartnerRelationRequestDtoRest, localVarRequestOptions, configuration)
|
|
424
|
+
|
|
149
425
|
return {
|
|
150
426
|
url: toPathString(localVarUrlObj),
|
|
151
427
|
options: localVarRequestOptions,
|
|
@@ -161,6 +437,42 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
161
437
|
export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
162
438
|
const localVarAxiosParamCreator = PartnerRelationsApiAxiosParamCreator(configuration)
|
|
163
439
|
return {
|
|
440
|
+
/**
|
|
441
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
442
|
+
* @summary Create the partner relation
|
|
443
|
+
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
444
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
445
|
+
* @param {*} [options] Override http request option.
|
|
446
|
+
* @throws {RequiredError}
|
|
447
|
+
*/
|
|
448
|
+
async createPartnerRelation(createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerRelationResponseClass>> {
|
|
449
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPartnerRelation(createPartnerRelationRequestDtoRest, authorization, options);
|
|
450
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
451
|
+
},
|
|
452
|
+
/**
|
|
453
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
454
|
+
* @summary Delete the partner-relation
|
|
455
|
+
* @param {number} id
|
|
456
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
457
|
+
* @param {*} [options] Override http request option.
|
|
458
|
+
* @throws {RequiredError}
|
|
459
|
+
*/
|
|
460
|
+
async deletePartnerRelation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
|
|
461
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePartnerRelation(id, authorization, options);
|
|
462
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
463
|
+
},
|
|
464
|
+
/**
|
|
465
|
+
* Retrieve a single partner relation identified by its id
|
|
466
|
+
* @summary Retrieve the partner relation
|
|
467
|
+
* @param {number} id Id of the partner relation
|
|
468
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
469
|
+
* @param {*} [options] Override http request option.
|
|
470
|
+
* @throws {RequiredError}
|
|
471
|
+
*/
|
|
472
|
+
async getPartnerRelation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationClass>> {
|
|
473
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerRelation(id, authorization, options);
|
|
474
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
475
|
+
},
|
|
164
476
|
/**
|
|
165
477
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
166
478
|
* @summary Retrieve the partner relation type
|
|
@@ -187,8 +499,39 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
187
499
|
* @param {*} [options] Override http request option.
|
|
188
500
|
* @throws {RequiredError}
|
|
189
501
|
*/
|
|
190
|
-
async
|
|
191
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
502
|
+
async 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>> {
|
|
503
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
504
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
505
|
+
},
|
|
506
|
+
/**
|
|
507
|
+
* List all partner relations
|
|
508
|
+
* @summary List partner relations
|
|
509
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
510
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
511
|
+
* @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.
|
|
512
|
+
* @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>
|
|
513
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
514
|
+
* @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>
|
|
515
|
+
* @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>
|
|
516
|
+
* @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>
|
|
517
|
+
* @param {*} [options] Override http request option.
|
|
518
|
+
* @throws {RequiredError}
|
|
519
|
+
*/
|
|
520
|
+
async 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>> {
|
|
521
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
522
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
523
|
+
},
|
|
524
|
+
/**
|
|
525
|
+
* Update a partner relation identified by its id
|
|
526
|
+
* @summary Update the partner relation
|
|
527
|
+
* @param {number} id Id of the partner relation
|
|
528
|
+
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
529
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
530
|
+
* @param {*} [options] Override http request option.
|
|
531
|
+
* @throws {RequiredError}
|
|
532
|
+
*/
|
|
533
|
+
async updatePartnerRelation(id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationClass>> {
|
|
534
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePartnerRelation(id, updatePartnerRelationRequestDtoRest, authorization, options);
|
|
192
535
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
193
536
|
},
|
|
194
537
|
}
|
|
@@ -201,6 +544,39 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
201
544
|
export const PartnerRelationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
202
545
|
const localVarFp = PartnerRelationsApiFp(configuration)
|
|
203
546
|
return {
|
|
547
|
+
/**
|
|
548
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
549
|
+
* @summary Create the partner relation
|
|
550
|
+
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
551
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
552
|
+
* @param {*} [options] Override http request option.
|
|
553
|
+
* @throws {RequiredError}
|
|
554
|
+
*/
|
|
555
|
+
createPartnerRelation(createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: any): AxiosPromise<CreatePartnerRelationResponseClass> {
|
|
556
|
+
return localVarFp.createPartnerRelation(createPartnerRelationRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
557
|
+
},
|
|
558
|
+
/**
|
|
559
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
560
|
+
* @summary Delete the partner-relation
|
|
561
|
+
* @param {number} id
|
|
562
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
563
|
+
* @param {*} [options] Override http request option.
|
|
564
|
+
* @throws {RequiredError}
|
|
565
|
+
*/
|
|
566
|
+
deletePartnerRelation(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
|
|
567
|
+
return localVarFp.deletePartnerRelation(id, authorization, options).then((request) => request(axios, basePath));
|
|
568
|
+
},
|
|
569
|
+
/**
|
|
570
|
+
* Retrieve a single partner relation identified by its id
|
|
571
|
+
* @summary Retrieve the partner relation
|
|
572
|
+
* @param {number} id Id of the partner relation
|
|
573
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
574
|
+
* @param {*} [options] Override http request option.
|
|
575
|
+
* @throws {RequiredError}
|
|
576
|
+
*/
|
|
577
|
+
getPartnerRelation(id: number, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationClass> {
|
|
578
|
+
return localVarFp.getPartnerRelation(id, authorization, options).then((request) => request(axios, basePath));
|
|
579
|
+
},
|
|
204
580
|
/**
|
|
205
581
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
206
582
|
* @summary Retrieve the partner relation type
|
|
@@ -226,12 +602,104 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
226
602
|
* @param {*} [options] Override http request option.
|
|
227
603
|
* @throws {RequiredError}
|
|
228
604
|
*/
|
|
229
|
-
|
|
230
|
-
return localVarFp.
|
|
605
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
|
|
606
|
+
return localVarFp.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
607
|
+
},
|
|
608
|
+
/**
|
|
609
|
+
* List all partner relations
|
|
610
|
+
* @summary List partner relations
|
|
611
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
612
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
613
|
+
* @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.
|
|
614
|
+
* @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>
|
|
615
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
616
|
+
* @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>
|
|
617
|
+
* @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>
|
|
618
|
+
* @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>
|
|
619
|
+
* @param {*} [options] Override http request option.
|
|
620
|
+
* @throws {RequiredError}
|
|
621
|
+
*/
|
|
622
|
+
listPartnerRelations(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass> {
|
|
623
|
+
return localVarFp.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
624
|
+
},
|
|
625
|
+
/**
|
|
626
|
+
* Update a partner relation identified by its id
|
|
627
|
+
* @summary Update the partner relation
|
|
628
|
+
* @param {number} id Id of the partner relation
|
|
629
|
+
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
630
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
631
|
+
* @param {*} [options] Override http request option.
|
|
632
|
+
* @throws {RequiredError}
|
|
633
|
+
*/
|
|
634
|
+
updatePartnerRelation(id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationClass> {
|
|
635
|
+
return localVarFp.updatePartnerRelation(id, updatePartnerRelationRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
231
636
|
},
|
|
232
637
|
};
|
|
233
638
|
};
|
|
234
639
|
|
|
640
|
+
/**
|
|
641
|
+
* Request parameters for createPartnerRelation operation in PartnerRelationsApi.
|
|
642
|
+
* @export
|
|
643
|
+
* @interface PartnerRelationsApiCreatePartnerRelationRequest
|
|
644
|
+
*/
|
|
645
|
+
export interface PartnerRelationsApiCreatePartnerRelationRequest {
|
|
646
|
+
/**
|
|
647
|
+
*
|
|
648
|
+
* @type {CreatePartnerRelationRequestDtoRest}
|
|
649
|
+
* @memberof PartnerRelationsApiCreatePartnerRelation
|
|
650
|
+
*/
|
|
651
|
+
readonly createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest
|
|
652
|
+
|
|
653
|
+
/**
|
|
654
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
655
|
+
* @type {string}
|
|
656
|
+
* @memberof PartnerRelationsApiCreatePartnerRelation
|
|
657
|
+
*/
|
|
658
|
+
readonly authorization?: string
|
|
659
|
+
}
|
|
660
|
+
|
|
661
|
+
/**
|
|
662
|
+
* Request parameters for deletePartnerRelation operation in PartnerRelationsApi.
|
|
663
|
+
* @export
|
|
664
|
+
* @interface PartnerRelationsApiDeletePartnerRelationRequest
|
|
665
|
+
*/
|
|
666
|
+
export interface PartnerRelationsApiDeletePartnerRelationRequest {
|
|
667
|
+
/**
|
|
668
|
+
*
|
|
669
|
+
* @type {number}
|
|
670
|
+
* @memberof PartnerRelationsApiDeletePartnerRelation
|
|
671
|
+
*/
|
|
672
|
+
readonly id: number
|
|
673
|
+
|
|
674
|
+
/**
|
|
675
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
676
|
+
* @type {string}
|
|
677
|
+
* @memberof PartnerRelationsApiDeletePartnerRelation
|
|
678
|
+
*/
|
|
679
|
+
readonly authorization?: string
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
/**
|
|
683
|
+
* Request parameters for getPartnerRelation operation in PartnerRelationsApi.
|
|
684
|
+
* @export
|
|
685
|
+
* @interface PartnerRelationsApiGetPartnerRelationRequest
|
|
686
|
+
*/
|
|
687
|
+
export interface PartnerRelationsApiGetPartnerRelationRequest {
|
|
688
|
+
/**
|
|
689
|
+
* Id of the partner relation
|
|
690
|
+
* @type {number}
|
|
691
|
+
* @memberof PartnerRelationsApiGetPartnerRelation
|
|
692
|
+
*/
|
|
693
|
+
readonly id: number
|
|
694
|
+
|
|
695
|
+
/**
|
|
696
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
697
|
+
* @type {string}
|
|
698
|
+
* @memberof PartnerRelationsApiGetPartnerRelation
|
|
699
|
+
*/
|
|
700
|
+
readonly authorization?: string
|
|
701
|
+
}
|
|
702
|
+
|
|
235
703
|
/**
|
|
236
704
|
* Request parameters for getPartnerRelationType operation in PartnerRelationsApi.
|
|
237
705
|
* @export
|
|
@@ -254,68 +722,159 @@ export interface PartnerRelationsApiGetPartnerRelationTypeRequest {
|
|
|
254
722
|
}
|
|
255
723
|
|
|
256
724
|
/**
|
|
257
|
-
* Request parameters for
|
|
725
|
+
* Request parameters for listPartnerRelationTypes operation in PartnerRelationsApi.
|
|
258
726
|
* @export
|
|
259
|
-
* @interface
|
|
727
|
+
* @interface PartnerRelationsApiListPartnerRelationTypesRequest
|
|
260
728
|
*/
|
|
261
|
-
export interface
|
|
729
|
+
export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
262
730
|
/**
|
|
263
731
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
264
732
|
* @type {string}
|
|
265
|
-
* @memberof
|
|
733
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
266
734
|
*/
|
|
267
735
|
readonly authorization?: string
|
|
268
736
|
|
|
269
737
|
/**
|
|
270
738
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
739
|
* @type {any}
|
|
272
|
-
* @memberof
|
|
740
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
273
741
|
*/
|
|
274
742
|
readonly pageSize?: any
|
|
275
743
|
|
|
276
744
|
/**
|
|
277
745
|
* 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.
|
|
278
746
|
* @type {any}
|
|
279
|
-
* @memberof
|
|
747
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
280
748
|
*/
|
|
281
749
|
readonly pageToken?: any
|
|
282
750
|
|
|
283
751
|
/**
|
|
284
752
|
* 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>
|
|
285
753
|
* @type {string}
|
|
286
|
-
* @memberof
|
|
754
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
287
755
|
*/
|
|
288
756
|
readonly filter?: string
|
|
289
757
|
|
|
290
758
|
/**
|
|
291
759
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
292
760
|
* @type {any}
|
|
293
|
-
* @memberof
|
|
761
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
294
762
|
*/
|
|
295
763
|
readonly search?: any
|
|
296
764
|
|
|
297
765
|
/**
|
|
298
766
|
* 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>
|
|
299
767
|
* @type {string}
|
|
300
|
-
* @memberof
|
|
768
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
301
769
|
*/
|
|
302
770
|
readonly order?: string
|
|
303
771
|
|
|
304
772
|
/**
|
|
305
773
|
* 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>
|
|
306
774
|
* @type {string}
|
|
307
|
-
* @memberof
|
|
775
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
308
776
|
*/
|
|
309
777
|
readonly expand?: string
|
|
310
778
|
|
|
311
779
|
/**
|
|
312
780
|
* 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>
|
|
313
781
|
* @type {string}
|
|
314
|
-
* @memberof
|
|
782
|
+
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
315
783
|
*/
|
|
316
784
|
readonly filters?: string
|
|
317
785
|
}
|
|
318
786
|
|
|
787
|
+
/**
|
|
788
|
+
* Request parameters for listPartnerRelations operation in PartnerRelationsApi.
|
|
789
|
+
* @export
|
|
790
|
+
* @interface PartnerRelationsApiListPartnerRelationsRequest
|
|
791
|
+
*/
|
|
792
|
+
export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
793
|
+
/**
|
|
794
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
795
|
+
* @type {string}
|
|
796
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
797
|
+
*/
|
|
798
|
+
readonly authorization?: string
|
|
799
|
+
|
|
800
|
+
/**
|
|
801
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
802
|
+
* @type {any}
|
|
803
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
804
|
+
*/
|
|
805
|
+
readonly pageSize?: any
|
|
806
|
+
|
|
807
|
+
/**
|
|
808
|
+
* 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.
|
|
809
|
+
* @type {any}
|
|
810
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
811
|
+
*/
|
|
812
|
+
readonly pageToken?: any
|
|
813
|
+
|
|
814
|
+
/**
|
|
815
|
+
* 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>
|
|
816
|
+
* @type {string}
|
|
817
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
818
|
+
*/
|
|
819
|
+
readonly filter?: string
|
|
820
|
+
|
|
821
|
+
/**
|
|
822
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
823
|
+
* @type {any}
|
|
824
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
825
|
+
*/
|
|
826
|
+
readonly search?: any
|
|
827
|
+
|
|
828
|
+
/**
|
|
829
|
+
* 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>
|
|
830
|
+
* @type {string}
|
|
831
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
832
|
+
*/
|
|
833
|
+
readonly order?: string
|
|
834
|
+
|
|
835
|
+
/**
|
|
836
|
+
* 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>
|
|
837
|
+
* @type {string}
|
|
838
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
839
|
+
*/
|
|
840
|
+
readonly expand?: string
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* 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>
|
|
844
|
+
* @type {string}
|
|
845
|
+
* @memberof PartnerRelationsApiListPartnerRelations
|
|
846
|
+
*/
|
|
847
|
+
readonly filters?: string
|
|
848
|
+
}
|
|
849
|
+
|
|
850
|
+
/**
|
|
851
|
+
* Request parameters for updatePartnerRelation operation in PartnerRelationsApi.
|
|
852
|
+
* @export
|
|
853
|
+
* @interface PartnerRelationsApiUpdatePartnerRelationRequest
|
|
854
|
+
*/
|
|
855
|
+
export interface PartnerRelationsApiUpdatePartnerRelationRequest {
|
|
856
|
+
/**
|
|
857
|
+
* Id of the partner relation
|
|
858
|
+
* @type {number}
|
|
859
|
+
* @memberof PartnerRelationsApiUpdatePartnerRelation
|
|
860
|
+
*/
|
|
861
|
+
readonly id: number
|
|
862
|
+
|
|
863
|
+
/**
|
|
864
|
+
*
|
|
865
|
+
* @type {UpdatePartnerRelationRequestDtoRest}
|
|
866
|
+
* @memberof PartnerRelationsApiUpdatePartnerRelation
|
|
867
|
+
*/
|
|
868
|
+
readonly updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest
|
|
869
|
+
|
|
870
|
+
/**
|
|
871
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
872
|
+
* @type {string}
|
|
873
|
+
* @memberof PartnerRelationsApiUpdatePartnerRelation
|
|
874
|
+
*/
|
|
875
|
+
readonly authorization?: string
|
|
876
|
+
}
|
|
877
|
+
|
|
319
878
|
/**
|
|
320
879
|
* PartnerRelationsApi - object-oriented interface
|
|
321
880
|
* @export
|
|
@@ -323,6 +882,42 @@ export interface PartnerRelationsApiListPartnerVersionRequest {
|
|
|
323
882
|
* @extends {BaseAPI}
|
|
324
883
|
*/
|
|
325
884
|
export class PartnerRelationsApi extends BaseAPI {
|
|
885
|
+
/**
|
|
886
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
887
|
+
* @summary Create the partner relation
|
|
888
|
+
* @param {PartnerRelationsApiCreatePartnerRelationRequest} requestParameters Request parameters.
|
|
889
|
+
* @param {*} [options] Override http request option.
|
|
890
|
+
* @throws {RequiredError}
|
|
891
|
+
* @memberof PartnerRelationsApi
|
|
892
|
+
*/
|
|
893
|
+
public createPartnerRelation(requestParameters: PartnerRelationsApiCreatePartnerRelationRequest, options?: AxiosRequestConfig) {
|
|
894
|
+
return PartnerRelationsApiFp(this.configuration).createPartnerRelation(requestParameters.createPartnerRelationRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
895
|
+
}
|
|
896
|
+
|
|
897
|
+
/**
|
|
898
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
899
|
+
* @summary Delete the partner-relation
|
|
900
|
+
* @param {PartnerRelationsApiDeletePartnerRelationRequest} requestParameters Request parameters.
|
|
901
|
+
* @param {*} [options] Override http request option.
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
* @memberof PartnerRelationsApi
|
|
904
|
+
*/
|
|
905
|
+
public deletePartnerRelation(requestParameters: PartnerRelationsApiDeletePartnerRelationRequest, options?: AxiosRequestConfig) {
|
|
906
|
+
return PartnerRelationsApiFp(this.configuration).deletePartnerRelation(requestParameters.id, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
/**
|
|
910
|
+
* Retrieve a single partner relation identified by its id
|
|
911
|
+
* @summary Retrieve the partner relation
|
|
912
|
+
* @param {PartnerRelationsApiGetPartnerRelationRequest} requestParameters Request parameters.
|
|
913
|
+
* @param {*} [options] Override http request option.
|
|
914
|
+
* @throws {RequiredError}
|
|
915
|
+
* @memberof PartnerRelationsApi
|
|
916
|
+
*/
|
|
917
|
+
public getPartnerRelation(requestParameters: PartnerRelationsApiGetPartnerRelationRequest, options?: AxiosRequestConfig) {
|
|
918
|
+
return PartnerRelationsApiFp(this.configuration).getPartnerRelation(requestParameters.id, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
919
|
+
}
|
|
920
|
+
|
|
326
921
|
/**
|
|
327
922
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
328
923
|
* @summary Retrieve the partner relation type
|
|
@@ -338,12 +933,36 @@ export class PartnerRelationsApi extends BaseAPI {
|
|
|
338
933
|
/**
|
|
339
934
|
* List all partner relation types - is used to create partner relations
|
|
340
935
|
* @summary List partner relation types
|
|
341
|
-
* @param {
|
|
936
|
+
* @param {PartnerRelationsApiListPartnerRelationTypesRequest} requestParameters Request parameters.
|
|
937
|
+
* @param {*} [options] Override http request option.
|
|
938
|
+
* @throws {RequiredError}
|
|
939
|
+
* @memberof PartnerRelationsApi
|
|
940
|
+
*/
|
|
941
|
+
public listPartnerRelationTypes(requestParameters: PartnerRelationsApiListPartnerRelationTypesRequest = {}, options?: AxiosRequestConfig) {
|
|
942
|
+
return PartnerRelationsApiFp(this.configuration).listPartnerRelationTypes(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
943
|
+
}
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
* List all partner relations
|
|
947
|
+
* @summary List partner relations
|
|
948
|
+
* @param {PartnerRelationsApiListPartnerRelationsRequest} requestParameters Request parameters.
|
|
949
|
+
* @param {*} [options] Override http request option.
|
|
950
|
+
* @throws {RequiredError}
|
|
951
|
+
* @memberof PartnerRelationsApi
|
|
952
|
+
*/
|
|
953
|
+
public listPartnerRelations(requestParameters: PartnerRelationsApiListPartnerRelationsRequest = {}, options?: AxiosRequestConfig) {
|
|
954
|
+
return PartnerRelationsApiFp(this.configuration).listPartnerRelations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
/**
|
|
958
|
+
* Update a partner relation identified by its id
|
|
959
|
+
* @summary Update the partner relation
|
|
960
|
+
* @param {PartnerRelationsApiUpdatePartnerRelationRequest} requestParameters Request parameters.
|
|
342
961
|
* @param {*} [options] Override http request option.
|
|
343
962
|
* @throws {RequiredError}
|
|
344
963
|
* @memberof PartnerRelationsApi
|
|
345
964
|
*/
|
|
346
|
-
public
|
|
347
|
-
return PartnerRelationsApiFp(this.configuration).
|
|
965
|
+
public updatePartnerRelation(requestParameters: PartnerRelationsApiUpdatePartnerRelationRequest, options?: AxiosRequestConfig) {
|
|
966
|
+
return PartnerRelationsApiFp(this.configuration).updatePartnerRelation(requestParameters.id, requestParameters.updatePartnerRelationRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
348
967
|
}
|
|
349
968
|
}
|