@connectedxm/admin-sdk 7.12.1 → 7.12.3
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 +22 -9
- package/dist/api.d.ts +14 -6
- package/dist/api.js +14 -9
- package/dist/esm/api.d.ts +14 -6
- package/dist/esm/api.js +14 -9
- package/docs/Tier.md +2 -0
- package/docs/TierUpdateInputs.md +2 -0
- package/docs/TiersApi.md +4 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -14017,6 +14017,7 @@ export interface Tier {
|
|
|
14017
14017
|
'image': BaseImage | null;
|
|
14018
14018
|
'description': string | null;
|
|
14019
14019
|
'exclusionGroup': string | null;
|
|
14020
|
+
'archived': boolean;
|
|
14020
14021
|
'createdAt': string;
|
|
14021
14022
|
'updatedAt': string;
|
|
14022
14023
|
'_count': TierAllOfCount;
|
|
@@ -14045,6 +14046,7 @@ export interface TierUpdateInputs {
|
|
|
14045
14046
|
'color'?: string | null;
|
|
14046
14047
|
'internal'?: boolean;
|
|
14047
14048
|
'exclusionGroup'?: string | null;
|
|
14049
|
+
'archived'?: boolean;
|
|
14048
14050
|
}
|
|
14049
14051
|
export interface Transfer {
|
|
14050
14052
|
'id': string;
|
|
@@ -152739,9 +152741,10 @@ export const TiersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
152739
152741
|
};
|
|
152740
152742
|
},
|
|
152741
152743
|
/**
|
|
152742
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
152744
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
152743
152745
|
* @summary List account tiers
|
|
152744
152746
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
152747
|
+
* @param {boolean} [archived] Filter by archived
|
|
152745
152748
|
* @param {number} [page] Page number
|
|
152746
152749
|
* @param {number} [pageSize] Number of items per page
|
|
152747
152750
|
* @param {string} [orderBy] Field to order by
|
|
@@ -152749,7 +152752,7 @@ export const TiersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
152749
152752
|
* @param {*} [options] Override http request option.
|
|
152750
152753
|
* @throws {RequiredError}
|
|
152751
152754
|
*/
|
|
152752
|
-
getTiers: async (type?: GetTiersTypeEnum, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152755
|
+
getTiers: async (type?: GetTiersTypeEnum, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152753
152756
|
const localVarPath = `/tiers`;
|
|
152754
152757
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152755
152758
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -152772,6 +152775,10 @@ export const TiersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
152772
152775
|
localVarQueryParameter['type'] = type;
|
|
152773
152776
|
}
|
|
152774
152777
|
|
|
152778
|
+
if (archived !== undefined) {
|
|
152779
|
+
localVarQueryParameter['archived'] = archived;
|
|
152780
|
+
}
|
|
152781
|
+
|
|
152775
152782
|
if (page !== undefined) {
|
|
152776
152783
|
localVarQueryParameter['page'] = page;
|
|
152777
152784
|
}
|
|
@@ -153000,9 +153007,10 @@ export const TiersApiFp = function(configuration?: Configuration) {
|
|
|
153000
153007
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
153001
153008
|
},
|
|
153002
153009
|
/**
|
|
153003
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
153010
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
153004
153011
|
* @summary List account tiers
|
|
153005
153012
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
153013
|
+
* @param {boolean} [archived] Filter by archived
|
|
153006
153014
|
* @param {number} [page] Page number
|
|
153007
153015
|
* @param {number} [pageSize] Number of items per page
|
|
153008
153016
|
* @param {string} [orderBy] Field to order by
|
|
@@ -153010,8 +153018,8 @@ export const TiersApiFp = function(configuration?: Configuration) {
|
|
|
153010
153018
|
* @param {*} [options] Override http request option.
|
|
153011
153019
|
* @throws {RequiredError}
|
|
153012
153020
|
*/
|
|
153013
|
-
async getTiers(type?: GetTiersTypeEnum, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountTiers200Response>> {
|
|
153014
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTiers(type, page, pageSize, orderBy, search, options);
|
|
153021
|
+
async getTiers(type?: GetTiersTypeEnum, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountTiers200Response>> {
|
|
153022
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTiers(type, archived, page, pageSize, orderBy, search, options);
|
|
153015
153023
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
153016
153024
|
const localVarOperationServerBasePath = operationServerMap['TiersApi.getTiers']?.[localVarOperationServerIndex]?.url;
|
|
153017
153025
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -153123,14 +153131,14 @@ export const TiersApiFactory = function (configuration?: Configuration, basePath
|
|
|
153123
153131
|
return localVarFp.getTierImports(requestParameters.tierId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
153124
153132
|
},
|
|
153125
153133
|
/**
|
|
153126
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
153134
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
153127
153135
|
* @summary List account tiers
|
|
153128
153136
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
153129
153137
|
* @param {*} [options] Override http request option.
|
|
153130
153138
|
* @throws {RequiredError}
|
|
153131
153139
|
*/
|
|
153132
153140
|
getTiers(requestParameters: TiersApiGetTiersRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountTiers200Response> {
|
|
153133
|
-
return localVarFp.getTiers(requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
153141
|
+
return localVarFp.getTiers(requestParameters.type, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
153134
153142
|
},
|
|
153135
153143
|
/**
|
|
153136
153144
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
|
@@ -153306,6 +153314,11 @@ export interface TiersApiGetTiersRequest {
|
|
|
153306
153314
|
*/
|
|
153307
153315
|
readonly type?: GetTiersTypeEnum
|
|
153308
153316
|
|
|
153317
|
+
/**
|
|
153318
|
+
* Filter by archived
|
|
153319
|
+
*/
|
|
153320
|
+
readonly archived?: boolean
|
|
153321
|
+
|
|
153309
153322
|
/**
|
|
153310
153323
|
* Page number
|
|
153311
153324
|
*/
|
|
@@ -153431,14 +153444,14 @@ export class TiersApi extends BaseAPI {
|
|
|
153431
153444
|
}
|
|
153432
153445
|
|
|
153433
153446
|
/**
|
|
153434
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
153447
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
153435
153448
|
* @summary List account tiers
|
|
153436
153449
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
153437
153450
|
* @param {*} [options] Override http request option.
|
|
153438
153451
|
* @throws {RequiredError}
|
|
153439
153452
|
*/
|
|
153440
153453
|
public getTiers(requestParameters: TiersApiGetTiersRequest = {}, options?: RawAxiosRequestConfig) {
|
|
153441
|
-
return TiersApiFp(this.configuration).getTiers(requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153454
|
+
return TiersApiFp(this.configuration).getTiers(requestParameters.type, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153442
153455
|
}
|
|
153443
153456
|
|
|
153444
153457
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -12485,6 +12485,7 @@ export interface Tier {
|
|
|
12485
12485
|
'image': BaseImage | null;
|
|
12486
12486
|
'description': string | null;
|
|
12487
12487
|
'exclusionGroup': string | null;
|
|
12488
|
+
'archived': boolean;
|
|
12488
12489
|
'createdAt': string;
|
|
12489
12490
|
'updatedAt': string;
|
|
12490
12491
|
'_count': TierAllOfCount;
|
|
@@ -12513,6 +12514,7 @@ export interface TierUpdateInputs {
|
|
|
12513
12514
|
'color'?: string | null;
|
|
12514
12515
|
'internal'?: boolean;
|
|
12515
12516
|
'exclusionGroup'?: string | null;
|
|
12517
|
+
'archived'?: boolean;
|
|
12516
12518
|
}
|
|
12517
12519
|
export interface Transfer {
|
|
12518
12520
|
'id': string;
|
|
@@ -82705,9 +82707,10 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82705
82707
|
*/
|
|
82706
82708
|
getTierImports: (tierId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82707
82709
|
/**
|
|
82708
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
82710
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
82709
82711
|
* @summary List account tiers
|
|
82710
82712
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
82713
|
+
* @param {boolean} [archived] Filter by archived
|
|
82711
82714
|
* @param {number} [page] Page number
|
|
82712
82715
|
* @param {number} [pageSize] Number of items per page
|
|
82713
82716
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82715,7 +82718,7 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82715
82718
|
* @param {*} [options] Override http request option.
|
|
82716
82719
|
* @throws {RequiredError}
|
|
82717
82720
|
*/
|
|
82718
|
-
getTiers: (type?: GetTiersTypeEnum, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82721
|
+
getTiers: (type?: GetTiersTypeEnum, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82719
82722
|
/**
|
|
82720
82723
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
|
82721
82724
|
* @summary Remove all accounts from a tier
|
|
@@ -82810,9 +82813,10 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
|
|
|
82810
82813
|
*/
|
|
82811
82814
|
getTierImports(tierId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImports200Response>>;
|
|
82812
82815
|
/**
|
|
82813
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
82816
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
82814
82817
|
* @summary List account tiers
|
|
82815
82818
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
82819
|
+
* @param {boolean} [archived] Filter by archived
|
|
82816
82820
|
* @param {number} [page] Page number
|
|
82817
82821
|
* @param {number} [pageSize] Number of items per page
|
|
82818
82822
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82820,7 +82824,7 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
|
|
|
82820
82824
|
* @param {*} [options] Override http request option.
|
|
82821
82825
|
* @throws {RequiredError}
|
|
82822
82826
|
*/
|
|
82823
|
-
getTiers(type?: GetTiersTypeEnum, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountTiers200Response>>;
|
|
82827
|
+
getTiers(type?: GetTiersTypeEnum, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountTiers200Response>>;
|
|
82824
82828
|
/**
|
|
82825
82829
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
|
82826
82830
|
* @summary Remove all accounts from a tier
|
|
@@ -82900,7 +82904,7 @@ export declare const TiersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
82900
82904
|
*/
|
|
82901
82905
|
getTierImports(requestParameters: TiersApiGetTierImportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetImports200Response>;
|
|
82902
82906
|
/**
|
|
82903
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
82907
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
82904
82908
|
* @summary List account tiers
|
|
82905
82909
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
82906
82910
|
* @param {*} [options] Override http request option.
|
|
@@ -83052,6 +83056,10 @@ export interface TiersApiGetTiersRequest {
|
|
|
83052
83056
|
* Filter by type
|
|
83053
83057
|
*/
|
|
83054
83058
|
readonly type?: GetTiersTypeEnum;
|
|
83059
|
+
/**
|
|
83060
|
+
* Filter by archived
|
|
83061
|
+
*/
|
|
83062
|
+
readonly archived?: boolean;
|
|
83055
83063
|
/**
|
|
83056
83064
|
* Page number
|
|
83057
83065
|
*/
|
|
@@ -83149,7 +83157,7 @@ export declare class TiersApi extends BaseAPI {
|
|
|
83149
83157
|
*/
|
|
83150
83158
|
getTierImports(requestParameters: TiersApiGetTierImportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetImports200Response, any, {}>>;
|
|
83151
83159
|
/**
|
|
83152
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
83160
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
83153
83161
|
* @summary List account tiers
|
|
83154
83162
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
83155
83163
|
* @param {*} [options] Override http request option.
|
package/dist/api.js
CHANGED
|
@@ -109058,9 +109058,10 @@ const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
109058
109058
|
};
|
|
109059
109059
|
}),
|
|
109060
109060
|
/**
|
|
109061
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
109061
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
109062
109062
|
* @summary List account tiers
|
|
109063
109063
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
109064
|
+
* @param {boolean} [archived] Filter by archived
|
|
109064
109065
|
* @param {number} [page] Page number
|
|
109065
109066
|
* @param {number} [pageSize] Number of items per page
|
|
109066
109067
|
* @param {string} [orderBy] Field to order by
|
|
@@ -109068,7 +109069,7 @@ const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
109068
109069
|
* @param {*} [options] Override http request option.
|
|
109069
109070
|
* @throws {RequiredError}
|
|
109070
109071
|
*/
|
|
109071
|
-
getTiers: (type_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [type_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (type, page, pageSize, orderBy, search, options = {}) {
|
|
109072
|
+
getTiers: (type_1, archived_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [type_1, archived_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (type, archived, page, pageSize, orderBy, search, options = {}) {
|
|
109072
109073
|
const localVarPath = `/tiers`;
|
|
109073
109074
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
109074
109075
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -109086,6 +109087,9 @@ const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
109086
109087
|
if (type !== undefined) {
|
|
109087
109088
|
localVarQueryParameter['type'] = type;
|
|
109088
109089
|
}
|
|
109090
|
+
if (archived !== undefined) {
|
|
109091
|
+
localVarQueryParameter['archived'] = archived;
|
|
109092
|
+
}
|
|
109089
109093
|
if (page !== undefined) {
|
|
109090
109094
|
localVarQueryParameter['page'] = page;
|
|
109091
109095
|
}
|
|
@@ -109317,9 +109321,10 @@ const TiersApiFp = function (configuration) {
|
|
|
109317
109321
|
});
|
|
109318
109322
|
},
|
|
109319
109323
|
/**
|
|
109320
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
109324
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
109321
109325
|
* @summary List account tiers
|
|
109322
109326
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
109327
|
+
* @param {boolean} [archived] Filter by archived
|
|
109323
109328
|
* @param {number} [page] Page number
|
|
109324
109329
|
* @param {number} [pageSize] Number of items per page
|
|
109325
109330
|
* @param {string} [orderBy] Field to order by
|
|
@@ -109327,10 +109332,10 @@ const TiersApiFp = function (configuration) {
|
|
|
109327
109332
|
* @param {*} [options] Override http request option.
|
|
109328
109333
|
* @throws {RequiredError}
|
|
109329
109334
|
*/
|
|
109330
|
-
getTiers(type, page, pageSize, orderBy, search, options) {
|
|
109335
|
+
getTiers(type, archived, page, pageSize, orderBy, search, options) {
|
|
109331
109336
|
return __awaiter(this, void 0, void 0, function* () {
|
|
109332
109337
|
var _a, _b, _c;
|
|
109333
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTiers(type, page, pageSize, orderBy, search, options);
|
|
109338
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTiers(type, archived, page, pageSize, orderBy, search, options);
|
|
109334
109339
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
109335
109340
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['TiersApi.getTiers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
109336
109341
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -109449,14 +109454,14 @@ const TiersApiFactory = function (configuration, basePath, axios) {
|
|
|
109449
109454
|
return localVarFp.getTierImports(requestParameters.tierId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
109450
109455
|
},
|
|
109451
109456
|
/**
|
|
109452
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
109457
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
109453
109458
|
* @summary List account tiers
|
|
109454
109459
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
109455
109460
|
* @param {*} [options] Override http request option.
|
|
109456
109461
|
* @throws {RequiredError}
|
|
109457
109462
|
*/
|
|
109458
109463
|
getTiers(requestParameters = {}, options) {
|
|
109459
|
-
return localVarFp.getTiers(requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
109464
|
+
return localVarFp.getTiers(requestParameters.type, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
109460
109465
|
},
|
|
109461
109466
|
/**
|
|
109462
109467
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
|
@@ -109556,14 +109561,14 @@ class TiersApi extends base_1.BaseAPI {
|
|
|
109556
109561
|
return (0, exports.TiersApiFp)(this.configuration).getTierImports(requestParameters.tierId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
109557
109562
|
}
|
|
109558
109563
|
/**
|
|
109559
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
109564
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
109560
109565
|
* @summary List account tiers
|
|
109561
109566
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
109562
109567
|
* @param {*} [options] Override http request option.
|
|
109563
109568
|
* @throws {RequiredError}
|
|
109564
109569
|
*/
|
|
109565
109570
|
getTiers(requestParameters = {}, options) {
|
|
109566
|
-
return (0, exports.TiersApiFp)(this.configuration).getTiers(requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
109571
|
+
return (0, exports.TiersApiFp)(this.configuration).getTiers(requestParameters.type, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
109567
109572
|
}
|
|
109568
109573
|
/**
|
|
109569
109574
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -12485,6 +12485,7 @@ export interface Tier {
|
|
|
12485
12485
|
'image': BaseImage | null;
|
|
12486
12486
|
'description': string | null;
|
|
12487
12487
|
'exclusionGroup': string | null;
|
|
12488
|
+
'archived': boolean;
|
|
12488
12489
|
'createdAt': string;
|
|
12489
12490
|
'updatedAt': string;
|
|
12490
12491
|
'_count': TierAllOfCount;
|
|
@@ -12513,6 +12514,7 @@ export interface TierUpdateInputs {
|
|
|
12513
12514
|
'color'?: string | null;
|
|
12514
12515
|
'internal'?: boolean;
|
|
12515
12516
|
'exclusionGroup'?: string | null;
|
|
12517
|
+
'archived'?: boolean;
|
|
12516
12518
|
}
|
|
12517
12519
|
export interface Transfer {
|
|
12518
12520
|
'id': string;
|
|
@@ -82705,9 +82707,10 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82705
82707
|
*/
|
|
82706
82708
|
getTierImports: (tierId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82707
82709
|
/**
|
|
82708
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
82710
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
82709
82711
|
* @summary List account tiers
|
|
82710
82712
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
82713
|
+
* @param {boolean} [archived] Filter by archived
|
|
82711
82714
|
* @param {number} [page] Page number
|
|
82712
82715
|
* @param {number} [pageSize] Number of items per page
|
|
82713
82716
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82715,7 +82718,7 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82715
82718
|
* @param {*} [options] Override http request option.
|
|
82716
82719
|
* @throws {RequiredError}
|
|
82717
82720
|
*/
|
|
82718
|
-
getTiers: (type?: GetTiersTypeEnum, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82721
|
+
getTiers: (type?: GetTiersTypeEnum, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82719
82722
|
/**
|
|
82720
82723
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
|
82721
82724
|
* @summary Remove all accounts from a tier
|
|
@@ -82810,9 +82813,10 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
|
|
|
82810
82813
|
*/
|
|
82811
82814
|
getTierImports(tierId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetImports200Response>>;
|
|
82812
82815
|
/**
|
|
82813
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
82816
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
82814
82817
|
* @summary List account tiers
|
|
82815
82818
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
82819
|
+
* @param {boolean} [archived] Filter by archived
|
|
82816
82820
|
* @param {number} [page] Page number
|
|
82817
82821
|
* @param {number} [pageSize] Number of items per page
|
|
82818
82822
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82820,7 +82824,7 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
|
|
|
82820
82824
|
* @param {*} [options] Override http request option.
|
|
82821
82825
|
* @throws {RequiredError}
|
|
82822
82826
|
*/
|
|
82823
|
-
getTiers(type?: GetTiersTypeEnum, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountTiers200Response>>;
|
|
82827
|
+
getTiers(type?: GetTiersTypeEnum, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountTiers200Response>>;
|
|
82824
82828
|
/**
|
|
82825
82829
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
|
82826
82830
|
* @summary Remove all accounts from a tier
|
|
@@ -82900,7 +82904,7 @@ export declare const TiersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
82900
82904
|
*/
|
|
82901
82905
|
getTierImports(requestParameters: TiersApiGetTierImportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetImports200Response>;
|
|
82902
82906
|
/**
|
|
82903
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
82907
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
82904
82908
|
* @summary List account tiers
|
|
82905
82909
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
82906
82910
|
* @param {*} [options] Override http request option.
|
|
@@ -83052,6 +83056,10 @@ export interface TiersApiGetTiersRequest {
|
|
|
83052
83056
|
* Filter by type
|
|
83053
83057
|
*/
|
|
83054
83058
|
readonly type?: GetTiersTypeEnum;
|
|
83059
|
+
/**
|
|
83060
|
+
* Filter by archived
|
|
83061
|
+
*/
|
|
83062
|
+
readonly archived?: boolean;
|
|
83055
83063
|
/**
|
|
83056
83064
|
* Page number
|
|
83057
83065
|
*/
|
|
@@ -83149,7 +83157,7 @@ export declare class TiersApi extends BaseAPI {
|
|
|
83149
83157
|
*/
|
|
83150
83158
|
getTierImports(requestParameters: TiersApiGetTierImportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetImports200Response, any, {}>>;
|
|
83151
83159
|
/**
|
|
83152
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
83160
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
83153
83161
|
* @summary List account tiers
|
|
83154
83162
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
83155
83163
|
* @param {*} [options] Override http request option.
|
package/dist/esm/api.js
CHANGED
|
@@ -108244,9 +108244,10 @@ export const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108244
108244
|
};
|
|
108245
108245
|
}),
|
|
108246
108246
|
/**
|
|
108247
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
108247
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
108248
108248
|
* @summary List account tiers
|
|
108249
108249
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
108250
|
+
* @param {boolean} [archived] Filter by archived
|
|
108250
108251
|
* @param {number} [page] Page number
|
|
108251
108252
|
* @param {number} [pageSize] Number of items per page
|
|
108252
108253
|
* @param {string} [orderBy] Field to order by
|
|
@@ -108254,7 +108255,7 @@ export const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108254
108255
|
* @param {*} [options] Override http request option.
|
|
108255
108256
|
* @throws {RequiredError}
|
|
108256
108257
|
*/
|
|
108257
|
-
getTiers: (type_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [type_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (type, page, pageSize, orderBy, search, options = {}) {
|
|
108258
|
+
getTiers: (type_1, archived_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [type_1, archived_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (type, archived, page, pageSize, orderBy, search, options = {}) {
|
|
108258
108259
|
const localVarPath = `/tiers`;
|
|
108259
108260
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
108260
108261
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -108272,6 +108273,9 @@ export const TiersApiAxiosParamCreator = function (configuration) {
|
|
|
108272
108273
|
if (type !== undefined) {
|
|
108273
108274
|
localVarQueryParameter['type'] = type;
|
|
108274
108275
|
}
|
|
108276
|
+
if (archived !== undefined) {
|
|
108277
|
+
localVarQueryParameter['archived'] = archived;
|
|
108278
|
+
}
|
|
108275
108279
|
if (page !== undefined) {
|
|
108276
108280
|
localVarQueryParameter['page'] = page;
|
|
108277
108281
|
}
|
|
@@ -108502,9 +108506,10 @@ export const TiersApiFp = function (configuration) {
|
|
|
108502
108506
|
});
|
|
108503
108507
|
},
|
|
108504
108508
|
/**
|
|
108505
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
108509
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
108506
108510
|
* @summary List account tiers
|
|
108507
108511
|
* @param {GetTiersTypeEnum} [type] Filter by type
|
|
108512
|
+
* @param {boolean} [archived] Filter by archived
|
|
108508
108513
|
* @param {number} [page] Page number
|
|
108509
108514
|
* @param {number} [pageSize] Number of items per page
|
|
108510
108515
|
* @param {string} [orderBy] Field to order by
|
|
@@ -108512,10 +108517,10 @@ export const TiersApiFp = function (configuration) {
|
|
|
108512
108517
|
* @param {*} [options] Override http request option.
|
|
108513
108518
|
* @throws {RequiredError}
|
|
108514
108519
|
*/
|
|
108515
|
-
getTiers(type, page, pageSize, orderBy, search, options) {
|
|
108520
|
+
getTiers(type, archived, page, pageSize, orderBy, search, options) {
|
|
108516
108521
|
return __awaiter(this, void 0, void 0, function* () {
|
|
108517
108522
|
var _a, _b, _c;
|
|
108518
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTiers(type, page, pageSize, orderBy, search, options);
|
|
108523
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTiers(type, archived, page, pageSize, orderBy, search, options);
|
|
108519
108524
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
108520
108525
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['TiersApi.getTiers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
108521
108526
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -108633,14 +108638,14 @@ export const TiersApiFactory = function (configuration, basePath, axios) {
|
|
|
108633
108638
|
return localVarFp.getTierImports(requestParameters.tierId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108634
108639
|
},
|
|
108635
108640
|
/**
|
|
108636
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
108641
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
108637
108642
|
* @summary List account tiers
|
|
108638
108643
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
108639
108644
|
* @param {*} [options] Override http request option.
|
|
108640
108645
|
* @throws {RequiredError}
|
|
108641
108646
|
*/
|
|
108642
108647
|
getTiers(requestParameters = {}, options) {
|
|
108643
|
-
return localVarFp.getTiers(requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108648
|
+
return localVarFp.getTiers(requestParameters.type, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108644
108649
|
},
|
|
108645
108650
|
/**
|
|
108646
108651
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
|
@@ -108739,14 +108744,14 @@ export class TiersApi extends BaseAPI {
|
|
|
108739
108744
|
return TiersApiFp(this.configuration).getTierImports(requestParameters.tierId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108740
108745
|
}
|
|
108741
108746
|
/**
|
|
108742
|
-
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
108747
|
+
* Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
108743
108748
|
* @summary List account tiers
|
|
108744
108749
|
* @param {TiersApiGetTiersRequest} requestParameters Request parameters.
|
|
108745
108750
|
* @param {*} [options] Override http request option.
|
|
108746
108751
|
* @throws {RequiredError}
|
|
108747
108752
|
*/
|
|
108748
108753
|
getTiers(requestParameters = {}, options) {
|
|
108749
|
-
return TiersApiFp(this.configuration).getTiers(requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108754
|
+
return TiersApiFp(this.configuration).getTiers(requestParameters.type, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108750
108755
|
}
|
|
108751
108756
|
/**
|
|
108752
108757
|
* Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
|
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
|
@@ -421,7 +421,7 @@ const { status, data } = await apiInstance.getTierImports(
|
|
|
421
421
|
# **getTiers**
|
|
422
422
|
> GetAccountTiers200Response getTiers()
|
|
423
423
|
|
|
424
|
-
Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
|
|
424
|
+
Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal), archived status, and search; requires read permission on tiers.
|
|
425
425
|
|
|
426
426
|
### Example
|
|
427
427
|
|
|
@@ -435,6 +435,7 @@ const configuration = new Configuration();
|
|
|
435
435
|
const apiInstance = new TiersApi(configuration);
|
|
436
436
|
|
|
437
437
|
let type: 'external' | 'internal'; //Filter by type (optional) (default to undefined)
|
|
438
|
+
let archived: boolean; //Filter by archived (optional) (default to undefined)
|
|
438
439
|
let page: number; //Page number (optional) (default to 1)
|
|
439
440
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
440
441
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
@@ -442,6 +443,7 @@ let search: string; //Search query (optional) (default to undefined)
|
|
|
442
443
|
|
|
443
444
|
const { status, data } = await apiInstance.getTiers(
|
|
444
445
|
type,
|
|
446
|
+
archived,
|
|
445
447
|
page,
|
|
446
448
|
pageSize,
|
|
447
449
|
orderBy,
|
|
@@ -454,6 +456,7 @@ const { status, data } = await apiInstance.getTiers(
|
|
|
454
456
|
|Name | Type | Description | Notes|
|
|
455
457
|
|------------- | ------------- | ------------- | -------------|
|
|
456
458
|
| **type** | [**'external' | 'internal'**]**Array<'external' | 'internal'>** | Filter by type | (optional) defaults to undefined|
|
|
459
|
+
| **archived** | [**boolean**] | Filter by archived | (optional) defaults to undefined|
|
|
457
460
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
458
461
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
459
462
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|