@emilgroup/partner-sdk 1.13.1-beta.2 → 1.14.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/README.md +2 -2
- package/api/partner-invitations-api.ts +4 -4
- package/api/partner-relations-api.ts +66 -66
- package/api/partner-tags-api.ts +43 -43
- package/api/partner-types-api.ts +60 -60
- package/api/partner-versions-api.ts +27 -27
- package/api/partners-api.ts +66 -66
- package/dist/api/partner-invitations-api.d.ts +4 -4
- package/dist/api/partner-invitations-api.js +4 -4
- package/dist/api/partner-relations-api.d.ts +66 -66
- package/dist/api/partner-relations-api.js +46 -46
- package/dist/api/partner-tags-api.d.ts +43 -43
- package/dist/api/partner-tags-api.js +32 -32
- package/dist/api/partner-types-api.d.ts +60 -60
- package/dist/api/partner-types-api.js +41 -41
- package/dist/api/partner-versions-api.d.ts +27 -27
- package/dist/api/partner-versions-api.js +17 -17
- package/dist/api/partners-api.d.ts +66 -66
- package/dist/api/partners-api.js +46 -46
- package/package.json +1 -1
|
@@ -31,7 +31,7 @@ import { ListPartnerVersionsResponseClass } from '../models';
|
|
|
31
31
|
export const PartnerVersionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
32
|
return {
|
|
33
33
|
/**
|
|
34
|
-
* Retrieve a partner version by providing partner code and version number
|
|
34
|
+
* Retrieve a partner version by providing partner code and version number **Required Permissions** \"partner-management.partners.view\"
|
|
35
35
|
* @summary Retrieve the partner version
|
|
36
36
|
* @param {string} code Unique identifier for the object.
|
|
37
37
|
* @param {number} version
|
|
@@ -80,21 +80,21 @@ export const PartnerVersionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
80
80
|
};
|
|
81
81
|
},
|
|
82
82
|
/**
|
|
83
|
-
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
83
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
84
84
|
* @summary List partner versions
|
|
85
85
|
* @param {string} code
|
|
86
86
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
|
-
* @param {
|
|
88
|
-
* @param {
|
|
87
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
88
|
+
* @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.
|
|
89
89
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
90
|
-
* @param {
|
|
90
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
91
91
|
* @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: displayName, createdAt, updatedAt, version</i>
|
|
92
92
|
* @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: partnerType<i>
|
|
93
93
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
96
96
|
*/
|
|
97
|
-
listPartnerVersion: async (code: string, authorization?: string, pageSize?:
|
|
97
|
+
listPartnerVersion: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
98
98
|
// verify required parameter 'code' is not null or undefined
|
|
99
99
|
assertParamExists('listPartnerVersion', 'code', code)
|
|
100
100
|
const localVarPath = `/partnerservice/v1/partners/{code}/versions`
|
|
@@ -170,7 +170,7 @@ export const PartnerVersionsApiFp = function(configuration?: Configuration) {
|
|
|
170
170
|
const localVarAxiosParamCreator = PartnerVersionsApiAxiosParamCreator(configuration)
|
|
171
171
|
return {
|
|
172
172
|
/**
|
|
173
|
-
* Retrieve a partner version by providing partner code and version number
|
|
173
|
+
* Retrieve a partner version by providing partner code and version number **Required Permissions** \"partner-management.partners.view\"
|
|
174
174
|
* @summary Retrieve the partner version
|
|
175
175
|
* @param {string} code Unique identifier for the object.
|
|
176
176
|
* @param {number} version
|
|
@@ -183,21 +183,21 @@ export const PartnerVersionsApiFp = function(configuration?: Configuration) {
|
|
|
183
183
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
186
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
187
187
|
* @summary List partner versions
|
|
188
188
|
* @param {string} code
|
|
189
189
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
190
|
-
* @param {
|
|
191
|
-
* @param {
|
|
190
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
191
|
+
* @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.
|
|
192
192
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
193
|
-
* @param {
|
|
193
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
194
|
* @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: displayName, createdAt, updatedAt, version</i>
|
|
195
195
|
* @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: partnerType<i>
|
|
196
196
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
198
198
|
* @throws {RequiredError}
|
|
199
199
|
*/
|
|
200
|
-
async listPartnerVersion(code: string, authorization?: string, pageSize?:
|
|
200
|
+
async listPartnerVersion(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerVersionsResponseClass>> {
|
|
201
201
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
202
202
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
203
203
|
},
|
|
@@ -212,7 +212,7 @@ export const PartnerVersionsApiFactory = function (configuration?: Configuration
|
|
|
212
212
|
const localVarFp = PartnerVersionsApiFp(configuration)
|
|
213
213
|
return {
|
|
214
214
|
/**
|
|
215
|
-
* Retrieve a partner version by providing partner code and version number
|
|
215
|
+
* Retrieve a partner version by providing partner code and version number **Required Permissions** \"partner-management.partners.view\"
|
|
216
216
|
* @summary Retrieve the partner version
|
|
217
217
|
* @param {string} code Unique identifier for the object.
|
|
218
218
|
* @param {number} version
|
|
@@ -224,21 +224,21 @@ export const PartnerVersionsApiFactory = function (configuration?: Configuration
|
|
|
224
224
|
return localVarFp.getPartnerVersion(code, version, authorization, options).then((request) => request(axios, basePath));
|
|
225
225
|
},
|
|
226
226
|
/**
|
|
227
|
-
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
227
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
228
228
|
* @summary List partner versions
|
|
229
229
|
* @param {string} code
|
|
230
230
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
|
-
* @param {
|
|
232
|
-
* @param {
|
|
231
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
|
+
* @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.
|
|
233
233
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
234
|
-
* @param {
|
|
234
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
235
|
* @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: displayName, createdAt, updatedAt, version</i>
|
|
236
236
|
* @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: partnerType<i>
|
|
237
237
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
240
|
*/
|
|
241
|
-
listPartnerVersion(code: string, authorization?: string, pageSize?:
|
|
241
|
+
listPartnerVersion(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerVersionsResponseClass> {
|
|
242
242
|
return localVarFp.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
243
243
|
},
|
|
244
244
|
};
|
|
@@ -294,17 +294,17 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
294
294
|
|
|
295
295
|
/**
|
|
296
296
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
297
|
-
* @type {
|
|
297
|
+
* @type {number}
|
|
298
298
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
299
299
|
*/
|
|
300
|
-
readonly pageSize?:
|
|
300
|
+
readonly pageSize?: number
|
|
301
301
|
|
|
302
302
|
/**
|
|
303
|
-
* 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,
|
|
304
|
-
* @type {
|
|
303
|
+
* 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.
|
|
304
|
+
* @type {string}
|
|
305
305
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
306
306
|
*/
|
|
307
|
-
readonly pageToken?:
|
|
307
|
+
readonly pageToken?: string
|
|
308
308
|
|
|
309
309
|
/**
|
|
310
310
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
@@ -315,10 +315,10 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
315
315
|
|
|
316
316
|
/**
|
|
317
317
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
318
|
-
* @type {
|
|
318
|
+
* @type {string}
|
|
319
319
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
320
320
|
*/
|
|
321
|
-
readonly search?:
|
|
321
|
+
readonly search?: string
|
|
322
322
|
|
|
323
323
|
/**
|
|
324
324
|
* 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: displayName, createdAt, updatedAt, version</i>
|
|
@@ -350,7 +350,7 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
350
350
|
*/
|
|
351
351
|
export class PartnerVersionsApi extends BaseAPI {
|
|
352
352
|
/**
|
|
353
|
-
* Retrieve a partner version by providing partner code and version number
|
|
353
|
+
* Retrieve a partner version by providing partner code and version number **Required Permissions** \"partner-management.partners.view\"
|
|
354
354
|
* @summary Retrieve the partner version
|
|
355
355
|
* @param {PartnerVersionsApiGetPartnerVersionRequest} requestParameters Request parameters.
|
|
356
356
|
* @param {*} [options] Override http request option.
|
|
@@ -362,7 +362,7 @@ export class PartnerVersionsApi extends BaseAPI {
|
|
|
362
362
|
}
|
|
363
363
|
|
|
364
364
|
/**
|
|
365
|
-
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
365
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
366
366
|
* @summary List partner versions
|
|
367
367
|
* @param {PartnerVersionsApiListPartnerVersionRequest} requestParameters Request parameters.
|
|
368
368
|
* @param {*} [options] Override http request option.
|
package/api/partners-api.ts
CHANGED
|
@@ -45,7 +45,7 @@ import { UpdatePartnerResponseClass } from '../models';
|
|
|
45
45
|
export const PartnersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46
46
|
return {
|
|
47
47
|
/**
|
|
48
|
-
* This will create a partner.
|
|
48
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
49
49
|
* @summary Create the partner
|
|
50
50
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
51
51
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -92,7 +92,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
92
92
|
};
|
|
93
93
|
},
|
|
94
94
|
/**
|
|
95
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
95
|
+
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
96
96
|
* @summary Delete the partner
|
|
97
97
|
* @param {string} code
|
|
98
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -137,7 +137,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
137
137
|
};
|
|
138
138
|
},
|
|
139
139
|
/**
|
|
140
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
140
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information. **Required Permissions** \"partner-management.partners.view\"
|
|
141
141
|
* @summary Retrieve the partner
|
|
142
142
|
* @param {string} code Unique identifier for the object.
|
|
143
143
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -187,20 +187,20 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
187
187
|
};
|
|
188
188
|
},
|
|
189
189
|
/**
|
|
190
|
-
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
190
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
191
191
|
* @summary List partners
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
-
* @param {
|
|
194
|
-
* @param {
|
|
193
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
|
+
* @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.
|
|
195
195
|
* @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, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
196
|
-
* @param {
|
|
196
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
197
197
|
* @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, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
198
198
|
* @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: partnerType, tags<i>
|
|
199
199
|
* @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, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
203
|
-
listPartners: async (authorization?: string, pageSize?:
|
|
203
|
+
listPartners: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
204
204
|
const localVarPath = `/partnerservice/v1/partners`;
|
|
205
205
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
206
206
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -263,21 +263,21 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
263
263
|
};
|
|
264
264
|
},
|
|
265
265
|
/**
|
|
266
|
-
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
266
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
267
267
|
* @summary List grouped relations for partner
|
|
268
268
|
* @param {string} code
|
|
269
269
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
-
* @param {
|
|
271
|
-
* @param {
|
|
270
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
|
+
* @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.
|
|
272
272
|
* @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, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
273
|
-
* @param {
|
|
273
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
274
274
|
* @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, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
275
275
|
* @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: partner1, partner2, partnerRelationType<i>
|
|
276
276
|
* @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, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
277
277
|
* @param {*} [options] Override http request option.
|
|
278
278
|
* @throws {RequiredError}
|
|
279
279
|
*/
|
|
280
|
-
listRelationsForPartner: async (code: string, authorization?: string, pageSize?:
|
|
280
|
+
listRelationsForPartner: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
281
281
|
// verify required parameter 'code' is not null or undefined
|
|
282
282
|
assertParamExists('listRelationsForPartner', 'code', code)
|
|
283
283
|
const localVarPath = `/partnerservice/v1/partners/{code}/relations`
|
|
@@ -343,7 +343,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
343
343
|
};
|
|
344
344
|
},
|
|
345
345
|
/**
|
|
346
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
346
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
347
347
|
* @summary Update the partner
|
|
348
348
|
* @param {string} code
|
|
349
349
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -394,7 +394,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
394
394
|
};
|
|
395
395
|
},
|
|
396
396
|
/**
|
|
397
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
397
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
398
398
|
* @summary Update the partner
|
|
399
399
|
* @param {string} code Unique identifier for the object.
|
|
400
400
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -455,7 +455,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
455
455
|
const localVarAxiosParamCreator = PartnersApiAxiosParamCreator(configuration)
|
|
456
456
|
return {
|
|
457
457
|
/**
|
|
458
|
-
* This will create a partner.
|
|
458
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
459
459
|
* @summary Create the partner
|
|
460
460
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
461
461
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -467,7 +467,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
467
467
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
468
468
|
},
|
|
469
469
|
/**
|
|
470
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
470
|
+
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
471
471
|
* @summary Delete the partner
|
|
472
472
|
* @param {string} code
|
|
473
473
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -479,7 +479,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
479
479
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
480
480
|
},
|
|
481
481
|
/**
|
|
482
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
482
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information. **Required Permissions** \"partner-management.partners.view\"
|
|
483
483
|
* @summary Retrieve the partner
|
|
484
484
|
* @param {string} code Unique identifier for the object.
|
|
485
485
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -492,44 +492,44 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
492
492
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
493
493
|
},
|
|
494
494
|
/**
|
|
495
|
-
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
495
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
496
496
|
* @summary List partners
|
|
497
497
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
498
|
-
* @param {
|
|
499
|
-
* @param {
|
|
498
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
499
|
+
* @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.
|
|
500
500
|
* @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, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
501
|
-
* @param {
|
|
501
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
502
502
|
* @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, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
503
503
|
* @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: partnerType, tags<i>
|
|
504
504
|
* @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, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
505
505
|
* @param {*} [options] Override http request option.
|
|
506
506
|
* @throws {RequiredError}
|
|
507
507
|
*/
|
|
508
|
-
async listPartners(authorization?: string, pageSize?:
|
|
508
|
+
async listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>> {
|
|
509
509
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
510
510
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
511
511
|
},
|
|
512
512
|
/**
|
|
513
|
-
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
513
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
514
514
|
* @summary List grouped relations for partner
|
|
515
515
|
* @param {string} code
|
|
516
516
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
517
|
-
* @param {
|
|
518
|
-
* @param {
|
|
517
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
518
|
+
* @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.
|
|
519
519
|
* @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, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
520
|
-
* @param {
|
|
520
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
521
521
|
* @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, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
522
522
|
* @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: partner1, partner2, partnerRelationType<i>
|
|
523
523
|
* @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, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
524
524
|
* @param {*} [options] Override http request option.
|
|
525
525
|
* @throws {RequiredError}
|
|
526
526
|
*/
|
|
527
|
-
async listRelationsForPartner(code: string, authorization?: string, pageSize?:
|
|
527
|
+
async listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRelatedPartnersResponseClass>> {
|
|
528
528
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
529
529
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
530
530
|
},
|
|
531
531
|
/**
|
|
532
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
532
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
533
533
|
* @summary Update the partner
|
|
534
534
|
* @param {string} code
|
|
535
535
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -542,7 +542,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
542
542
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
543
543
|
},
|
|
544
544
|
/**
|
|
545
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
545
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
546
546
|
* @summary Update the partner
|
|
547
547
|
* @param {string} code Unique identifier for the object.
|
|
548
548
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -565,7 +565,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
565
565
|
const localVarFp = PartnersApiFp(configuration)
|
|
566
566
|
return {
|
|
567
567
|
/**
|
|
568
|
-
* This will create a partner.
|
|
568
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
569
569
|
* @summary Create the partner
|
|
570
570
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
571
571
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -576,7 +576,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
576
576
|
return localVarFp.createPartner(createPartnerRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
577
577
|
},
|
|
578
578
|
/**
|
|
579
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
579
|
+
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
580
580
|
* @summary Delete the partner
|
|
581
581
|
* @param {string} code
|
|
582
582
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -587,7 +587,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
587
587
|
return localVarFp.deletePartner(code, authorization, options).then((request) => request(axios, basePath));
|
|
588
588
|
},
|
|
589
589
|
/**
|
|
590
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
590
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information. **Required Permissions** \"partner-management.partners.view\"
|
|
591
591
|
* @summary Retrieve the partner
|
|
592
592
|
* @param {string} code Unique identifier for the object.
|
|
593
593
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -599,42 +599,42 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
599
599
|
return localVarFp.getPartner(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
600
600
|
},
|
|
601
601
|
/**
|
|
602
|
-
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
602
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
603
603
|
* @summary List partners
|
|
604
604
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
605
|
-
* @param {
|
|
606
|
-
* @param {
|
|
605
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
606
|
+
* @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.
|
|
607
607
|
* @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, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
608
|
-
* @param {
|
|
608
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
609
609
|
* @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, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
610
610
|
* @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: partnerType, tags<i>
|
|
611
611
|
* @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, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
612
612
|
* @param {*} [options] Override http request option.
|
|
613
613
|
* @throws {RequiredError}
|
|
614
614
|
*/
|
|
615
|
-
listPartners(authorization?: string, pageSize?:
|
|
615
|
+
listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass> {
|
|
616
616
|
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
617
617
|
},
|
|
618
618
|
/**
|
|
619
|
-
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
619
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
620
620
|
* @summary List grouped relations for partner
|
|
621
621
|
* @param {string} code
|
|
622
622
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
623
|
-
* @param {
|
|
624
|
-
* @param {
|
|
623
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
624
|
+
* @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.
|
|
625
625
|
* @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, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
626
|
-
* @param {
|
|
626
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
627
627
|
* @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, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
628
628
|
* @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: partner1, partner2, partnerRelationType<i>
|
|
629
629
|
* @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, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
630
630
|
* @param {*} [options] Override http request option.
|
|
631
631
|
* @throws {RequiredError}
|
|
632
632
|
*/
|
|
633
|
-
listRelationsForPartner(code: string, authorization?: string, pageSize?:
|
|
633
|
+
listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRelatedPartnersResponseClass> {
|
|
634
634
|
return localVarFp.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
635
635
|
},
|
|
636
636
|
/**
|
|
637
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
637
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
638
638
|
* @summary Update the partner
|
|
639
639
|
* @param {string} code
|
|
640
640
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -646,7 +646,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
646
646
|
return localVarFp.tagPartner(code, tagPartnerRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
647
647
|
},
|
|
648
648
|
/**
|
|
649
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
649
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
650
650
|
* @summary Update the partner
|
|
651
651
|
* @param {string} code Unique identifier for the object.
|
|
652
652
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -745,17 +745,17 @@ export interface PartnersApiListPartnersRequest {
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
748
|
-
* @type {
|
|
748
|
+
* @type {number}
|
|
749
749
|
* @memberof PartnersApiListPartners
|
|
750
750
|
*/
|
|
751
|
-
readonly pageSize?:
|
|
751
|
+
readonly pageSize?: number
|
|
752
752
|
|
|
753
753
|
/**
|
|
754
|
-
* 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,
|
|
755
|
-
* @type {
|
|
754
|
+
* 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.
|
|
755
|
+
* @type {string}
|
|
756
756
|
* @memberof PartnersApiListPartners
|
|
757
757
|
*/
|
|
758
|
-
readonly pageToken?:
|
|
758
|
+
readonly pageToken?: string
|
|
759
759
|
|
|
760
760
|
/**
|
|
761
761
|
* 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, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
@@ -766,10 +766,10 @@ export interface PartnersApiListPartnersRequest {
|
|
|
766
766
|
|
|
767
767
|
/**
|
|
768
768
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
769
|
-
* @type {
|
|
769
|
+
* @type {string}
|
|
770
770
|
* @memberof PartnersApiListPartners
|
|
771
771
|
*/
|
|
772
|
-
readonly search?:
|
|
772
|
+
readonly search?: string
|
|
773
773
|
|
|
774
774
|
/**
|
|
775
775
|
* 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, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
@@ -815,17 +815,17 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
815
815
|
|
|
816
816
|
/**
|
|
817
817
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
818
|
-
* @type {
|
|
818
|
+
* @type {number}
|
|
819
819
|
* @memberof PartnersApiListRelationsForPartner
|
|
820
820
|
*/
|
|
821
|
-
readonly pageSize?:
|
|
821
|
+
readonly pageSize?: number
|
|
822
822
|
|
|
823
823
|
/**
|
|
824
|
-
* 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,
|
|
825
|
-
* @type {
|
|
824
|
+
* 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
|
+
* @type {string}
|
|
826
826
|
* @memberof PartnersApiListRelationsForPartner
|
|
827
827
|
*/
|
|
828
|
-
readonly pageToken?:
|
|
828
|
+
readonly pageToken?: string
|
|
829
829
|
|
|
830
830
|
/**
|
|
831
831
|
* 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, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
@@ -836,10 +836,10 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
836
836
|
|
|
837
837
|
/**
|
|
838
838
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
839
|
-
* @type {
|
|
839
|
+
* @type {string}
|
|
840
840
|
* @memberof PartnersApiListRelationsForPartner
|
|
841
841
|
*/
|
|
842
|
-
readonly search?:
|
|
842
|
+
readonly search?: string
|
|
843
843
|
|
|
844
844
|
/**
|
|
845
845
|
* 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, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
@@ -927,7 +927,7 @@ export interface PartnersApiUpdatePartnerRequest {
|
|
|
927
927
|
*/
|
|
928
928
|
export class PartnersApi extends BaseAPI {
|
|
929
929
|
/**
|
|
930
|
-
* This will create a partner.
|
|
930
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
931
931
|
* @summary Create the partner
|
|
932
932
|
* @param {PartnersApiCreatePartnerRequest} requestParameters Request parameters.
|
|
933
933
|
* @param {*} [options] Override http request option.
|
|
@@ -939,7 +939,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
939
939
|
}
|
|
940
940
|
|
|
941
941
|
/**
|
|
942
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
942
|
+
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
943
943
|
* @summary Delete the partner
|
|
944
944
|
* @param {PartnersApiDeletePartnerRequest} requestParameters Request parameters.
|
|
945
945
|
* @param {*} [options] Override http request option.
|
|
@@ -951,7 +951,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
951
951
|
}
|
|
952
952
|
|
|
953
953
|
/**
|
|
954
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
954
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information. **Required Permissions** \"partner-management.partners.view\"
|
|
955
955
|
* @summary Retrieve the partner
|
|
956
956
|
* @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
|
|
957
957
|
* @param {*} [options] Override http request option.
|
|
@@ -963,7 +963,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
963
963
|
}
|
|
964
964
|
|
|
965
965
|
/**
|
|
966
|
-
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
966
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
967
967
|
* @summary List partners
|
|
968
968
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
969
969
|
* @param {*} [options] Override http request option.
|
|
@@ -975,7 +975,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
975
975
|
}
|
|
976
976
|
|
|
977
977
|
/**
|
|
978
|
-
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
978
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
979
979
|
* @summary List grouped relations for partner
|
|
980
980
|
* @param {PartnersApiListRelationsForPartnerRequest} requestParameters Request parameters.
|
|
981
981
|
* @param {*} [options] Override http request option.
|
|
@@ -987,7 +987,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
987
987
|
}
|
|
988
988
|
|
|
989
989
|
/**
|
|
990
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
990
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
991
991
|
* @summary Update the partner
|
|
992
992
|
* @param {PartnersApiTagPartnerRequest} requestParameters Request parameters.
|
|
993
993
|
* @param {*} [options] Override http request option.
|
|
@@ -999,7 +999,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
999
999
|
}
|
|
1000
1000
|
|
|
1001
1001
|
/**
|
|
1002
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
1002
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
1003
1003
|
* @summary Update the partner
|
|
1004
1004
|
* @param {PartnersApiUpdatePartnerRequest} requestParameters Request parameters.
|
|
1005
1005
|
* @param {*} [options] Override http request option.
|