@emilgroup/partner-sdk-node 1.13.0 → 1.13.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/README.md +2 -2
- package/api/partner-invitations-api.ts +4 -4
- package/api/partner-relations-api.ts +66 -66
- package/api/partner-tags-api.ts +43 -43
- package/api/partner-types-api.ts +60 -60
- package/api/partner-versions-api.ts +27 -27
- package/api/partners-api.ts +66 -66
- package/base.ts +1 -1
- package/common.ts +2 -2
- package/configuration.ts +9 -0
- package/dist/api/partner-invitations-api.d.ts +4 -4
- package/dist/api/partner-invitations-api.js +4 -4
- package/dist/api/partner-relations-api.d.ts +66 -66
- package/dist/api/partner-relations-api.js +46 -46
- package/dist/api/partner-tags-api.d.ts +43 -43
- package/dist/api/partner-tags-api.js +32 -32
- package/dist/api/partner-types-api.d.ts +60 -60
- package/dist/api/partner-types-api.js +41 -41
- package/dist/api/partner-versions-api.d.ts +27 -27
- package/dist/api/partner-versions-api.js +17 -17
- package/dist/api/partners-api.d.ts +66 -66
- package/dist/api/partners-api.js +46 -46
- package/dist/base.js +1 -1
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +6 -0
- package/dist/configuration.js +8 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/partner-sdk-node@1.13.
|
|
20
|
+
npm install @emilgroup/partner-sdk-node@1.13.1-beta.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk-node@1.13.
|
|
24
|
+
yarn add @emilgroup/partner-sdk-node@1.13.1-beta.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -35,7 +35,7 @@ const FormData = require('form-data');
|
|
|
35
35
|
export const PartnerInvitationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
38
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
39
39
|
* @summary Create the Partner Invitation
|
|
40
40
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -92,7 +92,7 @@ export const PartnerInvitationsApiFp = function(configuration?: Configuration) {
|
|
|
92
92
|
const localVarAxiosParamCreator = PartnerInvitationsApiAxiosParamCreator(configuration)
|
|
93
93
|
return {
|
|
94
94
|
/**
|
|
95
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
95
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
96
96
|
* @summary Create the Partner Invitation
|
|
97
97
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
98
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -114,7 +114,7 @@ export const PartnerInvitationsApiFactory = function (configuration?: Configurat
|
|
|
114
114
|
const localVarFp = PartnerInvitationsApiFp(configuration)
|
|
115
115
|
return {
|
|
116
116
|
/**
|
|
117
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
117
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
118
118
|
* @summary Create the Partner Invitation
|
|
119
119
|
* @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
|
|
120
120
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -156,7 +156,7 @@ export interface PartnerInvitationsApiInvitePartnerToEISRequest {
|
|
|
156
156
|
*/
|
|
157
157
|
export class PartnerInvitationsApi extends BaseAPI {
|
|
158
158
|
/**
|
|
159
|
-
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
|
|
159
|
+
* Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
|
|
160
160
|
* @summary Create the Partner Invitation
|
|
161
161
|
* @param {PartnerInvitationsApiInvitePartnerToEISRequest} requestParameters Request parameters.
|
|
162
162
|
* @param {*} [options] Override http request option.
|
|
@@ -47,7 +47,7 @@ const FormData = require('form-data');
|
|
|
47
47
|
export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
48
|
return {
|
|
49
49
|
/**
|
|
50
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
50
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
51
51
|
* @summary Create the partner relation
|
|
52
52
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
53
53
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -94,7 +94,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
94
94
|
};
|
|
95
95
|
},
|
|
96
96
|
/**
|
|
97
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
97
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
98
98
|
* @summary Delete the partner-relation
|
|
99
99
|
* @param {number} id
|
|
100
100
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -139,7 +139,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
139
139
|
};
|
|
140
140
|
},
|
|
141
141
|
/**
|
|
142
|
-
* Retrieve a single partner relation identified by its id
|
|
142
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
143
143
|
* @summary Retrieve the partner relation
|
|
144
144
|
* @param {number} id Id of the partner relation
|
|
145
145
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -184,7 +184,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
184
184
|
};
|
|
185
185
|
},
|
|
186
186
|
/**
|
|
187
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
187
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
188
188
|
* @summary Retrieve the partner relation type
|
|
189
189
|
* @param {string} slug Identifying slug of the partner relation type
|
|
190
190
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -229,20 +229,20 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
229
229
|
};
|
|
230
230
|
},
|
|
231
231
|
/**
|
|
232
|
-
* List all partner relation types - is used to create partner relations
|
|
232
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
233
233
|
* @summary List partner relation types
|
|
234
234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
235
|
-
* @param {
|
|
236
|
-
* @param {
|
|
235
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
236
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
237
237
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
238
|
-
* @param {
|
|
238
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
239
239
|
* @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>
|
|
240
240
|
* @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/>
|
|
241
241
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
242
242
|
* @param {*} [options] Override http request option.
|
|
243
243
|
* @throws {RequiredError}
|
|
244
244
|
*/
|
|
245
|
-
listPartnerRelationTypes: async (authorization?: string, pageSize?:
|
|
245
|
+
listPartnerRelationTypes: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
246
246
|
const localVarPath = `/partnerservice/v1/partners/relations/types`;
|
|
247
247
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
248
248
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -305,20 +305,20 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
305
305
|
};
|
|
306
306
|
},
|
|
307
307
|
/**
|
|
308
|
-
* List all partner relations
|
|
308
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
309
309
|
* @summary List partner relations
|
|
310
310
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
311
|
-
* @param {
|
|
312
|
-
* @param {
|
|
311
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
312
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
313
313
|
* @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>
|
|
314
|
-
* @param {
|
|
314
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
315
315
|
* @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>
|
|
316
316
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
317
317
|
* @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>
|
|
318
318
|
* @param {*} [options] Override http request option.
|
|
319
319
|
* @throws {RequiredError}
|
|
320
320
|
*/
|
|
321
|
-
listPartnerRelations: async (authorization?: string, pageSize?:
|
|
321
|
+
listPartnerRelations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
322
322
|
const localVarPath = `/partnerservice/v1/partners/relations`;
|
|
323
323
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
324
324
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -381,7 +381,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
381
381
|
};
|
|
382
382
|
},
|
|
383
383
|
/**
|
|
384
|
-
* Update a partner relation identified by its id
|
|
384
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
385
385
|
* @summary Update the partner relation
|
|
386
386
|
* @param {number} id Id of the partner relation
|
|
387
387
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -442,7 +442,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
442
442
|
const localVarAxiosParamCreator = PartnerRelationsApiAxiosParamCreator(configuration)
|
|
443
443
|
return {
|
|
444
444
|
/**
|
|
445
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
445
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
446
446
|
* @summary Create the partner relation
|
|
447
447
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
448
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -454,7 +454,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
454
454
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
455
455
|
},
|
|
456
456
|
/**
|
|
457
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
457
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
458
458
|
* @summary Delete the partner-relation
|
|
459
459
|
* @param {number} id
|
|
460
460
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -466,7 +466,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
466
466
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
467
467
|
},
|
|
468
468
|
/**
|
|
469
|
-
* Retrieve a single partner relation identified by its id
|
|
469
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
470
470
|
* @summary Retrieve the partner relation
|
|
471
471
|
* @param {number} id Id of the partner relation
|
|
472
472
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -478,7 +478,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
478
478
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
479
479
|
},
|
|
480
480
|
/**
|
|
481
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
481
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
482
482
|
* @summary Retrieve the partner relation type
|
|
483
483
|
* @param {string} slug Identifying slug of the partner relation type
|
|
484
484
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -490,43 +490,43 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
490
490
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
491
491
|
},
|
|
492
492
|
/**
|
|
493
|
-
* List all partner relation types - is used to create partner relations
|
|
493
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
494
494
|
* @summary List partner relation types
|
|
495
495
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
496
|
-
* @param {
|
|
497
|
-
* @param {
|
|
496
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
497
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
498
498
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
499
|
-
* @param {
|
|
499
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
500
500
|
* @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>
|
|
501
501
|
* @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/>
|
|
502
502
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
503
503
|
* @param {*} [options] Override http request option.
|
|
504
504
|
* @throws {RequiredError}
|
|
505
505
|
*/
|
|
506
|
-
async listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
506
|
+
async listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>> {
|
|
507
507
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
508
508
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
509
509
|
},
|
|
510
510
|
/**
|
|
511
|
-
* List all partner relations
|
|
511
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
512
512
|
* @summary List partner relations
|
|
513
513
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
514
|
-
* @param {
|
|
515
|
-
* @param {
|
|
514
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
515
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
516
516
|
* @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>
|
|
517
|
-
* @param {
|
|
517
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
518
518
|
* @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>
|
|
519
519
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
520
520
|
* @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>
|
|
521
521
|
* @param {*} [options] Override http request option.
|
|
522
522
|
* @throws {RequiredError}
|
|
523
523
|
*/
|
|
524
|
-
async listPartnerRelations(authorization?: string, pageSize?:
|
|
524
|
+
async listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationClass>> {
|
|
525
525
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
526
526
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
527
527
|
},
|
|
528
528
|
/**
|
|
529
|
-
* Update a partner relation identified by its id
|
|
529
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
530
530
|
* @summary Update the partner relation
|
|
531
531
|
* @param {number} id Id of the partner relation
|
|
532
532
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -549,7 +549,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
549
549
|
const localVarFp = PartnerRelationsApiFp(configuration)
|
|
550
550
|
return {
|
|
551
551
|
/**
|
|
552
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
552
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
553
553
|
* @summary Create the partner relation
|
|
554
554
|
* @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
|
|
555
555
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -560,7 +560,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
560
560
|
return localVarFp.createPartnerRelation(createPartnerRelationRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
561
561
|
},
|
|
562
562
|
/**
|
|
563
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
563
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
564
564
|
* @summary Delete the partner-relation
|
|
565
565
|
* @param {number} id
|
|
566
566
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -571,7 +571,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
571
571
|
return localVarFp.deletePartnerRelation(id, authorization, options).then((request) => request(axios, basePath));
|
|
572
572
|
},
|
|
573
573
|
/**
|
|
574
|
-
* Retrieve a single partner relation identified by its id
|
|
574
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
575
575
|
* @summary Retrieve the partner relation
|
|
576
576
|
* @param {number} id Id of the partner relation
|
|
577
577
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -582,7 +582,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
582
582
|
return localVarFp.getPartnerRelation(id, authorization, options).then((request) => request(axios, basePath));
|
|
583
583
|
},
|
|
584
584
|
/**
|
|
585
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
585
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
586
586
|
* @summary Retrieve the partner relation type
|
|
587
587
|
* @param {string} slug Identifying slug of the partner relation type
|
|
588
588
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -593,41 +593,41 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
593
593
|
return localVarFp.getPartnerRelationType(slug, authorization, options).then((request) => request(axios, basePath));
|
|
594
594
|
},
|
|
595
595
|
/**
|
|
596
|
-
* List all partner relation types - is used to create partner relations
|
|
596
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
597
597
|
* @summary List partner relation types
|
|
598
598
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
599
|
-
* @param {
|
|
600
|
-
* @param {
|
|
599
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
600
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
601
601
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
602
|
-
* @param {
|
|
602
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
603
603
|
* @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>
|
|
604
604
|
* @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/>
|
|
605
605
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
606
606
|
* @param {*} [options] Override http request option.
|
|
607
607
|
* @throws {RequiredError}
|
|
608
608
|
*/
|
|
609
|
-
listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
609
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
|
|
610
610
|
return localVarFp.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
611
611
|
},
|
|
612
612
|
/**
|
|
613
|
-
* List all partner relations
|
|
613
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
614
614
|
* @summary List partner relations
|
|
615
615
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
616
|
-
* @param {
|
|
617
|
-
* @param {
|
|
616
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
617
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
618
618
|
* @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>
|
|
619
|
-
* @param {
|
|
619
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
620
620
|
* @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>
|
|
621
621
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
622
622
|
* @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>
|
|
623
623
|
* @param {*} [options] Override http request option.
|
|
624
624
|
* @throws {RequiredError}
|
|
625
625
|
*/
|
|
626
|
-
listPartnerRelations(authorization?: string, pageSize?:
|
|
626
|
+
listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass> {
|
|
627
627
|
return localVarFp.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
628
628
|
},
|
|
629
629
|
/**
|
|
630
|
-
* Update a partner relation identified by its id
|
|
630
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
631
631
|
* @summary Update the partner relation
|
|
632
632
|
* @param {number} id Id of the partner relation
|
|
633
633
|
* @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
|
|
@@ -740,17 +740,17 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
740
740
|
|
|
741
741
|
/**
|
|
742
742
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
743
|
-
* @type {
|
|
743
|
+
* @type {number}
|
|
744
744
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
745
745
|
*/
|
|
746
|
-
readonly pageSize?:
|
|
746
|
+
readonly pageSize?: number
|
|
747
747
|
|
|
748
748
|
/**
|
|
749
|
-
* 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,
|
|
750
|
-
* @type {
|
|
749
|
+
* 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.
|
|
750
|
+
* @type {string}
|
|
751
751
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
752
752
|
*/
|
|
753
|
-
readonly pageToken?:
|
|
753
|
+
readonly pageToken?: string
|
|
754
754
|
|
|
755
755
|
/**
|
|
756
756
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
@@ -761,10 +761,10 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
761
761
|
|
|
762
762
|
/**
|
|
763
763
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
764
|
-
* @type {
|
|
764
|
+
* @type {string}
|
|
765
765
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
766
766
|
*/
|
|
767
|
-
readonly search?:
|
|
767
|
+
readonly search?: string
|
|
768
768
|
|
|
769
769
|
/**
|
|
770
770
|
* 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>
|
|
@@ -803,17 +803,17 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
803
803
|
|
|
804
804
|
/**
|
|
805
805
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
806
|
-
* @type {
|
|
806
|
+
* @type {number}
|
|
807
807
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
808
808
|
*/
|
|
809
|
-
readonly pageSize?:
|
|
809
|
+
readonly pageSize?: number
|
|
810
810
|
|
|
811
811
|
/**
|
|
812
|
-
* 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,
|
|
813
|
-
* @type {
|
|
812
|
+
* 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.
|
|
813
|
+
* @type {string}
|
|
814
814
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
815
815
|
*/
|
|
816
|
-
readonly pageToken?:
|
|
816
|
+
readonly pageToken?: string
|
|
817
817
|
|
|
818
818
|
/**
|
|
819
819
|
* 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>
|
|
@@ -824,10 +824,10 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
824
824
|
|
|
825
825
|
/**
|
|
826
826
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
827
|
-
* @type {
|
|
827
|
+
* @type {string}
|
|
828
828
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
829
829
|
*/
|
|
830
|
-
readonly search?:
|
|
830
|
+
readonly search?: string
|
|
831
831
|
|
|
832
832
|
/**
|
|
833
833
|
* 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>
|
|
@@ -887,7 +887,7 @@ export interface PartnerRelationsApiUpdatePartnerRelationRequest {
|
|
|
887
887
|
*/
|
|
888
888
|
export class PartnerRelationsApi extends BaseAPI {
|
|
889
889
|
/**
|
|
890
|
-
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
|
|
890
|
+
* This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
|
|
891
891
|
* @summary Create the partner relation
|
|
892
892
|
* @param {PartnerRelationsApiCreatePartnerRelationRequest} requestParameters Request parameters.
|
|
893
893
|
* @param {*} [options] Override http request option.
|
|
@@ -899,7 +899,7 @@ export class PartnerRelationsApi extends BaseAPI {
|
|
|
899
899
|
}
|
|
900
900
|
|
|
901
901
|
/**
|
|
902
|
-
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
|
|
902
|
+
* Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
903
903
|
* @summary Delete the partner-relation
|
|
904
904
|
* @param {PartnerRelationsApiDeletePartnerRelationRequest} requestParameters Request parameters.
|
|
905
905
|
* @param {*} [options] Override http request option.
|
|
@@ -911,7 +911,7 @@ export class PartnerRelationsApi extends BaseAPI {
|
|
|
911
911
|
}
|
|
912
912
|
|
|
913
913
|
/**
|
|
914
|
-
* Retrieve a single partner relation identified by its id
|
|
914
|
+
* Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
|
|
915
915
|
* @summary Retrieve the partner relation
|
|
916
916
|
* @param {PartnerRelationsApiGetPartnerRelationRequest} requestParameters Request parameters.
|
|
917
917
|
* @param {*} [options] Override http request option.
|
|
@@ -923,7 +923,7 @@ export class PartnerRelationsApi extends BaseAPI {
|
|
|
923
923
|
}
|
|
924
924
|
|
|
925
925
|
/**
|
|
926
|
-
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
926
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
927
927
|
* @summary Retrieve the partner relation type
|
|
928
928
|
* @param {PartnerRelationsApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
|
|
929
929
|
* @param {*} [options] Override http request option.
|
|
@@ -935,7 +935,7 @@ export class PartnerRelationsApi extends BaseAPI {
|
|
|
935
935
|
}
|
|
936
936
|
|
|
937
937
|
/**
|
|
938
|
-
* List all partner relation types - is used to create partner relations
|
|
938
|
+
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
939
939
|
* @summary List partner relation types
|
|
940
940
|
* @param {PartnerRelationsApiListPartnerRelationTypesRequest} requestParameters Request parameters.
|
|
941
941
|
* @param {*} [options] Override http request option.
|
|
@@ -947,7 +947,7 @@ export class PartnerRelationsApi extends BaseAPI {
|
|
|
947
947
|
}
|
|
948
948
|
|
|
949
949
|
/**
|
|
950
|
-
* List all partner relations
|
|
950
|
+
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
951
951
|
* @summary List partner relations
|
|
952
952
|
* @param {PartnerRelationsApiListPartnerRelationsRequest} requestParameters Request parameters.
|
|
953
953
|
* @param {*} [options] Override http request option.
|
|
@@ -959,7 +959,7 @@ export class PartnerRelationsApi extends BaseAPI {
|
|
|
959
959
|
}
|
|
960
960
|
|
|
961
961
|
/**
|
|
962
|
-
* Update a partner relation identified by its id
|
|
962
|
+
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
963
963
|
* @summary Update the partner relation
|
|
964
964
|
* @param {PartnerRelationsApiUpdatePartnerRelationRequest} requestParameters Request parameters.
|
|
965
965
|
* @param {*} [options] Override http request option.
|