@emilgroup/partner-sdk-node 1.13.1-beta.2 → 1.13.1-beta.3
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
|
@@ -35,7 +35,7 @@ const FormData = require('form-data');
|
|
|
35
35
|
export const PartnerVersionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* Retrieve a partner version by providing partner code and version number
|
|
38
|
+
* Retrieve a partner version by providing partner code and version number **Required Permissions** \"partner-management.partners.view\"
|
|
39
39
|
* @summary Retrieve the partner version
|
|
40
40
|
* @param {string} code Unique identifier for the object.
|
|
41
41
|
* @param {number} version
|
|
@@ -84,21 +84,21 @@ export const PartnerVersionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
84
84
|
};
|
|
85
85
|
},
|
|
86
86
|
/**
|
|
87
|
-
* 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.
|
|
87
|
+
* 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\"
|
|
88
88
|
* @summary List partner versions
|
|
89
89
|
* @param {string} code
|
|
90
90
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
|
-
* @param {
|
|
92
|
-
* @param {
|
|
91
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
92
|
+
* @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.
|
|
93
93
|
* @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>
|
|
94
|
-
* @param {
|
|
94
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
95
95
|
* @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>
|
|
96
96
|
* @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>
|
|
97
97
|
* @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>
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
101
|
-
listPartnerVersion: async (code: string, authorization?: string, pageSize?:
|
|
101
|
+
listPartnerVersion: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
102
102
|
// verify required parameter 'code' is not null or undefined
|
|
103
103
|
assertParamExists('listPartnerVersion', 'code', code)
|
|
104
104
|
const localVarPath = `/partnerservice/v1/partners/{code}/versions`
|
|
@@ -174,7 +174,7 @@ export const PartnerVersionsApiFp = function(configuration?: Configuration) {
|
|
|
174
174
|
const localVarAxiosParamCreator = PartnerVersionsApiAxiosParamCreator(configuration)
|
|
175
175
|
return {
|
|
176
176
|
/**
|
|
177
|
-
* Retrieve a partner version by providing partner code and version number
|
|
177
|
+
* Retrieve a partner version by providing partner code and version number **Required Permissions** \"partner-management.partners.view\"
|
|
178
178
|
* @summary Retrieve the partner version
|
|
179
179
|
* @param {string} code Unique identifier for the object.
|
|
180
180
|
* @param {number} version
|
|
@@ -187,21 +187,21 @@ export const PartnerVersionsApiFp = function(configuration?: Configuration) {
|
|
|
187
187
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
188
188
|
},
|
|
189
189
|
/**
|
|
190
|
-
* 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.
|
|
190
|
+
* 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\"
|
|
191
191
|
* @summary List partner versions
|
|
192
192
|
* @param {string} code
|
|
193
193
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
|
-
* @param {
|
|
195
|
-
* @param {
|
|
194
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
195
|
+
* @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.
|
|
196
196
|
* @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>
|
|
197
|
-
* @param {
|
|
197
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
198
198
|
* @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>
|
|
199
199
|
* @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>
|
|
200
200
|
* @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>
|
|
201
201
|
* @param {*} [options] Override http request option.
|
|
202
202
|
* @throws {RequiredError}
|
|
203
203
|
*/
|
|
204
|
-
async listPartnerVersion(code: string, authorization?: string, pageSize?:
|
|
204
|
+
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>> {
|
|
205
205
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
206
206
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
207
207
|
},
|
|
@@ -216,7 +216,7 @@ export const PartnerVersionsApiFactory = function (configuration?: Configuration
|
|
|
216
216
|
const localVarFp = PartnerVersionsApiFp(configuration)
|
|
217
217
|
return {
|
|
218
218
|
/**
|
|
219
|
-
* Retrieve a partner version by providing partner code and version number
|
|
219
|
+
* Retrieve a partner version by providing partner code and version number **Required Permissions** \"partner-management.partners.view\"
|
|
220
220
|
* @summary Retrieve the partner version
|
|
221
221
|
* @param {string} code Unique identifier for the object.
|
|
222
222
|
* @param {number} version
|
|
@@ -228,21 +228,21 @@ export const PartnerVersionsApiFactory = function (configuration?: Configuration
|
|
|
228
228
|
return localVarFp.getPartnerVersion(code, version, authorization, options).then((request) => request(axios, basePath));
|
|
229
229
|
},
|
|
230
230
|
/**
|
|
231
|
-
* 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.
|
|
231
|
+
* 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\"
|
|
232
232
|
* @summary List partner versions
|
|
233
233
|
* @param {string} code
|
|
234
234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
235
|
-
* @param {
|
|
236
|
-
* @param {
|
|
235
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
236
|
+
* @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.
|
|
237
237
|
* @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>
|
|
238
|
-
* @param {
|
|
238
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
239
239
|
* @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>
|
|
240
240
|
* @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>
|
|
241
241
|
* @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>
|
|
242
242
|
* @param {*} [options] Override http request option.
|
|
243
243
|
* @throws {RequiredError}
|
|
244
244
|
*/
|
|
245
|
-
listPartnerVersion(code: string, authorization?: string, pageSize?:
|
|
245
|
+
listPartnerVersion(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerVersionsResponseClass> {
|
|
246
246
|
return localVarFp.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
247
247
|
},
|
|
248
248
|
};
|
|
@@ -298,17 +298,17 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
298
298
|
|
|
299
299
|
/**
|
|
300
300
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
301
|
-
* @type {
|
|
301
|
+
* @type {number}
|
|
302
302
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
303
303
|
*/
|
|
304
|
-
readonly pageSize?:
|
|
304
|
+
readonly pageSize?: number
|
|
305
305
|
|
|
306
306
|
/**
|
|
307
|
-
* 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,
|
|
308
|
-
* @type {
|
|
307
|
+
* 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.
|
|
308
|
+
* @type {string}
|
|
309
309
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
310
310
|
*/
|
|
311
|
-
readonly pageToken?:
|
|
311
|
+
readonly pageToken?: string
|
|
312
312
|
|
|
313
313
|
/**
|
|
314
314
|
* 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>
|
|
@@ -319,10 +319,10 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
319
319
|
|
|
320
320
|
/**
|
|
321
321
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
322
|
-
* @type {
|
|
322
|
+
* @type {string}
|
|
323
323
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
324
324
|
*/
|
|
325
|
-
readonly search?:
|
|
325
|
+
readonly search?: string
|
|
326
326
|
|
|
327
327
|
/**
|
|
328
328
|
* 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>
|
|
@@ -354,7 +354,7 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
354
354
|
*/
|
|
355
355
|
export class PartnerVersionsApi extends BaseAPI {
|
|
356
356
|
/**
|
|
357
|
-
* Retrieve a partner version by providing partner code and version number
|
|
357
|
+
* Retrieve a partner version by providing partner code and version number **Required Permissions** \"partner-management.partners.view\"
|
|
358
358
|
* @summary Retrieve the partner version
|
|
359
359
|
* @param {PartnerVersionsApiGetPartnerVersionRequest} requestParameters Request parameters.
|
|
360
360
|
* @param {*} [options] Override http request option.
|
|
@@ -366,7 +366,7 @@ export class PartnerVersionsApi extends BaseAPI {
|
|
|
366
366
|
}
|
|
367
367
|
|
|
368
368
|
/**
|
|
369
|
-
* 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.
|
|
369
|
+
* 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\"
|
|
370
370
|
* @summary List partner versions
|
|
371
371
|
* @param {PartnerVersionsApiListPartnerVersionRequest} requestParameters Request parameters.
|
|
372
372
|
* @param {*} [options] Override http request option.
|
package/api/partners-api.ts
CHANGED
|
@@ -49,7 +49,7 @@ const FormData = require('form-data');
|
|
|
49
49
|
export const PartnersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
50
50
|
return {
|
|
51
51
|
/**
|
|
52
|
-
* This will create a partner.
|
|
52
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
53
53
|
* @summary Create the partner
|
|
54
54
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
55
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -96,7 +96,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
96
96
|
};
|
|
97
97
|
},
|
|
98
98
|
/**
|
|
99
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
99
|
+
* 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\"
|
|
100
100
|
* @summary Delete the partner
|
|
101
101
|
* @param {string} code
|
|
102
102
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -141,7 +141,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
141
141
|
};
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
* 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.
|
|
144
|
+
* 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\"
|
|
145
145
|
* @summary Retrieve the partner
|
|
146
146
|
* @param {string} code Unique identifier for the object.
|
|
147
147
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -191,20 +191,20 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
191
191
|
};
|
|
192
192
|
},
|
|
193
193
|
/**
|
|
194
|
-
* 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.
|
|
194
|
+
* 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\"
|
|
195
195
|
* @summary List partners
|
|
196
196
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
|
-
* @param {
|
|
198
|
-
* @param {
|
|
197
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
198
|
+
* @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.
|
|
199
199
|
* @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>
|
|
200
|
-
* @param {
|
|
200
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
201
201
|
* @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>
|
|
202
202
|
* @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>
|
|
203
203
|
* @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>
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
207
|
-
listPartners: async (authorization?: string, pageSize?:
|
|
207
|
+
listPartners: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
208
208
|
const localVarPath = `/partnerservice/v1/partners`;
|
|
209
209
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
210
210
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -267,21 +267,21 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
267
267
|
};
|
|
268
268
|
},
|
|
269
269
|
/**
|
|
270
|
-
* 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.
|
|
270
|
+
* 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\"
|
|
271
271
|
* @summary List grouped relations for partner
|
|
272
272
|
* @param {string} code
|
|
273
273
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
274
|
-
* @param {
|
|
275
|
-
* @param {
|
|
274
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @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.
|
|
276
276
|
* @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>
|
|
277
|
-
* @param {
|
|
277
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
278
278
|
* @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>
|
|
279
279
|
* @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>
|
|
280
280
|
* @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>
|
|
281
281
|
* @param {*} [options] Override http request option.
|
|
282
282
|
* @throws {RequiredError}
|
|
283
283
|
*/
|
|
284
|
-
listRelationsForPartner: async (code: string, authorization?: string, pageSize?:
|
|
284
|
+
listRelationsForPartner: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
285
285
|
// verify required parameter 'code' is not null or undefined
|
|
286
286
|
assertParamExists('listRelationsForPartner', 'code', code)
|
|
287
287
|
const localVarPath = `/partnerservice/v1/partners/{code}/relations`
|
|
@@ -347,7 +347,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
347
347
|
};
|
|
348
348
|
},
|
|
349
349
|
/**
|
|
350
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
350
|
+
* 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\"
|
|
351
351
|
* @summary Update the partner
|
|
352
352
|
* @param {string} code
|
|
353
353
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -398,7 +398,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
398
398
|
};
|
|
399
399
|
},
|
|
400
400
|
/**
|
|
401
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
401
|
+
* 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\"
|
|
402
402
|
* @summary Update the partner
|
|
403
403
|
* @param {string} code Unique identifier for the object.
|
|
404
404
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -459,7 +459,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
459
459
|
const localVarAxiosParamCreator = PartnersApiAxiosParamCreator(configuration)
|
|
460
460
|
return {
|
|
461
461
|
/**
|
|
462
|
-
* This will create a partner.
|
|
462
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
463
463
|
* @summary Create the partner
|
|
464
464
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
465
465
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -471,7 +471,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
471
471
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
472
472
|
},
|
|
473
473
|
/**
|
|
474
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
474
|
+
* 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\"
|
|
475
475
|
* @summary Delete the partner
|
|
476
476
|
* @param {string} code
|
|
477
477
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -483,7 +483,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
483
483
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
484
484
|
},
|
|
485
485
|
/**
|
|
486
|
-
* 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.
|
|
486
|
+
* 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\"
|
|
487
487
|
* @summary Retrieve the partner
|
|
488
488
|
* @param {string} code Unique identifier for the object.
|
|
489
489
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -496,44 +496,44 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
496
496
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
497
497
|
},
|
|
498
498
|
/**
|
|
499
|
-
* 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.
|
|
499
|
+
* 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\"
|
|
500
500
|
* @summary List partners
|
|
501
501
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
502
|
-
* @param {
|
|
503
|
-
* @param {
|
|
502
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
503
|
+
* @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.
|
|
504
504
|
* @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>
|
|
505
|
-
* @param {
|
|
505
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
506
506
|
* @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>
|
|
507
507
|
* @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>
|
|
508
508
|
* @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>
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
510
510
|
* @throws {RequiredError}
|
|
511
511
|
*/
|
|
512
|
-
async listPartners(authorization?: string, pageSize?:
|
|
512
|
+
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>> {
|
|
513
513
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
514
514
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
515
515
|
},
|
|
516
516
|
/**
|
|
517
|
-
* 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.
|
|
517
|
+
* 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\"
|
|
518
518
|
* @summary List grouped relations for partner
|
|
519
519
|
* @param {string} code
|
|
520
520
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
521
|
-
* @param {
|
|
522
|
-
* @param {
|
|
521
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
522
|
+
* @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.
|
|
523
523
|
* @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>
|
|
524
|
-
* @param {
|
|
524
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
525
525
|
* @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>
|
|
526
526
|
* @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>
|
|
527
527
|
* @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>
|
|
528
528
|
* @param {*} [options] Override http request option.
|
|
529
529
|
* @throws {RequiredError}
|
|
530
530
|
*/
|
|
531
|
-
async listRelationsForPartner(code: string, authorization?: string, pageSize?:
|
|
531
|
+
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>> {
|
|
532
532
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
533
533
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
534
534
|
},
|
|
535
535
|
/**
|
|
536
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
536
|
+
* 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\"
|
|
537
537
|
* @summary Update the partner
|
|
538
538
|
* @param {string} code
|
|
539
539
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -546,7 +546,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
546
546
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
547
547
|
},
|
|
548
548
|
/**
|
|
549
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
549
|
+
* 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\"
|
|
550
550
|
* @summary Update the partner
|
|
551
551
|
* @param {string} code Unique identifier for the object.
|
|
552
552
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -569,7 +569,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
569
569
|
const localVarFp = PartnersApiFp(configuration)
|
|
570
570
|
return {
|
|
571
571
|
/**
|
|
572
|
-
* This will create a partner.
|
|
572
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
573
573
|
* @summary Create the partner
|
|
574
574
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
575
575
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -580,7 +580,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
580
580
|
return localVarFp.createPartner(createPartnerRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
581
581
|
},
|
|
582
582
|
/**
|
|
583
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
583
|
+
* 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\"
|
|
584
584
|
* @summary Delete the partner
|
|
585
585
|
* @param {string} code
|
|
586
586
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -591,7 +591,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
591
591
|
return localVarFp.deletePartner(code, authorization, options).then((request) => request(axios, basePath));
|
|
592
592
|
},
|
|
593
593
|
/**
|
|
594
|
-
* 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.
|
|
594
|
+
* 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\"
|
|
595
595
|
* @summary Retrieve the partner
|
|
596
596
|
* @param {string} code Unique identifier for the object.
|
|
597
597
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -603,42 +603,42 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
603
603
|
return localVarFp.getPartner(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
604
604
|
},
|
|
605
605
|
/**
|
|
606
|
-
* 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.
|
|
606
|
+
* 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\"
|
|
607
607
|
* @summary List partners
|
|
608
608
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
609
|
-
* @param {
|
|
610
|
-
* @param {
|
|
609
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
610
|
+
* @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.
|
|
611
611
|
* @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>
|
|
612
|
-
* @param {
|
|
612
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
613
613
|
* @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>
|
|
614
614
|
* @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>
|
|
615
615
|
* @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>
|
|
616
616
|
* @param {*} [options] Override http request option.
|
|
617
617
|
* @throws {RequiredError}
|
|
618
618
|
*/
|
|
619
|
-
listPartners(authorization?: string, pageSize?:
|
|
619
|
+
listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass> {
|
|
620
620
|
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
621
621
|
},
|
|
622
622
|
/**
|
|
623
|
-
* 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.
|
|
623
|
+
* 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\"
|
|
624
624
|
* @summary List grouped relations for partner
|
|
625
625
|
* @param {string} code
|
|
626
626
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
627
|
-
* @param {
|
|
628
|
-
* @param {
|
|
627
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
628
|
+
* @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.
|
|
629
629
|
* @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>
|
|
630
|
-
* @param {
|
|
630
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
631
631
|
* @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>
|
|
632
632
|
* @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>
|
|
633
633
|
* @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>
|
|
634
634
|
* @param {*} [options] Override http request option.
|
|
635
635
|
* @throws {RequiredError}
|
|
636
636
|
*/
|
|
637
|
-
listRelationsForPartner(code: string, authorization?: string, pageSize?:
|
|
637
|
+
listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRelatedPartnersResponseClass> {
|
|
638
638
|
return localVarFp.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
639
639
|
},
|
|
640
640
|
/**
|
|
641
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
641
|
+
* 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\"
|
|
642
642
|
* @summary Update the partner
|
|
643
643
|
* @param {string} code
|
|
644
644
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -650,7 +650,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
650
650
|
return localVarFp.tagPartner(code, tagPartnerRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
651
651
|
},
|
|
652
652
|
/**
|
|
653
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
653
|
+
* 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\"
|
|
654
654
|
* @summary Update the partner
|
|
655
655
|
* @param {string} code Unique identifier for the object.
|
|
656
656
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -749,17 +749,17 @@ export interface PartnersApiListPartnersRequest {
|
|
|
749
749
|
|
|
750
750
|
/**
|
|
751
751
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
752
|
-
* @type {
|
|
752
|
+
* @type {number}
|
|
753
753
|
* @memberof PartnersApiListPartners
|
|
754
754
|
*/
|
|
755
|
-
readonly pageSize?:
|
|
755
|
+
readonly pageSize?: number
|
|
756
756
|
|
|
757
757
|
/**
|
|
758
|
-
* 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,
|
|
759
|
-
* @type {
|
|
758
|
+
* 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.
|
|
759
|
+
* @type {string}
|
|
760
760
|
* @memberof PartnersApiListPartners
|
|
761
761
|
*/
|
|
762
|
-
readonly pageToken?:
|
|
762
|
+
readonly pageToken?: string
|
|
763
763
|
|
|
764
764
|
/**
|
|
765
765
|
* 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>
|
|
@@ -770,10 +770,10 @@ export interface PartnersApiListPartnersRequest {
|
|
|
770
770
|
|
|
771
771
|
/**
|
|
772
772
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
773
|
-
* @type {
|
|
773
|
+
* @type {string}
|
|
774
774
|
* @memberof PartnersApiListPartners
|
|
775
775
|
*/
|
|
776
|
-
readonly search?:
|
|
776
|
+
readonly search?: string
|
|
777
777
|
|
|
778
778
|
/**
|
|
779
779
|
* 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>
|
|
@@ -819,17 +819,17 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
819
819
|
|
|
820
820
|
/**
|
|
821
821
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
822
|
-
* @type {
|
|
822
|
+
* @type {number}
|
|
823
823
|
* @memberof PartnersApiListRelationsForPartner
|
|
824
824
|
*/
|
|
825
|
-
readonly pageSize?:
|
|
825
|
+
readonly pageSize?: number
|
|
826
826
|
|
|
827
827
|
/**
|
|
828
|
-
* 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,
|
|
829
|
-
* @type {
|
|
828
|
+
* 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.
|
|
829
|
+
* @type {string}
|
|
830
830
|
* @memberof PartnersApiListRelationsForPartner
|
|
831
831
|
*/
|
|
832
|
-
readonly pageToken?:
|
|
832
|
+
readonly pageToken?: string
|
|
833
833
|
|
|
834
834
|
/**
|
|
835
835
|
* 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>
|
|
@@ -840,10 +840,10 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
840
840
|
|
|
841
841
|
/**
|
|
842
842
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
843
|
-
* @type {
|
|
843
|
+
* @type {string}
|
|
844
844
|
* @memberof PartnersApiListRelationsForPartner
|
|
845
845
|
*/
|
|
846
|
-
readonly search?:
|
|
846
|
+
readonly search?: string
|
|
847
847
|
|
|
848
848
|
/**
|
|
849
849
|
* 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>
|
|
@@ -931,7 +931,7 @@ export interface PartnersApiUpdatePartnerRequest {
|
|
|
931
931
|
*/
|
|
932
932
|
export class PartnersApi extends BaseAPI {
|
|
933
933
|
/**
|
|
934
|
-
* This will create a partner.
|
|
934
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
935
935
|
* @summary Create the partner
|
|
936
936
|
* @param {PartnersApiCreatePartnerRequest} requestParameters Request parameters.
|
|
937
937
|
* @param {*} [options] Override http request option.
|
|
@@ -943,7 +943,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
943
943
|
}
|
|
944
944
|
|
|
945
945
|
/**
|
|
946
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
946
|
+
* 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\"
|
|
947
947
|
* @summary Delete the partner
|
|
948
948
|
* @param {PartnersApiDeletePartnerRequest} requestParameters Request parameters.
|
|
949
949
|
* @param {*} [options] Override http request option.
|
|
@@ -955,7 +955,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
955
955
|
}
|
|
956
956
|
|
|
957
957
|
/**
|
|
958
|
-
* 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.
|
|
958
|
+
* 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\"
|
|
959
959
|
* @summary Retrieve the partner
|
|
960
960
|
* @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
|
|
961
961
|
* @param {*} [options] Override http request option.
|
|
@@ -967,7 +967,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
967
967
|
}
|
|
968
968
|
|
|
969
969
|
/**
|
|
970
|
-
* 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.
|
|
970
|
+
* 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\"
|
|
971
971
|
* @summary List partners
|
|
972
972
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
973
973
|
* @param {*} [options] Override http request option.
|
|
@@ -979,7 +979,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
979
979
|
}
|
|
980
980
|
|
|
981
981
|
/**
|
|
982
|
-
* 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.
|
|
982
|
+
* 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\"
|
|
983
983
|
* @summary List grouped relations for partner
|
|
984
984
|
* @param {PartnersApiListRelationsForPartnerRequest} requestParameters Request parameters.
|
|
985
985
|
* @param {*} [options] Override http request option.
|
|
@@ -991,7 +991,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
991
991
|
}
|
|
992
992
|
|
|
993
993
|
/**
|
|
994
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
994
|
+
* 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\"
|
|
995
995
|
* @summary Update the partner
|
|
996
996
|
* @param {PartnersApiTagPartnerRequest} requestParameters Request parameters.
|
|
997
997
|
* @param {*} [options] Override http request option.
|
|
@@ -1003,7 +1003,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
1003
1003
|
}
|
|
1004
1004
|
|
|
1005
1005
|
/**
|
|
1006
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
1006
|
+
* 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\"
|
|
1007
1007
|
* @summary Update the partner
|
|
1008
1008
|
* @param {PartnersApiUpdatePartnerRequest} requestParameters Request parameters.
|
|
1009
1009
|
* @param {*} [options] Override http request option.
|