@emilgroup/partner-sdk 1.6.0 → 1.6.1-beta.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 +10 -4
- package/README.md +2 -2
- package/api/{partners-api.ts → partner-api.ts} +82 -82
- package/api/partner-invitation-api.ts +165 -0
- package/api/{partner-relations-api.ts → partner-relation-api.ts} +91 -91
- package/api/{partner-tags-api.ts → partner-tag-api.ts} +66 -66
- package/api/{partner-types-api.ts → partner-type-api.ts} +64 -64
- package/api.ts +10 -8
- package/dist/api/{partners-api.d.ts → partner-api.d.ts} +74 -74
- package/dist/api/{partners-api.js → partner-api.js} +49 -49
- package/dist/api/partner-invitation-api.d.ts +97 -0
- package/dist/api/partner-invitation-api.js +224 -0
- package/dist/api/{partner-relations-api.d.ts → partner-relation-api.d.ts} +82 -82
- package/dist/api/{partner-relations-api.js → partner-relation-api.js} +50 -50
- package/dist/api/{partner-tags-api.d.ts → partner-tag-api.d.ts} +59 -59
- package/dist/api/{partner-tags-api.js → partner-tag-api.js} +42 -42
- package/dist/api/{partner-types-api.d.ts → partner-type-api.d.ts} +57 -57
- package/dist/api/{partner-types-api.js → partner-type-api.js} +39 -39
- package/dist/api.d.ts +5 -4
- package/dist/api.js +5 -4
- package/dist/models/create-partner-response-class.d.ts +7 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/models/invite-class.d.ts +79 -0
- package/dist/models/invite-class.js +15 -0
- package/dist/models/invite-partner-to-eis-response-class.d.ts +25 -0
- package/dist/models/invite-partner-to-eis-response-class.js +15 -0
- package/dist/models/invite-partner-to-eisrequest-dto.d.ts +42 -0
- package/dist/models/invite-partner-to-eisrequest-dto.js +15 -0
- package/dist/models/partner-class.d.ts +6 -0
- package/dist/models/permission-class.d.ts +72 -0
- package/dist/models/permission-class.js +15 -0
- package/dist/models/role-class.d.ts +73 -0
- package/dist/models/role-class.js +15 -0
- package/models/create-partner-response-class.ts +7 -0
- package/models/index.ts +5 -0
- package/models/invite-class.ts +85 -0
- package/models/invite-partner-to-eis-response-class.ts +31 -0
- package/models/invite-partner-to-eisrequest-dto.ts +48 -0
- package/models/partner-class.ts +6 -0
- package/models/permission-class.ts +78 -0
- package/models/role-class.ts +79 -0
- package/package.json +1 -1
|
@@ -21,10 +21,10 @@ import { ListPartnerRelationClass } from '../models';
|
|
|
21
21
|
import { ListPartnerRelationTypesClass } from '../models';
|
|
22
22
|
import { UpdatePartnerRelationRequestDtoRest } from '../models';
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* PartnerRelationApi - axios parameter creator
|
|
25
25
|
* @export
|
|
26
26
|
*/
|
|
27
|
-
export declare const
|
|
27
|
+
export declare const PartnerRelationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
28
|
/**
|
|
29
29
|
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
30
30
|
* @summary Create the partner relation
|
|
@@ -70,7 +70,7 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
70
70
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
71
71
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
72
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
73
|
-
* @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/>
|
|
73
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
74
74
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
@@ -103,10 +103,10 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
103
103
|
updatePartnerRelation: (id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
104
|
};
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
106
|
+
* PartnerRelationApi - functional programming interface
|
|
107
107
|
* @export
|
|
108
108
|
*/
|
|
109
|
-
export declare const
|
|
109
|
+
export declare const PartnerRelationApiFp: (configuration?: Configuration) => {
|
|
110
110
|
/**
|
|
111
111
|
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
112
112
|
* @summary Create the partner relation
|
|
@@ -152,7 +152,7 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
152
152
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
153
153
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
154
154
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
155
|
-
* @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/>
|
|
155
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
156
156
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
@@ -185,10 +185,10 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
185
185
|
updatePartnerRelation(id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationClass>>;
|
|
186
186
|
};
|
|
187
187
|
/**
|
|
188
|
-
*
|
|
188
|
+
* PartnerRelationApi - factory interface
|
|
189
189
|
* @export
|
|
190
190
|
*/
|
|
191
|
-
export declare const
|
|
191
|
+
export declare const PartnerRelationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
192
192
|
/**
|
|
193
193
|
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
194
194
|
* @summary Create the partner relation
|
|
@@ -234,7 +234,7 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
234
234
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
235
235
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
236
236
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
237
|
-
* @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/>
|
|
237
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
238
238
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
240
240
|
* @throws {RequiredError}
|
|
@@ -267,284 +267,284 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
267
267
|
updatePartnerRelation(id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationClass>;
|
|
268
268
|
};
|
|
269
269
|
/**
|
|
270
|
-
* Request parameters for createPartnerRelation operation in
|
|
270
|
+
* Request parameters for createPartnerRelation operation in PartnerRelationApi.
|
|
271
271
|
* @export
|
|
272
|
-
* @interface
|
|
272
|
+
* @interface PartnerRelationApiCreatePartnerRelationRequest
|
|
273
273
|
*/
|
|
274
|
-
export interface
|
|
274
|
+
export interface PartnerRelationApiCreatePartnerRelationRequest {
|
|
275
275
|
/**
|
|
276
276
|
*
|
|
277
277
|
* @type {CreatePartnerRelationRequestDtoRest}
|
|
278
|
-
* @memberof
|
|
278
|
+
* @memberof PartnerRelationApiCreatePartnerRelation
|
|
279
279
|
*/
|
|
280
280
|
readonly createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest;
|
|
281
281
|
/**
|
|
282
282
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
283
283
|
* @type {string}
|
|
284
|
-
* @memberof
|
|
284
|
+
* @memberof PartnerRelationApiCreatePartnerRelation
|
|
285
285
|
*/
|
|
286
286
|
readonly authorization?: string;
|
|
287
287
|
}
|
|
288
288
|
/**
|
|
289
|
-
* Request parameters for deletePartnerRelation operation in
|
|
289
|
+
* Request parameters for deletePartnerRelation operation in PartnerRelationApi.
|
|
290
290
|
* @export
|
|
291
|
-
* @interface
|
|
291
|
+
* @interface PartnerRelationApiDeletePartnerRelationRequest
|
|
292
292
|
*/
|
|
293
|
-
export interface
|
|
293
|
+
export interface PartnerRelationApiDeletePartnerRelationRequest {
|
|
294
294
|
/**
|
|
295
295
|
*
|
|
296
296
|
* @type {number}
|
|
297
|
-
* @memberof
|
|
297
|
+
* @memberof PartnerRelationApiDeletePartnerRelation
|
|
298
298
|
*/
|
|
299
299
|
readonly id: number;
|
|
300
300
|
/**
|
|
301
301
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
302
302
|
* @type {string}
|
|
303
|
-
* @memberof
|
|
303
|
+
* @memberof PartnerRelationApiDeletePartnerRelation
|
|
304
304
|
*/
|
|
305
305
|
readonly authorization?: string;
|
|
306
306
|
}
|
|
307
307
|
/**
|
|
308
|
-
* Request parameters for getPartnerRelation operation in
|
|
308
|
+
* Request parameters for getPartnerRelation operation in PartnerRelationApi.
|
|
309
309
|
* @export
|
|
310
|
-
* @interface
|
|
310
|
+
* @interface PartnerRelationApiGetPartnerRelationRequest
|
|
311
311
|
*/
|
|
312
|
-
export interface
|
|
312
|
+
export interface PartnerRelationApiGetPartnerRelationRequest {
|
|
313
313
|
/**
|
|
314
314
|
* Id of the partner relation
|
|
315
315
|
* @type {number}
|
|
316
|
-
* @memberof
|
|
316
|
+
* @memberof PartnerRelationApiGetPartnerRelation
|
|
317
317
|
*/
|
|
318
318
|
readonly id: number;
|
|
319
319
|
/**
|
|
320
320
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
321
321
|
* @type {string}
|
|
322
|
-
* @memberof
|
|
322
|
+
* @memberof PartnerRelationApiGetPartnerRelation
|
|
323
323
|
*/
|
|
324
324
|
readonly authorization?: string;
|
|
325
325
|
}
|
|
326
326
|
/**
|
|
327
|
-
* Request parameters for getPartnerRelationType operation in
|
|
327
|
+
* Request parameters for getPartnerRelationType operation in PartnerRelationApi.
|
|
328
328
|
* @export
|
|
329
|
-
* @interface
|
|
329
|
+
* @interface PartnerRelationApiGetPartnerRelationTypeRequest
|
|
330
330
|
*/
|
|
331
|
-
export interface
|
|
331
|
+
export interface PartnerRelationApiGetPartnerRelationTypeRequest {
|
|
332
332
|
/**
|
|
333
333
|
* Identifying slug of the partner relation type
|
|
334
334
|
* @type {string}
|
|
335
|
-
* @memberof
|
|
335
|
+
* @memberof PartnerRelationApiGetPartnerRelationType
|
|
336
336
|
*/
|
|
337
337
|
readonly slug: string;
|
|
338
338
|
/**
|
|
339
339
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
340
340
|
* @type {string}
|
|
341
|
-
* @memberof
|
|
341
|
+
* @memberof PartnerRelationApiGetPartnerRelationType
|
|
342
342
|
*/
|
|
343
343
|
readonly authorization?: string;
|
|
344
344
|
}
|
|
345
345
|
/**
|
|
346
|
-
* Request parameters for listPartnerRelationTypes operation in
|
|
346
|
+
* Request parameters for listPartnerRelationTypes operation in PartnerRelationApi.
|
|
347
347
|
* @export
|
|
348
|
-
* @interface
|
|
348
|
+
* @interface PartnerRelationApiListPartnerRelationTypesRequest
|
|
349
349
|
*/
|
|
350
|
-
export interface
|
|
350
|
+
export interface PartnerRelationApiListPartnerRelationTypesRequest {
|
|
351
351
|
/**
|
|
352
352
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
353
|
* @type {string}
|
|
354
|
-
* @memberof
|
|
354
|
+
* @memberof PartnerRelationApiListPartnerRelationTypes
|
|
355
355
|
*/
|
|
356
356
|
readonly authorization?: string;
|
|
357
357
|
/**
|
|
358
358
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
359
359
|
* @type {any}
|
|
360
|
-
* @memberof
|
|
360
|
+
* @memberof PartnerRelationApiListPartnerRelationTypes
|
|
361
361
|
*/
|
|
362
362
|
readonly pageSize?: any;
|
|
363
363
|
/**
|
|
364
364
|
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
365
365
|
* @type {any}
|
|
366
|
-
* @memberof
|
|
366
|
+
* @memberof PartnerRelationApiListPartnerRelationTypes
|
|
367
367
|
*/
|
|
368
368
|
readonly pageToken?: any;
|
|
369
369
|
/**
|
|
370
370
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
371
371
|
* @type {string}
|
|
372
|
-
* @memberof
|
|
372
|
+
* @memberof PartnerRelationApiListPartnerRelationTypes
|
|
373
373
|
*/
|
|
374
374
|
readonly filter?: string;
|
|
375
375
|
/**
|
|
376
376
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
377
377
|
* @type {any}
|
|
378
|
-
* @memberof
|
|
378
|
+
* @memberof PartnerRelationApiListPartnerRelationTypes
|
|
379
379
|
*/
|
|
380
380
|
readonly search?: any;
|
|
381
381
|
/**
|
|
382
382
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
383
383
|
* @type {string}
|
|
384
|
-
* @memberof
|
|
384
|
+
* @memberof PartnerRelationApiListPartnerRelationTypes
|
|
385
385
|
*/
|
|
386
386
|
readonly order?: string;
|
|
387
387
|
/**
|
|
388
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
388
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
389
389
|
* @type {string}
|
|
390
|
-
* @memberof
|
|
390
|
+
* @memberof PartnerRelationApiListPartnerRelationTypes
|
|
391
391
|
*/
|
|
392
392
|
readonly expand?: string;
|
|
393
393
|
/**
|
|
394
394
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
395
395
|
* @type {string}
|
|
396
|
-
* @memberof
|
|
396
|
+
* @memberof PartnerRelationApiListPartnerRelationTypes
|
|
397
397
|
*/
|
|
398
398
|
readonly filters?: string;
|
|
399
399
|
}
|
|
400
400
|
/**
|
|
401
|
-
* Request parameters for listPartnerRelations operation in
|
|
401
|
+
* Request parameters for listPartnerRelations operation in PartnerRelationApi.
|
|
402
402
|
* @export
|
|
403
|
-
* @interface
|
|
403
|
+
* @interface PartnerRelationApiListPartnerRelationsRequest
|
|
404
404
|
*/
|
|
405
|
-
export interface
|
|
405
|
+
export interface PartnerRelationApiListPartnerRelationsRequest {
|
|
406
406
|
/**
|
|
407
407
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
408
408
|
* @type {string}
|
|
409
|
-
* @memberof
|
|
409
|
+
* @memberof PartnerRelationApiListPartnerRelations
|
|
410
410
|
*/
|
|
411
411
|
readonly authorization?: string;
|
|
412
412
|
/**
|
|
413
413
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
414
414
|
* @type {any}
|
|
415
|
-
* @memberof
|
|
415
|
+
* @memberof PartnerRelationApiListPartnerRelations
|
|
416
416
|
*/
|
|
417
417
|
readonly pageSize?: any;
|
|
418
418
|
/**
|
|
419
419
|
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
420
420
|
* @type {any}
|
|
421
|
-
* @memberof
|
|
421
|
+
* @memberof PartnerRelationApiListPartnerRelations
|
|
422
422
|
*/
|
|
423
423
|
readonly pageToken?: any;
|
|
424
424
|
/**
|
|
425
425
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
426
426
|
* @type {string}
|
|
427
|
-
* @memberof
|
|
427
|
+
* @memberof PartnerRelationApiListPartnerRelations
|
|
428
428
|
*/
|
|
429
429
|
readonly filter?: string;
|
|
430
430
|
/**
|
|
431
431
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
432
432
|
* @type {any}
|
|
433
|
-
* @memberof
|
|
433
|
+
* @memberof PartnerRelationApiListPartnerRelations
|
|
434
434
|
*/
|
|
435
435
|
readonly search?: any;
|
|
436
436
|
/**
|
|
437
437
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
438
438
|
* @type {string}
|
|
439
|
-
* @memberof
|
|
439
|
+
* @memberof PartnerRelationApiListPartnerRelations
|
|
440
440
|
*/
|
|
441
441
|
readonly order?: string;
|
|
442
442
|
/**
|
|
443
443
|
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerRelationType<i>
|
|
444
444
|
* @type {string}
|
|
445
|
-
* @memberof
|
|
445
|
+
* @memberof PartnerRelationApiListPartnerRelations
|
|
446
446
|
*/
|
|
447
447
|
readonly expand?: string;
|
|
448
448
|
/**
|
|
449
449
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
450
450
|
* @type {string}
|
|
451
|
-
* @memberof
|
|
451
|
+
* @memberof PartnerRelationApiListPartnerRelations
|
|
452
452
|
*/
|
|
453
453
|
readonly filters?: string;
|
|
454
454
|
}
|
|
455
455
|
/**
|
|
456
|
-
* Request parameters for updatePartnerRelation operation in
|
|
456
|
+
* Request parameters for updatePartnerRelation operation in PartnerRelationApi.
|
|
457
457
|
* @export
|
|
458
|
-
* @interface
|
|
458
|
+
* @interface PartnerRelationApiUpdatePartnerRelationRequest
|
|
459
459
|
*/
|
|
460
|
-
export interface
|
|
460
|
+
export interface PartnerRelationApiUpdatePartnerRelationRequest {
|
|
461
461
|
/**
|
|
462
462
|
* Id of the partner relation
|
|
463
463
|
* @type {number}
|
|
464
|
-
* @memberof
|
|
464
|
+
* @memberof PartnerRelationApiUpdatePartnerRelation
|
|
465
465
|
*/
|
|
466
466
|
readonly id: number;
|
|
467
467
|
/**
|
|
468
468
|
*
|
|
469
469
|
* @type {UpdatePartnerRelationRequestDtoRest}
|
|
470
|
-
* @memberof
|
|
470
|
+
* @memberof PartnerRelationApiUpdatePartnerRelation
|
|
471
471
|
*/
|
|
472
472
|
readonly updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest;
|
|
473
473
|
/**
|
|
474
474
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
475
475
|
* @type {string}
|
|
476
|
-
* @memberof
|
|
476
|
+
* @memberof PartnerRelationApiUpdatePartnerRelation
|
|
477
477
|
*/
|
|
478
478
|
readonly authorization?: string;
|
|
479
479
|
}
|
|
480
480
|
/**
|
|
481
|
-
*
|
|
481
|
+
* PartnerRelationApi - object-oriented interface
|
|
482
482
|
* @export
|
|
483
|
-
* @class
|
|
483
|
+
* @class PartnerRelationApi
|
|
484
484
|
* @extends {BaseAPI}
|
|
485
485
|
*/
|
|
486
|
-
export declare class
|
|
486
|
+
export declare class PartnerRelationApi extends BaseAPI {
|
|
487
487
|
/**
|
|
488
488
|
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
489
489
|
* @summary Create the partner relation
|
|
490
|
-
* @param {
|
|
490
|
+
* @param {PartnerRelationApiCreatePartnerRelationRequest} requestParameters Request parameters.
|
|
491
491
|
* @param {*} [options] Override http request option.
|
|
492
492
|
* @throws {RequiredError}
|
|
493
|
-
* @memberof
|
|
493
|
+
* @memberof PartnerRelationApi
|
|
494
494
|
*/
|
|
495
|
-
createPartnerRelation(requestParameters:
|
|
495
|
+
createPartnerRelation(requestParameters: PartnerRelationApiCreatePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerRelationResponseClass, any>>;
|
|
496
496
|
/**
|
|
497
497
|
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
498
498
|
* @summary Delete the partner-relation
|
|
499
|
-
* @param {
|
|
499
|
+
* @param {PartnerRelationApiDeletePartnerRelationRequest} requestParameters Request parameters.
|
|
500
500
|
* @param {*} [options] Override http request option.
|
|
501
501
|
* @throws {RequiredError}
|
|
502
|
-
* @memberof
|
|
502
|
+
* @memberof PartnerRelationApi
|
|
503
503
|
*/
|
|
504
|
-
deletePartnerRelation(requestParameters:
|
|
504
|
+
deletePartnerRelation(requestParameters: PartnerRelationApiDeletePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
505
505
|
/**
|
|
506
506
|
* Retrieve a single partner relation identified by its id
|
|
507
507
|
* @summary Retrieve the partner relation
|
|
508
|
-
* @param {
|
|
508
|
+
* @param {PartnerRelationApiGetPartnerRelationRequest} requestParameters Request parameters.
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
510
510
|
* @throws {RequiredError}
|
|
511
|
-
* @memberof
|
|
511
|
+
* @memberof PartnerRelationApi
|
|
512
512
|
*/
|
|
513
|
-
getPartnerRelation(requestParameters:
|
|
513
|
+
getPartnerRelation(requestParameters: PartnerRelationApiGetPartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationClass, any>>;
|
|
514
514
|
/**
|
|
515
515
|
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
516
516
|
* @summary Retrieve the partner relation type
|
|
517
|
-
* @param {
|
|
517
|
+
* @param {PartnerRelationApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
|
|
518
518
|
* @param {*} [options] Override http request option.
|
|
519
519
|
* @throws {RequiredError}
|
|
520
|
-
* @memberof
|
|
520
|
+
* @memberof PartnerRelationApi
|
|
521
521
|
*/
|
|
522
|
-
getPartnerRelationType(requestParameters:
|
|
522
|
+
getPartnerRelationType(requestParameters: PartnerRelationApiGetPartnerRelationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationTypeClass, any>>;
|
|
523
523
|
/**
|
|
524
524
|
* List all partner relation types - is used to create partner relations
|
|
525
525
|
* @summary List partner relation types
|
|
526
|
-
* @param {
|
|
526
|
+
* @param {PartnerRelationApiListPartnerRelationTypesRequest} requestParameters Request parameters.
|
|
527
527
|
* @param {*} [options] Override http request option.
|
|
528
528
|
* @throws {RequiredError}
|
|
529
|
-
* @memberof
|
|
529
|
+
* @memberof PartnerRelationApi
|
|
530
530
|
*/
|
|
531
|
-
listPartnerRelationTypes(requestParameters?:
|
|
531
|
+
listPartnerRelationTypes(requestParameters?: PartnerRelationApiListPartnerRelationTypesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRelationTypesClass, any>>;
|
|
532
532
|
/**
|
|
533
533
|
* List all partner relations
|
|
534
534
|
* @summary List partner relations
|
|
535
|
-
* @param {
|
|
535
|
+
* @param {PartnerRelationApiListPartnerRelationsRequest} requestParameters Request parameters.
|
|
536
536
|
* @param {*} [options] Override http request option.
|
|
537
537
|
* @throws {RequiredError}
|
|
538
|
-
* @memberof
|
|
538
|
+
* @memberof PartnerRelationApi
|
|
539
539
|
*/
|
|
540
|
-
listPartnerRelations(requestParameters?:
|
|
540
|
+
listPartnerRelations(requestParameters?: PartnerRelationApiListPartnerRelationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRelationClass, any>>;
|
|
541
541
|
/**
|
|
542
542
|
* Update a partner relation identified by its id
|
|
543
543
|
* @summary Update the partner relation
|
|
544
|
-
* @param {
|
|
544
|
+
* @param {PartnerRelationApiUpdatePartnerRelationRequest} requestParameters Request parameters.
|
|
545
545
|
* @param {*} [options] Override http request option.
|
|
546
546
|
* @throws {RequiredError}
|
|
547
|
-
* @memberof
|
|
547
|
+
* @memberof PartnerRelationApi
|
|
548
548
|
*/
|
|
549
|
-
updatePartnerRelation(requestParameters:
|
|
549
|
+
updatePartnerRelation(requestParameters: PartnerRelationApiUpdatePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationClass, any>>;
|
|
550
550
|
}
|