@emilgroup/partner-sdk 1.0.1 → 1.1.0
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 +7 -0
- package/README.md +2 -2
- package/api/partner-relations-api.ts +349 -0
- package/api/partner-types-api.ts +36 -22
- package/api/partner-version-api.ts +375 -0
- package/api/partners-api.ts +36 -22
- package/api.ts +4 -0
- package/base.ts +1 -0
- package/dist/api/partner-relations-api.d.ts +206 -0
- package/dist/api/partner-relations-api.js +352 -0
- package/dist/api/partner-types-api.d.ts +28 -19
- package/dist/api/partner-types-api.js +26 -20
- package/dist/api/partner-version-api.d.ts +224 -0
- package/dist/api/partner-version-api.js +363 -0
- package/dist/api/partners-api.d.ts +28 -19
- package/dist/api/partners-api.js +26 -20
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/base.js +1 -0
- package/dist/models/get-partner-relation-type-class.d.ts +25 -0
- package/dist/models/get-partner-relation-type-class.js +15 -0
- package/dist/models/get-partner-version-response-class.d.ts +25 -0
- package/dist/models/get-partner-version-response-class.js +15 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/models/list-partner-relation-types-class.d.ts +31 -0
- package/dist/models/list-partner-relation-types-class.js +15 -0
- package/dist/models/list-partner-versions-response-class.d.ts +25 -0
- package/dist/models/list-partner-versions-response-class.js +15 -0
- package/dist/models/partner-class.d.ts +12 -0
- package/dist/models/partner-relation-type-class.d.ts +66 -0
- package/dist/models/partner-relation-type-class.js +15 -0
- package/dist/models/update-partner-type-request-dto.d.ts +6 -0
- package/models/get-partner-relation-type-class.ts +31 -0
- package/models/get-partner-version-response-class.ts +31 -0
- package/models/index.ts +5 -0
- package/models/list-partner-relation-types-class.ts +37 -0
- package/models/list-partner-versions-response-class.ts +31 -0
- package/models/partner-class.ts +12 -0
- package/models/partner-relation-type-class.ts +72 -0
- package/models/update-partner-type-request-dto.ts +6 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
6
|
api/default-api.ts
|
|
7
|
+
api/partner-relations-api.ts
|
|
7
8
|
api/partner-types-api.ts
|
|
9
|
+
api/partner-version-api.ts
|
|
8
10
|
api/partners-api.ts
|
|
9
11
|
base.ts
|
|
10
12
|
common.ts
|
|
@@ -16,14 +18,19 @@ models/create-partner-response-class.ts
|
|
|
16
18
|
models/create-partner-type-request-dto.ts
|
|
17
19
|
models/create-partner-type-response-class.ts
|
|
18
20
|
models/delete-response-class.ts
|
|
21
|
+
models/get-partner-relation-type-class.ts
|
|
19
22
|
models/get-partner-response-class.ts
|
|
20
23
|
models/get-partner-type-response-class.ts
|
|
24
|
+
models/get-partner-version-response-class.ts
|
|
21
25
|
models/index.ts
|
|
22
26
|
models/inline-response200.ts
|
|
23
27
|
models/inline-response503.ts
|
|
28
|
+
models/list-partner-relation-types-class.ts
|
|
24
29
|
models/list-partner-types-response-class.ts
|
|
30
|
+
models/list-partner-versions-response-class.ts
|
|
25
31
|
models/list-partners-response-class.ts
|
|
26
32
|
models/partner-class.ts
|
|
33
|
+
models/partner-relation-type-class.ts
|
|
27
34
|
models/partner-type-class.ts
|
|
28
35
|
models/partner-type-custom-schema-dto.ts
|
|
29
36
|
models/update-partner-request-dto.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/partner-sdk@1.0
|
|
20
|
+
npm install @emilgroup/partner-sdk@1.1.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk@1.0
|
|
24
|
+
yarn add @emilgroup/partner-sdk@1.1.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -0,0 +1,349 @@
|
|
|
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 { GetPartnerRelationTypeClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { ListPartnerRelationTypesClass } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* PartnerRelationsApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
35
|
+
* @summary Retrieve the partner relation type
|
|
36
|
+
* @param {string} slug Identifying slug of the partner relation type
|
|
37
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
getPartnerRelationType: async (slug: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
42
|
+
// verify required parameter 'slug' is not null or undefined
|
|
43
|
+
assertParamExists('getPartnerRelationType', 'slug', slug)
|
|
44
|
+
const localVarPath = `/partnerservice/v1/partners/relations/types/{slug}`
|
|
45
|
+
.replace(`{${"slug"}}`, encodeURIComponent(String(slug)));
|
|
46
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48
|
+
let baseOptions;
|
|
49
|
+
let baseAccessToken;
|
|
50
|
+
if (configuration) {
|
|
51
|
+
baseOptions = configuration.baseOptions;
|
|
52
|
+
baseAccessToken = configuration.accessToken;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
56
|
+
const localVarHeaderParameter = {} as any;
|
|
57
|
+
const localVarQueryParameter = {} as any;
|
|
58
|
+
|
|
59
|
+
// authentication bearer required
|
|
60
|
+
// http bearer authentication required
|
|
61
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
62
|
+
|
|
63
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
64
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
70
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
72
|
+
|
|
73
|
+
return {
|
|
74
|
+
url: toPathString(localVarUrlObj),
|
|
75
|
+
options: localVarRequestOptions,
|
|
76
|
+
};
|
|
77
|
+
},
|
|
78
|
+
/**
|
|
79
|
+
* List all partner relation types - is used to create partner relations
|
|
80
|
+
* @summary List partner relation types
|
|
81
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
|
+
* @param {any} [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.
|
|
84
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
85
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
86
|
+
* @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, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
87
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
88
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
listPartnerVersion: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
|
+
const localVarPath = `/partnerservice/v1/partners/relations/types`;
|
|
94
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
95
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
96
|
+
let baseOptions;
|
|
97
|
+
let baseAccessToken;
|
|
98
|
+
if (configuration) {
|
|
99
|
+
baseOptions = configuration.baseOptions;
|
|
100
|
+
baseAccessToken = configuration.accessToken;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
104
|
+
const localVarHeaderParameter = {} as any;
|
|
105
|
+
const localVarQueryParameter = {} as any;
|
|
106
|
+
|
|
107
|
+
// authentication bearer required
|
|
108
|
+
// http bearer authentication required
|
|
109
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
110
|
+
|
|
111
|
+
if (pageSize !== undefined) {
|
|
112
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
if (pageToken !== undefined) {
|
|
116
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
if (filter !== undefined) {
|
|
120
|
+
localVarQueryParameter['filter'] = filter;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
if (search !== undefined) {
|
|
124
|
+
localVarQueryParameter['search'] = search;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
if (order !== undefined) {
|
|
128
|
+
localVarQueryParameter['order'] = order;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
if (expand !== undefined) {
|
|
132
|
+
localVarQueryParameter['expand'] = expand;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
if (filters !== undefined) {
|
|
136
|
+
localVarQueryParameter['filters'] = filters;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
140
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
146
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
147
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
148
|
+
|
|
149
|
+
return {
|
|
150
|
+
url: toPathString(localVarUrlObj),
|
|
151
|
+
options: localVarRequestOptions,
|
|
152
|
+
};
|
|
153
|
+
},
|
|
154
|
+
}
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* PartnerRelationsApi - functional programming interface
|
|
159
|
+
* @export
|
|
160
|
+
*/
|
|
161
|
+
export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
162
|
+
const localVarAxiosParamCreator = PartnerRelationsApiAxiosParamCreator(configuration)
|
|
163
|
+
return {
|
|
164
|
+
/**
|
|
165
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
166
|
+
* @summary Retrieve the partner relation type
|
|
167
|
+
* @param {string} slug Identifying slug of the partner relation type
|
|
168
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
async getPartnerRelationType(slug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationTypeClass>> {
|
|
173
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerRelationType(slug, authorization, options);
|
|
174
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
175
|
+
},
|
|
176
|
+
/**
|
|
177
|
+
* List all partner relation types - is used to create partner relations
|
|
178
|
+
* @summary List partner relation types
|
|
179
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
181
|
+
* @param {any} [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.
|
|
182
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
183
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
184
|
+
* @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, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
185
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
186
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
async listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>> {
|
|
191
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
192
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
193
|
+
},
|
|
194
|
+
}
|
|
195
|
+
};
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* PartnerRelationsApi - factory interface
|
|
199
|
+
* @export
|
|
200
|
+
*/
|
|
201
|
+
export const PartnerRelationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
202
|
+
const localVarFp = PartnerRelationsApiFp(configuration)
|
|
203
|
+
return {
|
|
204
|
+
/**
|
|
205
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
206
|
+
* @summary Retrieve the partner relation type
|
|
207
|
+
* @param {string} slug Identifying slug of the partner relation type
|
|
208
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
209
|
+
* @param {*} [options] Override http request option.
|
|
210
|
+
* @throws {RequiredError}
|
|
211
|
+
*/
|
|
212
|
+
getPartnerRelationType(slug: string, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationTypeClass> {
|
|
213
|
+
return localVarFp.getPartnerRelationType(slug, authorization, options).then((request) => request(axios, basePath));
|
|
214
|
+
},
|
|
215
|
+
/**
|
|
216
|
+
* List all partner relation types - is used to create partner relations
|
|
217
|
+
* @summary List partner relation types
|
|
218
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
219
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
220
|
+
* @param {any} [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.
|
|
221
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
222
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
223
|
+
* @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, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
224
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
225
|
+
* @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, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
226
|
+
* @param {*} [options] Override http request option.
|
|
227
|
+
* @throws {RequiredError}
|
|
228
|
+
*/
|
|
229
|
+
listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
|
|
230
|
+
return localVarFp.listPartnerVersion(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
231
|
+
},
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* Request parameters for getPartnerRelationType operation in PartnerRelationsApi.
|
|
237
|
+
* @export
|
|
238
|
+
* @interface PartnerRelationsApiGetPartnerRelationTypeRequest
|
|
239
|
+
*/
|
|
240
|
+
export interface PartnerRelationsApiGetPartnerRelationTypeRequest {
|
|
241
|
+
/**
|
|
242
|
+
* Identifying slug of the partner relation type
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof PartnerRelationsApiGetPartnerRelationType
|
|
245
|
+
*/
|
|
246
|
+
readonly slug: string
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof PartnerRelationsApiGetPartnerRelationType
|
|
252
|
+
*/
|
|
253
|
+
readonly authorization?: string
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* Request parameters for listPartnerVersion operation in PartnerRelationsApi.
|
|
258
|
+
* @export
|
|
259
|
+
* @interface PartnerRelationsApiListPartnerVersionRequest
|
|
260
|
+
*/
|
|
261
|
+
export interface PartnerRelationsApiListPartnerVersionRequest {
|
|
262
|
+
/**
|
|
263
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
264
|
+
* @type {string}
|
|
265
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
266
|
+
*/
|
|
267
|
+
readonly authorization?: string
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
|
+
* @type {any}
|
|
272
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
273
|
+
*/
|
|
274
|
+
readonly pageSize?: any
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* 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.
|
|
278
|
+
* @type {any}
|
|
279
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
280
|
+
*/
|
|
281
|
+
readonly pageToken?: any
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* 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, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
287
|
+
*/
|
|
288
|
+
readonly filter?: string
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
292
|
+
* @type {any}
|
|
293
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
294
|
+
*/
|
|
295
|
+
readonly search?: any
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* 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, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
299
|
+
* @type {string}
|
|
300
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
301
|
+
*/
|
|
302
|
+
readonly order?: string
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
306
|
+
* @type {string}
|
|
307
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
308
|
+
*/
|
|
309
|
+
readonly expand?: string
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* 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, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
315
|
+
*/
|
|
316
|
+
readonly filters?: string
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* PartnerRelationsApi - object-oriented interface
|
|
321
|
+
* @export
|
|
322
|
+
* @class PartnerRelationsApi
|
|
323
|
+
* @extends {BaseAPI}
|
|
324
|
+
*/
|
|
325
|
+
export class PartnerRelationsApi extends BaseAPI {
|
|
326
|
+
/**
|
|
327
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
328
|
+
* @summary Retrieve the partner relation type
|
|
329
|
+
* @param {PartnerRelationsApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
* @memberof PartnerRelationsApi
|
|
333
|
+
*/
|
|
334
|
+
public getPartnerRelationType(requestParameters: PartnerRelationsApiGetPartnerRelationTypeRequest, options?: AxiosRequestConfig) {
|
|
335
|
+
return PartnerRelationsApiFp(this.configuration).getPartnerRelationType(requestParameters.slug, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* List all partner relation types - is used to create partner relations
|
|
340
|
+
* @summary List partner relation types
|
|
341
|
+
* @param {PartnerRelationsApiListPartnerVersionRequest} requestParameters Request parameters.
|
|
342
|
+
* @param {*} [options] Override http request option.
|
|
343
|
+
* @throws {RequiredError}
|
|
344
|
+
* @memberof PartnerRelationsApi
|
|
345
|
+
*/
|
|
346
|
+
public listPartnerVersion(requestParameters: PartnerRelationsApiListPartnerVersionRequest = {}, options?: AxiosRequestConfig) {
|
|
347
|
+
return PartnerRelationsApiFp(this.configuration).listPartnerVersion(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
348
|
+
}
|
|
349
|
+
}
|
package/api/partner-types-api.ts
CHANGED
|
@@ -133,7 +133,7 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
|
|
|
133
133
|
};
|
|
134
134
|
},
|
|
135
135
|
/**
|
|
136
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
136
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
137
137
|
* @summary Retrieve the partner-types
|
|
138
138
|
* @param {string} code Unique identifier for the object.
|
|
139
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -183,19 +183,20 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
|
|
|
183
183
|
};
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* Returns a list of partner-types you have previously created.
|
|
186
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
187
187
|
* @summary List partner-types
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
189
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
190
|
* @param {any} [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.
|
|
191
191
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
192
|
-
* @param {any} [search]
|
|
192
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
193
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
194
194
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
195
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
195
196
|
* @param {*} [options] Override http request option.
|
|
196
197
|
* @throws {RequiredError}
|
|
197
198
|
*/
|
|
198
|
-
listPartnerTypes: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
199
|
+
listPartnerTypes: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
199
200
|
const localVarPath = `/partnerservice/v1/partner-types`;
|
|
200
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
201
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -238,6 +239,10 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
|
|
|
238
239
|
localVarQueryParameter['expand'] = expand;
|
|
239
240
|
}
|
|
240
241
|
|
|
242
|
+
if (filters !== undefined) {
|
|
243
|
+
localVarQueryParameter['filters'] = filters;
|
|
244
|
+
}
|
|
245
|
+
|
|
241
246
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
242
247
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
243
248
|
}
|
|
@@ -339,7 +344,7 @@ export const PartnerTypesApiFp = function(configuration?: Configuration) {
|
|
|
339
344
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
340
345
|
},
|
|
341
346
|
/**
|
|
342
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
347
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
343
348
|
* @summary Retrieve the partner-types
|
|
344
349
|
* @param {string} code Unique identifier for the object.
|
|
345
350
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -352,20 +357,21 @@ export const PartnerTypesApiFp = function(configuration?: Configuration) {
|
|
|
352
357
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
353
358
|
},
|
|
354
359
|
/**
|
|
355
|
-
* Returns a list of partner-types you have previously created.
|
|
360
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
356
361
|
* @summary List partner-types
|
|
357
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
358
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
363
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
359
364
|
* @param {any} [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.
|
|
360
365
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
361
|
-
* @param {any} [search]
|
|
366
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
362
367
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
363
368
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
369
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
364
370
|
* @param {*} [options] Override http request option.
|
|
365
371
|
* @throws {RequiredError}
|
|
366
372
|
*/
|
|
367
|
-
async listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerTypesResponseClass>> {
|
|
368
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
373
|
+
async listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerTypesResponseClass>> {
|
|
374
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
369
375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
370
376
|
},
|
|
371
377
|
/**
|
|
@@ -414,7 +420,7 @@ export const PartnerTypesApiFactory = function (configuration?: Configuration, b
|
|
|
414
420
|
return localVarFp.deletePartnerType(code, authorization, options).then((request) => request(axios, basePath));
|
|
415
421
|
},
|
|
416
422
|
/**
|
|
417
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
423
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
418
424
|
* @summary Retrieve the partner-types
|
|
419
425
|
* @param {string} code Unique identifier for the object.
|
|
420
426
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -426,20 +432,21 @@ export const PartnerTypesApiFactory = function (configuration?: Configuration, b
|
|
|
426
432
|
return localVarFp.getPartnerType(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
427
433
|
},
|
|
428
434
|
/**
|
|
429
|
-
* Returns a list of partner-types you have previously created.
|
|
435
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
430
436
|
* @summary List partner-types
|
|
431
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
432
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
438
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
433
439
|
* @param {any} [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.
|
|
434
440
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
435
|
-
* @param {any} [search]
|
|
441
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
436
442
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
437
443
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
444
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
438
445
|
* @param {*} [options] Override http request option.
|
|
439
446
|
* @throws {RequiredError}
|
|
440
447
|
*/
|
|
441
|
-
listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPartnerTypesResponseClass> {
|
|
442
|
-
return localVarFp.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
448
|
+
listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPartnerTypesResponseClass> {
|
|
449
|
+
return localVarFp.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
443
450
|
},
|
|
444
451
|
/**
|
|
445
452
|
* Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -540,7 +547,7 @@ export interface PartnerTypesApiListPartnerTypesRequest {
|
|
|
540
547
|
readonly authorization?: string
|
|
541
548
|
|
|
542
549
|
/**
|
|
543
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
550
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
544
551
|
* @type {any}
|
|
545
552
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
546
553
|
*/
|
|
@@ -561,7 +568,7 @@ export interface PartnerTypesApiListPartnerTypesRequest {
|
|
|
561
568
|
readonly filter?: any
|
|
562
569
|
|
|
563
570
|
/**
|
|
564
|
-
*
|
|
571
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
565
572
|
* @type {any}
|
|
566
573
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
567
574
|
*/
|
|
@@ -580,6 +587,13 @@ export interface PartnerTypesApiListPartnerTypesRequest {
|
|
|
580
587
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
581
588
|
*/
|
|
582
589
|
readonly expand?: any
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
593
|
+
* @type {any}
|
|
594
|
+
* @memberof PartnerTypesApiListPartnerTypes
|
|
595
|
+
*/
|
|
596
|
+
readonly filters?: any
|
|
583
597
|
}
|
|
584
598
|
|
|
585
599
|
/**
|
|
@@ -642,7 +656,7 @@ export class PartnerTypesApi extends BaseAPI {
|
|
|
642
656
|
}
|
|
643
657
|
|
|
644
658
|
/**
|
|
645
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
659
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
646
660
|
* @summary Retrieve the partner-types
|
|
647
661
|
* @param {PartnerTypesApiGetPartnerTypeRequest} requestParameters Request parameters.
|
|
648
662
|
* @param {*} [options] Override http request option.
|
|
@@ -654,7 +668,7 @@ export class PartnerTypesApi extends BaseAPI {
|
|
|
654
668
|
}
|
|
655
669
|
|
|
656
670
|
/**
|
|
657
|
-
* Returns a list of partner-types you have previously created.
|
|
671
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
658
672
|
* @summary List partner-types
|
|
659
673
|
* @param {PartnerTypesApiListPartnerTypesRequest} requestParameters Request parameters.
|
|
660
674
|
* @param {*} [options] Override http request option.
|
|
@@ -662,7 +676,7 @@ export class PartnerTypesApi extends BaseAPI {
|
|
|
662
676
|
* @memberof PartnerTypesApi
|
|
663
677
|
*/
|
|
664
678
|
public listPartnerTypes(requestParameters: PartnerTypesApiListPartnerTypesRequest = {}, options?: AxiosRequestConfig) {
|
|
665
|
-
return PartnerTypesApiFp(this.configuration).listPartnerTypes(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
679
|
+
return PartnerTypesApiFp(this.configuration).listPartnerTypes(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
666
680
|
}
|
|
667
681
|
|
|
668
682
|
/**
|