@emilgroup/partner-sdk-node 1.4.1-beta.0 → 1.5.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 -5
- package/README.md +2 -2
- package/api/{partners-api.ts → partner-api.ts} +90 -90
- package/api/partner-invitation-api.ts +169 -0
- package/api/{partner-relations-api.ts → partner-relation-api.ts} +95 -95
- package/api/{partner-tags-api.ts → partner-tag-api.ts} +70 -70
- package/api/{partner-types-api.ts → partner-type-api.ts} +68 -68
- package/api/partner-version-api.ts +4 -4
- package/api.ts +10 -8
- package/base.ts +3 -3
- package/dist/api/{partners-api.d.ts → partner-api.d.ts} +82 -82
- package/dist/api/{partners-api.js → partner-api.js} +56 -56
- package/dist/api/partner-invitation-api.d.ts +97 -0
- package/dist/api/partner-invitation-api.js +228 -0
- package/dist/api/{partner-relations-api.d.ts → partner-relation-api.d.ts} +86 -86
- package/dist/api/{partner-relations-api.js → partner-relation-api.js} +53 -53
- package/dist/api/{partner-tags-api.d.ts → partner-tag-api.d.ts} +63 -63
- package/dist/api/{partner-tags-api.js → partner-tag-api.js} +46 -46
- package/dist/api/{partner-types-api.d.ts → partner-type-api.d.ts} +61 -61
- package/dist/api/{partner-types-api.js → partner-type-api.js} +43 -43
- package/dist/api/partner-version-api.d.ts +4 -4
- package/dist/api/partner-version-api.js +3 -3
- package/dist/api.d.ts +5 -4
- package/dist/api.js +5 -4
- package/dist/base.d.ts +2 -2
- package/dist/base.js +1 -2
- package/dist/models/create-partner-response-class.d.ts +7 -0
- package/dist/models/create-partner-type-request-dto.d.ts +2 -3
- package/dist/models/create-partner-type-response-class.d.ts +1 -1
- package/dist/models/create-tag-request-dto.d.ts +1 -1
- package/dist/models/get-partner-type-response-class.d.ts +1 -1
- package/dist/models/get-partner-version-response-class.d.ts +3 -3
- package/dist/models/index.d.ts +5 -1
- package/dist/models/index.js +5 -1
- package/dist/models/invite-class.d.ts +79 -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/list-partner-relation-class.d.ts +1 -1
- package/dist/models/list-partner-relation-types-class.d.ts +1 -1
- package/dist/models/list-partner-types-response-class.d.ts +1 -1
- package/dist/models/list-partner-versions-response-class.d.ts +7 -1
- package/dist/models/list-partners-response-class.d.ts +1 -1
- package/dist/models/partner-class.d.ts +24 -6
- package/dist/models/partner-relation-class.d.ts +12 -0
- package/dist/models/partner-relation-type-class.d.ts +12 -0
- package/dist/models/partner-type-class.d.ts +12 -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/dist/models/tag-class.d.ts +12 -0
- package/dist/models/update-partner-type-request-dto.d.ts +2 -3
- package/dist/models/update-partner-type-response-class.d.ts +1 -1
- package/models/create-partner-response-class.ts +7 -0
- package/models/create-partner-type-request-dto.ts +2 -3
- package/models/create-partner-type-response-class.ts +1 -1
- package/models/create-tag-request-dto.ts +1 -1
- package/models/get-partner-type-response-class.ts +1 -1
- package/models/get-partner-version-response-class.ts +3 -3
- package/models/index.ts +5 -1
- 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/list-partner-relation-class.ts +1 -1
- package/models/list-partner-relation-types-class.ts +1 -1
- package/models/list-partner-types-response-class.ts +1 -1
- package/models/list-partner-versions-response-class.ts +7 -1
- package/models/list-partners-response-class.ts +1 -1
- package/models/partner-class.ts +24 -6
- package/models/partner-relation-class.ts +12 -0
- package/models/partner-relation-type-class.ts +12 -0
- package/models/partner-type-class.ts +12 -0
- package/models/permission-class.ts +78 -0
- package/models/role-class.ts +79 -0
- package/models/tag-class.ts +12 -0
- package/models/update-partner-type-request-dto.ts +2 -3
- package/models/update-partner-type-response-class.ts +1 -1
- package/package.json +1 -1
- package/dist/models/partner-type-custom-schema-dto.d.ts +0 -102
- package/models/partner-type-custom-schema-dto.ts +0 -108
- /package/dist/models/{partner-type-custom-schema-dto.js → invite-class.js} +0 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -4,11 +4,12 @@
|
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
6
|
api/default-api.ts
|
|
7
|
-
api/partner-
|
|
8
|
-
api/partner-
|
|
9
|
-
api/partner-
|
|
7
|
+
api/partner-api.ts
|
|
8
|
+
api/partner-invitation-api.ts
|
|
9
|
+
api/partner-relation-api.ts
|
|
10
|
+
api/partner-tag-api.ts
|
|
11
|
+
api/partner-type-api.ts
|
|
10
12
|
api/partner-version-api.ts
|
|
11
|
-
api/partners-api.ts
|
|
12
13
|
base.ts
|
|
13
14
|
common.ts
|
|
14
15
|
configuration.ts
|
|
@@ -32,6 +33,9 @@ models/get-tag-response-class.ts
|
|
|
32
33
|
models/index.ts
|
|
33
34
|
models/inline-response200.ts
|
|
34
35
|
models/inline-response503.ts
|
|
36
|
+
models/invite-class.ts
|
|
37
|
+
models/invite-partner-to-eis-response-class.ts
|
|
38
|
+
models/invite-partner-to-eisrequest-dto.ts
|
|
35
39
|
models/list-partner-relation-class.ts
|
|
36
40
|
models/list-partner-relation-types-class.ts
|
|
37
41
|
models/list-partner-types-response-class.ts
|
|
@@ -42,7 +46,8 @@ models/partner-class.ts
|
|
|
42
46
|
models/partner-relation-class.ts
|
|
43
47
|
models/partner-relation-type-class.ts
|
|
44
48
|
models/partner-type-class.ts
|
|
45
|
-
models/
|
|
49
|
+
models/permission-class.ts
|
|
50
|
+
models/role-class.ts
|
|
46
51
|
models/tag-class.ts
|
|
47
52
|
models/tag-partner-request-dto-rest.ts
|
|
48
53
|
models/update-partner-relation-request-dto-rest.ts
|
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.
|
|
20
|
+
npm install @emilgroup/partner-sdk-node@1.5.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/partner-sdk-node@1.5.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -41,10 +41,10 @@ import { UpdatePartnerResponseClass } from '../models';
|
|
|
41
41
|
import { URL, URLSearchParams } from 'url';
|
|
42
42
|
const FormData = require('form-data');
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* PartnerApi - axios parameter creator
|
|
45
45
|
* @export
|
|
46
46
|
*/
|
|
47
|
-
export const
|
|
47
|
+
export const PartnerApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
48
|
return {
|
|
49
49
|
/**
|
|
50
50
|
* This will create a partner.
|
|
@@ -139,7 +139,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
139
139
|
};
|
|
140
140
|
},
|
|
141
141
|
/**
|
|
142
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
142
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
143
143
|
* @summary Retrieve the partner
|
|
144
144
|
* @param {string} code Unique identifier for the object.
|
|
145
145
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -194,11 +194,11 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
194
194
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
195
195
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
196
196
|
* @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.
|
|
197
|
-
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
197
|
+
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
198
198
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
199
199
|
* @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, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
200
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
201
|
-
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
200
|
+
* @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: partnerType, tags<i>
|
|
201
|
+
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
202
202
|
* @param {*} [options] Override http request option.
|
|
203
203
|
* @throws {RequiredError}
|
|
204
204
|
*/
|
|
@@ -370,11 +370,11 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
370
370
|
};
|
|
371
371
|
|
|
372
372
|
/**
|
|
373
|
-
*
|
|
373
|
+
* PartnerApi - functional programming interface
|
|
374
374
|
* @export
|
|
375
375
|
*/
|
|
376
|
-
export const
|
|
377
|
-
const localVarAxiosParamCreator =
|
|
376
|
+
export const PartnerApiFp = function(configuration?: Configuration) {
|
|
377
|
+
const localVarAxiosParamCreator = PartnerApiAxiosParamCreator(configuration)
|
|
378
378
|
return {
|
|
379
379
|
/**
|
|
380
380
|
* This will create a partner.
|
|
@@ -401,7 +401,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
401
401
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
402
402
|
},
|
|
403
403
|
/**
|
|
404
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
404
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
405
405
|
* @summary Retrieve the partner
|
|
406
406
|
* @param {string} code Unique identifier for the object.
|
|
407
407
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -419,11 +419,11 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
419
419
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
420
420
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
421
421
|
* @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.
|
|
422
|
-
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
422
|
+
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
423
423
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
424
424
|
* @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, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
425
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
426
|
-
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
425
|
+
* @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: partnerType, tags<i>
|
|
426
|
+
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
427
427
|
* @param {*} [options] Override http request option.
|
|
428
428
|
* @throws {RequiredError}
|
|
429
429
|
*/
|
|
@@ -461,11 +461,11 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
461
461
|
};
|
|
462
462
|
|
|
463
463
|
/**
|
|
464
|
-
*
|
|
464
|
+
* PartnerApi - factory interface
|
|
465
465
|
* @export
|
|
466
466
|
*/
|
|
467
|
-
export const
|
|
468
|
-
const localVarFp =
|
|
467
|
+
export const PartnerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
468
|
+
const localVarFp = PartnerApiFp(configuration)
|
|
469
469
|
return {
|
|
470
470
|
/**
|
|
471
471
|
* This will create a partner.
|
|
@@ -490,7 +490,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
490
490
|
return localVarFp.deletePartner(code, authorization, options).then((request) => request(axios, basePath));
|
|
491
491
|
},
|
|
492
492
|
/**
|
|
493
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
493
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
494
494
|
* @summary Retrieve the partner
|
|
495
495
|
* @param {string} code Unique identifier for the object.
|
|
496
496
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -507,11 +507,11 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
507
507
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
508
508
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
509
509
|
* @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.
|
|
510
|
-
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
510
|
+
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
511
511
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
512
512
|
* @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, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
513
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
514
|
-
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
513
|
+
* @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: partnerType, tags<i>
|
|
514
|
+
* @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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
515
515
|
* @param {*} [options] Override http request option.
|
|
516
516
|
* @throws {RequiredError}
|
|
517
517
|
*/
|
|
@@ -546,270 +546,270 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
546
546
|
};
|
|
547
547
|
|
|
548
548
|
/**
|
|
549
|
-
* Request parameters for createPartner operation in
|
|
549
|
+
* Request parameters for createPartner operation in PartnerApi.
|
|
550
550
|
* @export
|
|
551
|
-
* @interface
|
|
551
|
+
* @interface PartnerApiCreatePartnerRequest
|
|
552
552
|
*/
|
|
553
|
-
export interface
|
|
553
|
+
export interface PartnerApiCreatePartnerRequest {
|
|
554
554
|
/**
|
|
555
555
|
*
|
|
556
556
|
* @type {CreatePartnerRequestDto}
|
|
557
|
-
* @memberof
|
|
557
|
+
* @memberof PartnerApiCreatePartner
|
|
558
558
|
*/
|
|
559
559
|
readonly createPartnerRequestDto: CreatePartnerRequestDto
|
|
560
560
|
|
|
561
561
|
/**
|
|
562
562
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
563
563
|
* @type {string}
|
|
564
|
-
* @memberof
|
|
564
|
+
* @memberof PartnerApiCreatePartner
|
|
565
565
|
*/
|
|
566
566
|
readonly authorization?: string
|
|
567
567
|
}
|
|
568
568
|
|
|
569
569
|
/**
|
|
570
|
-
* Request parameters for deletePartner operation in
|
|
570
|
+
* Request parameters for deletePartner operation in PartnerApi.
|
|
571
571
|
* @export
|
|
572
|
-
* @interface
|
|
572
|
+
* @interface PartnerApiDeletePartnerRequest
|
|
573
573
|
*/
|
|
574
|
-
export interface
|
|
574
|
+
export interface PartnerApiDeletePartnerRequest {
|
|
575
575
|
/**
|
|
576
576
|
*
|
|
577
577
|
* @type {string}
|
|
578
|
-
* @memberof
|
|
578
|
+
* @memberof PartnerApiDeletePartner
|
|
579
579
|
*/
|
|
580
580
|
readonly code: string
|
|
581
581
|
|
|
582
582
|
/**
|
|
583
583
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
584
584
|
* @type {string}
|
|
585
|
-
* @memberof
|
|
585
|
+
* @memberof PartnerApiDeletePartner
|
|
586
586
|
*/
|
|
587
587
|
readonly authorization?: string
|
|
588
588
|
}
|
|
589
589
|
|
|
590
590
|
/**
|
|
591
|
-
* Request parameters for getPartner operation in
|
|
591
|
+
* Request parameters for getPartner operation in PartnerApi.
|
|
592
592
|
* @export
|
|
593
|
-
* @interface
|
|
593
|
+
* @interface PartnerApiGetPartnerRequest
|
|
594
594
|
*/
|
|
595
|
-
export interface
|
|
595
|
+
export interface PartnerApiGetPartnerRequest {
|
|
596
596
|
/**
|
|
597
597
|
* Unique identifier for the object.
|
|
598
598
|
* @type {string}
|
|
599
|
-
* @memberof
|
|
599
|
+
* @memberof PartnerApiGetPartner
|
|
600
600
|
*/
|
|
601
601
|
readonly code: string
|
|
602
602
|
|
|
603
603
|
/**
|
|
604
604
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
605
605
|
* @type {string}
|
|
606
|
-
* @memberof
|
|
606
|
+
* @memberof PartnerApiGetPartner
|
|
607
607
|
*/
|
|
608
608
|
readonly authorization?: string
|
|
609
609
|
|
|
610
610
|
/**
|
|
611
611
|
*
|
|
612
612
|
* @type {any}
|
|
613
|
-
* @memberof
|
|
613
|
+
* @memberof PartnerApiGetPartner
|
|
614
614
|
*/
|
|
615
615
|
readonly expand?: any
|
|
616
616
|
}
|
|
617
617
|
|
|
618
618
|
/**
|
|
619
|
-
* Request parameters for listPartners operation in
|
|
619
|
+
* Request parameters for listPartners operation in PartnerApi.
|
|
620
620
|
* @export
|
|
621
|
-
* @interface
|
|
621
|
+
* @interface PartnerApiListPartnersRequest
|
|
622
622
|
*/
|
|
623
|
-
export interface
|
|
623
|
+
export interface PartnerApiListPartnersRequest {
|
|
624
624
|
/**
|
|
625
625
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
626
626
|
* @type {string}
|
|
627
|
-
* @memberof
|
|
627
|
+
* @memberof PartnerApiListPartners
|
|
628
628
|
*/
|
|
629
629
|
readonly authorization?: string
|
|
630
630
|
|
|
631
631
|
/**
|
|
632
632
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
633
633
|
* @type {any}
|
|
634
|
-
* @memberof
|
|
634
|
+
* @memberof PartnerApiListPartners
|
|
635
635
|
*/
|
|
636
636
|
readonly pageSize?: any
|
|
637
637
|
|
|
638
638
|
/**
|
|
639
639
|
* 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.
|
|
640
640
|
* @type {any}
|
|
641
|
-
* @memberof
|
|
641
|
+
* @memberof PartnerApiListPartners
|
|
642
642
|
*/
|
|
643
643
|
readonly pageToken?: any
|
|
644
644
|
|
|
645
645
|
/**
|
|
646
|
-
* 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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
646
|
+
* 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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
647
647
|
* @type {string}
|
|
648
|
-
* @memberof
|
|
648
|
+
* @memberof PartnerApiListPartners
|
|
649
649
|
*/
|
|
650
650
|
readonly filter?: string
|
|
651
651
|
|
|
652
652
|
/**
|
|
653
653
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
654
654
|
* @type {any}
|
|
655
|
-
* @memberof
|
|
655
|
+
* @memberof PartnerApiListPartners
|
|
656
656
|
*/
|
|
657
657
|
readonly search?: any
|
|
658
658
|
|
|
659
659
|
/**
|
|
660
660
|
* 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, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
661
661
|
* @type {string}
|
|
662
|
-
* @memberof
|
|
662
|
+
* @memberof PartnerApiListPartners
|
|
663
663
|
*/
|
|
664
664
|
readonly order?: string
|
|
665
665
|
|
|
666
666
|
/**
|
|
667
|
-
* Expand to fetch additional information about the list items.
|
|
667
|
+
* 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: partnerType, tags<i>
|
|
668
668
|
* @type {string}
|
|
669
|
-
* @memberof
|
|
669
|
+
* @memberof PartnerApiListPartners
|
|
670
670
|
*/
|
|
671
671
|
readonly expand?: string
|
|
672
672
|
|
|
673
673
|
/**
|
|
674
|
-
* 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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
674
|
+
* 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, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode</i>
|
|
675
675
|
* @type {string}
|
|
676
|
-
* @memberof
|
|
676
|
+
* @memberof PartnerApiListPartners
|
|
677
677
|
*/
|
|
678
678
|
readonly filters?: string
|
|
679
679
|
}
|
|
680
680
|
|
|
681
681
|
/**
|
|
682
|
-
* Request parameters for tagPartner operation in
|
|
682
|
+
* Request parameters for tagPartner operation in PartnerApi.
|
|
683
683
|
* @export
|
|
684
|
-
* @interface
|
|
684
|
+
* @interface PartnerApiTagPartnerRequest
|
|
685
685
|
*/
|
|
686
|
-
export interface
|
|
686
|
+
export interface PartnerApiTagPartnerRequest {
|
|
687
687
|
/**
|
|
688
688
|
*
|
|
689
689
|
* @type {string}
|
|
690
|
-
* @memberof
|
|
690
|
+
* @memberof PartnerApiTagPartner
|
|
691
691
|
*/
|
|
692
692
|
readonly code: string
|
|
693
693
|
|
|
694
694
|
/**
|
|
695
695
|
*
|
|
696
696
|
* @type {TagPartnerRequestDtoRest}
|
|
697
|
-
* @memberof
|
|
697
|
+
* @memberof PartnerApiTagPartner
|
|
698
698
|
*/
|
|
699
699
|
readonly tagPartnerRequestDtoRest: TagPartnerRequestDtoRest
|
|
700
700
|
|
|
701
701
|
/**
|
|
702
702
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
703
703
|
* @type {string}
|
|
704
|
-
* @memberof
|
|
704
|
+
* @memberof PartnerApiTagPartner
|
|
705
705
|
*/
|
|
706
706
|
readonly authorization?: string
|
|
707
707
|
}
|
|
708
708
|
|
|
709
709
|
/**
|
|
710
|
-
* Request parameters for updatePartner operation in
|
|
710
|
+
* Request parameters for updatePartner operation in PartnerApi.
|
|
711
711
|
* @export
|
|
712
|
-
* @interface
|
|
712
|
+
* @interface PartnerApiUpdatePartnerRequest
|
|
713
713
|
*/
|
|
714
|
-
export interface
|
|
714
|
+
export interface PartnerApiUpdatePartnerRequest {
|
|
715
715
|
/**
|
|
716
716
|
* Unique identifier for the object.
|
|
717
717
|
* @type {string}
|
|
718
|
-
* @memberof
|
|
718
|
+
* @memberof PartnerApiUpdatePartner
|
|
719
719
|
*/
|
|
720
720
|
readonly code: string
|
|
721
721
|
|
|
722
722
|
/**
|
|
723
723
|
*
|
|
724
724
|
* @type {UpdatePartnerRequestDto}
|
|
725
|
-
* @memberof
|
|
725
|
+
* @memberof PartnerApiUpdatePartner
|
|
726
726
|
*/
|
|
727
727
|
readonly updatePartnerRequestDto: UpdatePartnerRequestDto
|
|
728
728
|
|
|
729
729
|
/**
|
|
730
730
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
731
731
|
* @type {string}
|
|
732
|
-
* @memberof
|
|
732
|
+
* @memberof PartnerApiUpdatePartner
|
|
733
733
|
*/
|
|
734
734
|
readonly authorization?: string
|
|
735
735
|
}
|
|
736
736
|
|
|
737
737
|
/**
|
|
738
|
-
*
|
|
738
|
+
* PartnerApi - object-oriented interface
|
|
739
739
|
* @export
|
|
740
|
-
* @class
|
|
740
|
+
* @class PartnerApi
|
|
741
741
|
* @extends {BaseAPI}
|
|
742
742
|
*/
|
|
743
|
-
export class
|
|
743
|
+
export class PartnerApi extends BaseAPI {
|
|
744
744
|
/**
|
|
745
745
|
* This will create a partner.
|
|
746
746
|
* @summary Create the partner
|
|
747
|
-
* @param {
|
|
747
|
+
* @param {PartnerApiCreatePartnerRequest} requestParameters Request parameters.
|
|
748
748
|
* @param {*} [options] Override http request option.
|
|
749
749
|
* @throws {RequiredError}
|
|
750
|
-
* @memberof
|
|
750
|
+
* @memberof PartnerApi
|
|
751
751
|
*/
|
|
752
|
-
public createPartner(requestParameters:
|
|
753
|
-
return
|
|
752
|
+
public createPartner(requestParameters: PartnerApiCreatePartnerRequest, options?: AxiosRequestConfig) {
|
|
753
|
+
return PartnerApiFp(this.configuration).createPartner(requestParameters.createPartnerRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
754
754
|
}
|
|
755
755
|
|
|
756
756
|
/**
|
|
757
757
|
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
758
758
|
* @summary Delete the partner
|
|
759
|
-
* @param {
|
|
759
|
+
* @param {PartnerApiDeletePartnerRequest} requestParameters Request parameters.
|
|
760
760
|
* @param {*} [options] Override http request option.
|
|
761
761
|
* @throws {RequiredError}
|
|
762
|
-
* @memberof
|
|
762
|
+
* @memberof PartnerApi
|
|
763
763
|
*/
|
|
764
|
-
public deletePartner(requestParameters:
|
|
765
|
-
return
|
|
764
|
+
public deletePartner(requestParameters: PartnerApiDeletePartnerRequest, options?: AxiosRequestConfig) {
|
|
765
|
+
return PartnerApiFp(this.configuration).deletePartner(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
766
766
|
}
|
|
767
767
|
|
|
768
768
|
/**
|
|
769
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
769
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
770
770
|
* @summary Retrieve the partner
|
|
771
|
-
* @param {
|
|
771
|
+
* @param {PartnerApiGetPartnerRequest} requestParameters Request parameters.
|
|
772
772
|
* @param {*} [options] Override http request option.
|
|
773
773
|
* @throws {RequiredError}
|
|
774
|
-
* @memberof
|
|
774
|
+
* @memberof PartnerApi
|
|
775
775
|
*/
|
|
776
|
-
public getPartner(requestParameters:
|
|
777
|
-
return
|
|
776
|
+
public getPartner(requestParameters: PartnerApiGetPartnerRequest, options?: AxiosRequestConfig) {
|
|
777
|
+
return PartnerApiFp(this.configuration).getPartner(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
778
778
|
}
|
|
779
779
|
|
|
780
780
|
/**
|
|
781
781
|
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
782
782
|
* @summary List partners
|
|
783
|
-
* @param {
|
|
783
|
+
* @param {PartnerApiListPartnersRequest} requestParameters Request parameters.
|
|
784
784
|
* @param {*} [options] Override http request option.
|
|
785
785
|
* @throws {RequiredError}
|
|
786
|
-
* @memberof
|
|
786
|
+
* @memberof PartnerApi
|
|
787
787
|
*/
|
|
788
|
-
public listPartners(requestParameters:
|
|
789
|
-
return
|
|
788
|
+
public listPartners(requestParameters: PartnerApiListPartnersRequest = {}, options?: AxiosRequestConfig) {
|
|
789
|
+
return PartnerApiFp(this.configuration).listPartners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
790
790
|
}
|
|
791
791
|
|
|
792
792
|
/**
|
|
793
793
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
794
794
|
* @summary Update the partner
|
|
795
|
-
* @param {
|
|
795
|
+
* @param {PartnerApiTagPartnerRequest} requestParameters Request parameters.
|
|
796
796
|
* @param {*} [options] Override http request option.
|
|
797
797
|
* @throws {RequiredError}
|
|
798
|
-
* @memberof
|
|
798
|
+
* @memberof PartnerApi
|
|
799
799
|
*/
|
|
800
|
-
public tagPartner(requestParameters:
|
|
801
|
-
return
|
|
800
|
+
public tagPartner(requestParameters: PartnerApiTagPartnerRequest, options?: AxiosRequestConfig) {
|
|
801
|
+
return PartnerApiFp(this.configuration).tagPartner(requestParameters.code, requestParameters.tagPartnerRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
802
802
|
}
|
|
803
803
|
|
|
804
804
|
/**
|
|
805
805
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
806
806
|
* @summary Update the partner
|
|
807
|
-
* @param {
|
|
807
|
+
* @param {PartnerApiUpdatePartnerRequest} requestParameters Request parameters.
|
|
808
808
|
* @param {*} [options] Override http request option.
|
|
809
809
|
* @throws {RequiredError}
|
|
810
|
-
* @memberof
|
|
810
|
+
* @memberof PartnerApi
|
|
811
811
|
*/
|
|
812
|
-
public updatePartner(requestParameters:
|
|
813
|
-
return
|
|
812
|
+
public updatePartner(requestParameters: PartnerApiUpdatePartnerRequest, options?: AxiosRequestConfig) {
|
|
813
|
+
return PartnerApiFp(this.configuration).updatePartner(requestParameters.code, requestParameters.updatePartnerRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
814
814
|
}
|
|
815
815
|
}
|