@connectedxm/admin-sdk 10.19.0 → 10.20.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/README.md +2 -2
- package/api.ts +24 -39
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +24 -39
- package/dist/api.js +21 -21
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +24 -39
- package/dist/esm/api.js +21 -21
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/EventPage.md +2 -0
- package/docs/EventPageCreateInputs.md +2 -0
- package/docs/EventPageUpdateInputs.md +2 -0
- package/docs/Organization.md +0 -14
- package/docs/OrganizationApi.md +1 -1
- package/docs/OrganizationEntitiesApi.md +4 -4
- package/docs/OrganizationEntity.md +0 -4
- package/docs/OrganizationEntityCreateInputs.md +0 -2
- package/docs/OrganizationEntityUpdateInputs.md +0 -2
- package/docs/OrganizationUpdateInputs.md +0 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@10.
|
|
1
|
+
## @connectedxm/admin-sdk@10.20.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@10.
|
|
39
|
+
npm install @connectedxm/admin-sdk@10.20.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.20.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5670,6 +5670,7 @@ export interface EventPage {
|
|
|
5670
5670
|
'subtitle': string | null;
|
|
5671
5671
|
'sortOrder': number;
|
|
5672
5672
|
'html': string | null;
|
|
5673
|
+
'externalUrl': string | null;
|
|
5673
5674
|
'createdAt': string;
|
|
5674
5675
|
'updatedAt': string;
|
|
5675
5676
|
}
|
|
@@ -5679,6 +5680,7 @@ export interface EventPageCreateInputs {
|
|
|
5679
5680
|
'active'?: boolean;
|
|
5680
5681
|
'subtitle'?: string | null;
|
|
5681
5682
|
'html'?: string | null;
|
|
5683
|
+
'externalUrl'?: string | null;
|
|
5682
5684
|
'sortOrder'?: number | null;
|
|
5683
5685
|
}
|
|
5684
5686
|
export interface EventPageTranslation {
|
|
@@ -5701,6 +5703,7 @@ export interface EventPageUpdateInputs {
|
|
|
5701
5703
|
'active'?: boolean;
|
|
5702
5704
|
'subtitle'?: string | null;
|
|
5703
5705
|
'html'?: string | null;
|
|
5706
|
+
'externalUrl'?: string | null;
|
|
5704
5707
|
'sortOrder'?: number | null;
|
|
5705
5708
|
}
|
|
5706
5709
|
export interface EventPass {
|
|
@@ -11626,16 +11629,9 @@ export interface Organization {
|
|
|
11626
11629
|
'domain': string | null;
|
|
11627
11630
|
'locale': string;
|
|
11628
11631
|
'email': string | null;
|
|
11629
|
-
'legalName': string | null;
|
|
11630
11632
|
'description': string | null;
|
|
11631
11633
|
'phone': string | null;
|
|
11632
11634
|
'privacyPolicyLink': string | null;
|
|
11633
|
-
'address1': string | null;
|
|
11634
|
-
'address2': string | null;
|
|
11635
|
-
'city': string | null;
|
|
11636
|
-
'state': string | null;
|
|
11637
|
-
'country': string | null;
|
|
11638
|
-
'zip': string | null;
|
|
11639
11635
|
'primaryColor': string | null;
|
|
11640
11636
|
'secondaryColor': string | null;
|
|
11641
11637
|
'darkPrimaryColor': string | null;
|
|
@@ -11725,8 +11721,6 @@ export interface OrganizationEntity {
|
|
|
11725
11721
|
'country': string;
|
|
11726
11722
|
'zip': string;
|
|
11727
11723
|
'companyCode': string | null;
|
|
11728
|
-
'invoicePrefix': string | null;
|
|
11729
|
-
'invoiceSequence': number;
|
|
11730
11724
|
'paymentIntegrationId': string | null;
|
|
11731
11725
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
11732
11726
|
'createdAt': string;
|
|
@@ -11745,7 +11739,6 @@ export interface OrganizationEntityCreateInputs {
|
|
|
11745
11739
|
'vatNumber'?: string | null;
|
|
11746
11740
|
'vatCountry'?: string | null;
|
|
11747
11741
|
'companyCode'?: string | null;
|
|
11748
|
-
'invoicePrefix'?: string | null;
|
|
11749
11742
|
'paymentIntegrationId'?: string | null;
|
|
11750
11743
|
}
|
|
11751
11744
|
export interface OrganizationEntityUpdateInputs {
|
|
@@ -11761,7 +11754,6 @@ export interface OrganizationEntityUpdateInputs {
|
|
|
11761
11754
|
'vatNumber'?: string | null;
|
|
11762
11755
|
'vatCountry'?: string | null;
|
|
11763
11756
|
'companyCode'?: string | null;
|
|
11764
|
-
'invoicePrefix'?: string | null;
|
|
11765
11757
|
'paymentIntegrationId'?: string | null;
|
|
11766
11758
|
}
|
|
11767
11759
|
export interface OrganizationLanguageOverride {
|
|
@@ -12035,19 +12027,12 @@ export enum OrganizationTriggerType {
|
|
|
12035
12027
|
export interface OrganizationUpdateInputs {
|
|
12036
12028
|
'email'?: string | null;
|
|
12037
12029
|
'name'?: string | null;
|
|
12038
|
-
'legalName'?: string | null;
|
|
12039
12030
|
'description'?: string | null;
|
|
12040
12031
|
'slug'?: string | null;
|
|
12041
12032
|
'phone'?: string | null;
|
|
12042
12033
|
'timezone'?: string | null;
|
|
12043
12034
|
'website'?: string | null;
|
|
12044
12035
|
'privacyPolicyLink'?: string | null;
|
|
12045
|
-
'address1'?: string | null;
|
|
12046
|
-
'address2'?: string | null;
|
|
12047
|
-
'city'?: string | null;
|
|
12048
|
-
'state'?: string | null;
|
|
12049
|
-
'country'?: string | null;
|
|
12050
|
-
'zip'?: string | null;
|
|
12051
12036
|
'primaryColor'?: string | null;
|
|
12052
12037
|
'secondaryColor'?: string | null;
|
|
12053
12038
|
'darkPrimaryColor'?: string | null;
|
|
@@ -119623,7 +119608,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config
|
|
|
119623
119608
|
};
|
|
119624
119609
|
},
|
|
119625
119610
|
/**
|
|
119626
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
119611
|
+
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
119627
119612
|
* @summary Update the organization\'s profile
|
|
119628
119613
|
* @param {OrganizationUpdateInputs} organizationUpdateInputs
|
|
119629
119614
|
* @param {*} [options] Override http request option.
|
|
@@ -119869,7 +119854,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
|
|
|
119869
119854
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
119870
119855
|
},
|
|
119871
119856
|
/**
|
|
119872
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
119857
|
+
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
119873
119858
|
* @summary Update the organization\'s profile
|
|
119874
119859
|
* @param {OrganizationUpdateInputs} organizationUpdateInputs
|
|
119875
119860
|
* @param {*} [options] Override http request option.
|
|
@@ -119980,7 +119965,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
|
|
|
119980
119965
|
return localVarFp.searchOrganization(requestParameters.filters, options).then((request) => request(axios, basePath));
|
|
119981
119966
|
},
|
|
119982
119967
|
/**
|
|
119983
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
119968
|
+
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
119984
119969
|
* @summary Update the organization\'s profile
|
|
119985
119970
|
* @param {OrganizationApiUpdateOrganizationRequest} requestParameters Request parameters.
|
|
119986
119971
|
* @param {*} [options] Override http request option.
|
|
@@ -120179,7 +120164,7 @@ export class OrganizationApi extends BaseAPI {
|
|
|
120179
120164
|
}
|
|
120180
120165
|
|
|
120181
120166
|
/**
|
|
120182
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
120167
|
+
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
120183
120168
|
* @summary Update the organization\'s profile
|
|
120184
120169
|
* @param {OrganizationApiUpdateOrganizationRequest} requestParameters Request parameters.
|
|
120185
120170
|
* @param {*} [options] Override http request option.
|
|
@@ -121107,7 +121092,7 @@ export class OrganizationDomainsApi extends BaseAPI {
|
|
|
121107
121092
|
export const OrganizationEntitiesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
121108
121093
|
return {
|
|
121109
121094
|
/**
|
|
121110
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
121095
|
+
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address and VAT registration. The entity is not made primary on creation - use the set-primary route for that.
|
|
121111
121096
|
* @summary Create an organization legal entity
|
|
121112
121097
|
* @param {OrganizationEntityCreateInputs} organizationEntityCreateInputs
|
|
121113
121098
|
* @param {*} [options] Override http request option.
|
|
@@ -121188,7 +121173,7 @@ export const OrganizationEntitiesApiAxiosParamCreator = function (configuration?
|
|
|
121188
121173
|
};
|
|
121189
121174
|
},
|
|
121190
121175
|
/**
|
|
121191
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
121176
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
121192
121177
|
* @summary List an organization\'s legal entities
|
|
121193
121178
|
* @param {number} [page] Page number
|
|
121194
121179
|
* @param {number} [pageSize] Number of items per page
|
|
@@ -121244,7 +121229,7 @@ export const OrganizationEntitiesApiAxiosParamCreator = function (configuration?
|
|
|
121244
121229
|
};
|
|
121245
121230
|
},
|
|
121246
121231
|
/**
|
|
121247
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
121232
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
121248
121233
|
* @summary Get an organization legal entity
|
|
121249
121234
|
* @param {string} entityId The entity identifier
|
|
121250
121235
|
* @param {*} [options] Override http request option.
|
|
@@ -121324,7 +121309,7 @@ export const OrganizationEntitiesApiAxiosParamCreator = function (configuration?
|
|
|
121324
121309
|
};
|
|
121325
121310
|
},
|
|
121326
121311
|
/**
|
|
121327
|
-
* Updates the identity, registered address
|
|
121312
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
121328
121313
|
* @summary Update an organization legal entity
|
|
121329
121314
|
* @param {string} entityId The entity identifier
|
|
121330
121315
|
* @param {OrganizationEntityUpdateInputs} organizationEntityUpdateInputs
|
|
@@ -121378,7 +121363,7 @@ export const OrganizationEntitiesApiFp = function(configuration?: Configuration)
|
|
|
121378
121363
|
const localVarAxiosParamCreator = OrganizationEntitiesApiAxiosParamCreator(configuration)
|
|
121379
121364
|
return {
|
|
121380
121365
|
/**
|
|
121381
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
121366
|
+
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address and VAT registration. The entity is not made primary on creation - use the set-primary route for that.
|
|
121382
121367
|
* @summary Create an organization legal entity
|
|
121383
121368
|
* @param {OrganizationEntityCreateInputs} organizationEntityCreateInputs
|
|
121384
121369
|
* @param {*} [options] Override http request option.
|
|
@@ -121404,7 +121389,7 @@ export const OrganizationEntitiesApiFp = function(configuration?: Configuration)
|
|
|
121404
121389
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
121405
121390
|
},
|
|
121406
121391
|
/**
|
|
121407
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
121392
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
121408
121393
|
* @summary List an organization\'s legal entities
|
|
121409
121394
|
* @param {number} [page] Page number
|
|
121410
121395
|
* @param {number} [pageSize] Number of items per page
|
|
@@ -121420,7 +121405,7 @@ export const OrganizationEntitiesApiFp = function(configuration?: Configuration)
|
|
|
121420
121405
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
121421
121406
|
},
|
|
121422
121407
|
/**
|
|
121423
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
121408
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
121424
121409
|
* @summary Get an organization legal entity
|
|
121425
121410
|
* @param {string} entityId The entity identifier
|
|
121426
121411
|
* @param {*} [options] Override http request option.
|
|
@@ -121446,7 +121431,7 @@ export const OrganizationEntitiesApiFp = function(configuration?: Configuration)
|
|
|
121446
121431
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
121447
121432
|
},
|
|
121448
121433
|
/**
|
|
121449
|
-
* Updates the identity, registered address
|
|
121434
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
121450
121435
|
* @summary Update an organization legal entity
|
|
121451
121436
|
* @param {string} entityId The entity identifier
|
|
121452
121437
|
* @param {OrganizationEntityUpdateInputs} organizationEntityUpdateInputs
|
|
@@ -121469,7 +121454,7 @@ export const OrganizationEntitiesApiFactory = function (configuration?: Configur
|
|
|
121469
121454
|
const localVarFp = OrganizationEntitiesApiFp(configuration)
|
|
121470
121455
|
return {
|
|
121471
121456
|
/**
|
|
121472
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
121457
|
+
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address and VAT registration. The entity is not made primary on creation - use the set-primary route for that.
|
|
121473
121458
|
* @summary Create an organization legal entity
|
|
121474
121459
|
* @param {OrganizationEntitiesApiCreateOrganizationEntityRequest} requestParameters Request parameters.
|
|
121475
121460
|
* @param {*} [options] Override http request option.
|
|
@@ -121489,7 +121474,7 @@ export const OrganizationEntitiesApiFactory = function (configuration?: Configur
|
|
|
121489
121474
|
return localVarFp.deleteOrganizationEntity(requestParameters.entityId, options).then((request) => request(axios, basePath));
|
|
121490
121475
|
},
|
|
121491
121476
|
/**
|
|
121492
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
121477
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
121493
121478
|
* @summary List an organization\'s legal entities
|
|
121494
121479
|
* @param {OrganizationEntitiesApiGetOrganizationEntitiesRequest} requestParameters Request parameters.
|
|
121495
121480
|
* @param {*} [options] Override http request option.
|
|
@@ -121499,7 +121484,7 @@ export const OrganizationEntitiesApiFactory = function (configuration?: Configur
|
|
|
121499
121484
|
return localVarFp.getOrganizationEntities(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
121500
121485
|
},
|
|
121501
121486
|
/**
|
|
121502
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
121487
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
121503
121488
|
* @summary Get an organization legal entity
|
|
121504
121489
|
* @param {OrganizationEntitiesApiGetOrganizationEntityRequest} requestParameters Request parameters.
|
|
121505
121490
|
* @param {*} [options] Override http request option.
|
|
@@ -121519,7 +121504,7 @@ export const OrganizationEntitiesApiFactory = function (configuration?: Configur
|
|
|
121519
121504
|
return localVarFp.setPrimaryOrganizationEntity(requestParameters.entityId, options).then((request) => request(axios, basePath));
|
|
121520
121505
|
},
|
|
121521
121506
|
/**
|
|
121522
|
-
* Updates the identity, registered address
|
|
121507
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
121523
121508
|
* @summary Update an organization legal entity
|
|
121524
121509
|
* @param {OrganizationEntitiesApiUpdateOrganizationEntityRequest} requestParameters Request parameters.
|
|
121525
121510
|
* @param {*} [options] Override http request option.
|
|
@@ -121610,7 +121595,7 @@ export interface OrganizationEntitiesApiUpdateOrganizationEntityRequest {
|
|
|
121610
121595
|
*/
|
|
121611
121596
|
export class OrganizationEntitiesApi extends BaseAPI {
|
|
121612
121597
|
/**
|
|
121613
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
121598
|
+
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address and VAT registration. The entity is not made primary on creation - use the set-primary route for that.
|
|
121614
121599
|
* @summary Create an organization legal entity
|
|
121615
121600
|
* @param {OrganizationEntitiesApiCreateOrganizationEntityRequest} requestParameters Request parameters.
|
|
121616
121601
|
* @param {*} [options] Override http request option.
|
|
@@ -121632,7 +121617,7 @@ export class OrganizationEntitiesApi extends BaseAPI {
|
|
|
121632
121617
|
}
|
|
121633
121618
|
|
|
121634
121619
|
/**
|
|
121635
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
121620
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
121636
121621
|
* @summary List an organization\'s legal entities
|
|
121637
121622
|
* @param {OrganizationEntitiesApiGetOrganizationEntitiesRequest} requestParameters Request parameters.
|
|
121638
121623
|
* @param {*} [options] Override http request option.
|
|
@@ -121643,7 +121628,7 @@ export class OrganizationEntitiesApi extends BaseAPI {
|
|
|
121643
121628
|
}
|
|
121644
121629
|
|
|
121645
121630
|
/**
|
|
121646
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
121631
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
121647
121632
|
* @summary Get an organization legal entity
|
|
121648
121633
|
* @param {OrganizationEntitiesApiGetOrganizationEntityRequest} requestParameters Request parameters.
|
|
121649
121634
|
* @param {*} [options] Override http request option.
|
|
@@ -121665,7 +121650,7 @@ export class OrganizationEntitiesApi extends BaseAPI {
|
|
|
121665
121650
|
}
|
|
121666
121651
|
|
|
121667
121652
|
/**
|
|
121668
|
-
* Updates the identity, registered address
|
|
121653
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
121669
121654
|
* @summary Update an organization legal entity
|
|
121670
121655
|
* @param {OrganizationEntitiesApiUpdateOrganizationEntityRequest} requestParameters Request parameters.
|
|
121671
121656
|
* @param {*} [options] Override http request option.
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.20.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.20.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 10.
|
|
6
|
+
* The version of the OpenAPI document: 10.20.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.20.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5169,6 +5169,7 @@ export interface EventPage {
|
|
|
5169
5169
|
'subtitle': string | null;
|
|
5170
5170
|
'sortOrder': number;
|
|
5171
5171
|
'html': string | null;
|
|
5172
|
+
'externalUrl': string | null;
|
|
5172
5173
|
'createdAt': string;
|
|
5173
5174
|
'updatedAt': string;
|
|
5174
5175
|
}
|
|
@@ -5178,6 +5179,7 @@ export interface EventPageCreateInputs {
|
|
|
5178
5179
|
'active'?: boolean;
|
|
5179
5180
|
'subtitle'?: string | null;
|
|
5180
5181
|
'html'?: string | null;
|
|
5182
|
+
'externalUrl'?: string | null;
|
|
5181
5183
|
'sortOrder'?: number | null;
|
|
5182
5184
|
}
|
|
5183
5185
|
export interface EventPageTranslation {
|
|
@@ -5200,6 +5202,7 @@ export interface EventPageUpdateInputs {
|
|
|
5200
5202
|
'active'?: boolean;
|
|
5201
5203
|
'subtitle'?: string | null;
|
|
5202
5204
|
'html'?: string | null;
|
|
5205
|
+
'externalUrl'?: string | null;
|
|
5203
5206
|
'sortOrder'?: number | null;
|
|
5204
5207
|
}
|
|
5205
5208
|
export interface EventPass {
|
|
@@ -10290,16 +10293,9 @@ export interface Organization {
|
|
|
10290
10293
|
'domain': string | null;
|
|
10291
10294
|
'locale': string;
|
|
10292
10295
|
'email': string | null;
|
|
10293
|
-
'legalName': string | null;
|
|
10294
10296
|
'description': string | null;
|
|
10295
10297
|
'phone': string | null;
|
|
10296
10298
|
'privacyPolicyLink': string | null;
|
|
10297
|
-
'address1': string | null;
|
|
10298
|
-
'address2': string | null;
|
|
10299
|
-
'city': string | null;
|
|
10300
|
-
'state': string | null;
|
|
10301
|
-
'country': string | null;
|
|
10302
|
-
'zip': string | null;
|
|
10303
10299
|
'primaryColor': string | null;
|
|
10304
10300
|
'secondaryColor': string | null;
|
|
10305
10301
|
'darkPrimaryColor': string | null;
|
|
@@ -10384,8 +10380,6 @@ export interface OrganizationEntity {
|
|
|
10384
10380
|
'country': string;
|
|
10385
10381
|
'zip': string;
|
|
10386
10382
|
'companyCode': string | null;
|
|
10387
|
-
'invoicePrefix': string | null;
|
|
10388
|
-
'invoiceSequence': number;
|
|
10389
10383
|
'paymentIntegrationId': string | null;
|
|
10390
10384
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
10391
10385
|
'createdAt': string;
|
|
@@ -10404,7 +10398,6 @@ export interface OrganizationEntityCreateInputs {
|
|
|
10404
10398
|
'vatNumber'?: string | null;
|
|
10405
10399
|
'vatCountry'?: string | null;
|
|
10406
10400
|
'companyCode'?: string | null;
|
|
10407
|
-
'invoicePrefix'?: string | null;
|
|
10408
10401
|
'paymentIntegrationId'?: string | null;
|
|
10409
10402
|
}
|
|
10410
10403
|
export interface OrganizationEntityUpdateInputs {
|
|
@@ -10420,7 +10413,6 @@ export interface OrganizationEntityUpdateInputs {
|
|
|
10420
10413
|
'vatNumber'?: string | null;
|
|
10421
10414
|
'vatCountry'?: string | null;
|
|
10422
10415
|
'companyCode'?: string | null;
|
|
10423
|
-
'invoicePrefix'?: string | null;
|
|
10424
10416
|
'paymentIntegrationId'?: string | null;
|
|
10425
10417
|
}
|
|
10426
10418
|
export interface OrganizationLanguageOverride {
|
|
@@ -10686,19 +10678,12 @@ export declare enum OrganizationTriggerType {
|
|
|
10686
10678
|
export interface OrganizationUpdateInputs {
|
|
10687
10679
|
'email'?: string | null;
|
|
10688
10680
|
'name'?: string | null;
|
|
10689
|
-
'legalName'?: string | null;
|
|
10690
10681
|
'description'?: string | null;
|
|
10691
10682
|
'slug'?: string | null;
|
|
10692
10683
|
'phone'?: string | null;
|
|
10693
10684
|
'timezone'?: string | null;
|
|
10694
10685
|
'website'?: string | null;
|
|
10695
10686
|
'privacyPolicyLink'?: string | null;
|
|
10696
|
-
'address1'?: string | null;
|
|
10697
|
-
'address2'?: string | null;
|
|
10698
|
-
'city'?: string | null;
|
|
10699
|
-
'state'?: string | null;
|
|
10700
|
-
'country'?: string | null;
|
|
10701
|
-
'zip'?: string | null;
|
|
10702
10687
|
'primaryColor'?: string | null;
|
|
10703
10688
|
'secondaryColor'?: string | null;
|
|
10704
10689
|
'darkPrimaryColor'?: string | null;
|
|
@@ -66441,7 +66426,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
66441
66426
|
*/
|
|
66442
66427
|
searchOrganization: (filters?: SearchOrganizationFilters, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66443
66428
|
/**
|
|
66444
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
66429
|
+
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
66445
66430
|
* @summary Update the organization\'s profile
|
|
66446
66431
|
* @param {OrganizationUpdateInputs} organizationUpdateInputs
|
|
66447
66432
|
* @param {*} [options] Override http request option.
|
|
@@ -66523,7 +66508,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
66523
66508
|
*/
|
|
66524
66509
|
searchOrganization(filters?: SearchOrganizationFilters, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchOrganization200Response>>;
|
|
66525
66510
|
/**
|
|
66526
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
66511
|
+
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
66527
66512
|
* @summary Update the organization\'s profile
|
|
66528
66513
|
* @param {OrganizationUpdateInputs} organizationUpdateInputs
|
|
66529
66514
|
* @param {*} [options] Override http request option.
|
|
@@ -66600,7 +66585,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
66600
66585
|
*/
|
|
66601
66586
|
searchOrganization(requestParameters?: OrganizationApiSearchOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchOrganization200Response>;
|
|
66602
66587
|
/**
|
|
66603
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
66588
|
+
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
66604
66589
|
* @summary Update the organization\'s profile
|
|
66605
66590
|
* @param {OrganizationApiUpdateOrganizationRequest} requestParameters Request parameters.
|
|
66606
66591
|
* @param {*} [options] Override http request option.
|
|
@@ -66760,7 +66745,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
66760
66745
|
*/
|
|
66761
66746
|
searchOrganization(requestParameters?: OrganizationApiSearchOrganizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchOrganization200Response, any, {}>>;
|
|
66762
66747
|
/**
|
|
66763
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
66748
|
+
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
66764
66749
|
* @summary Update the organization\'s profile
|
|
66765
66750
|
* @param {OrganizationApiUpdateOrganizationRequest} requestParameters Request parameters.
|
|
66766
66751
|
* @param {*} [options] Override http request option.
|
|
@@ -67210,7 +67195,7 @@ export declare class OrganizationDomainsApi extends BaseAPI {
|
|
|
67210
67195
|
*/
|
|
67211
67196
|
export declare const OrganizationEntitiesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
67212
67197
|
/**
|
|
67213
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
67198
|
+
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address and VAT registration. The entity is not made primary on creation - use the set-primary route for that.
|
|
67214
67199
|
* @summary Create an organization legal entity
|
|
67215
67200
|
* @param {OrganizationEntityCreateInputs} organizationEntityCreateInputs
|
|
67216
67201
|
* @param {*} [options] Override http request option.
|
|
@@ -67226,7 +67211,7 @@ export declare const OrganizationEntitiesApiAxiosParamCreator: (configuration?:
|
|
|
67226
67211
|
*/
|
|
67227
67212
|
deleteOrganizationEntity: (entityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67228
67213
|
/**
|
|
67229
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
67214
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
67230
67215
|
* @summary List an organization\'s legal entities
|
|
67231
67216
|
* @param {number} [page] Page number
|
|
67232
67217
|
* @param {number} [pageSize] Number of items per page
|
|
@@ -67237,7 +67222,7 @@ export declare const OrganizationEntitiesApiAxiosParamCreator: (configuration?:
|
|
|
67237
67222
|
*/
|
|
67238
67223
|
getOrganizationEntities: (page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67239
67224
|
/**
|
|
67240
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
67225
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
67241
67226
|
* @summary Get an organization legal entity
|
|
67242
67227
|
* @param {string} entityId The entity identifier
|
|
67243
67228
|
* @param {*} [options] Override http request option.
|
|
@@ -67253,7 +67238,7 @@ export declare const OrganizationEntitiesApiAxiosParamCreator: (configuration?:
|
|
|
67253
67238
|
*/
|
|
67254
67239
|
setPrimaryOrganizationEntity: (entityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67255
67240
|
/**
|
|
67256
|
-
* Updates the identity, registered address
|
|
67241
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
67257
67242
|
* @summary Update an organization legal entity
|
|
67258
67243
|
* @param {string} entityId The entity identifier
|
|
67259
67244
|
* @param {OrganizationEntityUpdateInputs} organizationEntityUpdateInputs
|
|
@@ -67267,7 +67252,7 @@ export declare const OrganizationEntitiesApiAxiosParamCreator: (configuration?:
|
|
|
67267
67252
|
*/
|
|
67268
67253
|
export declare const OrganizationEntitiesApiFp: (configuration?: Configuration) => {
|
|
67269
67254
|
/**
|
|
67270
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
67255
|
+
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address and VAT registration. The entity is not made primary on creation - use the set-primary route for that.
|
|
67271
67256
|
* @summary Create an organization legal entity
|
|
67272
67257
|
* @param {OrganizationEntityCreateInputs} organizationEntityCreateInputs
|
|
67273
67258
|
* @param {*} [options] Override http request option.
|
|
@@ -67283,7 +67268,7 @@ export declare const OrganizationEntitiesApiFp: (configuration?: Configuration)
|
|
|
67283
67268
|
*/
|
|
67284
67269
|
deleteOrganizationEntity(entityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67285
67270
|
/**
|
|
67286
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
67271
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
67287
67272
|
* @summary List an organization\'s legal entities
|
|
67288
67273
|
* @param {number} [page] Page number
|
|
67289
67274
|
* @param {number} [pageSize] Number of items per page
|
|
@@ -67294,7 +67279,7 @@ export declare const OrganizationEntitiesApiFp: (configuration?: Configuration)
|
|
|
67294
67279
|
*/
|
|
67295
67280
|
getOrganizationEntities(page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationEntities200Response>>;
|
|
67296
67281
|
/**
|
|
67297
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
67282
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
67298
67283
|
* @summary Get an organization legal entity
|
|
67299
67284
|
* @param {string} entityId The entity identifier
|
|
67300
67285
|
* @param {*} [options] Override http request option.
|
|
@@ -67310,7 +67295,7 @@ export declare const OrganizationEntitiesApiFp: (configuration?: Configuration)
|
|
|
67310
67295
|
*/
|
|
67311
67296
|
setPrimaryOrganizationEntity(entityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrganizationEntity200Response>>;
|
|
67312
67297
|
/**
|
|
67313
|
-
* Updates the identity, registered address
|
|
67298
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
67314
67299
|
* @summary Update an organization legal entity
|
|
67315
67300
|
* @param {string} entityId The entity identifier
|
|
67316
67301
|
* @param {OrganizationEntityUpdateInputs} organizationEntityUpdateInputs
|
|
@@ -67324,7 +67309,7 @@ export declare const OrganizationEntitiesApiFp: (configuration?: Configuration)
|
|
|
67324
67309
|
*/
|
|
67325
67310
|
export declare const OrganizationEntitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
67326
67311
|
/**
|
|
67327
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
67312
|
+
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address and VAT registration. The entity is not made primary on creation - use the set-primary route for that.
|
|
67328
67313
|
* @summary Create an organization legal entity
|
|
67329
67314
|
* @param {OrganizationEntitiesApiCreateOrganizationEntityRequest} requestParameters Request parameters.
|
|
67330
67315
|
* @param {*} [options] Override http request option.
|
|
@@ -67340,7 +67325,7 @@ export declare const OrganizationEntitiesApiFactory: (configuration?: Configurat
|
|
|
67340
67325
|
*/
|
|
67341
67326
|
deleteOrganizationEntity(requestParameters: OrganizationEntitiesApiDeleteOrganizationEntityRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67342
67327
|
/**
|
|
67343
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
67328
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
67344
67329
|
* @summary List an organization\'s legal entities
|
|
67345
67330
|
* @param {OrganizationEntitiesApiGetOrganizationEntitiesRequest} requestParameters Request parameters.
|
|
67346
67331
|
* @param {*} [options] Override http request option.
|
|
@@ -67348,7 +67333,7 @@ export declare const OrganizationEntitiesApiFactory: (configuration?: Configurat
|
|
|
67348
67333
|
*/
|
|
67349
67334
|
getOrganizationEntities(requestParameters?: OrganizationEntitiesApiGetOrganizationEntitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationEntities200Response>;
|
|
67350
67335
|
/**
|
|
67351
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
67336
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
67352
67337
|
* @summary Get an organization legal entity
|
|
67353
67338
|
* @param {OrganizationEntitiesApiGetOrganizationEntityRequest} requestParameters Request parameters.
|
|
67354
67339
|
* @param {*} [options] Override http request option.
|
|
@@ -67364,7 +67349,7 @@ export declare const OrganizationEntitiesApiFactory: (configuration?: Configurat
|
|
|
67364
67349
|
*/
|
|
67365
67350
|
setPrimaryOrganizationEntity(requestParameters: OrganizationEntitiesApiSetPrimaryOrganizationEntityRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrganizationEntity200Response>;
|
|
67366
67351
|
/**
|
|
67367
|
-
* Updates the identity, registered address
|
|
67352
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
67368
67353
|
* @summary Update an organization legal entity
|
|
67369
67354
|
* @param {OrganizationEntitiesApiUpdateOrganizationEntityRequest} requestParameters Request parameters.
|
|
67370
67355
|
* @param {*} [options] Override http request option.
|
|
@@ -67441,7 +67426,7 @@ export interface OrganizationEntitiesApiUpdateOrganizationEntityRequest {
|
|
|
67441
67426
|
*/
|
|
67442
67427
|
export declare class OrganizationEntitiesApi extends BaseAPI {
|
|
67443
67428
|
/**
|
|
67444
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
67429
|
+
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address and VAT registration. The entity is not made primary on creation - use the set-primary route for that.
|
|
67445
67430
|
* @summary Create an organization legal entity
|
|
67446
67431
|
* @param {OrganizationEntitiesApiCreateOrganizationEntityRequest} requestParameters Request parameters.
|
|
67447
67432
|
* @param {*} [options] Override http request option.
|
|
@@ -67457,7 +67442,7 @@ export declare class OrganizationEntitiesApi extends BaseAPI {
|
|
|
67457
67442
|
*/
|
|
67458
67443
|
deleteOrganizationEntity(requestParameters: OrganizationEntitiesApiDeleteOrganizationEntityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
67459
67444
|
/**
|
|
67460
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
67445
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
67461
67446
|
* @summary List an organization\'s legal entities
|
|
67462
67447
|
* @param {OrganizationEntitiesApiGetOrganizationEntitiesRequest} requestParameters Request parameters.
|
|
67463
67448
|
* @param {*} [options] Override http request option.
|
|
@@ -67465,7 +67450,7 @@ export declare class OrganizationEntitiesApi extends BaseAPI {
|
|
|
67465
67450
|
*/
|
|
67466
67451
|
getOrganizationEntities(requestParameters?: OrganizationEntitiesApiGetOrganizationEntitiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationEntities200Response, any, {}>>;
|
|
67467
67452
|
/**
|
|
67468
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
67453
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
67469
67454
|
* @summary Get an organization legal entity
|
|
67470
67455
|
* @param {OrganizationEntitiesApiGetOrganizationEntityRequest} requestParameters Request parameters.
|
|
67471
67456
|
* @param {*} [options] Override http request option.
|
|
@@ -67481,7 +67466,7 @@ export declare class OrganizationEntitiesApi extends BaseAPI {
|
|
|
67481
67466
|
*/
|
|
67482
67467
|
setPrimaryOrganizationEntity(requestParameters: OrganizationEntitiesApiSetPrimaryOrganizationEntityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrganizationEntity200Response, any, {}>>;
|
|
67483
67468
|
/**
|
|
67484
|
-
* Updates the identity, registered address
|
|
67469
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
67485
67470
|
* @summary Update an organization legal entity
|
|
67486
67471
|
* @param {OrganizationEntitiesApiUpdateOrganizationEntityRequest} requestParameters Request parameters.
|
|
67487
67472
|
* @param {*} [options] Override http request option.
|