@emilgroup/partner-sdk-node 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/partner-relations-api.ts +31 -31
- package/api/partner-types-api.ts +12 -12
- package/api/partner-version-api.ts +4 -4
- package/api/partners-api.ts +12 -12
- package/dist/api/partner-relations-api.d.ts +31 -31
- package/dist/api/partner-relations-api.js +15 -15
- package/dist/api/partner-types-api.d.ts +12 -12
- package/dist/api/partner-types-api.js +11 -11
- package/dist/api/partner-version-api.d.ts +4 -4
- package/dist/api/partner-version-api.js +3 -3
- package/dist/api/partners-api.d.ts +12 -12
- package/dist/api/partners-api.js +11 -11
- package/dist/models/partner-relation-type-class.d.ts +1 -1
- package/models/partner-relation-type-class.ts +1 -1
- package/package.json +1 -4
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/partner-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/partner-sdk-node@1.1.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/partner-sdk-node@1.1.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -81,15 +81,15 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
81
81
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
82
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
83
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
84
|
-
* @param {
|
|
85
|
-
* @param {any} [search]
|
|
86
|
-
* @param {
|
|
87
|
-
* @param {
|
|
88
|
-
* @param {
|
|
84
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
85
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
86
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
87
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
88
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
90
90
|
* @throws {RequiredError}
|
|
91
91
|
*/
|
|
92
|
-
listPartnerVersion: async (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
92
|
+
listPartnerVersion: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
93
|
const localVarPath = `/partnerservice/v1/partners/relations/types`;
|
|
94
94
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
95
95
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -179,15 +179,15 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
179
179
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
180
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
181
181
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
182
|
-
* @param {
|
|
183
|
-
* @param {any} [search]
|
|
184
|
-
* @param {
|
|
185
|
-
* @param {
|
|
186
|
-
* @param {
|
|
182
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
183
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
184
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
185
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
186
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
187
187
|
* @param {*} [options] Override http request option.
|
|
188
188
|
* @throws {RequiredError}
|
|
189
189
|
*/
|
|
190
|
-
async listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
190
|
+
async listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>> {
|
|
191
191
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
192
192
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
193
193
|
},
|
|
@@ -218,15 +218,15 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
218
218
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
219
219
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
220
220
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
221
|
-
* @param {
|
|
222
|
-
* @param {any} [search]
|
|
223
|
-
* @param {
|
|
224
|
-
* @param {
|
|
225
|
-
* @param {
|
|
221
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
222
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
223
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
224
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
225
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
226
226
|
* @param {*} [options] Override http request option.
|
|
227
227
|
* @throws {RequiredError}
|
|
228
228
|
*/
|
|
229
|
-
listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
229
|
+
listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
|
|
230
230
|
return localVarFp.listPartnerVersion(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
231
231
|
},
|
|
232
232
|
};
|
|
@@ -281,39 +281,39 @@ export interface PartnerRelationsApiListPartnerVersionRequest {
|
|
|
281
281
|
readonly pageToken?: any
|
|
282
282
|
|
|
283
283
|
/**
|
|
284
|
-
* Filter the response by one or multiple fields
|
|
285
|
-
* @type {
|
|
284
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
285
|
+
* @type {string}
|
|
286
286
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
287
287
|
*/
|
|
288
|
-
readonly filter?:
|
|
288
|
+
readonly filter?: string
|
|
289
289
|
|
|
290
290
|
/**
|
|
291
|
-
*
|
|
291
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
292
292
|
* @type {any}
|
|
293
293
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
294
294
|
*/
|
|
295
295
|
readonly search?: any
|
|
296
296
|
|
|
297
297
|
/**
|
|
298
|
-
* Order
|
|
299
|
-
* @type {
|
|
298
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
299
|
+
* @type {string}
|
|
300
300
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
301
301
|
*/
|
|
302
|
-
readonly order?:
|
|
302
|
+
readonly order?: string
|
|
303
303
|
|
|
304
304
|
/**
|
|
305
|
-
*
|
|
306
|
-
* @type {
|
|
305
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
306
|
+
* @type {string}
|
|
307
307
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
308
308
|
*/
|
|
309
|
-
readonly expand?:
|
|
309
|
+
readonly expand?: string
|
|
310
310
|
|
|
311
311
|
/**
|
|
312
|
-
* Filters the response by one or multiple fields.
|
|
313
|
-
* @type {
|
|
312
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
313
|
+
* @type {string}
|
|
314
314
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
315
315
|
*/
|
|
316
|
-
readonly filters?:
|
|
316
|
+
readonly filters?: string
|
|
317
317
|
}
|
|
318
318
|
|
|
319
319
|
/**
|
package/api/partner-types-api.ts
CHANGED
|
@@ -133,7 +133,7 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
|
|
|
133
133
|
};
|
|
134
134
|
},
|
|
135
135
|
/**
|
|
136
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
136
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
137
137
|
* @summary Retrieve the partner-types
|
|
138
138
|
* @param {string} code Unique identifier for the object.
|
|
139
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -183,13 +183,13 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
|
|
|
183
183
|
};
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* Returns a list of partner-types you have previously created.
|
|
186
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
187
187
|
* @summary List partner-types
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
189
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
190
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
191
191
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
192
|
-
* @param {any} [search]
|
|
192
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
193
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
194
194
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
195
195
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -344,7 +344,7 @@ export const PartnerTypesApiFp = function(configuration?: Configuration) {
|
|
|
344
344
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
345
345
|
},
|
|
346
346
|
/**
|
|
347
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
347
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
348
348
|
* @summary Retrieve the partner-types
|
|
349
349
|
* @param {string} code Unique identifier for the object.
|
|
350
350
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -357,13 +357,13 @@ export const PartnerTypesApiFp = function(configuration?: Configuration) {
|
|
|
357
357
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
358
358
|
},
|
|
359
359
|
/**
|
|
360
|
-
* Returns a list of partner-types you have previously created.
|
|
360
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
361
361
|
* @summary List partner-types
|
|
362
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
363
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
364
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
365
365
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
366
|
-
* @param {any} [search]
|
|
366
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
367
367
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
368
368
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
369
369
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -420,7 +420,7 @@ export const PartnerTypesApiFactory = function (configuration?: Configuration, b
|
|
|
420
420
|
return localVarFp.deletePartnerType(code, authorization, options).then((request) => request(axios, basePath));
|
|
421
421
|
},
|
|
422
422
|
/**
|
|
423
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
423
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
424
424
|
* @summary Retrieve the partner-types
|
|
425
425
|
* @param {string} code Unique identifier for the object.
|
|
426
426
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -432,13 +432,13 @@ export const PartnerTypesApiFactory = function (configuration?: Configuration, b
|
|
|
432
432
|
return localVarFp.getPartnerType(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
433
433
|
},
|
|
434
434
|
/**
|
|
435
|
-
* Returns a list of partner-types you have previously created.
|
|
435
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
436
436
|
* @summary List partner-types
|
|
437
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
438
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
439
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
440
440
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
441
|
-
* @param {any} [search]
|
|
441
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
442
442
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
443
443
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
444
444
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -568,7 +568,7 @@ export interface PartnerTypesApiListPartnerTypesRequest {
|
|
|
568
568
|
readonly filter?: any
|
|
569
569
|
|
|
570
570
|
/**
|
|
571
|
-
*
|
|
571
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
572
572
|
* @type {any}
|
|
573
573
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
574
574
|
*/
|
|
@@ -656,7 +656,7 @@ export class PartnerTypesApi extends BaseAPI {
|
|
|
656
656
|
}
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
659
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
660
660
|
* @summary Retrieve the partner-types
|
|
661
661
|
* @param {PartnerTypesApiGetPartnerTypeRequest} requestParameters Request parameters.
|
|
662
662
|
* @param {*} [options] Override http request option.
|
|
@@ -668,7 +668,7 @@ export class PartnerTypesApi extends BaseAPI {
|
|
|
668
668
|
}
|
|
669
669
|
|
|
670
670
|
/**
|
|
671
|
-
* Returns a list of partner-types you have previously created.
|
|
671
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
672
672
|
* @summary List partner-types
|
|
673
673
|
* @param {PartnerTypesApiListPartnerTypesRequest} requestParameters Request parameters.
|
|
674
674
|
* @param {*} [options] Override http request option.
|
|
@@ -87,7 +87,7 @@ export const PartnerVersionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
87
87
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
88
88
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
89
89
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
90
|
-
* @param {any} [search]
|
|
90
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
91
91
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
92
92
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
93
93
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -190,7 +190,7 @@ export const PartnerVersionApiFp = function(configuration?: Configuration) {
|
|
|
190
190
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
191
191
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
192
192
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
193
|
-
* @param {any} [search]
|
|
193
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
194
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
195
195
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
196
196
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -231,7 +231,7 @@ export const PartnerVersionApiFactory = function (configuration?: Configuration,
|
|
|
231
231
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
232
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
233
233
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
234
|
-
* @param {any} [search]
|
|
234
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
235
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
236
236
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
237
237
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -314,7 +314,7 @@ export interface PartnerVersionApiListPartnerVersionRequest {
|
|
|
314
314
|
readonly filter?: any
|
|
315
315
|
|
|
316
316
|
/**
|
|
317
|
-
*
|
|
317
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
318
318
|
* @type {any}
|
|
319
319
|
* @memberof PartnerVersionApiListPartnerVersion
|
|
320
320
|
*/
|
package/api/partners-api.ts
CHANGED
|
@@ -133,7 +133,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
133
133
|
};
|
|
134
134
|
},
|
|
135
135
|
/**
|
|
136
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
136
|
+
* 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.
|
|
137
137
|
* @summary Retrieve the partner
|
|
138
138
|
* @param {string} code Unique identifier for the object.
|
|
139
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -183,13 +183,13 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
183
183
|
};
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* Returns a list of partners you have previously created.
|
|
186
|
+
* 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.
|
|
187
187
|
* @summary List partners
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
189
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
190
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
191
191
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
192
|
-
* @param {any} [search]
|
|
192
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
193
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
194
194
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
195
195
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -344,7 +344,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
344
344
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
345
345
|
},
|
|
346
346
|
/**
|
|
347
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
347
|
+
* 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.
|
|
348
348
|
* @summary Retrieve the partner
|
|
349
349
|
* @param {string} code Unique identifier for the object.
|
|
350
350
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -357,13 +357,13 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
357
357
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
358
358
|
},
|
|
359
359
|
/**
|
|
360
|
-
* Returns a list of partners you have previously created.
|
|
360
|
+
* 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.
|
|
361
361
|
* @summary List partners
|
|
362
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
363
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
364
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
365
365
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
366
|
-
* @param {any} [search]
|
|
366
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
367
367
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
368
368
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
369
369
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -420,7 +420,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
420
420
|
return localVarFp.deletePartner(code, authorization, options).then((request) => request(axios, basePath));
|
|
421
421
|
},
|
|
422
422
|
/**
|
|
423
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
423
|
+
* 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.
|
|
424
424
|
* @summary Retrieve the partner
|
|
425
425
|
* @param {string} code Unique identifier for the object.
|
|
426
426
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -432,13 +432,13 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
432
432
|
return localVarFp.getPartner(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
433
433
|
},
|
|
434
434
|
/**
|
|
435
|
-
* Returns a list of partners you have previously created.
|
|
435
|
+
* 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.
|
|
436
436
|
* @summary List partners
|
|
437
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
438
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
439
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
440
440
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
441
|
-
* @param {any} [search]
|
|
441
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
442
442
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
443
443
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
444
444
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -568,7 +568,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
568
568
|
readonly filter?: any
|
|
569
569
|
|
|
570
570
|
/**
|
|
571
|
-
*
|
|
571
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
572
572
|
* @type {any}
|
|
573
573
|
* @memberof PartnersApiListPartners
|
|
574
574
|
*/
|
|
@@ -656,7 +656,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
656
656
|
}
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
659
|
+
* 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.
|
|
660
660
|
* @summary Retrieve the partner
|
|
661
661
|
* @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
|
|
662
662
|
* @param {*} [options] Override http request option.
|
|
@@ -668,7 +668,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
668
668
|
}
|
|
669
669
|
|
|
670
670
|
/**
|
|
671
|
-
* Returns a list of partners you have previously created.
|
|
671
|
+
* 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.
|
|
672
672
|
* @summary List partners
|
|
673
673
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
674
674
|
* @param {*} [options] Override http request option.
|
|
@@ -34,15 +34,15 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
34
34
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
35
35
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
36
36
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
37
|
-
* @param {
|
|
38
|
-
* @param {any} [search]
|
|
39
|
-
* @param {
|
|
40
|
-
* @param {
|
|
41
|
-
* @param {
|
|
37
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
38
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
39
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
40
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
41
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
|
-
listPartnerVersion: (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
45
|
+
listPartnerVersion: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
};
|
|
47
47
|
/**
|
|
48
48
|
* PartnerRelationsApi - functional programming interface
|
|
@@ -64,15 +64,15 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
64
64
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
65
65
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
66
66
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
67
|
-
* @param {
|
|
68
|
-
* @param {any} [search]
|
|
69
|
-
* @param {
|
|
70
|
-
* @param {
|
|
71
|
-
* @param {
|
|
67
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
68
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
69
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
70
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
71
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
72
72
|
* @param {*} [options] Override http request option.
|
|
73
73
|
* @throws {RequiredError}
|
|
74
74
|
*/
|
|
75
|
-
listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
75
|
+
listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>>;
|
|
76
76
|
};
|
|
77
77
|
/**
|
|
78
78
|
* PartnerRelationsApi - factory interface
|
|
@@ -94,15 +94,15 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
94
94
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
95
95
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
96
96
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
97
|
-
* @param {
|
|
98
|
-
* @param {any} [search]
|
|
99
|
-
* @param {
|
|
100
|
-
* @param {
|
|
101
|
-
* @param {
|
|
97
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
98
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
99
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
100
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
101
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
102
102
|
* @param {*} [options] Override http request option.
|
|
103
103
|
* @throws {RequiredError}
|
|
104
104
|
*/
|
|
105
|
-
listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
105
|
+
listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass>;
|
|
106
106
|
};
|
|
107
107
|
/**
|
|
108
108
|
* Request parameters for getPartnerRelationType operation in PartnerRelationsApi.
|
|
@@ -148,35 +148,35 @@ export interface PartnerRelationsApiListPartnerVersionRequest {
|
|
|
148
148
|
*/
|
|
149
149
|
readonly pageToken?: any;
|
|
150
150
|
/**
|
|
151
|
-
* Filter the response by one or multiple fields
|
|
152
|
-
* @type {
|
|
151
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
152
|
+
* @type {string}
|
|
153
153
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
154
154
|
*/
|
|
155
|
-
readonly filter?:
|
|
155
|
+
readonly filter?: string;
|
|
156
156
|
/**
|
|
157
|
-
*
|
|
157
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
158
158
|
* @type {any}
|
|
159
159
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
160
160
|
*/
|
|
161
161
|
readonly search?: any;
|
|
162
162
|
/**
|
|
163
|
-
* Order
|
|
164
|
-
* @type {
|
|
163
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
164
|
+
* @type {string}
|
|
165
165
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
166
166
|
*/
|
|
167
|
-
readonly order?:
|
|
167
|
+
readonly order?: string;
|
|
168
168
|
/**
|
|
169
|
-
*
|
|
170
|
-
* @type {
|
|
169
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
170
|
+
* @type {string}
|
|
171
171
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
172
172
|
*/
|
|
173
|
-
readonly expand?:
|
|
173
|
+
readonly expand?: string;
|
|
174
174
|
/**
|
|
175
|
-
* Filters the response by one or multiple fields.
|
|
176
|
-
* @type {
|
|
175
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
176
|
+
* @type {string}
|
|
177
177
|
* @memberof PartnerRelationsApiListPartnerVersion
|
|
178
178
|
*/
|
|
179
|
-
readonly filters?:
|
|
179
|
+
readonly filters?: string;
|
|
180
180
|
}
|
|
181
181
|
/**
|
|
182
182
|
* PartnerRelationsApi - object-oriented interface
|
|
@@ -146,11 +146,11 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
147
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
148
148
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
149
|
-
* @param {
|
|
150
|
-
* @param {any} [search]
|
|
151
|
-
* @param {
|
|
152
|
-
* @param {
|
|
153
|
-
* @param {
|
|
149
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
150
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
151
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
152
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
153
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
154
154
|
* @param {*} [options] Override http request option.
|
|
155
155
|
* @throws {RequiredError}
|
|
156
156
|
*/
|
|
@@ -249,11 +249,11 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
250
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
252
|
-
* @param {
|
|
253
|
-
* @param {any} [search]
|
|
254
|
-
* @param {
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
253
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
255
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
256
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -297,11 +297,11 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
297
297
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
298
298
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
299
299
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
300
|
-
* @param {
|
|
301
|
-
* @param {any} [search]
|
|
302
|
-
* @param {
|
|
303
|
-
* @param {
|
|
304
|
-
* @param {
|
|
300
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
301
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
302
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
303
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
304
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
305
305
|
* @param {*} [options] Override http request option.
|
|
306
306
|
* @throws {RequiredError}
|
|
307
307
|
*/
|
|
@@ -43,7 +43,7 @@ export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configur
|
|
|
43
43
|
*/
|
|
44
44
|
deletePartnerType: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
46
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
47
47
|
* @summary Retrieve the partner-types
|
|
48
48
|
* @param {string} code Unique identifier for the object.
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -53,13 +53,13 @@ export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configur
|
|
|
53
53
|
*/
|
|
54
54
|
getPartnerType: (code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of partner-types you have previously created.
|
|
56
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
57
57
|
* @summary List partner-types
|
|
58
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
59
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
60
60
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
61
61
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
62
|
-
* @param {any} [search]
|
|
62
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
63
63
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
64
64
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
65
65
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -102,7 +102,7 @@ export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
|
|
|
102
102
|
*/
|
|
103
103
|
deletePartnerType(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
104
104
|
/**
|
|
105
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
105
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
106
106
|
* @summary Retrieve the partner-types
|
|
107
107
|
* @param {string} code Unique identifier for the object.
|
|
108
108
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -112,13 +112,13 @@ export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
|
|
|
112
112
|
*/
|
|
113
113
|
getPartnerType(code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerTypeResponseClass>>;
|
|
114
114
|
/**
|
|
115
|
-
* Returns a list of partner-types you have previously created.
|
|
115
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
116
116
|
* @summary List partner-types
|
|
117
117
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
118
118
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
119
119
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
120
120
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
121
|
-
* @param {any} [search]
|
|
121
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
122
122
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
123
123
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
124
124
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -161,7 +161,7 @@ export declare const PartnerTypesApiFactory: (configuration?: Configuration, bas
|
|
|
161
161
|
*/
|
|
162
162
|
deletePartnerType(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
163
163
|
/**
|
|
164
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
164
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
165
165
|
* @summary Retrieve the partner-types
|
|
166
166
|
* @param {string} code Unique identifier for the object.
|
|
167
167
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -171,13 +171,13 @@ export declare const PartnerTypesApiFactory: (configuration?: Configuration, bas
|
|
|
171
171
|
*/
|
|
172
172
|
getPartnerType(code: string, authorization?: string, expand?: any, options?: any): AxiosPromise<GetPartnerTypeResponseClass>;
|
|
173
173
|
/**
|
|
174
|
-
* Returns a list of partner-types you have previously created.
|
|
174
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
175
175
|
* @summary List partner-types
|
|
176
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
177
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
178
178
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
179
179
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
180
|
-
* @param {any} [search]
|
|
180
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
181
181
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
182
182
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
183
183
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -290,7 +290,7 @@ export interface PartnerTypesApiListPartnerTypesRequest {
|
|
|
290
290
|
*/
|
|
291
291
|
readonly filter?: any;
|
|
292
292
|
/**
|
|
293
|
-
*
|
|
293
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
294
294
|
* @type {any}
|
|
295
295
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
296
296
|
*/
|
|
@@ -365,7 +365,7 @@ export declare class PartnerTypesApi extends BaseAPI {
|
|
|
365
365
|
*/
|
|
366
366
|
deletePartnerType(requestParameters: PartnerTypesApiDeletePartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
367
367
|
/**
|
|
368
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
368
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
369
369
|
* @summary Retrieve the partner-types
|
|
370
370
|
* @param {PartnerTypesApiGetPartnerTypeRequest} requestParameters Request parameters.
|
|
371
371
|
* @param {*} [options] Override http request option.
|
|
@@ -374,7 +374,7 @@ export declare class PartnerTypesApi extends BaseAPI {
|
|
|
374
374
|
*/
|
|
375
375
|
getPartnerType(requestParameters: PartnerTypesApiGetPartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerTypeResponseClass, any>>;
|
|
376
376
|
/**
|
|
377
|
-
* Returns a list of partner-types you have previously created.
|
|
377
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
378
378
|
* @summary List partner-types
|
|
379
379
|
* @param {PartnerTypesApiListPartnerTypesRequest} requestParameters Request parameters.
|
|
380
380
|
* @param {*} [options] Override http request option.
|
|
@@ -190,7 +190,7 @@ var PartnerTypesApiAxiosParamCreator = function (configuration) {
|
|
|
190
190
|
});
|
|
191
191
|
},
|
|
192
192
|
/**
|
|
193
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
193
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
194
194
|
* @summary Retrieve the partner-types
|
|
195
195
|
* @param {string} code Unique identifier for the object.
|
|
196
196
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -242,13 +242,13 @@ var PartnerTypesApiAxiosParamCreator = function (configuration) {
|
|
|
242
242
|
});
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
245
|
-
* Returns a list of partner-types you have previously created.
|
|
245
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
246
246
|
* @summary List partner-types
|
|
247
247
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
248
248
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
249
249
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
250
250
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
251
|
-
* @param {any} [search]
|
|
251
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
252
252
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
253
253
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
254
254
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -419,7 +419,7 @@ var PartnerTypesApiFp = function (configuration) {
|
|
|
419
419
|
});
|
|
420
420
|
},
|
|
421
421
|
/**
|
|
422
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
422
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
423
423
|
* @summary Retrieve the partner-types
|
|
424
424
|
* @param {string} code Unique identifier for the object.
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -441,13 +441,13 @@ var PartnerTypesApiFp = function (configuration) {
|
|
|
441
441
|
});
|
|
442
442
|
},
|
|
443
443
|
/**
|
|
444
|
-
* Returns a list of partner-types you have previously created.
|
|
444
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
445
445
|
* @summary List partner-types
|
|
446
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
447
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
448
448
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
449
449
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
450
|
-
* @param {any} [search]
|
|
450
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
451
451
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
452
452
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
453
453
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -522,7 +522,7 @@ var PartnerTypesApiFactory = function (configuration, basePath, axios) {
|
|
|
522
522
|
return localVarFp.deletePartnerType(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
523
523
|
},
|
|
524
524
|
/**
|
|
525
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
525
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
526
526
|
* @summary Retrieve the partner-types
|
|
527
527
|
* @param {string} code Unique identifier for the object.
|
|
528
528
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -534,13 +534,13 @@ var PartnerTypesApiFactory = function (configuration, basePath, axios) {
|
|
|
534
534
|
return localVarFp.getPartnerType(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
535
535
|
},
|
|
536
536
|
/**
|
|
537
|
-
* Returns a list of partner-types you have previously created.
|
|
537
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
538
538
|
* @summary List partner-types
|
|
539
539
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
540
540
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
541
541
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
542
542
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
543
|
-
* @param {any} [search]
|
|
543
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
544
544
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
545
545
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
546
546
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -601,7 +601,7 @@ var PartnerTypesApi = /** @class */ (function (_super) {
|
|
|
601
601
|
return (0, exports.PartnerTypesApiFp)(this.configuration).deletePartnerType(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
602
602
|
};
|
|
603
603
|
/**
|
|
604
|
-
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code
|
|
604
|
+
* Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
|
|
605
605
|
* @summary Retrieve the partner-types
|
|
606
606
|
* @param {PartnerTypesApiGetPartnerTypeRequest} requestParameters Request parameters.
|
|
607
607
|
* @param {*} [options] Override http request option.
|
|
@@ -613,7 +613,7 @@ var PartnerTypesApi = /** @class */ (function (_super) {
|
|
|
613
613
|
return (0, exports.PartnerTypesApiFp)(this.configuration).getPartnerType(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
614
614
|
};
|
|
615
615
|
/**
|
|
616
|
-
* Returns a list of partner-types you have previously created.
|
|
616
|
+
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
617
617
|
* @summary List partner-types
|
|
618
618
|
* @param {PartnerTypesApiListPartnerTypesRequest} requestParameters Request parameters.
|
|
619
619
|
* @param {*} [options] Override http request option.
|
|
@@ -37,7 +37,7 @@ export declare const PartnerVersionApiAxiosParamCreator: (configuration?: Config
|
|
|
37
37
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
38
38
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
39
39
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
40
|
-
* @param {any} [search]
|
|
40
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
41
41
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
42
42
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
43
43
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -69,7 +69,7 @@ export declare const PartnerVersionApiFp: (configuration?: Configuration) => {
|
|
|
69
69
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
70
70
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
71
71
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
72
|
-
* @param {any} [search]
|
|
72
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
73
73
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
74
74
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
75
75
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -101,7 +101,7 @@ export declare const PartnerVersionApiFactory: (configuration?: Configuration, b
|
|
|
101
101
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
102
102
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
103
103
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
104
|
-
* @param {any} [search]
|
|
104
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
105
105
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
106
106
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
107
107
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -172,7 +172,7 @@ export interface PartnerVersionApiListPartnerVersionRequest {
|
|
|
172
172
|
*/
|
|
173
173
|
readonly filter?: any;
|
|
174
174
|
/**
|
|
175
|
-
*
|
|
175
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
176
176
|
* @type {any}
|
|
177
177
|
* @memberof PartnerVersionApiListPartnerVersion
|
|
178
178
|
*/
|
|
@@ -152,7 +152,7 @@ var PartnerVersionApiAxiosParamCreator = function (configuration) {
|
|
|
152
152
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
153
153
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
154
154
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
155
|
-
* @param {any} [search]
|
|
155
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
156
156
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
157
157
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
158
158
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -260,7 +260,7 @@ var PartnerVersionApiFp = function (configuration) {
|
|
|
260
260
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
261
261
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
262
262
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
263
|
-
* @param {any} [search]
|
|
263
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
264
264
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
265
265
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
266
266
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -310,7 +310,7 @@ var PartnerVersionApiFactory = function (configuration, basePath, axios) {
|
|
|
310
310
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
311
311
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
312
312
|
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
313
|
-
* @param {any} [search]
|
|
313
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
314
314
|
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
315
315
|
* @param {'partnerType'} [expand] Allowed expands for the partner version
|
|
316
316
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -43,7 +43,7 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
43
43
|
*/
|
|
44
44
|
deletePartner: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
46
|
+
* 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.
|
|
47
47
|
* @summary Retrieve the partner
|
|
48
48
|
* @param {string} code Unique identifier for the object.
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -53,13 +53,13 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
53
53
|
*/
|
|
54
54
|
getPartner: (code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of partners you have previously created.
|
|
56
|
+
* 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.
|
|
57
57
|
* @summary List partners
|
|
58
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
59
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
60
60
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
61
61
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
62
|
-
* @param {any} [search]
|
|
62
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
63
63
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
64
64
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
65
65
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -102,7 +102,7 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
102
102
|
*/
|
|
103
103
|
deletePartner(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
104
104
|
/**
|
|
105
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
105
|
+
* 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.
|
|
106
106
|
* @summary Retrieve the partner
|
|
107
107
|
* @param {string} code Unique identifier for the object.
|
|
108
108
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -112,13 +112,13 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
112
112
|
*/
|
|
113
113
|
getPartner(code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerResponseClass>>;
|
|
114
114
|
/**
|
|
115
|
-
* Returns a list of partners you have previously created.
|
|
115
|
+
* 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.
|
|
116
116
|
* @summary List partners
|
|
117
117
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
118
118
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
119
119
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
120
120
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
121
|
-
* @param {any} [search]
|
|
121
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
122
122
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
123
123
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
124
124
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -161,7 +161,7 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
161
161
|
*/
|
|
162
162
|
deletePartner(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
163
163
|
/**
|
|
164
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
164
|
+
* 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.
|
|
165
165
|
* @summary Retrieve the partner
|
|
166
166
|
* @param {string} code Unique identifier for the object.
|
|
167
167
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -171,13 +171,13 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
171
171
|
*/
|
|
172
172
|
getPartner(code: string, authorization?: string, expand?: any, options?: any): AxiosPromise<GetPartnerResponseClass>;
|
|
173
173
|
/**
|
|
174
|
-
* Returns a list of partners you have previously created.
|
|
174
|
+
* 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.
|
|
175
175
|
* @summary List partners
|
|
176
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
177
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
178
178
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
179
179
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
180
|
-
* @param {any} [search]
|
|
180
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
181
181
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
182
182
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
183
183
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -290,7 +290,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
290
290
|
*/
|
|
291
291
|
readonly filter?: any;
|
|
292
292
|
/**
|
|
293
|
-
*
|
|
293
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
294
294
|
* @type {any}
|
|
295
295
|
* @memberof PartnersApiListPartners
|
|
296
296
|
*/
|
|
@@ -365,7 +365,7 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
365
365
|
*/
|
|
366
366
|
deletePartner(requestParameters: PartnersApiDeletePartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
367
367
|
/**
|
|
368
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
368
|
+
* 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.
|
|
369
369
|
* @summary Retrieve the partner
|
|
370
370
|
* @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
|
|
371
371
|
* @param {*} [options] Override http request option.
|
|
@@ -374,7 +374,7 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
374
374
|
*/
|
|
375
375
|
getPartner(requestParameters: PartnersApiGetPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerResponseClass, any>>;
|
|
376
376
|
/**
|
|
377
|
-
* Returns a list of partners you have previously created.
|
|
377
|
+
* 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.
|
|
378
378
|
* @summary List partners
|
|
379
379
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
380
380
|
* @param {*} [options] Override http request option.
|
package/dist/api/partners-api.js
CHANGED
|
@@ -190,7 +190,7 @@ var PartnersApiAxiosParamCreator = function (configuration) {
|
|
|
190
190
|
});
|
|
191
191
|
},
|
|
192
192
|
/**
|
|
193
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
193
|
+
* 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.
|
|
194
194
|
* @summary Retrieve the partner
|
|
195
195
|
* @param {string} code Unique identifier for the object.
|
|
196
196
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -242,13 +242,13 @@ var PartnersApiAxiosParamCreator = function (configuration) {
|
|
|
242
242
|
});
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
245
|
-
* Returns a list of partners you have previously created.
|
|
245
|
+
* 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.
|
|
246
246
|
* @summary List partners
|
|
247
247
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
248
248
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
249
249
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
250
250
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
251
|
-
* @param {any} [search]
|
|
251
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
252
252
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
253
253
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
254
254
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -419,7 +419,7 @@ var PartnersApiFp = function (configuration) {
|
|
|
419
419
|
});
|
|
420
420
|
},
|
|
421
421
|
/**
|
|
422
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
422
|
+
* 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.
|
|
423
423
|
* @summary Retrieve the partner
|
|
424
424
|
* @param {string} code Unique identifier for the object.
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -441,13 +441,13 @@ var PartnersApiFp = function (configuration) {
|
|
|
441
441
|
});
|
|
442
442
|
},
|
|
443
443
|
/**
|
|
444
|
-
* Returns a list of partners you have previously created.
|
|
444
|
+
* 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.
|
|
445
445
|
* @summary List partners
|
|
446
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
447
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
448
448
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
449
449
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
450
|
-
* @param {any} [search]
|
|
450
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
451
451
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
452
452
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
453
453
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -522,7 +522,7 @@ var PartnersApiFactory = function (configuration, basePath, axios) {
|
|
|
522
522
|
return localVarFp.deletePartner(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
523
523
|
},
|
|
524
524
|
/**
|
|
525
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
525
|
+
* 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.
|
|
526
526
|
* @summary Retrieve the partner
|
|
527
527
|
* @param {string} code Unique identifier for the object.
|
|
528
528
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -534,13 +534,13 @@ var PartnersApiFactory = function (configuration, basePath, axios) {
|
|
|
534
534
|
return localVarFp.getPartner(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
535
535
|
},
|
|
536
536
|
/**
|
|
537
|
-
* Returns a list of partners you have previously created.
|
|
537
|
+
* 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.
|
|
538
538
|
* @summary List partners
|
|
539
539
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
540
540
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
541
541
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
542
542
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
543
|
-
* @param {any} [search]
|
|
543
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
544
544
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
545
545
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
546
546
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -601,7 +601,7 @@ var PartnersApi = /** @class */ (function (_super) {
|
|
|
601
601
|
return (0, exports.PartnersApiFp)(this.configuration).deletePartner(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
602
602
|
};
|
|
603
603
|
/**
|
|
604
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
604
|
+
* 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.
|
|
605
605
|
* @summary Retrieve the partner
|
|
606
606
|
* @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
|
|
607
607
|
* @param {*} [options] Override http request option.
|
|
@@ -613,7 +613,7 @@ var PartnersApi = /** @class */ (function (_super) {
|
|
|
613
613
|
return (0, exports.PartnersApiFp)(this.configuration).getPartner(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
614
614
|
};
|
|
615
615
|
/**
|
|
616
|
-
* Returns a list of partners you have previously created.
|
|
616
|
+
* 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.
|
|
617
617
|
* @summary List partners
|
|
618
618
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
619
619
|
* @param {*} [options] Override http request option.
|
|
@@ -22,7 +22,7 @@ export interface PartnerRelationTypeClass {
|
|
|
22
22
|
*/
|
|
23
23
|
'id': number;
|
|
24
24
|
/**
|
|
25
|
-
* A slug is a human-readable, unique identifier, used to identify a resource
|
|
25
|
+
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof PartnerRelationTypeClass
|
|
28
28
|
*/
|
|
@@ -27,7 +27,7 @@ export interface PartnerRelationTypeClass {
|
|
|
27
27
|
*/
|
|
28
28
|
'id': number;
|
|
29
29
|
/**
|
|
30
|
-
* A slug is a human-readable, unique identifier, used to identify a resource
|
|
30
|
+
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof PartnerRelationTypeClass
|
|
33
33
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@emilgroup/partner-sdk-node",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "OpenAPI client for @emilgroup/partner-sdk-node",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"keywords": [
|
|
@@ -22,8 +22,5 @@
|
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"typescript": "^4.0"
|
|
25
|
-
},
|
|
26
|
-
"volta": {
|
|
27
|
-
"node": "16.20.2"
|
|
28
25
|
}
|
|
29
26
|
}
|