@emilgroup/partner-sdk 1.22.1-beta.16 → 1.22.1-beta.18
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/.openapi-generator/FILES +49 -1
- package/README.md +2 -2
- package/api/blacklist-api.ts +662 -0
- package/api/blacklist-reasons-api.ts +797 -0
- package/api/{default-api.ts → health-api.ts} +13 -13
- package/api/partner-hierarchies-api.ts +1342 -0
- package/api/partner-hierarchy-nodes-api.ts +1178 -0
- package/api/partner-hierarchy-types-api.ts +679 -0
- package/api/partners-api.ts +12 -12
- package/api.ts +12 -2
- package/base.ts +1 -0
- package/dist/api/blacklist-api.d.ts +375 -0
- package/dist/api/blacklist-api.js +629 -0
- package/dist/api/blacklist-reasons-api.d.ts +450 -0
- package/dist/api/blacklist-reasons-api.js +735 -0
- package/dist/api/{default-api.d.ts → health-api.d.ts} +10 -10
- package/dist/api/{default-api.js → health-api.js} +22 -22
- package/dist/api/partner-hierarchies-api.d.ts +760 -0
- package/dist/api/partner-hierarchies-api.js +1164 -0
- package/dist/api/partner-hierarchy-nodes-api.d.ts +663 -0
- package/dist/api/partner-hierarchy-nodes-api.js +1043 -0
- package/dist/api/partner-hierarchy-types-api.d.ts +385 -0
- package/dist/api/partner-hierarchy-types-api.js +636 -0
- package/dist/api/partners-api.d.ts +12 -12
- package/dist/api/partners-api.js +9 -9
- package/dist/api.d.ts +6 -1
- package/dist/api.js +6 -1
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/blacklist-item-class.d.ts +78 -0
- package/dist/models/blacklist-item-class.js +15 -0
- package/dist/models/blacklist-reason-class.d.ts +78 -0
- package/dist/models/blacklist-reason-class.js +15 -0
- package/dist/models/create-blacklist-item-request-dto.d.ts +36 -0
- package/dist/models/create-blacklist-item-request-dto.js +15 -0
- package/dist/models/create-blacklist-item-response-class.d.ts +25 -0
- package/dist/models/create-blacklist-item-response-class.js +15 -0
- package/dist/models/create-blacklist-reason-request-dto.d.ts +36 -0
- package/dist/models/create-blacklist-reason-request-dto.js +15 -0
- package/dist/models/create-blacklist-reason-response-class.d.ts +25 -0
- package/dist/models/create-blacklist-reason-response-class.js +15 -0
- package/dist/models/create-partner-hierarchy-node-request-dto.d.ts +42 -0
- package/dist/models/create-partner-hierarchy-node-request-dto.js +15 -0
- package/dist/models/create-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/create-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/create-partner-hierarchy-request-dto.d.ts +30 -0
- package/dist/models/create-partner-hierarchy-request-dto.js +15 -0
- package/dist/models/create-partner-hierarchy-response-class.d.ts +25 -0
- package/dist/models/create-partner-hierarchy-response-class.js +15 -0
- package/dist/models/create-partner-hierarchy-type-request-dto.d.ts +30 -0
- package/dist/models/create-partner-hierarchy-type-request-dto.js +15 -0
- package/dist/models/create-partner-hierarchy-type-response-class.d.ts +25 -0
- package/dist/models/create-partner-hierarchy-type-response-class.js +15 -0
- package/dist/models/delete-by-code-response-class.d.ts +24 -0
- package/dist/models/delete-by-code-response-class.js +15 -0
- package/dist/models/get-blacklist-item-response-class.d.ts +25 -0
- package/dist/models/get-blacklist-item-response-class.js +15 -0
- package/dist/models/get-blacklist-reason-response-class.d.ts +25 -0
- package/dist/models/get-blacklist-reason-response-class.js +15 -0
- package/dist/models/get-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/get-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/get-partner-hierarchy-response-class.d.ts +25 -0
- package/dist/models/get-partner-hierarchy-response-class.js +15 -0
- package/dist/models/get-partner-hierarchy-tree-response-class.d.ts +25 -0
- package/dist/models/get-partner-hierarchy-tree-response-class.js +15 -0
- package/dist/models/get-partner-hierarchy-type-response-class.d.ts +25 -0
- package/dist/models/get-partner-hierarchy-type-response-class.js +15 -0
- package/dist/models/index.d.ts +43 -0
- package/dist/models/index.js +43 -0
- package/dist/models/is-blacklisted-response-class.d.ts +54 -0
- package/dist/models/is-blacklisted-response-class.js +15 -0
- package/dist/models/list-blacklist-items-response-class.d.ts +43 -0
- package/dist/models/list-blacklist-items-response-class.js +15 -0
- package/dist/models/list-blacklist-reasons-response-class.d.ts +43 -0
- package/dist/models/list-blacklist-reasons-response-class.js +15 -0
- package/dist/models/list-partner-hierarchies-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchies-response-class.js +15 -0
- package/dist/models/list-partner-hierarchy-node-history-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchy-node-history-response-class.js +15 -0
- package/dist/models/list-partner-hierarchy-nodes-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchy-nodes-response-class.js +15 -0
- package/dist/models/list-partner-hierarchy-types-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchy-types-response-class.js +15 -0
- package/dist/models/list-partner-relation-class.d.ts +18 -6
- package/dist/models/list-partner-relation-types-class.d.ts +18 -6
- package/dist/models/list-partner-types-response-class.d.ts +18 -6
- package/dist/models/list-partner-versions-response-class.d.ts +18 -6
- package/dist/models/list-partners-response-class.d.ts +18 -6
- package/dist/models/list-related-partners-response-class.d.ts +18 -6
- package/dist/models/list-tags-response-class.d.ts +18 -6
- package/dist/models/move-partner-hierarchy-node-request-dto.d.ts +30 -0
- package/dist/models/move-partner-hierarchy-node-request-dto.js +15 -0
- package/dist/models/move-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/move-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/partner-hierarchy-class.d.ts +78 -0
- package/dist/models/partner-hierarchy-class.js +15 -0
- package/dist/models/partner-hierarchy-node-class.d.ts +109 -0
- package/dist/models/partner-hierarchy-node-class.js +15 -0
- package/dist/models/partner-hierarchy-node-history-class.d.ts +97 -0
- package/dist/models/partner-hierarchy-node-history-class.js +15 -0
- package/dist/models/partner-hierarchy-node-tree-class.d.ts +96 -0
- package/dist/models/partner-hierarchy-node-tree-class.js +15 -0
- package/dist/models/partner-hierarchy-type-class.d.ts +66 -0
- package/dist/models/partner-hierarchy-type-class.js +15 -0
- package/dist/models/unassign-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/unassign-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/update-blacklist-reason-request-dto.d.ts +30 -0
- package/dist/models/update-blacklist-reason-request-dto.js +15 -0
- package/dist/models/update-blacklist-reason-response-class.d.ts +25 -0
- package/dist/models/update-blacklist-reason-response-class.js +15 -0
- package/dist/models/update-blacklist-reason-status-request-dto.d.ts +24 -0
- package/dist/models/update-blacklist-reason-status-request-dto.js +15 -0
- package/dist/models/update-partner-hierarchy-node-request-dto.d.ts +30 -0
- package/dist/models/update-partner-hierarchy-node-request-dto.js +15 -0
- package/dist/models/update-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/update-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/update-partner-hierarchy-request-dto.d.ts +24 -0
- package/dist/models/update-partner-hierarchy-request-dto.js +15 -0
- package/dist/models/update-partner-hierarchy-response-class.d.ts +25 -0
- package/dist/models/update-partner-hierarchy-response-class.js +15 -0
- package/dist/models/update-partner-hierarchy-type-request-dto.d.ts +30 -0
- package/dist/models/update-partner-hierarchy-type-request-dto.js +15 -0
- package/dist/models/update-partner-hierarchy-type-response-class.d.ts +25 -0
- package/dist/models/update-partner-hierarchy-type-response-class.js +15 -0
- package/models/blacklist-item-class.ts +84 -0
- package/models/blacklist-reason-class.ts +84 -0
- package/models/create-blacklist-item-request-dto.ts +42 -0
- package/models/create-blacklist-item-response-class.ts +31 -0
- package/models/create-blacklist-reason-request-dto.ts +42 -0
- package/models/create-blacklist-reason-response-class.ts +31 -0
- package/models/create-partner-hierarchy-node-request-dto.ts +48 -0
- package/models/create-partner-hierarchy-node-response-class.ts +31 -0
- package/models/create-partner-hierarchy-request-dto.ts +36 -0
- package/models/create-partner-hierarchy-response-class.ts +31 -0
- package/models/create-partner-hierarchy-type-request-dto.ts +36 -0
- package/models/create-partner-hierarchy-type-response-class.ts +31 -0
- package/models/delete-by-code-response-class.ts +30 -0
- package/models/get-blacklist-item-response-class.ts +31 -0
- package/models/get-blacklist-reason-response-class.ts +31 -0
- package/models/get-partner-hierarchy-node-response-class.ts +31 -0
- package/models/get-partner-hierarchy-response-class.ts +31 -0
- package/models/get-partner-hierarchy-tree-response-class.ts +31 -0
- package/models/get-partner-hierarchy-type-response-class.ts +31 -0
- package/models/index.ts +43 -0
- package/models/is-blacklisted-response-class.ts +60 -0
- package/models/list-blacklist-items-response-class.ts +49 -0
- package/models/list-blacklist-reasons-response-class.ts +49 -0
- package/models/list-partner-hierarchies-response-class.ts +49 -0
- package/models/list-partner-hierarchy-node-history-response-class.ts +49 -0
- package/models/list-partner-hierarchy-nodes-response-class.ts +49 -0
- package/models/list-partner-hierarchy-types-response-class.ts +49 -0
- package/models/list-partner-relation-class.ts +18 -6
- package/models/list-partner-relation-types-class.ts +18 -6
- package/models/list-partner-types-response-class.ts +18 -6
- package/models/list-partner-versions-response-class.ts +18 -6
- package/models/list-partners-response-class.ts +18 -6
- package/models/list-related-partners-response-class.ts +18 -6
- package/models/list-tags-response-class.ts +18 -6
- package/models/move-partner-hierarchy-node-request-dto.ts +36 -0
- package/models/move-partner-hierarchy-node-response-class.ts +31 -0
- package/models/partner-hierarchy-class.ts +84 -0
- package/models/partner-hierarchy-node-class.ts +115 -0
- package/models/partner-hierarchy-node-history-class.ts +103 -0
- package/models/partner-hierarchy-node-tree-class.ts +102 -0
- package/models/partner-hierarchy-type-class.ts +72 -0
- package/models/unassign-partner-hierarchy-node-response-class.ts +31 -0
- package/models/update-blacklist-reason-request-dto.ts +36 -0
- package/models/update-blacklist-reason-response-class.ts +31 -0
- package/models/update-blacklist-reason-status-request-dto.ts +30 -0
- package/models/update-partner-hierarchy-node-request-dto.ts +36 -0
- package/models/update-partner-hierarchy-node-response-class.ts +31 -0
- package/models/update-partner-hierarchy-request-dto.ts +30 -0
- package/models/update-partner-hierarchy-response-class.ts +31 -0
- package/models/update-partner-hierarchy-type-request-dto.ts +36 -0
- package/models/update-partner-hierarchy-type-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -0,0 +1,1342 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL PartnerService
|
|
5
|
+
* The EMIL PartnerService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { CreatePartnerHierarchyRequestDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { CreatePartnerHierarchyResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { DeleteByCodeResponseClass } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import { GetPartnerHierarchyResponseClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
import { GetPartnerHierarchyTreeResponseClass } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
import { ListPartnerHierarchiesResponseClass } from '../models';
|
|
35
|
+
// @ts-ignore
|
|
36
|
+
import { UpdatePartnerHierarchyRequestDto } from '../models';
|
|
37
|
+
// @ts-ignore
|
|
38
|
+
import { UpdatePartnerHierarchyResponseClass } from '../models';
|
|
39
|
+
/**
|
|
40
|
+
* PartnerHierarchiesApi - axios parameter creator
|
|
41
|
+
* @export
|
|
42
|
+
*/
|
|
43
|
+
export const PartnerHierarchiesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
|
+
return {
|
|
45
|
+
/**
|
|
46
|
+
* Creates a partner hierarchy from an existing hierarchy type. The hierarchy starts empty, so nodes can be added after it is created. **Required Permissions** \"partner-management.partners.create\"
|
|
47
|
+
* @summary Create the partner hierarchy
|
|
48
|
+
* @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
|
|
49
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
createPartnerHierarchy: async (createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54
|
+
// verify required parameter 'createPartnerHierarchyRequestDto' is not null or undefined
|
|
55
|
+
assertParamExists('createPartnerHierarchy', 'createPartnerHierarchyRequestDto', createPartnerHierarchyRequestDto)
|
|
56
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies`;
|
|
57
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
58
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59
|
+
let baseOptions;
|
|
60
|
+
let baseAccessToken;
|
|
61
|
+
if (configuration) {
|
|
62
|
+
baseOptions = configuration.baseOptions;
|
|
63
|
+
baseAccessToken = configuration.accessToken;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
67
|
+
const localVarHeaderParameter = {} as any;
|
|
68
|
+
const localVarQueryParameter = {} as any;
|
|
69
|
+
|
|
70
|
+
// authentication bearer required
|
|
71
|
+
// http bearer authentication required
|
|
72
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
73
|
+
|
|
74
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
75
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
81
|
+
|
|
82
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
83
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
84
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
85
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createPartnerHierarchyRequestDto, localVarRequestOptions, configuration)
|
|
86
|
+
|
|
87
|
+
return {
|
|
88
|
+
url: toPathString(localVarUrlObj),
|
|
89
|
+
options: localVarRequestOptions,
|
|
90
|
+
};
|
|
91
|
+
},
|
|
92
|
+
/**
|
|
93
|
+
* Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
|
|
94
|
+
* @summary Delete the partner hierarchy
|
|
95
|
+
* @param {string} code Unique identifier for the object.
|
|
96
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
deletePartnerHierarchy: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
101
|
+
// verify required parameter 'code' is not null or undefined
|
|
102
|
+
assertParamExists('deletePartnerHierarchy', 'code', code)
|
|
103
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies/{code}`
|
|
104
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
105
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107
|
+
let baseOptions;
|
|
108
|
+
let baseAccessToken;
|
|
109
|
+
if (configuration) {
|
|
110
|
+
baseOptions = configuration.baseOptions;
|
|
111
|
+
baseAccessToken = configuration.accessToken;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
115
|
+
const localVarHeaderParameter = {} as any;
|
|
116
|
+
const localVarQueryParameter = {} as any;
|
|
117
|
+
|
|
118
|
+
// authentication bearer required
|
|
119
|
+
// http bearer authentication required
|
|
120
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
121
|
+
|
|
122
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
123
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
129
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
131
|
+
|
|
132
|
+
return {
|
|
133
|
+
url: toPathString(localVarUrlObj),
|
|
134
|
+
options: localVarRequestOptions,
|
|
135
|
+
};
|
|
136
|
+
},
|
|
137
|
+
/**
|
|
138
|
+
* Returns a pre-signed upload URL for a hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
|
|
139
|
+
* @summary Create the partner hierarchy upload url
|
|
140
|
+
* @param {string} code Unique identifier for the object.
|
|
141
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
generateUploadUrl: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
146
|
+
// verify required parameter 'code' is not null or undefined
|
|
147
|
+
assertParamExists('generateUploadUrl', 'code', code)
|
|
148
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies/{code}/upload-url`
|
|
149
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
150
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
151
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152
|
+
let baseOptions;
|
|
153
|
+
let baseAccessToken;
|
|
154
|
+
if (configuration) {
|
|
155
|
+
baseOptions = configuration.baseOptions;
|
|
156
|
+
baseAccessToken = configuration.accessToken;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
160
|
+
const localVarHeaderParameter = {} as any;
|
|
161
|
+
const localVarQueryParameter = {} as any;
|
|
162
|
+
|
|
163
|
+
// authentication bearer required
|
|
164
|
+
// http bearer authentication required
|
|
165
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
166
|
+
|
|
167
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
168
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
174
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
175
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
176
|
+
|
|
177
|
+
return {
|
|
178
|
+
url: toPathString(localVarUrlObj),
|
|
179
|
+
options: localVarRequestOptions,
|
|
180
|
+
};
|
|
181
|
+
},
|
|
182
|
+
/**
|
|
183
|
+
* Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
|
|
184
|
+
* @summary Retrieve the partner hierarchy
|
|
185
|
+
* @param {string} code Unique identifier for the object.
|
|
186
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
getPartnerHierarchy: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
191
|
+
// verify required parameter 'code' is not null or undefined
|
|
192
|
+
assertParamExists('getPartnerHierarchy', 'code', code)
|
|
193
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies/{code}`
|
|
194
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
195
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
196
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
197
|
+
let baseOptions;
|
|
198
|
+
let baseAccessToken;
|
|
199
|
+
if (configuration) {
|
|
200
|
+
baseOptions = configuration.baseOptions;
|
|
201
|
+
baseAccessToken = configuration.accessToken;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
205
|
+
const localVarHeaderParameter = {} as any;
|
|
206
|
+
const localVarQueryParameter = {} as any;
|
|
207
|
+
|
|
208
|
+
// authentication bearer required
|
|
209
|
+
// http bearer authentication required
|
|
210
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
211
|
+
|
|
212
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
213
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
219
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
220
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
221
|
+
|
|
222
|
+
return {
|
|
223
|
+
url: toPathString(localVarUrlObj),
|
|
224
|
+
options: localVarRequestOptions,
|
|
225
|
+
};
|
|
226
|
+
},
|
|
227
|
+
/**
|
|
228
|
+
* Returns one part of the hierarchy tree: the selected node and its direct children. If no node is selected, it starts from the top of the hierarchy. **Required Permissions** \"partner-management.partners.view\"
|
|
229
|
+
* @summary Retrieve the partner hierarchy tree
|
|
230
|
+
* @param {string} code Unique identifier for the object.
|
|
231
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
232
|
+
* @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
|
|
233
|
+
* @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
|
|
234
|
+
* @param {string} [pageToken] Value returned by the previous response when more children are available.
|
|
235
|
+
* @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
getPartnerHierarchyTree: async (code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
240
|
+
// verify required parameter 'code' is not null or undefined
|
|
241
|
+
assertParamExists('getPartnerHierarchyTree', 'code', code)
|
|
242
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies/{code}/tree`
|
|
243
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
244
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
245
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
246
|
+
let baseOptions;
|
|
247
|
+
let baseAccessToken;
|
|
248
|
+
if (configuration) {
|
|
249
|
+
baseOptions = configuration.baseOptions;
|
|
250
|
+
baseAccessToken = configuration.accessToken;
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
254
|
+
const localVarHeaderParameter = {} as any;
|
|
255
|
+
const localVarQueryParameter = {} as any;
|
|
256
|
+
|
|
257
|
+
// authentication bearer required
|
|
258
|
+
// http bearer authentication required
|
|
259
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
260
|
+
|
|
261
|
+
if (nodeCode !== undefined) {
|
|
262
|
+
localVarQueryParameter['nodeCode'] = nodeCode;
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
if (pageSize !== undefined) {
|
|
266
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
if (pageToken !== undefined) {
|
|
270
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
if (asOf !== undefined) {
|
|
274
|
+
localVarQueryParameter['asOf'] = (asOf as any instanceof Date) ?
|
|
275
|
+
(asOf as any).toISOString() :
|
|
276
|
+
asOf;
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
280
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
286
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
287
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
288
|
+
|
|
289
|
+
return {
|
|
290
|
+
url: toPathString(localVarUrlObj),
|
|
291
|
+
options: localVarRequestOptions,
|
|
292
|
+
};
|
|
293
|
+
},
|
|
294
|
+
/**
|
|
295
|
+
* Returns a download URL for the full hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
|
|
296
|
+
* @summary Retrieve the partner hierarchy tree file
|
|
297
|
+
* @param {string} code Unique identifier for the object.
|
|
298
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
299
|
+
* @param {*} [options] Override http request option.
|
|
300
|
+
* @throws {RequiredError}
|
|
301
|
+
*/
|
|
302
|
+
getPartnerHierarchyTreeFile: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
303
|
+
// verify required parameter 'code' is not null or undefined
|
|
304
|
+
assertParamExists('getPartnerHierarchyTreeFile', 'code', code)
|
|
305
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies/{code}/tree/file`
|
|
306
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
307
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
308
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
309
|
+
let baseOptions;
|
|
310
|
+
let baseAccessToken;
|
|
311
|
+
if (configuration) {
|
|
312
|
+
baseOptions = configuration.baseOptions;
|
|
313
|
+
baseAccessToken = configuration.accessToken;
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
317
|
+
const localVarHeaderParameter = {} as any;
|
|
318
|
+
const localVarQueryParameter = {} as any;
|
|
319
|
+
|
|
320
|
+
// authentication bearer required
|
|
321
|
+
// http bearer authentication required
|
|
322
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
323
|
+
|
|
324
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
325
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
331
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
332
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
333
|
+
|
|
334
|
+
return {
|
|
335
|
+
url: toPathString(localVarUrlObj),
|
|
336
|
+
options: localVarRequestOptions,
|
|
337
|
+
};
|
|
338
|
+
},
|
|
339
|
+
/**
|
|
340
|
+
* Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
|
|
341
|
+
* @summary List partner hierarchies
|
|
342
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
343
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
344
|
+
* @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.
|
|
345
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
346
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
347
|
+
* @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, name, createdAt, updatedAt</i>
|
|
348
|
+
* @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/>
|
|
349
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
350
|
+
* @param {*} [options] Override http request option.
|
|
351
|
+
* @throws {RequiredError}
|
|
352
|
+
*/
|
|
353
|
+
listPartnerHierarchies: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
354
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies`;
|
|
355
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
356
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
357
|
+
let baseOptions;
|
|
358
|
+
let baseAccessToken;
|
|
359
|
+
if (configuration) {
|
|
360
|
+
baseOptions = configuration.baseOptions;
|
|
361
|
+
baseAccessToken = configuration.accessToken;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
365
|
+
const localVarHeaderParameter = {} as any;
|
|
366
|
+
const localVarQueryParameter = {} as any;
|
|
367
|
+
|
|
368
|
+
// authentication bearer required
|
|
369
|
+
// http bearer authentication required
|
|
370
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
371
|
+
|
|
372
|
+
if (pageSize !== undefined) {
|
|
373
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
if (pageToken !== undefined) {
|
|
377
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
if (filter !== undefined) {
|
|
381
|
+
localVarQueryParameter['filter'] = filter;
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
if (search !== undefined) {
|
|
385
|
+
localVarQueryParameter['search'] = search;
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
if (order !== undefined) {
|
|
389
|
+
localVarQueryParameter['order'] = order;
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
if (expand !== undefined) {
|
|
393
|
+
localVarQueryParameter['expand'] = expand;
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
if (filters !== undefined) {
|
|
397
|
+
localVarQueryParameter['filters'] = filters;
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
401
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
407
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
408
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
409
|
+
|
|
410
|
+
return {
|
|
411
|
+
url: toPathString(localVarUrlObj),
|
|
412
|
+
options: localVarRequestOptions,
|
|
413
|
+
};
|
|
414
|
+
},
|
|
415
|
+
/**
|
|
416
|
+
* Returns long-running file operations for this hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
|
|
417
|
+
* @summary List partner hierarchy operations
|
|
418
|
+
* @param {any} code Unique identifier for the object.
|
|
419
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
420
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
421
|
+
* @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.
|
|
422
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
423
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
424
|
+
* @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, name, createdAt, updatedAt</i>
|
|
425
|
+
* @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/>
|
|
426
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
427
|
+
* @param {*} [options] Override http request option.
|
|
428
|
+
* @throws {RequiredError}
|
|
429
|
+
*/
|
|
430
|
+
listPartnerHierarchyOperations: async (code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
431
|
+
// verify required parameter 'code' is not null or undefined
|
|
432
|
+
assertParamExists('listPartnerHierarchyOperations', 'code', code)
|
|
433
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies/{code}/operations`
|
|
434
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
435
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
436
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
437
|
+
let baseOptions;
|
|
438
|
+
let baseAccessToken;
|
|
439
|
+
if (configuration) {
|
|
440
|
+
baseOptions = configuration.baseOptions;
|
|
441
|
+
baseAccessToken = configuration.accessToken;
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
445
|
+
const localVarHeaderParameter = {} as any;
|
|
446
|
+
const localVarQueryParameter = {} as any;
|
|
447
|
+
|
|
448
|
+
// authentication bearer required
|
|
449
|
+
// http bearer authentication required
|
|
450
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
451
|
+
|
|
452
|
+
if (pageSize !== undefined) {
|
|
453
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
if (pageToken !== undefined) {
|
|
457
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
if (filter !== undefined) {
|
|
461
|
+
localVarQueryParameter['filter'] = filter;
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
if (search !== undefined) {
|
|
465
|
+
localVarQueryParameter['search'] = search;
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
if (order !== undefined) {
|
|
469
|
+
localVarQueryParameter['order'] = order;
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
if (expand !== undefined) {
|
|
473
|
+
localVarQueryParameter['expand'] = expand;
|
|
474
|
+
}
|
|
475
|
+
|
|
476
|
+
if (filters !== undefined) {
|
|
477
|
+
localVarQueryParameter['filters'] = filters;
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
481
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
487
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
488
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
489
|
+
|
|
490
|
+
return {
|
|
491
|
+
url: toPathString(localVarUrlObj),
|
|
492
|
+
options: localVarRequestOptions,
|
|
493
|
+
};
|
|
494
|
+
},
|
|
495
|
+
/**
|
|
496
|
+
* Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
497
|
+
* @summary Update the partner hierarchy
|
|
498
|
+
* @param {string} code Unique identifier for the object.
|
|
499
|
+
* @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
|
|
500
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
501
|
+
* @param {*} [options] Override http request option.
|
|
502
|
+
* @throws {RequiredError}
|
|
503
|
+
*/
|
|
504
|
+
updatePartnerHierarchy: async (code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
505
|
+
// verify required parameter 'code' is not null or undefined
|
|
506
|
+
assertParamExists('updatePartnerHierarchy', 'code', code)
|
|
507
|
+
// verify required parameter 'updatePartnerHierarchyRequestDto' is not null or undefined
|
|
508
|
+
assertParamExists('updatePartnerHierarchy', 'updatePartnerHierarchyRequestDto', updatePartnerHierarchyRequestDto)
|
|
509
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies/{code}`
|
|
510
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
511
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
512
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
513
|
+
let baseOptions;
|
|
514
|
+
let baseAccessToken;
|
|
515
|
+
if (configuration) {
|
|
516
|
+
baseOptions = configuration.baseOptions;
|
|
517
|
+
baseAccessToken = configuration.accessToken;
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
521
|
+
const localVarHeaderParameter = {} as any;
|
|
522
|
+
const localVarQueryParameter = {} as any;
|
|
523
|
+
|
|
524
|
+
// authentication bearer required
|
|
525
|
+
// http bearer authentication required
|
|
526
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
527
|
+
|
|
528
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
529
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
535
|
+
|
|
536
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
537
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
538
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
539
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updatePartnerHierarchyRequestDto, localVarRequestOptions, configuration)
|
|
540
|
+
|
|
541
|
+
return {
|
|
542
|
+
url: toPathString(localVarUrlObj),
|
|
543
|
+
options: localVarRequestOptions,
|
|
544
|
+
};
|
|
545
|
+
},
|
|
546
|
+
/**
|
|
547
|
+
* Replaces the hierarchy tree with an uploaded file. **Required Permissions** \"partner-management.partners.update\"
|
|
548
|
+
* @summary Update the partner hierarchy tree
|
|
549
|
+
* @param {string} code Unique identifier for the object.
|
|
550
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
551
|
+
* @param {*} [options] Override http request option.
|
|
552
|
+
* @throws {RequiredError}
|
|
553
|
+
*/
|
|
554
|
+
updatePartnerHierarchyTree: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
555
|
+
// verify required parameter 'code' is not null or undefined
|
|
556
|
+
assertParamExists('updatePartnerHierarchyTree', 'code', code)
|
|
557
|
+
const localVarPath = `/partnerservice/v1/partner-hierarchies/{code}/tree`
|
|
558
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
559
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
560
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
561
|
+
let baseOptions;
|
|
562
|
+
let baseAccessToken;
|
|
563
|
+
if (configuration) {
|
|
564
|
+
baseOptions = configuration.baseOptions;
|
|
565
|
+
baseAccessToken = configuration.accessToken;
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
569
|
+
const localVarHeaderParameter = {} as any;
|
|
570
|
+
const localVarQueryParameter = {} as any;
|
|
571
|
+
|
|
572
|
+
// authentication bearer required
|
|
573
|
+
// http bearer authentication required
|
|
574
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
575
|
+
|
|
576
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
577
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
578
|
+
}
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
583
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
584
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
585
|
+
|
|
586
|
+
return {
|
|
587
|
+
url: toPathString(localVarUrlObj),
|
|
588
|
+
options: localVarRequestOptions,
|
|
589
|
+
};
|
|
590
|
+
},
|
|
591
|
+
}
|
|
592
|
+
};
|
|
593
|
+
|
|
594
|
+
/**
|
|
595
|
+
* PartnerHierarchiesApi - functional programming interface
|
|
596
|
+
* @export
|
|
597
|
+
*/
|
|
598
|
+
export const PartnerHierarchiesApiFp = function(configuration?: Configuration) {
|
|
599
|
+
const localVarAxiosParamCreator = PartnerHierarchiesApiAxiosParamCreator(configuration)
|
|
600
|
+
return {
|
|
601
|
+
/**
|
|
602
|
+
* Creates a partner hierarchy from an existing hierarchy type. The hierarchy starts empty, so nodes can be added after it is created. **Required Permissions** \"partner-management.partners.create\"
|
|
603
|
+
* @summary Create the partner hierarchy
|
|
604
|
+
* @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
|
|
605
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
606
|
+
* @param {*} [options] Override http request option.
|
|
607
|
+
* @throws {RequiredError}
|
|
608
|
+
*/
|
|
609
|
+
async createPartnerHierarchy(createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerHierarchyResponseClass>> {
|
|
610
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPartnerHierarchy(createPartnerHierarchyRequestDto, authorization, options);
|
|
611
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
612
|
+
},
|
|
613
|
+
/**
|
|
614
|
+
* Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
|
|
615
|
+
* @summary Delete the partner hierarchy
|
|
616
|
+
* @param {string} code Unique identifier for the object.
|
|
617
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
618
|
+
* @param {*} [options] Override http request option.
|
|
619
|
+
* @throws {RequiredError}
|
|
620
|
+
*/
|
|
621
|
+
async deletePartnerHierarchy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>> {
|
|
622
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePartnerHierarchy(code, authorization, options);
|
|
623
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
624
|
+
},
|
|
625
|
+
/**
|
|
626
|
+
* Returns a pre-signed upload URL for a hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
|
|
627
|
+
* @summary Create the partner hierarchy upload url
|
|
628
|
+
* @param {string} code Unique identifier for the object.
|
|
629
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
630
|
+
* @param {*} [options] Override http request option.
|
|
631
|
+
* @throws {RequiredError}
|
|
632
|
+
*/
|
|
633
|
+
async generateUploadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
634
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateUploadUrl(code, authorization, options);
|
|
635
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
636
|
+
},
|
|
637
|
+
/**
|
|
638
|
+
* Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
|
|
639
|
+
* @summary Retrieve the partner hierarchy
|
|
640
|
+
* @param {string} code Unique identifier for the object.
|
|
641
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
642
|
+
* @param {*} [options] Override http request option.
|
|
643
|
+
* @throws {RequiredError}
|
|
644
|
+
*/
|
|
645
|
+
async getPartnerHierarchy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyResponseClass>> {
|
|
646
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerHierarchy(code, authorization, options);
|
|
647
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
648
|
+
},
|
|
649
|
+
/**
|
|
650
|
+
* Returns one part of the hierarchy tree: the selected node and its direct children. If no node is selected, it starts from the top of the hierarchy. **Required Permissions** \"partner-management.partners.view\"
|
|
651
|
+
* @summary Retrieve the partner hierarchy tree
|
|
652
|
+
* @param {string} code Unique identifier for the object.
|
|
653
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
654
|
+
* @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
|
|
655
|
+
* @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
|
|
656
|
+
* @param {string} [pageToken] Value returned by the previous response when more children are available.
|
|
657
|
+
* @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
|
|
658
|
+
* @param {*} [options] Override http request option.
|
|
659
|
+
* @throws {RequiredError}
|
|
660
|
+
*/
|
|
661
|
+
async getPartnerHierarchyTree(code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyTreeResponseClass>> {
|
|
662
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerHierarchyTree(code, authorization, nodeCode, pageSize, pageToken, asOf, options);
|
|
663
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
664
|
+
},
|
|
665
|
+
/**
|
|
666
|
+
* Returns a download URL for the full hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
|
|
667
|
+
* @summary Retrieve the partner hierarchy tree file
|
|
668
|
+
* @param {string} code Unique identifier for the object.
|
|
669
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
670
|
+
* @param {*} [options] Override http request option.
|
|
671
|
+
* @throws {RequiredError}
|
|
672
|
+
*/
|
|
673
|
+
async getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
674
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerHierarchyTreeFile(code, authorization, options);
|
|
675
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
676
|
+
},
|
|
677
|
+
/**
|
|
678
|
+
* Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
|
|
679
|
+
* @summary List partner hierarchies
|
|
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: id, code, name, partnerHierarchyTypeCode, 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, name, 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/>
|
|
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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
688
|
+
* @param {*} [options] Override http request option.
|
|
689
|
+
* @throws {RequiredError}
|
|
690
|
+
*/
|
|
691
|
+
async listPartnerHierarchies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchiesResponseClass>> {
|
|
692
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerHierarchies(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
693
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
694
|
+
},
|
|
695
|
+
/**
|
|
696
|
+
* Returns long-running file operations for this hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
|
|
697
|
+
* @summary List partner hierarchy operations
|
|
698
|
+
* @param {any} code Unique identifier for the object.
|
|
699
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
700
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
701
|
+
* @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.
|
|
702
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
703
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
704
|
+
* @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, name, createdAt, updatedAt</i>
|
|
705
|
+
* @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/>
|
|
706
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
707
|
+
* @param {*} [options] Override http request option.
|
|
708
|
+
* @throws {RequiredError}
|
|
709
|
+
*/
|
|
710
|
+
async listPartnerHierarchyOperations(code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
711
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerHierarchyOperations(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
712
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
713
|
+
},
|
|
714
|
+
/**
|
|
715
|
+
* Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
716
|
+
* @summary Update the partner hierarchy
|
|
717
|
+
* @param {string} code Unique identifier for the object.
|
|
718
|
+
* @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
|
|
719
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
720
|
+
* @param {*} [options] Override http request option.
|
|
721
|
+
* @throws {RequiredError}
|
|
722
|
+
*/
|
|
723
|
+
async updatePartnerHierarchy(code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerHierarchyResponseClass>> {
|
|
724
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePartnerHierarchy(code, updatePartnerHierarchyRequestDto, authorization, options);
|
|
725
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
726
|
+
},
|
|
727
|
+
/**
|
|
728
|
+
* Replaces the hierarchy tree with an uploaded file. **Required Permissions** \"partner-management.partners.update\"
|
|
729
|
+
* @summary Update the partner hierarchy tree
|
|
730
|
+
* @param {string} code Unique identifier for the object.
|
|
731
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
732
|
+
* @param {*} [options] Override http request option.
|
|
733
|
+
* @throws {RequiredError}
|
|
734
|
+
*/
|
|
735
|
+
async updatePartnerHierarchyTree(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
736
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePartnerHierarchyTree(code, authorization, options);
|
|
737
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
738
|
+
},
|
|
739
|
+
}
|
|
740
|
+
};
|
|
741
|
+
|
|
742
|
+
/**
|
|
743
|
+
* PartnerHierarchiesApi - factory interface
|
|
744
|
+
* @export
|
|
745
|
+
*/
|
|
746
|
+
export const PartnerHierarchiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
747
|
+
const localVarFp = PartnerHierarchiesApiFp(configuration)
|
|
748
|
+
return {
|
|
749
|
+
/**
|
|
750
|
+
* Creates a partner hierarchy from an existing hierarchy type. The hierarchy starts empty, so nodes can be added after it is created. **Required Permissions** \"partner-management.partners.create\"
|
|
751
|
+
* @summary Create the partner hierarchy
|
|
752
|
+
* @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
|
|
753
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
754
|
+
* @param {*} [options] Override http request option.
|
|
755
|
+
* @throws {RequiredError}
|
|
756
|
+
*/
|
|
757
|
+
createPartnerHierarchy(createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerHierarchyResponseClass> {
|
|
758
|
+
return localVarFp.createPartnerHierarchy(createPartnerHierarchyRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
759
|
+
},
|
|
760
|
+
/**
|
|
761
|
+
* Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
|
|
762
|
+
* @summary Delete the partner hierarchy
|
|
763
|
+
* @param {string} code Unique identifier for the object.
|
|
764
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
765
|
+
* @param {*} [options] Override http request option.
|
|
766
|
+
* @throws {RequiredError}
|
|
767
|
+
*/
|
|
768
|
+
deletePartnerHierarchy(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass> {
|
|
769
|
+
return localVarFp.deletePartnerHierarchy(code, authorization, options).then((request) => request(axios, basePath));
|
|
770
|
+
},
|
|
771
|
+
/**
|
|
772
|
+
* Returns a pre-signed upload URL for a hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
|
|
773
|
+
* @summary Create the partner hierarchy upload url
|
|
774
|
+
* @param {string} code Unique identifier for the object.
|
|
775
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
776
|
+
* @param {*} [options] Override http request option.
|
|
777
|
+
* @throws {RequiredError}
|
|
778
|
+
*/
|
|
779
|
+
generateUploadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
780
|
+
return localVarFp.generateUploadUrl(code, authorization, options).then((request) => request(axios, basePath));
|
|
781
|
+
},
|
|
782
|
+
/**
|
|
783
|
+
* Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
|
|
784
|
+
* @summary Retrieve the partner hierarchy
|
|
785
|
+
* @param {string} code Unique identifier for the object.
|
|
786
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
787
|
+
* @param {*} [options] Override http request option.
|
|
788
|
+
* @throws {RequiredError}
|
|
789
|
+
*/
|
|
790
|
+
getPartnerHierarchy(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyResponseClass> {
|
|
791
|
+
return localVarFp.getPartnerHierarchy(code, authorization, options).then((request) => request(axios, basePath));
|
|
792
|
+
},
|
|
793
|
+
/**
|
|
794
|
+
* Returns one part of the hierarchy tree: the selected node and its direct children. If no node is selected, it starts from the top of the hierarchy. **Required Permissions** \"partner-management.partners.view\"
|
|
795
|
+
* @summary Retrieve the partner hierarchy tree
|
|
796
|
+
* @param {string} code Unique identifier for the object.
|
|
797
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
798
|
+
* @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
|
|
799
|
+
* @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
|
|
800
|
+
* @param {string} [pageToken] Value returned by the previous response when more children are available.
|
|
801
|
+
* @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
|
|
802
|
+
* @param {*} [options] Override http request option.
|
|
803
|
+
* @throws {RequiredError}
|
|
804
|
+
*/
|
|
805
|
+
getPartnerHierarchyTree(code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: any): AxiosPromise<GetPartnerHierarchyTreeResponseClass> {
|
|
806
|
+
return localVarFp.getPartnerHierarchyTree(code, authorization, nodeCode, pageSize, pageToken, asOf, options).then((request) => request(axios, basePath));
|
|
807
|
+
},
|
|
808
|
+
/**
|
|
809
|
+
* Returns a download URL for the full hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
|
|
810
|
+
* @summary Retrieve the partner hierarchy tree file
|
|
811
|
+
* @param {string} code Unique identifier for the object.
|
|
812
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
813
|
+
* @param {*} [options] Override http request option.
|
|
814
|
+
* @throws {RequiredError}
|
|
815
|
+
*/
|
|
816
|
+
getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
817
|
+
return localVarFp.getPartnerHierarchyTreeFile(code, authorization, options).then((request) => request(axios, basePath));
|
|
818
|
+
},
|
|
819
|
+
/**
|
|
820
|
+
* Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
|
|
821
|
+
* @summary List partner hierarchies
|
|
822
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
823
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
824
|
+
* @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.
|
|
825
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
826
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
827
|
+
* @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, name, createdAt, updatedAt</i>
|
|
828
|
+
* @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/>
|
|
829
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
830
|
+
* @param {*} [options] Override http request option.
|
|
831
|
+
* @throws {RequiredError}
|
|
832
|
+
*/
|
|
833
|
+
listPartnerHierarchies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchiesResponseClass> {
|
|
834
|
+
return localVarFp.listPartnerHierarchies(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
835
|
+
},
|
|
836
|
+
/**
|
|
837
|
+
* Returns long-running file operations for this hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
|
|
838
|
+
* @summary List partner hierarchy operations
|
|
839
|
+
* @param {any} code Unique identifier for the object.
|
|
840
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
841
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
842
|
+
* @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.
|
|
843
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
844
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
845
|
+
* @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, name, createdAt, updatedAt</i>
|
|
846
|
+
* @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/>
|
|
847
|
+
* @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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
848
|
+
* @param {*} [options] Override http request option.
|
|
849
|
+
* @throws {RequiredError}
|
|
850
|
+
*/
|
|
851
|
+
listPartnerHierarchyOperations(code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
|
|
852
|
+
return localVarFp.listPartnerHierarchyOperations(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
853
|
+
},
|
|
854
|
+
/**
|
|
855
|
+
* Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
856
|
+
* @summary Update the partner hierarchy
|
|
857
|
+
* @param {string} code Unique identifier for the object.
|
|
858
|
+
* @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
|
|
859
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
860
|
+
* @param {*} [options] Override http request option.
|
|
861
|
+
* @throws {RequiredError}
|
|
862
|
+
*/
|
|
863
|
+
updatePartnerHierarchy(code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerHierarchyResponseClass> {
|
|
864
|
+
return localVarFp.updatePartnerHierarchy(code, updatePartnerHierarchyRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
865
|
+
},
|
|
866
|
+
/**
|
|
867
|
+
* Replaces the hierarchy tree with an uploaded file. **Required Permissions** \"partner-management.partners.update\"
|
|
868
|
+
* @summary Update the partner hierarchy tree
|
|
869
|
+
* @param {string} code Unique identifier for the object.
|
|
870
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
871
|
+
* @param {*} [options] Override http request option.
|
|
872
|
+
* @throws {RequiredError}
|
|
873
|
+
*/
|
|
874
|
+
updatePartnerHierarchyTree(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
875
|
+
return localVarFp.updatePartnerHierarchyTree(code, authorization, options).then((request) => request(axios, basePath));
|
|
876
|
+
},
|
|
877
|
+
};
|
|
878
|
+
};
|
|
879
|
+
|
|
880
|
+
/**
|
|
881
|
+
* Request parameters for createPartnerHierarchy operation in PartnerHierarchiesApi.
|
|
882
|
+
* @export
|
|
883
|
+
* @interface PartnerHierarchiesApiCreatePartnerHierarchyRequest
|
|
884
|
+
*/
|
|
885
|
+
export interface PartnerHierarchiesApiCreatePartnerHierarchyRequest {
|
|
886
|
+
/**
|
|
887
|
+
*
|
|
888
|
+
* @type {CreatePartnerHierarchyRequestDto}
|
|
889
|
+
* @memberof PartnerHierarchiesApiCreatePartnerHierarchy
|
|
890
|
+
*/
|
|
891
|
+
readonly createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto
|
|
892
|
+
|
|
893
|
+
/**
|
|
894
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
895
|
+
* @type {string}
|
|
896
|
+
* @memberof PartnerHierarchiesApiCreatePartnerHierarchy
|
|
897
|
+
*/
|
|
898
|
+
readonly authorization?: string
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
/**
|
|
902
|
+
* Request parameters for deletePartnerHierarchy operation in PartnerHierarchiesApi.
|
|
903
|
+
* @export
|
|
904
|
+
* @interface PartnerHierarchiesApiDeletePartnerHierarchyRequest
|
|
905
|
+
*/
|
|
906
|
+
export interface PartnerHierarchiesApiDeletePartnerHierarchyRequest {
|
|
907
|
+
/**
|
|
908
|
+
* Unique identifier for the object.
|
|
909
|
+
* @type {string}
|
|
910
|
+
* @memberof PartnerHierarchiesApiDeletePartnerHierarchy
|
|
911
|
+
*/
|
|
912
|
+
readonly code: string
|
|
913
|
+
|
|
914
|
+
/**
|
|
915
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
916
|
+
* @type {string}
|
|
917
|
+
* @memberof PartnerHierarchiesApiDeletePartnerHierarchy
|
|
918
|
+
*/
|
|
919
|
+
readonly authorization?: string
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
/**
|
|
923
|
+
* Request parameters for generateUploadUrl operation in PartnerHierarchiesApi.
|
|
924
|
+
* @export
|
|
925
|
+
* @interface PartnerHierarchiesApiGenerateUploadUrlRequest
|
|
926
|
+
*/
|
|
927
|
+
export interface PartnerHierarchiesApiGenerateUploadUrlRequest {
|
|
928
|
+
/**
|
|
929
|
+
* Unique identifier for the object.
|
|
930
|
+
* @type {string}
|
|
931
|
+
* @memberof PartnerHierarchiesApiGenerateUploadUrl
|
|
932
|
+
*/
|
|
933
|
+
readonly code: string
|
|
934
|
+
|
|
935
|
+
/**
|
|
936
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
937
|
+
* @type {string}
|
|
938
|
+
* @memberof PartnerHierarchiesApiGenerateUploadUrl
|
|
939
|
+
*/
|
|
940
|
+
readonly authorization?: string
|
|
941
|
+
}
|
|
942
|
+
|
|
943
|
+
/**
|
|
944
|
+
* Request parameters for getPartnerHierarchy operation in PartnerHierarchiesApi.
|
|
945
|
+
* @export
|
|
946
|
+
* @interface PartnerHierarchiesApiGetPartnerHierarchyRequest
|
|
947
|
+
*/
|
|
948
|
+
export interface PartnerHierarchiesApiGetPartnerHierarchyRequest {
|
|
949
|
+
/**
|
|
950
|
+
* Unique identifier for the object.
|
|
951
|
+
* @type {string}
|
|
952
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchy
|
|
953
|
+
*/
|
|
954
|
+
readonly code: string
|
|
955
|
+
|
|
956
|
+
/**
|
|
957
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
958
|
+
* @type {string}
|
|
959
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchy
|
|
960
|
+
*/
|
|
961
|
+
readonly authorization?: string
|
|
962
|
+
}
|
|
963
|
+
|
|
964
|
+
/**
|
|
965
|
+
* Request parameters for getPartnerHierarchyTree operation in PartnerHierarchiesApi.
|
|
966
|
+
* @export
|
|
967
|
+
* @interface PartnerHierarchiesApiGetPartnerHierarchyTreeRequest
|
|
968
|
+
*/
|
|
969
|
+
export interface PartnerHierarchiesApiGetPartnerHierarchyTreeRequest {
|
|
970
|
+
/**
|
|
971
|
+
* Unique identifier for the object.
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
|
|
974
|
+
*/
|
|
975
|
+
readonly code: string
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
979
|
+
* @type {string}
|
|
980
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
|
|
981
|
+
*/
|
|
982
|
+
readonly authorization?: string
|
|
983
|
+
|
|
984
|
+
/**
|
|
985
|
+
* Node to start from. Omit this to start from the top of the hierarchy.
|
|
986
|
+
* @type {string}
|
|
987
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
|
|
988
|
+
*/
|
|
989
|
+
readonly nodeCode?: string
|
|
990
|
+
|
|
991
|
+
/**
|
|
992
|
+
* Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
|
|
993
|
+
* @type {number}
|
|
994
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
|
|
995
|
+
*/
|
|
996
|
+
readonly pageSize?: number
|
|
997
|
+
|
|
998
|
+
/**
|
|
999
|
+
* Value returned by the previous response when more children are available.
|
|
1000
|
+
* @type {string}
|
|
1001
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
|
|
1002
|
+
*/
|
|
1003
|
+
readonly pageToken?: string
|
|
1004
|
+
|
|
1005
|
+
/**
|
|
1006
|
+
* Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
|
|
1007
|
+
* @type {string}
|
|
1008
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
|
|
1009
|
+
*/
|
|
1010
|
+
readonly asOf?: string
|
|
1011
|
+
}
|
|
1012
|
+
|
|
1013
|
+
/**
|
|
1014
|
+
* Request parameters for getPartnerHierarchyTreeFile operation in PartnerHierarchiesApi.
|
|
1015
|
+
* @export
|
|
1016
|
+
* @interface PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest
|
|
1017
|
+
*/
|
|
1018
|
+
export interface PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest {
|
|
1019
|
+
/**
|
|
1020
|
+
* Unique identifier for the object.
|
|
1021
|
+
* @type {string}
|
|
1022
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchyTreeFile
|
|
1023
|
+
*/
|
|
1024
|
+
readonly code: string
|
|
1025
|
+
|
|
1026
|
+
/**
|
|
1027
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1028
|
+
* @type {string}
|
|
1029
|
+
* @memberof PartnerHierarchiesApiGetPartnerHierarchyTreeFile
|
|
1030
|
+
*/
|
|
1031
|
+
readonly authorization?: string
|
|
1032
|
+
}
|
|
1033
|
+
|
|
1034
|
+
/**
|
|
1035
|
+
* Request parameters for listPartnerHierarchies operation in PartnerHierarchiesApi.
|
|
1036
|
+
* @export
|
|
1037
|
+
* @interface PartnerHierarchiesApiListPartnerHierarchiesRequest
|
|
1038
|
+
*/
|
|
1039
|
+
export interface PartnerHierarchiesApiListPartnerHierarchiesRequest {
|
|
1040
|
+
/**
|
|
1041
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1042
|
+
* @type {string}
|
|
1043
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchies
|
|
1044
|
+
*/
|
|
1045
|
+
readonly authorization?: string
|
|
1046
|
+
|
|
1047
|
+
/**
|
|
1048
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1049
|
+
* @type {number}
|
|
1050
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchies
|
|
1051
|
+
*/
|
|
1052
|
+
readonly pageSize?: number
|
|
1053
|
+
|
|
1054
|
+
/**
|
|
1055
|
+
* 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.
|
|
1056
|
+
* @type {string}
|
|
1057
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchies
|
|
1058
|
+
*/
|
|
1059
|
+
readonly pageToken?: string
|
|
1060
|
+
|
|
1061
|
+
/**
|
|
1062
|
+
* 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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
1063
|
+
* @type {string}
|
|
1064
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchies
|
|
1065
|
+
*/
|
|
1066
|
+
readonly filter?: string
|
|
1067
|
+
|
|
1068
|
+
/**
|
|
1069
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1070
|
+
* @type {string}
|
|
1071
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchies
|
|
1072
|
+
*/
|
|
1073
|
+
readonly search?: string
|
|
1074
|
+
|
|
1075
|
+
/**
|
|
1076
|
+
* 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, name, createdAt, updatedAt</i>
|
|
1077
|
+
* @type {string}
|
|
1078
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchies
|
|
1079
|
+
*/
|
|
1080
|
+
readonly order?: string
|
|
1081
|
+
|
|
1082
|
+
/**
|
|
1083
|
+
* 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/>
|
|
1084
|
+
* @type {string}
|
|
1085
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchies
|
|
1086
|
+
*/
|
|
1087
|
+
readonly expand?: string
|
|
1088
|
+
|
|
1089
|
+
/**
|
|
1090
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
1091
|
+
* @type {string}
|
|
1092
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchies
|
|
1093
|
+
*/
|
|
1094
|
+
readonly filters?: string
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
/**
|
|
1098
|
+
* Request parameters for listPartnerHierarchyOperations operation in PartnerHierarchiesApi.
|
|
1099
|
+
* @export
|
|
1100
|
+
* @interface PartnerHierarchiesApiListPartnerHierarchyOperationsRequest
|
|
1101
|
+
*/
|
|
1102
|
+
export interface PartnerHierarchiesApiListPartnerHierarchyOperationsRequest {
|
|
1103
|
+
/**
|
|
1104
|
+
* Unique identifier for the object.
|
|
1105
|
+
* @type {any}
|
|
1106
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1107
|
+
*/
|
|
1108
|
+
readonly code: any
|
|
1109
|
+
|
|
1110
|
+
/**
|
|
1111
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1112
|
+
* @type {string}
|
|
1113
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1114
|
+
*/
|
|
1115
|
+
readonly authorization?: string
|
|
1116
|
+
|
|
1117
|
+
/**
|
|
1118
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1119
|
+
* @type {number}
|
|
1120
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1121
|
+
*/
|
|
1122
|
+
readonly pageSize?: number
|
|
1123
|
+
|
|
1124
|
+
/**
|
|
1125
|
+
* 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.
|
|
1126
|
+
* @type {string}
|
|
1127
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1128
|
+
*/
|
|
1129
|
+
readonly pageToken?: string
|
|
1130
|
+
|
|
1131
|
+
/**
|
|
1132
|
+
* 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: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
1133
|
+
* @type {string}
|
|
1134
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1135
|
+
*/
|
|
1136
|
+
readonly filter?: string
|
|
1137
|
+
|
|
1138
|
+
/**
|
|
1139
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1140
|
+
* @type {string}
|
|
1141
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1142
|
+
*/
|
|
1143
|
+
readonly search?: string
|
|
1144
|
+
|
|
1145
|
+
/**
|
|
1146
|
+
* 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, name, createdAt, updatedAt</i>
|
|
1147
|
+
* @type {string}
|
|
1148
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1149
|
+
*/
|
|
1150
|
+
readonly order?: string
|
|
1151
|
+
|
|
1152
|
+
/**
|
|
1153
|
+
* 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/>
|
|
1154
|
+
* @type {string}
|
|
1155
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1156
|
+
*/
|
|
1157
|
+
readonly expand?: string
|
|
1158
|
+
|
|
1159
|
+
/**
|
|
1160
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt</i>
|
|
1161
|
+
* @type {string}
|
|
1162
|
+
* @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
|
|
1163
|
+
*/
|
|
1164
|
+
readonly filters?: string
|
|
1165
|
+
}
|
|
1166
|
+
|
|
1167
|
+
/**
|
|
1168
|
+
* Request parameters for updatePartnerHierarchy operation in PartnerHierarchiesApi.
|
|
1169
|
+
* @export
|
|
1170
|
+
* @interface PartnerHierarchiesApiUpdatePartnerHierarchyRequest
|
|
1171
|
+
*/
|
|
1172
|
+
export interface PartnerHierarchiesApiUpdatePartnerHierarchyRequest {
|
|
1173
|
+
/**
|
|
1174
|
+
* Unique identifier for the object.
|
|
1175
|
+
* @type {string}
|
|
1176
|
+
* @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
|
|
1177
|
+
*/
|
|
1178
|
+
readonly code: string
|
|
1179
|
+
|
|
1180
|
+
/**
|
|
1181
|
+
*
|
|
1182
|
+
* @type {UpdatePartnerHierarchyRequestDto}
|
|
1183
|
+
* @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
|
|
1184
|
+
*/
|
|
1185
|
+
readonly updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto
|
|
1186
|
+
|
|
1187
|
+
/**
|
|
1188
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1189
|
+
* @type {string}
|
|
1190
|
+
* @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
|
|
1191
|
+
*/
|
|
1192
|
+
readonly authorization?: string
|
|
1193
|
+
}
|
|
1194
|
+
|
|
1195
|
+
/**
|
|
1196
|
+
* Request parameters for updatePartnerHierarchyTree operation in PartnerHierarchiesApi.
|
|
1197
|
+
* @export
|
|
1198
|
+
* @interface PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest
|
|
1199
|
+
*/
|
|
1200
|
+
export interface PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest {
|
|
1201
|
+
/**
|
|
1202
|
+
* Unique identifier for the object.
|
|
1203
|
+
* @type {string}
|
|
1204
|
+
* @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
|
|
1205
|
+
*/
|
|
1206
|
+
readonly code: string
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1210
|
+
* @type {string}
|
|
1211
|
+
* @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
|
|
1212
|
+
*/
|
|
1213
|
+
readonly authorization?: string
|
|
1214
|
+
}
|
|
1215
|
+
|
|
1216
|
+
/**
|
|
1217
|
+
* PartnerHierarchiesApi - object-oriented interface
|
|
1218
|
+
* @export
|
|
1219
|
+
* @class PartnerHierarchiesApi
|
|
1220
|
+
* @extends {BaseAPI}
|
|
1221
|
+
*/
|
|
1222
|
+
export class PartnerHierarchiesApi extends BaseAPI {
|
|
1223
|
+
/**
|
|
1224
|
+
* Creates a partner hierarchy from an existing hierarchy type. The hierarchy starts empty, so nodes can be added after it is created. **Required Permissions** \"partner-management.partners.create\"
|
|
1225
|
+
* @summary Create the partner hierarchy
|
|
1226
|
+
* @param {PartnerHierarchiesApiCreatePartnerHierarchyRequest} requestParameters Request parameters.
|
|
1227
|
+
* @param {*} [options] Override http request option.
|
|
1228
|
+
* @throws {RequiredError}
|
|
1229
|
+
* @memberof PartnerHierarchiesApi
|
|
1230
|
+
*/
|
|
1231
|
+
public createPartnerHierarchy(requestParameters: PartnerHierarchiesApiCreatePartnerHierarchyRequest, options?: AxiosRequestConfig) {
|
|
1232
|
+
return PartnerHierarchiesApiFp(this.configuration).createPartnerHierarchy(requestParameters.createPartnerHierarchyRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1233
|
+
}
|
|
1234
|
+
|
|
1235
|
+
/**
|
|
1236
|
+
* Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
|
|
1237
|
+
* @summary Delete the partner hierarchy
|
|
1238
|
+
* @param {PartnerHierarchiesApiDeletePartnerHierarchyRequest} requestParameters Request parameters.
|
|
1239
|
+
* @param {*} [options] Override http request option.
|
|
1240
|
+
* @throws {RequiredError}
|
|
1241
|
+
* @memberof PartnerHierarchiesApi
|
|
1242
|
+
*/
|
|
1243
|
+
public deletePartnerHierarchy(requestParameters: PartnerHierarchiesApiDeletePartnerHierarchyRequest, options?: AxiosRequestConfig) {
|
|
1244
|
+
return PartnerHierarchiesApiFp(this.configuration).deletePartnerHierarchy(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1245
|
+
}
|
|
1246
|
+
|
|
1247
|
+
/**
|
|
1248
|
+
* Returns a pre-signed upload URL for a hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
|
|
1249
|
+
* @summary Create the partner hierarchy upload url
|
|
1250
|
+
* @param {PartnerHierarchiesApiGenerateUploadUrlRequest} requestParameters Request parameters.
|
|
1251
|
+
* @param {*} [options] Override http request option.
|
|
1252
|
+
* @throws {RequiredError}
|
|
1253
|
+
* @memberof PartnerHierarchiesApi
|
|
1254
|
+
*/
|
|
1255
|
+
public generateUploadUrl(requestParameters: PartnerHierarchiesApiGenerateUploadUrlRequest, options?: AxiosRequestConfig) {
|
|
1256
|
+
return PartnerHierarchiesApiFp(this.configuration).generateUploadUrl(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1257
|
+
}
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
|
|
1261
|
+
* @summary Retrieve the partner hierarchy
|
|
1262
|
+
* @param {PartnerHierarchiesApiGetPartnerHierarchyRequest} requestParameters Request parameters.
|
|
1263
|
+
* @param {*} [options] Override http request option.
|
|
1264
|
+
* @throws {RequiredError}
|
|
1265
|
+
* @memberof PartnerHierarchiesApi
|
|
1266
|
+
*/
|
|
1267
|
+
public getPartnerHierarchy(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyRequest, options?: AxiosRequestConfig) {
|
|
1268
|
+
return PartnerHierarchiesApiFp(this.configuration).getPartnerHierarchy(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1269
|
+
}
|
|
1270
|
+
|
|
1271
|
+
/**
|
|
1272
|
+
* Returns one part of the hierarchy tree: the selected node and its direct children. If no node is selected, it starts from the top of the hierarchy. **Required Permissions** \"partner-management.partners.view\"
|
|
1273
|
+
* @summary Retrieve the partner hierarchy tree
|
|
1274
|
+
* @param {PartnerHierarchiesApiGetPartnerHierarchyTreeRequest} requestParameters Request parameters.
|
|
1275
|
+
* @param {*} [options] Override http request option.
|
|
1276
|
+
* @throws {RequiredError}
|
|
1277
|
+
* @memberof PartnerHierarchiesApi
|
|
1278
|
+
*/
|
|
1279
|
+
public getPartnerHierarchyTree(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeRequest, options?: AxiosRequestConfig) {
|
|
1280
|
+
return PartnerHierarchiesApiFp(this.configuration).getPartnerHierarchyTree(requestParameters.code, requestParameters.authorization, requestParameters.nodeCode, requestParameters.pageSize, requestParameters.pageToken, requestParameters.asOf, options).then((request) => request(this.axios, this.basePath));
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
/**
|
|
1284
|
+
* Returns a download URL for the full hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
|
|
1285
|
+
* @summary Retrieve the partner hierarchy tree file
|
|
1286
|
+
* @param {PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest} requestParameters Request parameters.
|
|
1287
|
+
* @param {*} [options] Override http request option.
|
|
1288
|
+
* @throws {RequiredError}
|
|
1289
|
+
* @memberof PartnerHierarchiesApi
|
|
1290
|
+
*/
|
|
1291
|
+
public getPartnerHierarchyTreeFile(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest, options?: AxiosRequestConfig) {
|
|
1292
|
+
return PartnerHierarchiesApiFp(this.configuration).getPartnerHierarchyTreeFile(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1293
|
+
}
|
|
1294
|
+
|
|
1295
|
+
/**
|
|
1296
|
+
* Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
|
|
1297
|
+
* @summary List partner hierarchies
|
|
1298
|
+
* @param {PartnerHierarchiesApiListPartnerHierarchiesRequest} requestParameters Request parameters.
|
|
1299
|
+
* @param {*} [options] Override http request option.
|
|
1300
|
+
* @throws {RequiredError}
|
|
1301
|
+
* @memberof PartnerHierarchiesApi
|
|
1302
|
+
*/
|
|
1303
|
+
public listPartnerHierarchies(requestParameters: PartnerHierarchiesApiListPartnerHierarchiesRequest = {}, options?: AxiosRequestConfig) {
|
|
1304
|
+
return PartnerHierarchiesApiFp(this.configuration).listPartnerHierarchies(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1305
|
+
}
|
|
1306
|
+
|
|
1307
|
+
/**
|
|
1308
|
+
* Returns long-running file operations for this hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
|
|
1309
|
+
* @summary List partner hierarchy operations
|
|
1310
|
+
* @param {PartnerHierarchiesApiListPartnerHierarchyOperationsRequest} requestParameters Request parameters.
|
|
1311
|
+
* @param {*} [options] Override http request option.
|
|
1312
|
+
* @throws {RequiredError}
|
|
1313
|
+
* @memberof PartnerHierarchiesApi
|
|
1314
|
+
*/
|
|
1315
|
+
public listPartnerHierarchyOperations(requestParameters: PartnerHierarchiesApiListPartnerHierarchyOperationsRequest, options?: AxiosRequestConfig) {
|
|
1316
|
+
return PartnerHierarchiesApiFp(this.configuration).listPartnerHierarchyOperations(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1317
|
+
}
|
|
1318
|
+
|
|
1319
|
+
/**
|
|
1320
|
+
* Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
1321
|
+
* @summary Update the partner hierarchy
|
|
1322
|
+
* @param {PartnerHierarchiesApiUpdatePartnerHierarchyRequest} requestParameters Request parameters.
|
|
1323
|
+
* @param {*} [options] Override http request option.
|
|
1324
|
+
* @throws {RequiredError}
|
|
1325
|
+
* @memberof PartnerHierarchiesApi
|
|
1326
|
+
*/
|
|
1327
|
+
public updatePartnerHierarchy(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyRequest, options?: AxiosRequestConfig) {
|
|
1328
|
+
return PartnerHierarchiesApiFp(this.configuration).updatePartnerHierarchy(requestParameters.code, requestParameters.updatePartnerHierarchyRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1329
|
+
}
|
|
1330
|
+
|
|
1331
|
+
/**
|
|
1332
|
+
* Replaces the hierarchy tree with an uploaded file. **Required Permissions** \"partner-management.partners.update\"
|
|
1333
|
+
* @summary Update the partner hierarchy tree
|
|
1334
|
+
* @param {PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest} requestParameters Request parameters.
|
|
1335
|
+
* @param {*} [options] Override http request option.
|
|
1336
|
+
* @throws {RequiredError}
|
|
1337
|
+
* @memberof PartnerHierarchiesApi
|
|
1338
|
+
*/
|
|
1339
|
+
public updatePartnerHierarchyTree(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest, options?: AxiosRequestConfig) {
|
|
1340
|
+
return PartnerHierarchiesApiFp(this.configuration).updatePartnerHierarchyTree(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1341
|
+
}
|
|
1342
|
+
}
|