@emilgroup/partner-sdk-node 1.22.1-beta.21 → 1.22.1-beta.23
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-node@1.22.1-beta.
|
|
20
|
+
npm install @emilgroup/partner-sdk-node@1.22.1-beta.23 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk-node@1.22.1-beta.
|
|
24
|
+
yarn add @emilgroup/partner-sdk-node@1.22.1-beta.23
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -231,6 +231,86 @@ export const PartnerHierarchyNodesApiAxiosParamCreator = function (configuration
|
|
|
231
231
|
|
|
232
232
|
|
|
233
233
|
|
|
234
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
235
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
236
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
237
|
+
|
|
238
|
+
return {
|
|
239
|
+
url: toPathString(localVarUrlObj),
|
|
240
|
+
options: localVarRequestOptions,
|
|
241
|
+
};
|
|
242
|
+
},
|
|
243
|
+
/**
|
|
244
|
+
* 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\"
|
|
245
|
+
* @summary List descendant partner hierarchy nodes
|
|
246
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
247
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
248
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
249
|
+
* @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.
|
|
250
|
+
* @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>
|
|
251
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
252
|
+
* @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>
|
|
253
|
+
* @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>
|
|
254
|
+
* @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>
|
|
255
|
+
* @param {*} [options] Override http request option.
|
|
256
|
+
* @throws {RequiredError}
|
|
257
|
+
*/
|
|
258
|
+
listDescendantPartnerHierarchyNodes: async (partnerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
259
|
+
// verify required parameter 'partnerCode' is not null or undefined
|
|
260
|
+
assertParamExists('listDescendantPartnerHierarchyNodes', 'partnerCode', partnerCode)
|
|
261
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchy-nodes/descendants/{partnerCode}`
|
|
262
|
+
.replace(`{${"partnerCode"}}`, encodeURIComponent(String(partnerCode)));
|
|
263
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
264
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
265
|
+
let baseOptions;
|
|
266
|
+
let baseAccessToken;
|
|
267
|
+
if (configuration) {
|
|
268
|
+
baseOptions = configuration.baseOptions;
|
|
269
|
+
baseAccessToken = configuration.accessToken;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
273
|
+
const localVarHeaderParameter = {} as any;
|
|
274
|
+
const localVarQueryParameter = {} as any;
|
|
275
|
+
|
|
276
|
+
// authentication bearer required
|
|
277
|
+
// http bearer authentication required
|
|
278
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
279
|
+
|
|
280
|
+
if (pageSize !== undefined) {
|
|
281
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
if (pageToken !== undefined) {
|
|
285
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
if (filter !== undefined) {
|
|
289
|
+
localVarQueryParameter['filter'] = filter;
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
if (search !== undefined) {
|
|
293
|
+
localVarQueryParameter['search'] = search;
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
if (order !== undefined) {
|
|
297
|
+
localVarQueryParameter['order'] = order;
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
if (expand !== undefined) {
|
|
301
|
+
localVarQueryParameter['expand'] = expand;
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
if (filters !== undefined) {
|
|
305
|
+
localVarQueryParameter['filters'] = filters;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
309
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
234
314
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
235
315
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
236
316
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -597,6 +677,25 @@ export const PartnerHierarchyNodesApiFp = function(configuration?: Configuration
|
|
|
597
677
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerHierarchyNode(code, authorization, options);
|
|
598
678
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
599
679
|
},
|
|
680
|
+
/**
|
|
681
|
+
* 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\"
|
|
682
|
+
* @summary List descendant partner hierarchy nodes
|
|
683
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
684
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
685
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
686
|
+
* @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.
|
|
687
|
+
* @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>
|
|
688
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
689
|
+
* @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>
|
|
690
|
+
* @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>
|
|
691
|
+
* @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>
|
|
692
|
+
* @param {*} [options] Override http request option.
|
|
693
|
+
* @throws {RequiredError}
|
|
694
|
+
*/
|
|
695
|
+
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>> {
|
|
696
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDescendantPartnerHierarchyNodes(partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
697
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
698
|
+
},
|
|
600
699
|
/**
|
|
601
700
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
602
701
|
* @summary List partner hierarchy node history
|
|
@@ -725,6 +824,24 @@ export const PartnerHierarchyNodesApiFactory = function (configuration?: Configu
|
|
|
725
824
|
getPartnerHierarchyNode(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyNodeResponseClass> {
|
|
726
825
|
return localVarFp.getPartnerHierarchyNode(code, authorization, options).then((request) => request(axios, basePath));
|
|
727
826
|
},
|
|
827
|
+
/**
|
|
828
|
+
* 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\"
|
|
829
|
+
* @summary List descendant partner hierarchy nodes
|
|
830
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
831
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
832
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
833
|
+
* @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.
|
|
834
|
+
* @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>
|
|
835
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
836
|
+
* @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>
|
|
837
|
+
* @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>
|
|
838
|
+
* @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>
|
|
839
|
+
* @param {*} [options] Override http request option.
|
|
840
|
+
* @throws {RequiredError}
|
|
841
|
+
*/
|
|
842
|
+
listDescendantPartnerHierarchyNodes(partnerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyNodesResponseClass> {
|
|
843
|
+
return localVarFp.listDescendantPartnerHierarchyNodes(partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
844
|
+
},
|
|
728
845
|
/**
|
|
729
846
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
730
847
|
* @summary List partner hierarchy node history
|
|
@@ -881,6 +998,76 @@ export interface PartnerHierarchyNodesApiGetPartnerHierarchyNodeRequest {
|
|
|
881
998
|
readonly authorization?: string
|
|
882
999
|
}
|
|
883
1000
|
|
|
1001
|
+
/**
|
|
1002
|
+
* Request parameters for listDescendantPartnerHierarchyNodes operation in PartnerHierarchyNodesApi.
|
|
1003
|
+
* @export
|
|
1004
|
+
* @interface PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest
|
|
1005
|
+
*/
|
|
1006
|
+
export interface PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest {
|
|
1007
|
+
/**
|
|
1008
|
+
* Code of the partner used to find descendant hierarchy nodes.
|
|
1009
|
+
* @type {string}
|
|
1010
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1011
|
+
*/
|
|
1012
|
+
readonly partnerCode: string
|
|
1013
|
+
|
|
1014
|
+
/**
|
|
1015
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1016
|
+
* @type {string}
|
|
1017
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1018
|
+
*/
|
|
1019
|
+
readonly authorization?: string
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1023
|
+
* @type {number}
|
|
1024
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1025
|
+
*/
|
|
1026
|
+
readonly pageSize?: number
|
|
1027
|
+
|
|
1028
|
+
/**
|
|
1029
|
+
* 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.
|
|
1030
|
+
* @type {string}
|
|
1031
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1032
|
+
*/
|
|
1033
|
+
readonly pageToken?: string
|
|
1034
|
+
|
|
1035
|
+
/**
|
|
1036
|
+
* 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>
|
|
1037
|
+
* @type {string}
|
|
1038
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1039
|
+
*/
|
|
1040
|
+
readonly filter?: string
|
|
1041
|
+
|
|
1042
|
+
/**
|
|
1043
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1044
|
+
* @type {string}
|
|
1045
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1046
|
+
*/
|
|
1047
|
+
readonly search?: string
|
|
1048
|
+
|
|
1049
|
+
/**
|
|
1050
|
+
* 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>
|
|
1051
|
+
* @type {string}
|
|
1052
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1053
|
+
*/
|
|
1054
|
+
readonly order?: string
|
|
1055
|
+
|
|
1056
|
+
/**
|
|
1057
|
+
* 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>
|
|
1058
|
+
* @type {string}
|
|
1059
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1060
|
+
*/
|
|
1061
|
+
readonly expand?: string
|
|
1062
|
+
|
|
1063
|
+
/**
|
|
1064
|
+
* 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>
|
|
1065
|
+
* @type {string}
|
|
1066
|
+
* @memberof PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodes
|
|
1067
|
+
*/
|
|
1068
|
+
readonly filters?: string
|
|
1069
|
+
}
|
|
1070
|
+
|
|
884
1071
|
/**
|
|
885
1072
|
* Request parameters for listPartnerHierarchyNodeHistory operation in PartnerHierarchyNodesApi.
|
|
886
1073
|
* @export
|
|
@@ -1139,6 +1326,18 @@ export class PartnerHierarchyNodesApi extends BaseAPI {
|
|
|
1139
1326
|
return PartnerHierarchyNodesApiFp(this.configuration).getPartnerHierarchyNode(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1140
1327
|
}
|
|
1141
1328
|
|
|
1329
|
+
/**
|
|
1330
|
+
* 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\"
|
|
1331
|
+
* @summary List descendant partner hierarchy nodes
|
|
1332
|
+
* @param {PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest} requestParameters Request parameters.
|
|
1333
|
+
* @param {*} [options] Override http request option.
|
|
1334
|
+
* @throws {RequiredError}
|
|
1335
|
+
* @memberof PartnerHierarchyNodesApi
|
|
1336
|
+
*/
|
|
1337
|
+
public listDescendantPartnerHierarchyNodes(requestParameters: PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest, options?: AxiosRequestConfig) {
|
|
1338
|
+
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));
|
|
1339
|
+
}
|
|
1340
|
+
|
|
1142
1341
|
/**
|
|
1143
1342
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
1144
1343
|
* @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
|
|
@@ -290,6 +290,82 @@ var PartnerHierarchyNodesApiAxiosParamCreator = function (configuration) {
|
|
|
290
290
|
});
|
|
291
291
|
});
|
|
292
292
|
},
|
|
293
|
+
/**
|
|
294
|
+
* 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\"
|
|
295
|
+
* @summary List descendant partner hierarchy nodes
|
|
296
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
297
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
298
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
299
|
+
* @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.
|
|
300
|
+
* @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>
|
|
301
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
302
|
+
* @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>
|
|
303
|
+
* @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>
|
|
304
|
+
* @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>
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
*/
|
|
308
|
+
listDescendantPartnerHierarchyNodes: function (partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
309
|
+
if (options === void 0) { options = {}; }
|
|
310
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
311
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
312
|
+
return __generator(this, function (_a) {
|
|
313
|
+
switch (_a.label) {
|
|
314
|
+
case 0:
|
|
315
|
+
// verify required parameter 'partnerCode' is not null or undefined
|
|
316
|
+
(0, common_1.assertParamExists)('listDescendantPartnerHierarchyNodes', 'partnerCode', partnerCode);
|
|
317
|
+
localVarPath = "/partnerservice/v1/partner-hierarchy-nodes/descendants/{partnerCode}"
|
|
318
|
+
.replace("{".concat("partnerCode", "}"), encodeURIComponent(String(partnerCode)));
|
|
319
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
320
|
+
if (configuration) {
|
|
321
|
+
baseOptions = configuration.baseOptions;
|
|
322
|
+
baseAccessToken = configuration.accessToken;
|
|
323
|
+
}
|
|
324
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
325
|
+
localVarHeaderParameter = {};
|
|
326
|
+
localVarQueryParameter = {};
|
|
327
|
+
// authentication bearer required
|
|
328
|
+
// http bearer authentication required
|
|
329
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
330
|
+
case 1:
|
|
331
|
+
// authentication bearer required
|
|
332
|
+
// http bearer authentication required
|
|
333
|
+
_a.sent();
|
|
334
|
+
if (pageSize !== undefined) {
|
|
335
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
336
|
+
}
|
|
337
|
+
if (pageToken !== undefined) {
|
|
338
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
339
|
+
}
|
|
340
|
+
if (filter !== undefined) {
|
|
341
|
+
localVarQueryParameter['filter'] = filter;
|
|
342
|
+
}
|
|
343
|
+
if (search !== undefined) {
|
|
344
|
+
localVarQueryParameter['search'] = search;
|
|
345
|
+
}
|
|
346
|
+
if (order !== undefined) {
|
|
347
|
+
localVarQueryParameter['order'] = order;
|
|
348
|
+
}
|
|
349
|
+
if (expand !== undefined) {
|
|
350
|
+
localVarQueryParameter['expand'] = expand;
|
|
351
|
+
}
|
|
352
|
+
if (filters !== undefined) {
|
|
353
|
+
localVarQueryParameter['filters'] = filters;
|
|
354
|
+
}
|
|
355
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
356
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
357
|
+
}
|
|
358
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
359
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
360
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
361
|
+
return [2 /*return*/, {
|
|
362
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
363
|
+
options: localVarRequestOptions,
|
|
364
|
+
}];
|
|
365
|
+
}
|
|
366
|
+
});
|
|
367
|
+
});
|
|
368
|
+
},
|
|
293
369
|
/**
|
|
294
370
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
295
371
|
* @summary List partner hierarchy node history
|
|
@@ -682,6 +758,34 @@ var PartnerHierarchyNodesApiFp = function (configuration) {
|
|
|
682
758
|
});
|
|
683
759
|
});
|
|
684
760
|
},
|
|
761
|
+
/**
|
|
762
|
+
* 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\"
|
|
763
|
+
* @summary List descendant partner hierarchy nodes
|
|
764
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
765
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
766
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
767
|
+
* @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.
|
|
768
|
+
* @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>
|
|
769
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
770
|
+
* @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>
|
|
771
|
+
* @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>
|
|
772
|
+
* @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>
|
|
773
|
+
* @param {*} [options] Override http request option.
|
|
774
|
+
* @throws {RequiredError}
|
|
775
|
+
*/
|
|
776
|
+
listDescendantPartnerHierarchyNodes: function (partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
777
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
778
|
+
var localVarAxiosArgs;
|
|
779
|
+
return __generator(this, function (_a) {
|
|
780
|
+
switch (_a.label) {
|
|
781
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDescendantPartnerHierarchyNodes(partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
782
|
+
case 1:
|
|
783
|
+
localVarAxiosArgs = _a.sent();
|
|
784
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
785
|
+
}
|
|
786
|
+
});
|
|
787
|
+
});
|
|
788
|
+
},
|
|
685
789
|
/**
|
|
686
790
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
687
791
|
* @summary List partner hierarchy node history
|
|
@@ -855,6 +959,24 @@ var PartnerHierarchyNodesApiFactory = function (configuration, basePath, axios)
|
|
|
855
959
|
getPartnerHierarchyNode: function (code, authorization, options) {
|
|
856
960
|
return localVarFp.getPartnerHierarchyNode(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
857
961
|
},
|
|
962
|
+
/**
|
|
963
|
+
* 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\"
|
|
964
|
+
* @summary List descendant partner hierarchy nodes
|
|
965
|
+
* @param {string} partnerCode Code of the partner used to find descendant hierarchy nodes.
|
|
966
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
967
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
968
|
+
* @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.
|
|
969
|
+
* @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>
|
|
970
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
971
|
+
* @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>
|
|
972
|
+
* @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>
|
|
973
|
+
* @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>
|
|
974
|
+
* @param {*} [options] Override http request option.
|
|
975
|
+
* @throws {RequiredError}
|
|
976
|
+
*/
|
|
977
|
+
listDescendantPartnerHierarchyNodes: function (partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
978
|
+
return localVarFp.listDescendantPartnerHierarchyNodes(partnerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
979
|
+
},
|
|
858
980
|
/**
|
|
859
981
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
860
982
|
* @summary List partner hierarchy node history
|
|
@@ -986,6 +1108,18 @@ var PartnerHierarchyNodesApi = /** @class */ (function (_super) {
|
|
|
986
1108
|
var _this = this;
|
|
987
1109
|
return (0, exports.PartnerHierarchyNodesApiFp)(this.configuration).getPartnerHierarchyNode(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
988
1110
|
};
|
|
1111
|
+
/**
|
|
1112
|
+
* 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\"
|
|
1113
|
+
* @summary List descendant partner hierarchy nodes
|
|
1114
|
+
* @param {PartnerHierarchyNodesApiListDescendantPartnerHierarchyNodesRequest} requestParameters Request parameters.
|
|
1115
|
+
* @param {*} [options] Override http request option.
|
|
1116
|
+
* @throws {RequiredError}
|
|
1117
|
+
* @memberof PartnerHierarchyNodesApi
|
|
1118
|
+
*/
|
|
1119
|
+
PartnerHierarchyNodesApi.prototype.listDescendantPartnerHierarchyNodes = function (requestParameters, options) {
|
|
1120
|
+
var _this = this;
|
|
1121
|
+
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); });
|
|
1122
|
+
};
|
|
989
1123
|
/**
|
|
990
1124
|
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
991
1125
|
* @summary List partner hierarchy node history
|