@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/dist/esm/api.js
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).
|
|
@@ -82122,7 +82122,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration) {
|
|
|
82122
82122
|
};
|
|
82123
82123
|
}),
|
|
82124
82124
|
/**
|
|
82125
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
82125
|
+
* 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.
|
|
82126
82126
|
* @summary Update the organization\'s profile
|
|
82127
82127
|
* @param {OrganizationUpdateInputs} organizationUpdateInputs
|
|
82128
82128
|
* @param {*} [options] Override http request option.
|
|
@@ -82358,7 +82358,7 @@ export const OrganizationApiFp = function (configuration) {
|
|
|
82358
82358
|
});
|
|
82359
82359
|
},
|
|
82360
82360
|
/**
|
|
82361
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
82361
|
+
* 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.
|
|
82362
82362
|
* @summary Update the organization\'s profile
|
|
82363
82363
|
* @param {OrganizationUpdateInputs} organizationUpdateInputs
|
|
82364
82364
|
* @param {*} [options] Override http request option.
|
|
@@ -82480,7 +82480,7 @@ export const OrganizationApiFactory = function (configuration, basePath, axios)
|
|
|
82480
82480
|
return localVarFp.searchOrganization(requestParameters.filters, options).then((request) => request(axios, basePath));
|
|
82481
82481
|
},
|
|
82482
82482
|
/**
|
|
82483
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
82483
|
+
* 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.
|
|
82484
82484
|
* @summary Update the organization\'s profile
|
|
82485
82485
|
* @param {OrganizationApiUpdateOrganizationRequest} requestParameters Request parameters.
|
|
82486
82486
|
* @param {*} [options] Override http request option.
|
|
@@ -82575,7 +82575,7 @@ export class OrganizationApi extends BaseAPI {
|
|
|
82575
82575
|
return OrganizationApiFp(this.configuration).searchOrganization(requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
82576
82576
|
}
|
|
82577
82577
|
/**
|
|
82578
|
-
* Updates the current organization\'s core profile fields (such as name,
|
|
82578
|
+
* 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.
|
|
82579
82579
|
* @summary Update the organization\'s profile
|
|
82580
82580
|
* @param {OrganizationApiUpdateOrganizationRequest} requestParameters Request parameters.
|
|
82581
82581
|
* @param {*} [options] Override http request option.
|
|
@@ -83372,7 +83372,7 @@ export class OrganizationDomainsApi extends BaseAPI {
|
|
|
83372
83372
|
export const OrganizationEntitiesApiAxiosParamCreator = function (configuration) {
|
|
83373
83373
|
return {
|
|
83374
83374
|
/**
|
|
83375
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
83375
|
+
* 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.
|
|
83376
83376
|
* @summary Create an organization legal entity
|
|
83377
83377
|
* @param {OrganizationEntityCreateInputs} organizationEntityCreateInputs
|
|
83378
83378
|
* @param {*} [options] Override http request option.
|
|
@@ -83441,7 +83441,7 @@ export const OrganizationEntitiesApiAxiosParamCreator = function (configuration)
|
|
|
83441
83441
|
};
|
|
83442
83442
|
}),
|
|
83443
83443
|
/**
|
|
83444
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
83444
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
83445
83445
|
* @summary List an organization\'s legal entities
|
|
83446
83446
|
* @param {number} [page] Page number
|
|
83447
83447
|
* @param {number} [pageSize] Number of items per page
|
|
@@ -83487,7 +83487,7 @@ export const OrganizationEntitiesApiAxiosParamCreator = function (configuration)
|
|
|
83487
83487
|
};
|
|
83488
83488
|
}),
|
|
83489
83489
|
/**
|
|
83490
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
83490
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
83491
83491
|
* @summary Get an organization legal entity
|
|
83492
83492
|
* @param {string} entityId The entity identifier
|
|
83493
83493
|
* @param {*} [options] Override http request option.
|
|
@@ -83555,7 +83555,7 @@ export const OrganizationEntitiesApiAxiosParamCreator = function (configuration)
|
|
|
83555
83555
|
};
|
|
83556
83556
|
}),
|
|
83557
83557
|
/**
|
|
83558
|
-
* Updates the identity, registered address
|
|
83558
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
83559
83559
|
* @summary Update an organization legal entity
|
|
83560
83560
|
* @param {string} entityId The entity identifier
|
|
83561
83561
|
* @param {OrganizationEntityUpdateInputs} organizationEntityUpdateInputs
|
|
@@ -83602,7 +83602,7 @@ export const OrganizationEntitiesApiFp = function (configuration) {
|
|
|
83602
83602
|
const localVarAxiosParamCreator = OrganizationEntitiesApiAxiosParamCreator(configuration);
|
|
83603
83603
|
return {
|
|
83604
83604
|
/**
|
|
83605
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
83605
|
+
* 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.
|
|
83606
83606
|
* @summary Create an organization legal entity
|
|
83607
83607
|
* @param {OrganizationEntityCreateInputs} organizationEntityCreateInputs
|
|
83608
83608
|
* @param {*} [options] Override http request option.
|
|
@@ -83634,7 +83634,7 @@ export const OrganizationEntitiesApiFp = function (configuration) {
|
|
|
83634
83634
|
});
|
|
83635
83635
|
},
|
|
83636
83636
|
/**
|
|
83637
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
83637
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
83638
83638
|
* @summary List an organization\'s legal entities
|
|
83639
83639
|
* @param {number} [page] Page number
|
|
83640
83640
|
* @param {number} [pageSize] Number of items per page
|
|
@@ -83653,7 +83653,7 @@ export const OrganizationEntitiesApiFp = function (configuration) {
|
|
|
83653
83653
|
});
|
|
83654
83654
|
},
|
|
83655
83655
|
/**
|
|
83656
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
83656
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
83657
83657
|
* @summary Get an organization legal entity
|
|
83658
83658
|
* @param {string} entityId The entity identifier
|
|
83659
83659
|
* @param {*} [options] Override http request option.
|
|
@@ -83685,7 +83685,7 @@ export const OrganizationEntitiesApiFp = function (configuration) {
|
|
|
83685
83685
|
});
|
|
83686
83686
|
},
|
|
83687
83687
|
/**
|
|
83688
|
-
* Updates the identity, registered address
|
|
83688
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
83689
83689
|
* @summary Update an organization legal entity
|
|
83690
83690
|
* @param {string} entityId The entity identifier
|
|
83691
83691
|
* @param {OrganizationEntityUpdateInputs} organizationEntityUpdateInputs
|
|
@@ -83710,7 +83710,7 @@ export const OrganizationEntitiesApiFactory = function (configuration, basePath,
|
|
|
83710
83710
|
const localVarFp = OrganizationEntitiesApiFp(configuration);
|
|
83711
83711
|
return {
|
|
83712
83712
|
/**
|
|
83713
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
83713
|
+
* 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.
|
|
83714
83714
|
* @summary Create an organization legal entity
|
|
83715
83715
|
* @param {OrganizationEntitiesApiCreateOrganizationEntityRequest} requestParameters Request parameters.
|
|
83716
83716
|
* @param {*} [options] Override http request option.
|
|
@@ -83730,7 +83730,7 @@ export const OrganizationEntitiesApiFactory = function (configuration, basePath,
|
|
|
83730
83730
|
return localVarFp.deleteOrganizationEntity(requestParameters.entityId, options).then((request) => request(axios, basePath));
|
|
83731
83731
|
},
|
|
83732
83732
|
/**
|
|
83733
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
83733
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
83734
83734
|
* @summary List an organization\'s legal entities
|
|
83735
83735
|
* @param {OrganizationEntitiesApiGetOrganizationEntitiesRequest} requestParameters Request parameters.
|
|
83736
83736
|
* @param {*} [options] Override http request option.
|
|
@@ -83740,7 +83740,7 @@ export const OrganizationEntitiesApiFactory = function (configuration, basePath,
|
|
|
83740
83740
|
return localVarFp.getOrganizationEntities(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
83741
83741
|
},
|
|
83742
83742
|
/**
|
|
83743
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
83743
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
83744
83744
|
* @summary Get an organization legal entity
|
|
83745
83745
|
* @param {OrganizationEntitiesApiGetOrganizationEntityRequest} requestParameters Request parameters.
|
|
83746
83746
|
* @param {*} [options] Override http request option.
|
|
@@ -83760,7 +83760,7 @@ export const OrganizationEntitiesApiFactory = function (configuration, basePath,
|
|
|
83760
83760
|
return localVarFp.setPrimaryOrganizationEntity(requestParameters.entityId, options).then((request) => request(axios, basePath));
|
|
83761
83761
|
},
|
|
83762
83762
|
/**
|
|
83763
|
-
* Updates the identity, registered address
|
|
83763
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
83764
83764
|
* @summary Update an organization legal entity
|
|
83765
83765
|
* @param {OrganizationEntitiesApiUpdateOrganizationEntityRequest} requestParameters Request parameters.
|
|
83766
83766
|
* @param {*} [options] Override http request option.
|
|
@@ -83776,7 +83776,7 @@ export const OrganizationEntitiesApiFactory = function (configuration, basePath,
|
|
|
83776
83776
|
*/
|
|
83777
83777
|
export class OrganizationEntitiesApi extends BaseAPI {
|
|
83778
83778
|
/**
|
|
83779
|
-
* Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
83779
|
+
* 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.
|
|
83780
83780
|
* @summary Create an organization legal entity
|
|
83781
83781
|
* @param {OrganizationEntitiesApiCreateOrganizationEntityRequest} requestParameters Request parameters.
|
|
83782
83782
|
* @param {*} [options] Override http request option.
|
|
@@ -83796,7 +83796,7 @@ export class OrganizationEntitiesApi extends BaseAPI {
|
|
|
83796
83796
|
return OrganizationEntitiesApiFp(this.configuration).deleteOrganizationEntity(requestParameters.entityId, options).then((request) => request(this.axios, this.basePath));
|
|
83797
83797
|
}
|
|
83798
83798
|
/**
|
|
83799
|
-
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
83799
|
+
* Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
83800
83800
|
* @summary List an organization\'s legal entities
|
|
83801
83801
|
* @param {OrganizationEntitiesApiGetOrganizationEntitiesRequest} requestParameters Request parameters.
|
|
83802
83802
|
* @param {*} [options] Override http request option.
|
|
@@ -83806,7 +83806,7 @@ export class OrganizationEntitiesApi extends BaseAPI {
|
|
|
83806
83806
|
return OrganizationEntitiesApiFp(this.configuration).getOrganizationEntities(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
83807
83807
|
}
|
|
83808
83808
|
/**
|
|
83809
|
-
* Retrieves a single legal entity by ID, including its registered address
|
|
83809
|
+
* Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
83810
83810
|
* @summary Get an organization legal entity
|
|
83811
83811
|
* @param {OrganizationEntitiesApiGetOrganizationEntityRequest} requestParameters Request parameters.
|
|
83812
83812
|
* @param {*} [options] Override http request option.
|
|
@@ -83826,7 +83826,7 @@ export class OrganizationEntitiesApi extends BaseAPI {
|
|
|
83826
83826
|
return OrganizationEntitiesApiFp(this.configuration).setPrimaryOrganizationEntity(requestParameters.entityId, options).then((request) => request(this.axios, this.basePath));
|
|
83827
83827
|
}
|
|
83828
83828
|
/**
|
|
83829
|
-
* Updates the identity, registered address
|
|
83829
|
+
* Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
83830
83830
|
* @summary Update an organization legal entity
|
|
83831
83831
|
* @param {OrganizationEntitiesApiUpdateOrganizationEntityRequest} requestParameters Request parameters.
|
|
83832
83832
|
* @param {*} [options] Override http request option.
|
package/dist/esm/base.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).
|
package/dist/esm/base.js
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/dist/esm/common.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).
|
package/dist/esm/common.js
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).
|
|
@@ -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).
|
|
@@ -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/docs/EventPage.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**subtitle** | **string** | | [default to undefined]
|
|
13
13
|
**sortOrder** | **number** | | [default to undefined]
|
|
14
14
|
**html** | **string** | | [default to undefined]
|
|
15
|
+
**externalUrl** | **string** | | [default to undefined]
|
|
15
16
|
**createdAt** | **string** | | [default to undefined]
|
|
16
17
|
**updatedAt** | **string** | | [default to undefined]
|
|
17
18
|
|
|
@@ -28,6 +29,7 @@ const instance: EventPage = {
|
|
|
28
29
|
subtitle,
|
|
29
30
|
sortOrder,
|
|
30
31
|
html,
|
|
32
|
+
externalUrl,
|
|
31
33
|
createdAt,
|
|
32
34
|
updatedAt,
|
|
33
35
|
};
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**active** | **boolean** | | [optional] [default to undefined]
|
|
11
11
|
**subtitle** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**html** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**externalUrl** | **string** | | [optional] [default to undefined]
|
|
13
14
|
**sortOrder** | **number** | | [optional] [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
@@ -23,6 +24,7 @@ const instance: EventPageCreateInputs = {
|
|
|
23
24
|
active,
|
|
24
25
|
subtitle,
|
|
25
26
|
html,
|
|
27
|
+
externalUrl,
|
|
26
28
|
sortOrder,
|
|
27
29
|
};
|
|
28
30
|
```
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**active** | **boolean** | | [optional] [default to undefined]
|
|
11
11
|
**subtitle** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**html** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**externalUrl** | **string** | | [optional] [default to undefined]
|
|
13
14
|
**sortOrder** | **number** | | [optional] [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
@@ -23,6 +24,7 @@ const instance: EventPageUpdateInputs = {
|
|
|
23
24
|
active,
|
|
24
25
|
subtitle,
|
|
25
26
|
html,
|
|
27
|
+
externalUrl,
|
|
26
28
|
sortOrder,
|
|
27
29
|
};
|
|
28
30
|
```
|
package/docs/Organization.md
CHANGED
|
@@ -15,16 +15,9 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**domain** | **string** | | [default to undefined]
|
|
16
16
|
**locale** | **string** | | [default to undefined]
|
|
17
17
|
**email** | **string** | | [default to undefined]
|
|
18
|
-
**legalName** | **string** | | [default to undefined]
|
|
19
18
|
**description** | **string** | | [default to undefined]
|
|
20
19
|
**phone** | **string** | | [default to undefined]
|
|
21
20
|
**privacyPolicyLink** | **string** | | [default to undefined]
|
|
22
|
-
**address1** | **string** | | [default to undefined]
|
|
23
|
-
**address2** | **string** | | [default to undefined]
|
|
24
|
-
**city** | **string** | | [default to undefined]
|
|
25
|
-
**state** | **string** | | [default to undefined]
|
|
26
|
-
**country** | **string** | | [default to undefined]
|
|
27
|
-
**zip** | **string** | | [default to undefined]
|
|
28
21
|
**primaryColor** | **string** | | [default to undefined]
|
|
29
22
|
**secondaryColor** | **string** | | [default to undefined]
|
|
30
23
|
**darkPrimaryColor** | **string** | | [default to undefined]
|
|
@@ -101,16 +94,9 @@ const instance: Organization = {
|
|
|
101
94
|
domain,
|
|
102
95
|
locale,
|
|
103
96
|
email,
|
|
104
|
-
legalName,
|
|
105
97
|
description,
|
|
106
98
|
phone,
|
|
107
99
|
privacyPolicyLink,
|
|
108
|
-
address1,
|
|
109
|
-
address2,
|
|
110
|
-
city,
|
|
111
|
-
state,
|
|
112
|
-
country,
|
|
113
|
-
zip,
|
|
114
100
|
primaryColor,
|
|
115
101
|
secondaryColor,
|
|
116
102
|
darkPrimaryColor,
|
package/docs/OrganizationApi.md
CHANGED
|
@@ -281,7 +281,7 @@ const { status, data } = await apiInstance.searchOrganization(
|
|
|
281
281
|
# **updateOrganization**
|
|
282
282
|
> GetOrganization200Response updateOrganization(organizationUpdateInputs)
|
|
283
283
|
|
|
284
|
-
Updates the current organization\'s core profile fields (such as name,
|
|
284
|
+
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.
|
|
285
285
|
|
|
286
286
|
### Example
|
|
287
287
|
|
|
@@ -14,7 +14,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
14
14
|
# **createOrganizationEntity**
|
|
15
15
|
> CreateOrganizationEntity200Response createOrganizationEntity(organizationEntityCreateInputs)
|
|
16
16
|
|
|
17
|
-
Creates a legal entity that can sell on behalf of the organization, carrying its own registered address
|
|
17
|
+
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.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -117,7 +117,7 @@ const { status, data } = await apiInstance.deleteOrganizationEntity(
|
|
|
117
117
|
# **getOrganizationEntities**
|
|
118
118
|
> GetOrganizationEntities200Response getOrganizationEntities()
|
|
119
119
|
|
|
120
|
-
Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address
|
|
120
|
+
Returns a paginated, searchable list of the legal entities that sell on behalf of the organization, each carrying its registered address and VAT registration.
|
|
121
121
|
|
|
122
122
|
### Example
|
|
123
123
|
|
|
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.getOrganizationEntities(
|
|
|
177
177
|
# **getOrganizationEntity**
|
|
178
178
|
> CreateOrganizationEntity200Response getOrganizationEntity()
|
|
179
179
|
|
|
180
|
-
Retrieves a single legal entity by ID, including its registered address
|
|
180
|
+
Retrieves a single legal entity by ID, including its registered address and VAT registration details.
|
|
181
181
|
|
|
182
182
|
### Example
|
|
183
183
|
|
|
@@ -279,7 +279,7 @@ const { status, data } = await apiInstance.setPrimaryOrganizationEntity(
|
|
|
279
279
|
# **updateOrganizationEntity**
|
|
280
280
|
> CreateOrganizationEntity200Response updateOrganizationEntity(organizationEntityUpdateInputs)
|
|
281
281
|
|
|
282
|
-
Updates the identity, registered address
|
|
282
|
+
Updates the identity, registered address or VAT registration of a legal entity. Primary status cannot be changed here - use the set-primary route.
|
|
283
283
|
|
|
284
284
|
### Example
|
|
285
285
|
|
|
@@ -19,8 +19,6 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**country** | **string** | | [default to undefined]
|
|
20
20
|
**zip** | **string** | | [default to undefined]
|
|
21
21
|
**companyCode** | **string** | | [default to undefined]
|
|
22
|
-
**invoicePrefix** | **string** | | [default to undefined]
|
|
23
|
-
**invoiceSequence** | **number** | | [default to undefined]
|
|
24
22
|
**paymentIntegrationId** | **string** | | [default to undefined]
|
|
25
23
|
**paymentIntegration** | [**BasePaymentIntegration**](BasePaymentIntegration.md) | | [default to undefined]
|
|
26
24
|
**createdAt** | **string** | | [default to undefined]
|
|
@@ -46,8 +44,6 @@ const instance: OrganizationEntity = {
|
|
|
46
44
|
country,
|
|
47
45
|
zip,
|
|
48
46
|
companyCode,
|
|
49
|
-
invoicePrefix,
|
|
50
|
-
invoiceSequence,
|
|
51
47
|
paymentIntegrationId,
|
|
52
48
|
paymentIntegration,
|
|
53
49
|
createdAt,
|
|
@@ -17,7 +17,6 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**vatNumber** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**vatCountry** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**companyCode** | **string** | | [optional] [default to undefined]
|
|
20
|
-
**invoicePrefix** | **string** | | [optional] [default to undefined]
|
|
21
20
|
**paymentIntegrationId** | **string** | | [optional] [default to undefined]
|
|
22
21
|
|
|
23
22
|
## Example
|
|
@@ -38,7 +37,6 @@ const instance: OrganizationEntityCreateInputs = {
|
|
|
38
37
|
vatNumber,
|
|
39
38
|
vatCountry,
|
|
40
39
|
companyCode,
|
|
41
|
-
invoicePrefix,
|
|
42
40
|
paymentIntegrationId,
|
|
43
41
|
};
|
|
44
42
|
```
|
|
@@ -17,7 +17,6 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**vatNumber** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**vatCountry** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**companyCode** | **string** | | [optional] [default to undefined]
|
|
20
|
-
**invoicePrefix** | **string** | | [optional] [default to undefined]
|
|
21
20
|
**paymentIntegrationId** | **string** | | [optional] [default to undefined]
|
|
22
21
|
|
|
23
22
|
## Example
|
|
@@ -38,7 +37,6 @@ const instance: OrganizationEntityUpdateInputs = {
|
|
|
38
37
|
vatNumber,
|
|
39
38
|
vatCountry,
|
|
40
39
|
companyCode,
|
|
41
|
-
invoicePrefix,
|
|
42
40
|
paymentIntegrationId,
|
|
43
41
|
};
|
|
44
42
|
```
|
|
@@ -7,19 +7,12 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**email** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**legalName** | **string** | | [optional] [default to undefined]
|
|
11
10
|
**description** | **string** | | [optional] [default to undefined]
|
|
12
11
|
**slug** | **string** | | [optional] [default to undefined]
|
|
13
12
|
**phone** | **string** | | [optional] [default to undefined]
|
|
14
13
|
**timezone** | **string** | | [optional] [default to undefined]
|
|
15
14
|
**website** | **string** | | [optional] [default to undefined]
|
|
16
15
|
**privacyPolicyLink** | **string** | | [optional] [default to undefined]
|
|
17
|
-
**address1** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**address2** | **string** | | [optional] [default to undefined]
|
|
19
|
-
**city** | **string** | | [optional] [default to undefined]
|
|
20
|
-
**state** | **string** | | [optional] [default to undefined]
|
|
21
|
-
**country** | **string** | | [optional] [default to undefined]
|
|
22
|
-
**zip** | **string** | | [optional] [default to undefined]
|
|
23
16
|
**primaryColor** | **string** | | [optional] [default to undefined]
|
|
24
17
|
**secondaryColor** | **string** | | [optional] [default to undefined]
|
|
25
18
|
**darkPrimaryColor** | **string** | | [optional] [default to undefined]
|
|
@@ -69,19 +62,12 @@ import { OrganizationUpdateInputs } from '@connectedxm/admin-sdk';
|
|
|
69
62
|
const instance: OrganizationUpdateInputs = {
|
|
70
63
|
email,
|
|
71
64
|
name,
|
|
72
|
-
legalName,
|
|
73
65
|
description,
|
|
74
66
|
slug,
|
|
75
67
|
phone,
|
|
76
68
|
timezone,
|
|
77
69
|
website,
|
|
78
70
|
privacyPolicyLink,
|
|
79
|
-
address1,
|
|
80
|
-
address2,
|
|
81
|
-
city,
|
|
82
|
-
state,
|
|
83
|
-
country,
|
|
84
|
-
zip,
|
|
85
71
|
primaryColor,
|
|
86
72
|
secondaryColor,
|
|
87
73
|
darkPrimaryColor,
|