@connectedxm/admin-sdk 7.12.0 → 7.12.2
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/api.ts +36 -11
- package/dist/api.d.ts +20 -5
- package/dist/api.js +21 -10
- package/dist/esm/api.d.ts +20 -5
- package/dist/esm/api.js +21 -10
- package/docs/ImportItemStatus.md +2 -0
- package/docs/ImportsApi.md +3 -0
- package/docs/Tier.md +2 -0
- package/docs/TierUpdateInputs.md +2 -0
- package/docs/TiersApi.md +3 -0
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -10366,7 +10366,8 @@ export interface ImportItem {
|
|
|
10366
10366
|
export enum ImportItemStatus {
|
|
10367
10367
|
Pending = 'pending',
|
|
10368
10368
|
Resolved = 'resolved',
|
|
10369
|
-
Failed = 'failed'
|
|
10369
|
+
Failed = 'failed',
|
|
10370
|
+
Invalid = 'invalid'
|
|
10370
10371
|
}
|
|
10371
10372
|
|
|
10372
10373
|
|
|
@@ -14016,6 +14017,7 @@ export interface Tier {
|
|
|
14016
14017
|
'image': BaseImage | null;
|
|
14017
14018
|
'description': string | null;
|
|
14018
14019
|
'exclusionGroup': string | null;
|
|
14020
|
+
'archived': boolean;
|
|
14019
14021
|
'createdAt': string;
|
|
14020
14022
|
'updatedAt': string;
|
|
14021
14023
|
'_count': TierAllOfCount;
|
|
@@ -14044,6 +14046,7 @@ export interface TierUpdateInputs {
|
|
|
14044
14046
|
'color'?: string | null;
|
|
14045
14047
|
'internal'?: boolean;
|
|
14046
14048
|
'exclusionGroup'?: string | null;
|
|
14049
|
+
'archived'?: boolean;
|
|
14047
14050
|
}
|
|
14048
14051
|
export interface Transfer {
|
|
14049
14052
|
'id': string;
|
|
@@ -109133,6 +109136,7 @@ export const ImportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
109133
109136
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
109134
109137
|
* @summary List the rows in an import job
|
|
109135
109138
|
* @param {string} importId The import identifier
|
|
109139
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
109136
109140
|
* @param {number} [page] Page number
|
|
109137
109141
|
* @param {number} [pageSize] Number of items per page
|
|
109138
109142
|
* @param {string} [orderBy] Field to order by
|
|
@@ -109140,7 +109144,7 @@ export const ImportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
109140
109144
|
* @param {*} [options] Override http request option.
|
|
109141
109145
|
* @throws {RequiredError}
|
|
109142
109146
|
*/
|
|
109143
|
-
getImportItems: async (importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
109147
|
+
getImportItems: async (importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
109144
109148
|
// verify required parameter 'importId' is not null or undefined
|
|
109145
109149
|
assertParamExists('getImportItems', 'importId', importId)
|
|
109146
109150
|
const localVarPath = `/imports/{importId}/items`
|
|
@@ -109162,6 +109166,10 @@ export const ImportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
109162
109166
|
// authentication OrganizationId required
|
|
109163
109167
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
109164
109168
|
|
|
109169
|
+
if (status !== undefined) {
|
|
109170
|
+
localVarQueryParameter['status'] = status;
|
|
109171
|
+
}
|
|
109172
|
+
|
|
109165
109173
|
if (page !== undefined) {
|
|
109166
109174
|
localVarQueryParameter['page'] = page;
|
|
109167
109175
|
}
|
|
@@ -109291,6 +109299,7 @@ export const ImportsApiFp = function(configuration?: Configuration) {
|
|
|
109291
109299
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
109292
109300
|
* @summary List the rows in an import job
|
|
109293
109301
|
* @param {string} importId The import identifier
|
|
109302
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
109294
109303
|
* @param {number} [page] Page number
|
|
109295
109304
|
* @param {number} [pageSize] Number of items per page
|
|
109296
109305
|
* @param {string} [orderBy] Field to order by
|
|
@@ -109298,8 +109307,8 @@ export const ImportsApiFp = function(configuration?: Configuration) {
|
|
|
109298
109307
|
* @param {*} [options] Override http request option.
|
|
109299
109308
|
* @throws {RequiredError}
|
|
109300
109309
|
*/
|
|
109301
|
-
async getImportItems(importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>> {
|
|
109302
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getImportItems(importId, page, pageSize, orderBy, search, options);
|
|
109310
|
+
async getImportItems(importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>> {
|
|
109311
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getImportItems(importId, status, page, pageSize, orderBy, search, options);
|
|
109303
109312
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
109304
109313
|
const localVarOperationServerBasePath = operationServerMap['ImportsApi.getImportItems']?.[localVarOperationServerIndex]?.url;
|
|
109305
109314
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -109358,7 +109367,7 @@ export const ImportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
109358
109367
|
* @throws {RequiredError}
|
|
109359
109368
|
*/
|
|
109360
109369
|
getImportItems(requestParameters: ImportsApiGetImportItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetImportItems200Response> {
|
|
109361
|
-
return localVarFp.getImportItems(requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
109370
|
+
return localVarFp.getImportItems(requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
109362
109371
|
},
|
|
109363
109372
|
/**
|
|
109364
109373
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
@@ -109412,6 +109421,11 @@ export interface ImportsApiGetImportItemsRequest {
|
|
|
109412
109421
|
*/
|
|
109413
109422
|
readonly importId: string
|
|
109414
109423
|
|
|
109424
|
+
/**
|
|
109425
|
+
* Filter by status
|
|
109426
|
+
*/
|
|
109427
|
+
readonly status?: ImportItemStatus
|
|
109428
|
+
|
|
109415
109429
|
/**
|
|
109416
109430
|
* Page number
|
|
109417
109431
|
*/
|
|
@@ -109497,7 +109511,7 @@ export class ImportsApi extends BaseAPI {
|
|
|
109497
109511
|
* @throws {RequiredError}
|
|
109498
109512
|
*/
|
|
109499
109513
|
public getImportItems(requestParameters: ImportsApiGetImportItemsRequest, options?: RawAxiosRequestConfig) {
|
|
109500
|
-
return ImportsApiFp(this.configuration).getImportItems(requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
109514
|
+
return ImportsApiFp(this.configuration).getImportItems(requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
109501
109515
|
}
|
|
109502
109516
|
|
|
109503
109517
|
/**
|
|
@@ -152602,6 +152616,7 @@ export const TiersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
152602
152616
|
* @summary List rows of an account tier import
|
|
152603
152617
|
* @param {string} tierId The tier identifier
|
|
152604
152618
|
* @param {string} importId The import identifier
|
|
152619
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
152605
152620
|
* @param {number} [page] Page number
|
|
152606
152621
|
* @param {number} [pageSize] Number of items per page
|
|
152607
152622
|
* @param {string} [orderBy] Field to order by
|
|
@@ -152609,7 +152624,7 @@ export const TiersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
152609
152624
|
* @param {*} [options] Override http request option.
|
|
152610
152625
|
* @throws {RequiredError}
|
|
152611
152626
|
*/
|
|
152612
|
-
getTierImportItems: async (tierId: string, importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152627
|
+
getTierImportItems: async (tierId: string, importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152613
152628
|
// verify required parameter 'tierId' is not null or undefined
|
|
152614
152629
|
assertParamExists('getTierImportItems', 'tierId', tierId)
|
|
152615
152630
|
// verify required parameter 'importId' is not null or undefined
|
|
@@ -152634,6 +152649,10 @@ export const TiersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
152634
152649
|
// authentication OrganizationId required
|
|
152635
152650
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152636
152651
|
|
|
152652
|
+
if (status !== undefined) {
|
|
152653
|
+
localVarQueryParameter['status'] = status;
|
|
152654
|
+
}
|
|
152655
|
+
|
|
152637
152656
|
if (page !== undefined) {
|
|
152638
152657
|
localVarQueryParameter['page'] = page;
|
|
152639
152658
|
}
|
|
@@ -152951,6 +152970,7 @@ export const TiersApiFp = function(configuration?: Configuration) {
|
|
|
152951
152970
|
* @summary List rows of an account tier import
|
|
152952
152971
|
* @param {string} tierId The tier identifier
|
|
152953
152972
|
* @param {string} importId The import identifier
|
|
152973
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
152954
152974
|
* @param {number} [page] Page number
|
|
152955
152975
|
* @param {number} [pageSize] Number of items per page
|
|
152956
152976
|
* @param {string} [orderBy] Field to order by
|
|
@@ -152958,8 +152978,8 @@ export const TiersApiFp = function(configuration?: Configuration) {
|
|
|
152958
152978
|
* @param {*} [options] Override http request option.
|
|
152959
152979
|
* @throws {RequiredError}
|
|
152960
152980
|
*/
|
|
152961
|
-
async getTierImportItems(tierId: string, importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>> {
|
|
152962
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTierImportItems(tierId, importId, page, pageSize, orderBy, search, options);
|
|
152981
|
+
async getTierImportItems(tierId: string, importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>> {
|
|
152982
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTierImportItems(tierId, importId, status, page, pageSize, orderBy, search, options);
|
|
152963
152983
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152964
152984
|
const localVarOperationServerBasePath = operationServerMap['TiersApi.getTierImportItems']?.[localVarOperationServerIndex]?.url;
|
|
152965
152985
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -153092,7 +153112,7 @@ export const TiersApiFactory = function (configuration?: Configuration, basePath
|
|
|
153092
153112
|
* @throws {RequiredError}
|
|
153093
153113
|
*/
|
|
153094
153114
|
getTierImportItems(requestParameters: TiersApiGetTierImportItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetImportItems200Response> {
|
|
153095
|
-
return localVarFp.getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
153115
|
+
return localVarFp.getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
153096
153116
|
},
|
|
153097
153117
|
/**
|
|
153098
153118
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
|
@@ -153223,6 +153243,11 @@ export interface TiersApiGetTierImportItemsRequest {
|
|
|
153223
153243
|
*/
|
|
153224
153244
|
readonly importId: string
|
|
153225
153245
|
|
|
153246
|
+
/**
|
|
153247
|
+
* Filter by status
|
|
153248
|
+
*/
|
|
153249
|
+
readonly status?: ImportItemStatus
|
|
153250
|
+
|
|
153226
153251
|
/**
|
|
153227
153252
|
* Page number
|
|
153228
153253
|
*/
|
|
@@ -153393,7 +153418,7 @@ export class TiersApi extends BaseAPI {
|
|
|
153393
153418
|
* @throws {RequiredError}
|
|
153394
153419
|
*/
|
|
153395
153420
|
public getTierImportItems(requestParameters: TiersApiGetTierImportItemsRequest, options?: RawAxiosRequestConfig) {
|
|
153396
|
-
return TiersApiFp(this.configuration).getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153421
|
+
return TiersApiFp(this.configuration).getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153397
153422
|
}
|
|
153398
153423
|
|
|
153399
153424
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -9141,7 +9141,8 @@ export interface ImportItem {
|
|
|
9141
9141
|
export declare enum ImportItemStatus {
|
|
9142
9142
|
Pending = "pending",
|
|
9143
9143
|
Resolved = "resolved",
|
|
9144
|
-
Failed = "failed"
|
|
9144
|
+
Failed = "failed",
|
|
9145
|
+
Invalid = "invalid"
|
|
9145
9146
|
}
|
|
9146
9147
|
export interface ImportRooms200Response {
|
|
9147
9148
|
'status': ImportRooms200ResponseStatusEnum;
|
|
@@ -12484,6 +12485,7 @@ export interface Tier {
|
|
|
12484
12485
|
'image': BaseImage | null;
|
|
12485
12486
|
'description': string | null;
|
|
12486
12487
|
'exclusionGroup': string | null;
|
|
12488
|
+
'archived': boolean;
|
|
12487
12489
|
'createdAt': string;
|
|
12488
12490
|
'updatedAt': string;
|
|
12489
12491
|
'_count': TierAllOfCount;
|
|
@@ -12512,6 +12514,7 @@ export interface TierUpdateInputs {
|
|
|
12512
12514
|
'color'?: string | null;
|
|
12513
12515
|
'internal'?: boolean;
|
|
12514
12516
|
'exclusionGroup'?: string | null;
|
|
12517
|
+
'archived'?: boolean;
|
|
12515
12518
|
}
|
|
12516
12519
|
export interface Transfer {
|
|
12517
12520
|
'id': string;
|
|
@@ -60987,6 +60990,7 @@ export declare const ImportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
60987
60990
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
60988
60991
|
* @summary List the rows in an import job
|
|
60989
60992
|
* @param {string} importId The import identifier
|
|
60993
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
60990
60994
|
* @param {number} [page] Page number
|
|
60991
60995
|
* @param {number} [pageSize] Number of items per page
|
|
60992
60996
|
* @param {string} [orderBy] Field to order by
|
|
@@ -60994,7 +60998,7 @@ export declare const ImportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
60994
60998
|
* @param {*} [options] Override http request option.
|
|
60995
60999
|
* @throws {RequiredError}
|
|
60996
61000
|
*/
|
|
60997
|
-
getImportItems: (importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61001
|
+
getImportItems: (importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60998
61002
|
/**
|
|
60999
61003
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
61000
61004
|
* @summary List bulk import jobs
|
|
@@ -61034,6 +61038,7 @@ export declare const ImportsApiFp: (configuration?: Configuration) => {
|
|
|
61034
61038
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
61035
61039
|
* @summary List the rows in an import job
|
|
61036
61040
|
* @param {string} importId The import identifier
|
|
61041
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
61037
61042
|
* @param {number} [page] Page number
|
|
61038
61043
|
* @param {number} [pageSize] Number of items per page
|
|
61039
61044
|
* @param {string} [orderBy] Field to order by
|
|
@@ -61041,7 +61046,7 @@ export declare const ImportsApiFp: (configuration?: Configuration) => {
|
|
|
61041
61046
|
* @param {*} [options] Override http request option.
|
|
61042
61047
|
* @throws {RequiredError}
|
|
61043
61048
|
*/
|
|
61044
|
-
getImportItems(importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>>;
|
|
61049
|
+
getImportItems(importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>>;
|
|
61045
61050
|
/**
|
|
61046
61051
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
61047
61052
|
* @summary List bulk import jobs
|
|
@@ -61126,6 +61131,10 @@ export interface ImportsApiGetImportItemsRequest {
|
|
|
61126
61131
|
* The import identifier
|
|
61127
61132
|
*/
|
|
61128
61133
|
readonly importId: string;
|
|
61134
|
+
/**
|
|
61135
|
+
* Filter by status
|
|
61136
|
+
*/
|
|
61137
|
+
readonly status?: ImportItemStatus;
|
|
61129
61138
|
/**
|
|
61130
61139
|
* Page number
|
|
61131
61140
|
*/
|
|
@@ -82676,6 +82685,7 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82676
82685
|
* @summary List rows of an account tier import
|
|
82677
82686
|
* @param {string} tierId The tier identifier
|
|
82678
82687
|
* @param {string} importId The import identifier
|
|
82688
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
82679
82689
|
* @param {number} [page] Page number
|
|
82680
82690
|
* @param {number} [pageSize] Number of items per page
|
|
82681
82691
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82683,7 +82693,7 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82683
82693
|
* @param {*} [options] Override http request option.
|
|
82684
82694
|
* @throws {RequiredError}
|
|
82685
82695
|
*/
|
|
82686
|
-
getTierImportItems: (tierId: string, importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82696
|
+
getTierImportItems: (tierId: string, importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82687
82697
|
/**
|
|
82688
82698
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
|
82689
82699
|
* @summary List account tier imports
|
|
@@ -82780,6 +82790,7 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
|
|
|
82780
82790
|
* @summary List rows of an account tier import
|
|
82781
82791
|
* @param {string} tierId The tier identifier
|
|
82782
82792
|
* @param {string} importId The import identifier
|
|
82793
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
82783
82794
|
* @param {number} [page] Page number
|
|
82784
82795
|
* @param {number} [pageSize] Number of items per page
|
|
82785
82796
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82787,7 +82798,7 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
|
|
|
82787
82798
|
* @param {*} [options] Override http request option.
|
|
82788
82799
|
* @throws {RequiredError}
|
|
82789
82800
|
*/
|
|
82790
|
-
getTierImportItems(tierId: string, importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>>;
|
|
82801
|
+
getTierImportItems(tierId: string, importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>>;
|
|
82791
82802
|
/**
|
|
82792
82803
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
|
82793
82804
|
* @summary List account tier imports
|
|
@@ -82989,6 +83000,10 @@ export interface TiersApiGetTierImportItemsRequest {
|
|
|
82989
83000
|
* The import identifier
|
|
82990
83001
|
*/
|
|
82991
83002
|
readonly importId: string;
|
|
83003
|
+
/**
|
|
83004
|
+
* Filter by status
|
|
83005
|
+
*/
|
|
83006
|
+
readonly status?: ImportItemStatus;
|
|
82992
83007
|
/**
|
|
82993
83008
|
* Page number
|
|
82994
83009
|
*/
|
package/dist/api.js
CHANGED
|
@@ -2011,6 +2011,7 @@ var ImportItemStatus;
|
|
|
2011
2011
|
ImportItemStatus["Pending"] = "pending";
|
|
2012
2012
|
ImportItemStatus["Resolved"] = "resolved";
|
|
2013
2013
|
ImportItemStatus["Failed"] = "failed";
|
|
2014
|
+
ImportItemStatus["Invalid"] = "invalid";
|
|
2014
2015
|
})(ImportItemStatus || (exports.ImportItemStatus = ImportItemStatus = {}));
|
|
2015
2016
|
var ImportRooms200ResponseStatusEnum;
|
|
2016
2017
|
(function (ImportRooms200ResponseStatusEnum) {
|
|
@@ -74598,6 +74599,7 @@ const ImportsApiAxiosParamCreator = function (configuration) {
|
|
|
74598
74599
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
74599
74600
|
* @summary List the rows in an import job
|
|
74600
74601
|
* @param {string} importId The import identifier
|
|
74602
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
74601
74603
|
* @param {number} [page] Page number
|
|
74602
74604
|
* @param {number} [pageSize] Number of items per page
|
|
74603
74605
|
* @param {string} [orderBy] Field to order by
|
|
@@ -74605,7 +74607,7 @@ const ImportsApiAxiosParamCreator = function (configuration) {
|
|
|
74605
74607
|
* @param {*} [options] Override http request option.
|
|
74606
74608
|
* @throws {RequiredError}
|
|
74607
74609
|
*/
|
|
74608
|
-
getImportItems: (importId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [importId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (importId, page, pageSize, orderBy, search, options = {}) {
|
|
74610
|
+
getImportItems: (importId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [importId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (importId, status, page, pageSize, orderBy, search, options = {}) {
|
|
74609
74611
|
// verify required parameter 'importId' is not null or undefined
|
|
74610
74612
|
(0, common_1.assertParamExists)('getImportItems', 'importId', importId);
|
|
74611
74613
|
const localVarPath = `/imports/{importId}/items`
|
|
@@ -74623,6 +74625,9 @@ const ImportsApiAxiosParamCreator = function (configuration) {
|
|
|
74623
74625
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
74624
74626
|
// authentication OrganizationId required
|
|
74625
74627
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
74628
|
+
if (status !== undefined) {
|
|
74629
|
+
localVarQueryParameter['status'] = status;
|
|
74630
|
+
}
|
|
74626
74631
|
if (page !== undefined) {
|
|
74627
74632
|
localVarQueryParameter['page'] = page;
|
|
74628
74633
|
}
|
|
@@ -74741,6 +74746,7 @@ const ImportsApiFp = function (configuration) {
|
|
|
74741
74746
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
74742
74747
|
* @summary List the rows in an import job
|
|
74743
74748
|
* @param {string} importId The import identifier
|
|
74749
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
74744
74750
|
* @param {number} [page] Page number
|
|
74745
74751
|
* @param {number} [pageSize] Number of items per page
|
|
74746
74752
|
* @param {string} [orderBy] Field to order by
|
|
@@ -74748,10 +74754,10 @@ const ImportsApiFp = function (configuration) {
|
|
|
74748
74754
|
* @param {*} [options] Override http request option.
|
|
74749
74755
|
* @throws {RequiredError}
|
|
74750
74756
|
*/
|
|
74751
|
-
getImportItems(importId, page, pageSize, orderBy, search, options) {
|
|
74757
|
+
getImportItems(importId, status, page, pageSize, orderBy, search, options) {
|
|
74752
74758
|
return __awaiter(this, void 0, void 0, function* () {
|
|
74753
74759
|
var _a, _b, _c;
|
|
74754
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getImportItems(importId, page, pageSize, orderBy, search, options);
|
|
74760
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getImportItems(importId, status, page, pageSize, orderBy, search, options);
|
|
74755
74761
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
74756
74762
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ImportsApi.getImportItems']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
74757
74763
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -74814,7 +74820,7 @@ const ImportsApiFactory = function (configuration, basePath, axios) {
|
|
|
74814
74820
|
* @throws {RequiredError}
|
|
74815
74821
|
*/
|
|
74816
74822
|
getImportItems(requestParameters, options) {
|
|
74817
|
-
return localVarFp.getImportItems(requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
74823
|
+
return localVarFp.getImportItems(requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
74818
74824
|
},
|
|
74819
74825
|
/**
|
|
74820
74826
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
@@ -74861,7 +74867,7 @@ class ImportsApi extends base_1.BaseAPI {
|
|
|
74861
74867
|
* @throws {RequiredError}
|
|
74862
74868
|
*/
|
|
74863
74869
|
getImportItems(requestParameters, options) {
|
|
74864
|
-
return (0, exports.ImportsApiFp)(this.configuration).getImportItems(requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
74870
|
+
return (0, exports.ImportsApiFp)(this.configuration).getImportItems(requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
74865
74871
|
}
|
|
74866
74872
|
/**
|
|
74867
74873
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
@@ -108948,6 +108954,7 @@ const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108948
108954
|
* @summary List rows of an account tier import
|
|
108949
108955
|
* @param {string} tierId The tier identifier
|
|
108950
108956
|
* @param {string} importId The import identifier
|
|
108957
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
108951
108958
|
* @param {number} [page] Page number
|
|
108952
108959
|
* @param {number} [pageSize] Number of items per page
|
|
108953
108960
|
* @param {string} [orderBy] Field to order by
|
|
@@ -108955,7 +108962,7 @@ const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108955
108962
|
* @param {*} [options] Override http request option.
|
|
108956
108963
|
* @throws {RequiredError}
|
|
108957
108964
|
*/
|
|
108958
|
-
getTierImportItems: (tierId_1, importId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [tierId_1, importId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (tierId, importId, page, pageSize, orderBy, search, options = {}) {
|
|
108965
|
+
getTierImportItems: (tierId_1, importId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [tierId_1, importId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (tierId, importId, status, page, pageSize, orderBy, search, options = {}) {
|
|
108959
108966
|
// verify required parameter 'tierId' is not null or undefined
|
|
108960
108967
|
(0, common_1.assertParamExists)('getTierImportItems', 'tierId', tierId);
|
|
108961
108968
|
// verify required parameter 'importId' is not null or undefined
|
|
@@ -108976,6 +108983,9 @@ const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108976
108983
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
108977
108984
|
// authentication OrganizationId required
|
|
108978
108985
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
108986
|
+
if (status !== undefined) {
|
|
108987
|
+
localVarQueryParameter['status'] = status;
|
|
108988
|
+
}
|
|
108979
108989
|
if (page !== undefined) {
|
|
108980
108990
|
localVarQueryParameter['page'] = page;
|
|
108981
108991
|
}
|
|
@@ -109269,6 +109279,7 @@ const TiersApiFp = function (configuration) {
|
|
|
109269
109279
|
* @summary List rows of an account tier import
|
|
109270
109280
|
* @param {string} tierId The tier identifier
|
|
109271
109281
|
* @param {string} importId The import identifier
|
|
109282
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
109272
109283
|
* @param {number} [page] Page number
|
|
109273
109284
|
* @param {number} [pageSize] Number of items per page
|
|
109274
109285
|
* @param {string} [orderBy] Field to order by
|
|
@@ -109276,10 +109287,10 @@ const TiersApiFp = function (configuration) {
|
|
|
109276
109287
|
* @param {*} [options] Override http request option.
|
|
109277
109288
|
* @throws {RequiredError}
|
|
109278
109289
|
*/
|
|
109279
|
-
getTierImportItems(tierId, importId, page, pageSize, orderBy, search, options) {
|
|
109290
|
+
getTierImportItems(tierId, importId, status, page, pageSize, orderBy, search, options) {
|
|
109280
109291
|
return __awaiter(this, void 0, void 0, function* () {
|
|
109281
109292
|
var _a, _b, _c;
|
|
109282
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTierImportItems(tierId, importId, page, pageSize, orderBy, search, options);
|
|
109293
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTierImportItems(tierId, importId, status, page, pageSize, orderBy, search, options);
|
|
109283
109294
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
109284
109295
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['TiersApi.getTierImportItems']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
109285
109296
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -109425,7 +109436,7 @@ const TiersApiFactory = function (configuration, basePath, axios) {
|
|
|
109425
109436
|
* @throws {RequiredError}
|
|
109426
109437
|
*/
|
|
109427
109438
|
getTierImportItems(requestParameters, options) {
|
|
109428
|
-
return localVarFp.getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
109439
|
+
return localVarFp.getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
109429
109440
|
},
|
|
109430
109441
|
/**
|
|
109431
109442
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
|
@@ -109532,7 +109543,7 @@ class TiersApi extends base_1.BaseAPI {
|
|
|
109532
109543
|
* @throws {RequiredError}
|
|
109533
109544
|
*/
|
|
109534
109545
|
getTierImportItems(requestParameters, options) {
|
|
109535
|
-
return (0, exports.TiersApiFp)(this.configuration).getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
109546
|
+
return (0, exports.TiersApiFp)(this.configuration).getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
109536
109547
|
}
|
|
109537
109548
|
/**
|
|
109538
109549
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -9141,7 +9141,8 @@ export interface ImportItem {
|
|
|
9141
9141
|
export declare enum ImportItemStatus {
|
|
9142
9142
|
Pending = "pending",
|
|
9143
9143
|
Resolved = "resolved",
|
|
9144
|
-
Failed = "failed"
|
|
9144
|
+
Failed = "failed",
|
|
9145
|
+
Invalid = "invalid"
|
|
9145
9146
|
}
|
|
9146
9147
|
export interface ImportRooms200Response {
|
|
9147
9148
|
'status': ImportRooms200ResponseStatusEnum;
|
|
@@ -12484,6 +12485,7 @@ export interface Tier {
|
|
|
12484
12485
|
'image': BaseImage | null;
|
|
12485
12486
|
'description': string | null;
|
|
12486
12487
|
'exclusionGroup': string | null;
|
|
12488
|
+
'archived': boolean;
|
|
12487
12489
|
'createdAt': string;
|
|
12488
12490
|
'updatedAt': string;
|
|
12489
12491
|
'_count': TierAllOfCount;
|
|
@@ -12512,6 +12514,7 @@ export interface TierUpdateInputs {
|
|
|
12512
12514
|
'color'?: string | null;
|
|
12513
12515
|
'internal'?: boolean;
|
|
12514
12516
|
'exclusionGroup'?: string | null;
|
|
12517
|
+
'archived'?: boolean;
|
|
12515
12518
|
}
|
|
12516
12519
|
export interface Transfer {
|
|
12517
12520
|
'id': string;
|
|
@@ -60987,6 +60990,7 @@ export declare const ImportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
60987
60990
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
60988
60991
|
* @summary List the rows in an import job
|
|
60989
60992
|
* @param {string} importId The import identifier
|
|
60993
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
60990
60994
|
* @param {number} [page] Page number
|
|
60991
60995
|
* @param {number} [pageSize] Number of items per page
|
|
60992
60996
|
* @param {string} [orderBy] Field to order by
|
|
@@ -60994,7 +60998,7 @@ export declare const ImportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
60994
60998
|
* @param {*} [options] Override http request option.
|
|
60995
60999
|
* @throws {RequiredError}
|
|
60996
61000
|
*/
|
|
60997
|
-
getImportItems: (importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61001
|
+
getImportItems: (importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60998
61002
|
/**
|
|
60999
61003
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
61000
61004
|
* @summary List bulk import jobs
|
|
@@ -61034,6 +61038,7 @@ export declare const ImportsApiFp: (configuration?: Configuration) => {
|
|
|
61034
61038
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
61035
61039
|
* @summary List the rows in an import job
|
|
61036
61040
|
* @param {string} importId The import identifier
|
|
61041
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
61037
61042
|
* @param {number} [page] Page number
|
|
61038
61043
|
* @param {number} [pageSize] Number of items per page
|
|
61039
61044
|
* @param {string} [orderBy] Field to order by
|
|
@@ -61041,7 +61046,7 @@ export declare const ImportsApiFp: (configuration?: Configuration) => {
|
|
|
61041
61046
|
* @param {*} [options] Override http request option.
|
|
61042
61047
|
* @throws {RequiredError}
|
|
61043
61048
|
*/
|
|
61044
|
-
getImportItems(importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>>;
|
|
61049
|
+
getImportItems(importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>>;
|
|
61045
61050
|
/**
|
|
61046
61051
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
61047
61052
|
* @summary List bulk import jobs
|
|
@@ -61126,6 +61131,10 @@ export interface ImportsApiGetImportItemsRequest {
|
|
|
61126
61131
|
* The import identifier
|
|
61127
61132
|
*/
|
|
61128
61133
|
readonly importId: string;
|
|
61134
|
+
/**
|
|
61135
|
+
* Filter by status
|
|
61136
|
+
*/
|
|
61137
|
+
readonly status?: ImportItemStatus;
|
|
61129
61138
|
/**
|
|
61130
61139
|
* Page number
|
|
61131
61140
|
*/
|
|
@@ -82676,6 +82685,7 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82676
82685
|
* @summary List rows of an account tier import
|
|
82677
82686
|
* @param {string} tierId The tier identifier
|
|
82678
82687
|
* @param {string} importId The import identifier
|
|
82688
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
82679
82689
|
* @param {number} [page] Page number
|
|
82680
82690
|
* @param {number} [pageSize] Number of items per page
|
|
82681
82691
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82683,7 +82693,7 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82683
82693
|
* @param {*} [options] Override http request option.
|
|
82684
82694
|
* @throws {RequiredError}
|
|
82685
82695
|
*/
|
|
82686
|
-
getTierImportItems: (tierId: string, importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82696
|
+
getTierImportItems: (tierId: string, importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82687
82697
|
/**
|
|
82688
82698
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
|
82689
82699
|
* @summary List account tier imports
|
|
@@ -82780,6 +82790,7 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
|
|
|
82780
82790
|
* @summary List rows of an account tier import
|
|
82781
82791
|
* @param {string} tierId The tier identifier
|
|
82782
82792
|
* @param {string} importId The import identifier
|
|
82793
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
82783
82794
|
* @param {number} [page] Page number
|
|
82784
82795
|
* @param {number} [pageSize] Number of items per page
|
|
82785
82796
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82787,7 +82798,7 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
|
|
|
82787
82798
|
* @param {*} [options] Override http request option.
|
|
82788
82799
|
* @throws {RequiredError}
|
|
82789
82800
|
*/
|
|
82790
|
-
getTierImportItems(tierId: string, importId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>>;
|
|
82801
|
+
getTierImportItems(tierId: string, importId: string, status?: ImportItemStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImportItems200Response>>;
|
|
82791
82802
|
/**
|
|
82792
82803
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
|
82793
82804
|
* @summary List account tier imports
|
|
@@ -82989,6 +83000,10 @@ export interface TiersApiGetTierImportItemsRequest {
|
|
|
82989
83000
|
* The import identifier
|
|
82990
83001
|
*/
|
|
82991
83002
|
readonly importId: string;
|
|
83003
|
+
/**
|
|
83004
|
+
* Filter by status
|
|
83005
|
+
*/
|
|
83006
|
+
readonly status?: ImportItemStatus;
|
|
82992
83007
|
/**
|
|
82993
83008
|
* Page number
|
|
82994
83009
|
*/
|
package/dist/esm/api.js
CHANGED
|
@@ -1981,6 +1981,7 @@ export var ImportItemStatus;
|
|
|
1981
1981
|
ImportItemStatus["Pending"] = "pending";
|
|
1982
1982
|
ImportItemStatus["Resolved"] = "resolved";
|
|
1983
1983
|
ImportItemStatus["Failed"] = "failed";
|
|
1984
|
+
ImportItemStatus["Invalid"] = "invalid";
|
|
1984
1985
|
})(ImportItemStatus || (ImportItemStatus = {}));
|
|
1985
1986
|
export var ImportRooms200ResponseStatusEnum;
|
|
1986
1987
|
(function (ImportRooms200ResponseStatusEnum) {
|
|
@@ -74088,6 +74089,7 @@ export const ImportsApiAxiosParamCreator = function (configuration) {
|
|
|
74088
74089
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
74089
74090
|
* @summary List the rows in an import job
|
|
74090
74091
|
* @param {string} importId The import identifier
|
|
74092
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
74091
74093
|
* @param {number} [page] Page number
|
|
74092
74094
|
* @param {number} [pageSize] Number of items per page
|
|
74093
74095
|
* @param {string} [orderBy] Field to order by
|
|
@@ -74095,7 +74097,7 @@ export const ImportsApiAxiosParamCreator = function (configuration) {
|
|
|
74095
74097
|
* @param {*} [options] Override http request option.
|
|
74096
74098
|
* @throws {RequiredError}
|
|
74097
74099
|
*/
|
|
74098
|
-
getImportItems: (importId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [importId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (importId, page, pageSize, orderBy, search, options = {}) {
|
|
74100
|
+
getImportItems: (importId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [importId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (importId, status, page, pageSize, orderBy, search, options = {}) {
|
|
74099
74101
|
// verify required parameter 'importId' is not null or undefined
|
|
74100
74102
|
assertParamExists('getImportItems', 'importId', importId);
|
|
74101
74103
|
const localVarPath = `/imports/{importId}/items`
|
|
@@ -74113,6 +74115,9 @@ export const ImportsApiAxiosParamCreator = function (configuration) {
|
|
|
74113
74115
|
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
74114
74116
|
// authentication OrganizationId required
|
|
74115
74117
|
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
74118
|
+
if (status !== undefined) {
|
|
74119
|
+
localVarQueryParameter['status'] = status;
|
|
74120
|
+
}
|
|
74116
74121
|
if (page !== undefined) {
|
|
74117
74122
|
localVarQueryParameter['page'] = page;
|
|
74118
74123
|
}
|
|
@@ -74230,6 +74235,7 @@ export const ImportsApiFp = function (configuration) {
|
|
|
74230
74235
|
* Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
|
|
74231
74236
|
* @summary List the rows in an import job
|
|
74232
74237
|
* @param {string} importId The import identifier
|
|
74238
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
74233
74239
|
* @param {number} [page] Page number
|
|
74234
74240
|
* @param {number} [pageSize] Number of items per page
|
|
74235
74241
|
* @param {string} [orderBy] Field to order by
|
|
@@ -74237,10 +74243,10 @@ export const ImportsApiFp = function (configuration) {
|
|
|
74237
74243
|
* @param {*} [options] Override http request option.
|
|
74238
74244
|
* @throws {RequiredError}
|
|
74239
74245
|
*/
|
|
74240
|
-
getImportItems(importId, page, pageSize, orderBy, search, options) {
|
|
74246
|
+
getImportItems(importId, status, page, pageSize, orderBy, search, options) {
|
|
74241
74247
|
return __awaiter(this, void 0, void 0, function* () {
|
|
74242
74248
|
var _a, _b, _c;
|
|
74243
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getImportItems(importId, page, pageSize, orderBy, search, options);
|
|
74249
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getImportItems(importId, status, page, pageSize, orderBy, search, options);
|
|
74244
74250
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
74245
74251
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ImportsApi.getImportItems']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
74246
74252
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -74302,7 +74308,7 @@ export const ImportsApiFactory = function (configuration, basePath, axios) {
|
|
|
74302
74308
|
* @throws {RequiredError}
|
|
74303
74309
|
*/
|
|
74304
74310
|
getImportItems(requestParameters, options) {
|
|
74305
|
-
return localVarFp.getImportItems(requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
74311
|
+
return localVarFp.getImportItems(requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
74306
74312
|
},
|
|
74307
74313
|
/**
|
|
74308
74314
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
@@ -74348,7 +74354,7 @@ export class ImportsApi extends BaseAPI {
|
|
|
74348
74354
|
* @throws {RequiredError}
|
|
74349
74355
|
*/
|
|
74350
74356
|
getImportItems(requestParameters, options) {
|
|
74351
|
-
return ImportsApiFp(this.configuration).getImportItems(requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
74357
|
+
return ImportsApiFp(this.configuration).getImportItems(requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
74352
74358
|
}
|
|
74353
74359
|
/**
|
|
74354
74360
|
* Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
|
|
@@ -108134,6 +108140,7 @@ export const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108134
108140
|
* @summary List rows of an account tier import
|
|
108135
108141
|
* @param {string} tierId The tier identifier
|
|
108136
108142
|
* @param {string} importId The import identifier
|
|
108143
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
108137
108144
|
* @param {number} [page] Page number
|
|
108138
108145
|
* @param {number} [pageSize] Number of items per page
|
|
108139
108146
|
* @param {string} [orderBy] Field to order by
|
|
@@ -108141,7 +108148,7 @@ export const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108141
108148
|
* @param {*} [options] Override http request option.
|
|
108142
108149
|
* @throws {RequiredError}
|
|
108143
108150
|
*/
|
|
108144
|
-
getTierImportItems: (tierId_1, importId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [tierId_1, importId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (tierId, importId, page, pageSize, orderBy, search, options = {}) {
|
|
108151
|
+
getTierImportItems: (tierId_1, importId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [tierId_1, importId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (tierId, importId, status, page, pageSize, orderBy, search, options = {}) {
|
|
108145
108152
|
// verify required parameter 'tierId' is not null or undefined
|
|
108146
108153
|
assertParamExists('getTierImportItems', 'tierId', tierId);
|
|
108147
108154
|
// verify required parameter 'importId' is not null or undefined
|
|
@@ -108162,6 +108169,9 @@ export const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108162
108169
|
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
108163
108170
|
// authentication OrganizationId required
|
|
108164
108171
|
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
108172
|
+
if (status !== undefined) {
|
|
108173
|
+
localVarQueryParameter['status'] = status;
|
|
108174
|
+
}
|
|
108165
108175
|
if (page !== undefined) {
|
|
108166
108176
|
localVarQueryParameter['page'] = page;
|
|
108167
108177
|
}
|
|
@@ -108454,6 +108464,7 @@ export const TiersApiFp = function (configuration) {
|
|
|
108454
108464
|
* @summary List rows of an account tier import
|
|
108455
108465
|
* @param {string} tierId The tier identifier
|
|
108456
108466
|
* @param {string} importId The import identifier
|
|
108467
|
+
* @param {ImportItemStatus} [status] Filter by status
|
|
108457
108468
|
* @param {number} [page] Page number
|
|
108458
108469
|
* @param {number} [pageSize] Number of items per page
|
|
108459
108470
|
* @param {string} [orderBy] Field to order by
|
|
@@ -108461,10 +108472,10 @@ export const TiersApiFp = function (configuration) {
|
|
|
108461
108472
|
* @param {*} [options] Override http request option.
|
|
108462
108473
|
* @throws {RequiredError}
|
|
108463
108474
|
*/
|
|
108464
|
-
getTierImportItems(tierId, importId, page, pageSize, orderBy, search, options) {
|
|
108475
|
+
getTierImportItems(tierId, importId, status, page, pageSize, orderBy, search, options) {
|
|
108465
108476
|
return __awaiter(this, void 0, void 0, function* () {
|
|
108466
108477
|
var _a, _b, _c;
|
|
108467
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTierImportItems(tierId, importId, page, pageSize, orderBy, search, options);
|
|
108478
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTierImportItems(tierId, importId, status, page, pageSize, orderBy, search, options);
|
|
108468
108479
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
108469
108480
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['TiersApi.getTierImportItems']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
108470
108481
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -108609,7 +108620,7 @@ export const TiersApiFactory = function (configuration, basePath, axios) {
|
|
|
108609
108620
|
* @throws {RequiredError}
|
|
108610
108621
|
*/
|
|
108611
108622
|
getTierImportItems(requestParameters, options) {
|
|
108612
|
-
return localVarFp.getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108623
|
+
return localVarFp.getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108613
108624
|
},
|
|
108614
108625
|
/**
|
|
108615
108626
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
|
@@ -108715,7 +108726,7 @@ export class TiersApi extends BaseAPI {
|
|
|
108715
108726
|
* @throws {RequiredError}
|
|
108716
108727
|
*/
|
|
108717
108728
|
getTierImportItems(requestParameters, options) {
|
|
108718
|
-
return TiersApiFp(this.configuration).getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108729
|
+
return TiersApiFp(this.configuration).getTierImportItems(requestParameters.tierId, requestParameters.importId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108719
108730
|
}
|
|
108720
108731
|
/**
|
|
108721
108732
|
* Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
|
package/docs/ImportItemStatus.md
CHANGED
package/docs/ImportsApi.md
CHANGED
|
@@ -135,6 +135,7 @@ const configuration = new Configuration();
|
|
|
135
135
|
const apiInstance = new ImportsApi(configuration);
|
|
136
136
|
|
|
137
137
|
let importId: string; //The import identifier (default to undefined)
|
|
138
|
+
let status: ImportItemStatus; //Filter by status (optional) (default to undefined)
|
|
138
139
|
let page: number; //Page number (optional) (default to 1)
|
|
139
140
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
140
141
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
@@ -142,6 +143,7 @@ let search: string; //Search query (optional) (default to undefined)
|
|
|
142
143
|
|
|
143
144
|
const { status, data } = await apiInstance.getImportItems(
|
|
144
145
|
importId,
|
|
146
|
+
status,
|
|
145
147
|
page,
|
|
146
148
|
pageSize,
|
|
147
149
|
orderBy,
|
|
@@ -154,6 +156,7 @@ const { status, data } = await apiInstance.getImportItems(
|
|
|
154
156
|
|Name | Type | Description | Notes|
|
|
155
157
|
|------------- | ------------- | ------------- | -------------|
|
|
156
158
|
| **importId** | [**string**] | The import identifier | defaults to undefined|
|
|
159
|
+
| **status** | **ImportItemStatus** | Filter by status | (optional) defaults to undefined|
|
|
157
160
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
158
161
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
159
162
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
package/docs/Tier.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
17
17
|
**description** | **string** | | [default to undefined]
|
|
18
18
|
**exclusionGroup** | **string** | | [default to undefined]
|
|
19
|
+
**archived** | **boolean** | | [default to undefined]
|
|
19
20
|
**createdAt** | **string** | | [default to undefined]
|
|
20
21
|
**updatedAt** | **string** | | [default to undefined]
|
|
21
22
|
**_count** | [**TierAllOfCount**](TierAllOfCount.md) | | [default to undefined]
|
|
@@ -37,6 +38,7 @@ const instance: Tier = {
|
|
|
37
38
|
image,
|
|
38
39
|
description,
|
|
39
40
|
exclusionGroup,
|
|
41
|
+
archived,
|
|
40
42
|
createdAt,
|
|
41
43
|
updatedAt,
|
|
42
44
|
_count,
|
package/docs/TierUpdateInputs.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**color** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**internal** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**exclusionGroup** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**archived** | **boolean** | | [optional] [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -30,6 +31,7 @@ const instance: TierUpdateInputs = {
|
|
|
30
31
|
color,
|
|
31
32
|
internal,
|
|
32
33
|
exclusionGroup,
|
|
34
|
+
archived,
|
|
33
35
|
};
|
|
34
36
|
```
|
|
35
37
|
|
package/docs/TiersApi.md
CHANGED
|
@@ -304,6 +304,7 @@ const apiInstance = new TiersApi(configuration);
|
|
|
304
304
|
|
|
305
305
|
let tierId: string; //The tier identifier (default to undefined)
|
|
306
306
|
let importId: string; //The import identifier (default to undefined)
|
|
307
|
+
let status: ImportItemStatus; //Filter by status (optional) (default to undefined)
|
|
307
308
|
let page: number; //Page number (optional) (default to 1)
|
|
308
309
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
309
310
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
@@ -312,6 +313,7 @@ let search: string; //Search query (optional) (default to undefined)
|
|
|
312
313
|
const { status, data } = await apiInstance.getTierImportItems(
|
|
313
314
|
tierId,
|
|
314
315
|
importId,
|
|
316
|
+
status,
|
|
315
317
|
page,
|
|
316
318
|
pageSize,
|
|
317
319
|
orderBy,
|
|
@@ -325,6 +327,7 @@ const { status, data } = await apiInstance.getTierImportItems(
|
|
|
325
327
|
|------------- | ------------- | ------------- | -------------|
|
|
326
328
|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
327
329
|
| **importId** | [**string**] | The import identifier | defaults to undefined|
|
|
330
|
+
| **status** | **ImportItemStatus** | Filter by status | (optional) defaults to undefined|
|
|
328
331
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
329
332
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
330
333
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|