@emilgroup/partner-sdk 1.22.1-beta.23 → 1.22.1-beta.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/partner-sdk@1.22.1-beta.
|
|
20
|
+
npm install @emilgroup/partner-sdk@1.22.1-beta.25 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk@1.22.1-beta.
|
|
24
|
+
yarn add @emilgroup/partner-sdk@1.22.1-beta.25
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -227,6 +227,86 @@ export const PartnerHierarchyNodesApiAxiosParamCreator = function (configuration
|
|
|
227
227
|
|
|
228
228
|
|
|
229
229
|
|
|
230
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
231
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
232
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
233
|
+
|
|
234
|
+
return {
|
|
235
|
+
url: toPathString(localVarUrlObj),
|
|
236
|
+
options: localVarRequestOptions,
|
|
237
|
+
};
|
|
238
|
+
},
|
|
239
|
+
/**
|
|
240
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
241
|
+
* @summary List descendant partner hierarchy nodes
|
|
242
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
243
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
246
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
247
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
248
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
249
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
250
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
251
|
+
* @param {*} [options] Override http request option.
|
|
252
|
+
* @throws {RequiredError}
|
|
253
|
+
*/
|
|
254
|
+
listDescendantPartnerHierarchyNodes: async (partnerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
255
|
+
// verify required parameter 'partnerCode' is not null or undefined
|
|
256
|
+
assertParamExists('listDescendantPartnerHierarchyNodes', 'partnerCode', partnerCode)
|
|
257
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchy-nodes/descendants/{partnerCode}`
|
|
258
|
+
.replace(`{${"partnerCode"}}`, encodeURIComponent(String(partnerCode)));
|
|
259
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
260
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
261
|
+
let baseOptions;
|
|
262
|
+
let baseAccessToken;
|
|
263
|
+
if (configuration) {
|
|
264
|
+
baseOptions = configuration.baseOptions;
|
|
265
|
+
baseAccessToken = configuration.accessToken;
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
269
|
+
const localVarHeaderParameter = {} as any;
|
|
270
|
+
const localVarQueryParameter = {} as any;
|
|
271
|
+
|
|
272
|
+
// authentication bearer required
|
|
273
|
+
// http bearer authentication required
|
|
274
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
275
|
+
|
|
276
|
+
if (pageSize !== undefined) {
|
|
277
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
if (pageToken !== undefined) {
|
|
281
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
if (filter !== undefined) {
|
|
285
|
+
localVarQueryParameter['filter'] = filter;
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
if (search !== undefined) {
|
|
289
|
+
localVarQueryParameter['search'] = search;
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
if (order !== undefined) {
|
|
293
|
+
localVarQueryParameter['order'] = order;
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
if (expand !== undefined) {
|
|
297
|
+
localVarQueryParameter['expand'] = expand;
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
if (filters !== undefined) {
|
|
301
|
+
localVarQueryParameter['filters'] = filters;
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
305
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
230
310
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
231
311
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
232
312
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -593,6 +673,25 @@ export const PartnerHierarchyNodesApiFp = function(configuration?: Configuration
|
|
|
593
673
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerHierarchyNode(code, authorization, options);
|
|
594
674
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
595
675
|
},
|
|
676
|
+
/**
|
|
677
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
678
|
+
* @summary List descendant partner hierarchy nodes
|
|
679
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
680
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
681
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
682
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
683
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
684
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
685
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
686
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
687
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
688
|
+
* @param {*} [options] Override http request option.
|
|
689
|
+
* @throws {RequiredError}
|
|
690
|
+
*/
|
|
691
|
+
async listDescendantPartnerHierarchyNodes(partnerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchyNodesResponseClass>> {
|
|
692
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDescendantPartnerHierarchyNodes(partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
693
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
694
|
+
},
|
|
596
695
|
/**
|
|
597
696
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
598
697
|
* @summary List partner hierarchy node history
|
|
@@ -721,6 +820,24 @@ export const PartnerHierarchyNodesApiFactory = function (configuration?: Configu
|
|
|
721
820
|
getPartnerHierarchyNode(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyNodeResponseClass> {
|
|
722
821
|
return localVarFp.getPartnerHierarchyNode(code, authorization, options).then((request) => request(axios, basePath));
|
|
723
822
|
},
|
|
823
|
+
/**
|
|
824
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
825
|
+
* @summary List descendant partner hierarchy nodes
|
|
826
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
827
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
828
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
829
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
830
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
831
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
832
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
833
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
834
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
835
|
+
* @param {*} [options] Override http request option.
|
|
836
|
+
* @throws {RequiredError}
|
|
837
|
+
*/
|
|
838
|
+
listDescendantPartnerHierarchyNodes(partnerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyNodesResponseClass> {
|
|
839
|
+
return localVarFp.listDescendantPartnerHierarchyNodes(partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
840
|
+
},
|
|
724
841
|
/**
|
|
725
842
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
726
843
|
* @summary List partner hierarchy node history
|
|
@@ -877,6 +994,76 @@ export interface PartnerHierarchyNodesApiGetPartnerHierarchyNodeRequest {
|
|
|
877
994
|
readonly authorization?: string
|
|
878
995
|
}
|
|
879
996
|
|
|
997
|
+
/**
|
|
998
|
+
* Request parameters for listDescendantPartnerHierarchyNodes operation in PartnerHierarchyNodesApi.
|
|
999
|
+
* @export
|
|
1000
|
+
* @interface PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest
|
|
1001
|
+
*/
|
|
1002
|
+
export interface PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest {
|
|
1003
|
+
/**
|
|
1004
|
+
* Code of the partner used to find descendant hierarchy nodes.
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1007
|
+
*/
|
|
1008
|
+
readonly partnerCode: string
|
|
1009
|
+
|
|
1010
|
+
/**
|
|
1011
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1012
|
+
* @type {string}
|
|
1013
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1014
|
+
*/
|
|
1015
|
+
readonly authorization?: string
|
|
1016
|
+
|
|
1017
|
+
/**
|
|
1018
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1019
|
+
* @type {number}
|
|
1020
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1021
|
+
*/
|
|
1022
|
+
readonly pageSize?: number
|
|
1023
|
+
|
|
1024
|
+
/**
|
|
1025
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
1026
|
+
* @type {string}
|
|
1027
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1028
|
+
*/
|
|
1029
|
+
readonly pageToken?: string
|
|
1030
|
+
|
|
1031
|
+
/**
|
|
1032
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
1033
|
+
* @type {string}
|
|
1034
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1035
|
+
*/
|
|
1036
|
+
readonly filter?: string
|
|
1037
|
+
|
|
1038
|
+
/**
|
|
1039
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1040
|
+
* @type {string}
|
|
1041
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1042
|
+
*/
|
|
1043
|
+
readonly search?: string
|
|
1044
|
+
|
|
1045
|
+
/**
|
|
1046
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
1047
|
+
* @type {string}
|
|
1048
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1049
|
+
*/
|
|
1050
|
+
readonly order?: string
|
|
1051
|
+
|
|
1052
|
+
/**
|
|
1053
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
1054
|
+
* @type {string}
|
|
1055
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1056
|
+
*/
|
|
1057
|
+
readonly expand?: string
|
|
1058
|
+
|
|
1059
|
+
/**
|
|
1060
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
1061
|
+
* @type {string}
|
|
1062
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1063
|
+
*/
|
|
1064
|
+
readonly filters?: string
|
|
1065
|
+
}
|
|
1066
|
+
|
|
880
1067
|
/**
|
|
881
1068
|
* Request parameters for listPartnerHierarchyNodeHistory operation in PartnerHierarchyNodesApi.
|
|
882
1069
|
* @export
|
|
@@ -1135,6 +1322,18 @@ export class PartnerHierarchyNodesApi extends BaseAPI {
|
|
|
1135
1322
|
return PartnerHierarchyNodesApiFp(this.configuration).getPartnerHierarchyNode(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1136
1323
|
}
|
|
1137
1324
|
|
|
1325
|
+
/**
|
|
1326
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
1327
|
+
* @summary List descendant partner hierarchy nodes
|
|
1328
|
+
* @param {PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest} requestParameters Request parameters.
|
|
1329
|
+
* @param {*} [options] Override http request option.
|
|
1330
|
+
* @throws {RequiredError}
|
|
1331
|
+
* @memberof PartnerHierarchyNodesApi
|
|
1332
|
+
*/
|
|
1333
|
+
public listDescendantPartnerHierarchyNodes(requestParameters: PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest, options?: AxiosRequestConfig) {
|
|
1334
|
+
return PartnerHierarchyNodesApiFp(this.configuration).listDescendantPartnerHierarchyNodes(requestParameters.partnerCode, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1335
|
+
}
|
|
1336
|
+
|
|
1138
1337
|
/**
|
|
1139
1338
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
1140
1339
|
* @summary List partner hierarchy node history
|
|
@@ -66,6 +66,22 @@ export declare const PartnerHierarchyNodesApiAxiosParamCreator: (configuration?:
|
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
68
68
|
getPartnerHierarchyNode: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
71
|
+
* @summary List descendant partner hierarchy nodes
|
|
72
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
73
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
74
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
75
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
76
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
77
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
78
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
79
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
80
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
listDescendantPartnerHierarchyNodes: (partnerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
85
|
/**
|
|
70
86
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
71
87
|
* @summary List partner hierarchy node history
|
|
@@ -167,6 +183,22 @@ export declare const PartnerHierarchyNodesApiFp: (configuration?: Configuration)
|
|
|
167
183
|
* @throws {RequiredError}
|
|
168
184
|
*/
|
|
169
185
|
getPartnerHierarchyNode(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyNodeResponseClass>>;
|
|
186
|
+
/**
|
|
187
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
188
|
+
* @summary List descendant partner hierarchy nodes
|
|
189
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
190
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
192
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
194
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
195
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
196
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
197
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
198
|
+
* @param {*} [options] Override http request option.
|
|
199
|
+
* @throws {RequiredError}
|
|
200
|
+
*/
|
|
201
|
+
listDescendantPartnerHierarchyNodes(partnerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchyNodesResponseClass>>;
|
|
170
202
|
/**
|
|
171
203
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
172
204
|
* @summary List partner hierarchy node history
|
|
@@ -268,6 +300,22 @@ export declare const PartnerHierarchyNodesApiFactory: (configuration?: Configura
|
|
|
268
300
|
* @throws {RequiredError}
|
|
269
301
|
*/
|
|
270
302
|
getPartnerHierarchyNode(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyNodeResponseClass>;
|
|
303
|
+
/**
|
|
304
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
305
|
+
* @summary List descendant partner hierarchy nodes
|
|
306
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
307
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
309
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
310
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
311
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
312
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
313
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
314
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
315
|
+
* @param {*} [options] Override http request option.
|
|
316
|
+
* @throws {RequiredError}
|
|
317
|
+
*/
|
|
318
|
+
listDescendantPartnerHierarchyNodes(partnerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyNodesResponseClass>;
|
|
271
319
|
/**
|
|
272
320
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
273
321
|
* @summary List partner hierarchy node history
|
|
@@ -404,6 +452,67 @@ export interface PartnerHierarchyNodesApiGetPartnerHierarchyNodeRequest {
|
|
|
404
452
|
*/
|
|
405
453
|
readonly authorization?: string;
|
|
406
454
|
}
|
|
455
|
+
/**
|
|
456
|
+
* Request parameters for listDescendantPartnerHierarchyNodes operation in PartnerHierarchyNodesApi.
|
|
457
|
+
* @export
|
|
458
|
+
* @interface PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest
|
|
459
|
+
*/
|
|
460
|
+
export interface PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest {
|
|
461
|
+
/**
|
|
462
|
+
* Code of the partner used to find descendant hierarchy nodes.
|
|
463
|
+
* @type {string}
|
|
464
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
465
|
+
*/
|
|
466
|
+
readonly partnerCode: string;
|
|
467
|
+
/**
|
|
468
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
469
|
+
* @type {string}
|
|
470
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
471
|
+
*/
|
|
472
|
+
readonly authorization?: string;
|
|
473
|
+
/**
|
|
474
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
475
|
+
* @type {number}
|
|
476
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
477
|
+
*/
|
|
478
|
+
readonly pageSize?: number;
|
|
479
|
+
/**
|
|
480
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
481
|
+
* @type {string}
|
|
482
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
483
|
+
*/
|
|
484
|
+
readonly pageToken?: string;
|
|
485
|
+
/**
|
|
486
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
487
|
+
* @type {string}
|
|
488
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
489
|
+
*/
|
|
490
|
+
readonly filter?: string;
|
|
491
|
+
/**
|
|
492
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
493
|
+
* @type {string}
|
|
494
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
495
|
+
*/
|
|
496
|
+
readonly search?: string;
|
|
497
|
+
/**
|
|
498
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
499
|
+
* @type {string}
|
|
500
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
501
|
+
*/
|
|
502
|
+
readonly order?: string;
|
|
503
|
+
/**
|
|
504
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
505
|
+
* @type {string}
|
|
506
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
507
|
+
*/
|
|
508
|
+
readonly expand?: string;
|
|
509
|
+
/**
|
|
510
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
511
|
+
* @type {string}
|
|
512
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
513
|
+
*/
|
|
514
|
+
readonly filters?: string;
|
|
515
|
+
}
|
|
407
516
|
/**
|
|
408
517
|
* Request parameters for listPartnerHierarchyNodeHistory operation in PartnerHierarchyNodesApi.
|
|
409
518
|
* @export
|
|
@@ -626,6 +735,15 @@ export declare class PartnerHierarchyNodesApi extends BaseAPI {
|
|
|
626
735
|
* @memberof PartnerHierarchyNodesApi
|
|
627
736
|
*/
|
|
628
737
|
getPartnerHierarchyNode(requestParameters: PartnerHierarchyNodesApiGetPartnerHierarchyNodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyNodeResponseClass, any, {}>>;
|
|
738
|
+
/**
|
|
739
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
740
|
+
* @summary List descendant partner hierarchy nodes
|
|
741
|
+
* @param {PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest} requestParameters Request parameters.
|
|
742
|
+
* @param {*} [options] Override http request option.
|
|
743
|
+
* @throws {RequiredError}
|
|
744
|
+
* @memberof PartnerHierarchyNodesApi
|
|
745
|
+
*/
|
|
746
|
+
listDescendantPartnerHierarchyNodes(requestParameters: PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchyNodesResponseClass, any, {}>>;
|
|
629
747
|
/**
|
|
630
748
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
631
749
|
* @summary List partner hierarchy node history
|
|
@@ -286,6 +286,82 @@ var PartnerHierarchyNodesApiAxiosParamCreator = function (configuration) {
|
|
|
286
286
|
});
|
|
287
287
|
});
|
|
288
288
|
},
|
|
289
|
+
/**
|
|
290
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
291
|
+
* @summary List descendant partner hierarchy nodes
|
|
292
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
293
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
294
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
295
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
296
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
297
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
298
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
299
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
300
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
301
|
+
* @param {*} [options] Override http request option.
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
*/
|
|
304
|
+
listDescendantPartnerHierarchyNodes: function (partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
305
|
+
if (options === void 0) { options = {}; }
|
|
306
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
307
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
308
|
+
return __generator(this, function (_a) {
|
|
309
|
+
switch (_a.label) {
|
|
310
|
+
case 0:
|
|
311
|
+
// verify required parameter 'partnerCode' is not null or undefined
|
|
312
|
+
(0, common_1.assertParamExists)('listDescendantPartnerHierarchyNodes', 'partnerCode', partnerCode);
|
|
313
|
+
localVarPath = "/partnerservice/v1/partner-hierarchy-nodes/descendants/{partnerCode}"
|
|
314
|
+
.replace("{".concat("partnerCode", "}"), encodeURIComponent(String(partnerCode)));
|
|
315
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
316
|
+
if (configuration) {
|
|
317
|
+
baseOptions = configuration.baseOptions;
|
|
318
|
+
baseAccessToken = configuration.accessToken;
|
|
319
|
+
}
|
|
320
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
321
|
+
localVarHeaderParameter = {};
|
|
322
|
+
localVarQueryParameter = {};
|
|
323
|
+
// authentication bearer required
|
|
324
|
+
// http bearer authentication required
|
|
325
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
326
|
+
case 1:
|
|
327
|
+
// authentication bearer required
|
|
328
|
+
// http bearer authentication required
|
|
329
|
+
_a.sent();
|
|
330
|
+
if (pageSize !== undefined) {
|
|
331
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
332
|
+
}
|
|
333
|
+
if (pageToken !== undefined) {
|
|
334
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
335
|
+
}
|
|
336
|
+
if (filter !== undefined) {
|
|
337
|
+
localVarQueryParameter['filter'] = filter;
|
|
338
|
+
}
|
|
339
|
+
if (search !== undefined) {
|
|
340
|
+
localVarQueryParameter['search'] = search;
|
|
341
|
+
}
|
|
342
|
+
if (order !== undefined) {
|
|
343
|
+
localVarQueryParameter['order'] = order;
|
|
344
|
+
}
|
|
345
|
+
if (expand !== undefined) {
|
|
346
|
+
localVarQueryParameter['expand'] = expand;
|
|
347
|
+
}
|
|
348
|
+
if (filters !== undefined) {
|
|
349
|
+
localVarQueryParameter['filters'] = filters;
|
|
350
|
+
}
|
|
351
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
352
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
353
|
+
}
|
|
354
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
355
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
356
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
357
|
+
return [2 /*return*/, {
|
|
358
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
359
|
+
options: localVarRequestOptions,
|
|
360
|
+
}];
|
|
361
|
+
}
|
|
362
|
+
});
|
|
363
|
+
});
|
|
364
|
+
},
|
|
289
365
|
/**
|
|
290
366
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
291
367
|
* @summary List partner hierarchy node history
|
|
@@ -678,6 +754,34 @@ var PartnerHierarchyNodesApiFp = function (configuration) {
|
|
|
678
754
|
});
|
|
679
755
|
});
|
|
680
756
|
},
|
|
757
|
+
/**
|
|
758
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
759
|
+
* @summary List descendant partner hierarchy nodes
|
|
760
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
761
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
762
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
763
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
764
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
765
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
766
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
767
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
768
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
769
|
+
* @param {*} [options] Override http request option.
|
|
770
|
+
* @throws {RequiredError}
|
|
771
|
+
*/
|
|
772
|
+
listDescendantPartnerHierarchyNodes: function (partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
773
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
774
|
+
var localVarAxiosArgs;
|
|
775
|
+
return __generator(this, function (_a) {
|
|
776
|
+
switch (_a.label) {
|
|
777
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDescendantPartnerHierarchyNodes(partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
778
|
+
case 1:
|
|
779
|
+
localVarAxiosArgs = _a.sent();
|
|
780
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
781
|
+
}
|
|
782
|
+
});
|
|
783
|
+
});
|
|
784
|
+
},
|
|
681
785
|
/**
|
|
682
786
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
683
787
|
* @summary List partner hierarchy node history
|
|
@@ -851,6 +955,24 @@ var PartnerHierarchyNodesApiFactory = function (configuration, basePath, axios)
|
|
|
851
955
|
getPartnerHierarchyNode: function (code, authorization, options) {
|
|
852
956
|
return localVarFp.getPartnerHierarchyNode(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
853
957
|
},
|
|
958
|
+
/**
|
|
959
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
960
|
+
* @summary List descendant partner hierarchy nodes
|
|
961
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
962
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
963
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
964
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
965
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
966
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
967
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, depth, createdAt, updatedAt</i>
|
|
968
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner, parentNode<i>
|
|
969
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
970
|
+
* @param {*} [options] Override http request option.
|
|
971
|
+
* @throws {RequiredError}
|
|
972
|
+
*/
|
|
973
|
+
listDescendantPartnerHierarchyNodes: function (partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
974
|
+
return localVarFp.listDescendantPartnerHierarchyNodes(partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
975
|
+
},
|
|
854
976
|
/**
|
|
855
977
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
856
978
|
* @summary List partner hierarchy node history
|
|
@@ -982,6 +1104,18 @@ var PartnerHierarchyNodesApi = /** @class */ (function (_super) {
|
|
|
982
1104
|
var _this = this;
|
|
983
1105
|
return (0, exports.PartnerHierarchyNodesApiFp)(this.configuration).getPartnerHierarchyNode(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
984
1106
|
};
|
|
1107
|
+
/**
|
|
1108
|
+
* Returns a flat paginated list of descendant hierarchy nodes for the selected partner. The partner\'s own nodes are not included. **Required Permissions** \"partner-management.partners.view\"
|
|
1109
|
+
* @summary List descendant partner hierarchy nodes
|
|
1110
|
+
* @param {PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest} requestParameters Request parameters.
|
|
1111
|
+
* @param {*} [options] Override http request option.
|
|
1112
|
+
* @throws {RequiredError}
|
|
1113
|
+
* @memberof PartnerHierarchyNodesApi
|
|
1114
|
+
*/
|
|
1115
|
+
PartnerHierarchyNodesApi.prototype.listDescendantPartnerHierarchyNodes = function (requestParameters, options) {
|
|
1116
|
+
var _this = this;
|
|
1117
|
+
return (0, exports.PartnerHierarchyNodesApiFp)(this.configuration).listDescendantPartnerHierarchyNodes(requestParameters.partnerCode, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1118
|
+
};
|
|
985
1119
|
/**
|
|
986
1120
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
987
1121
|
* @summary List partner hierarchy node history
|