@emilgroup/partner-sdk 1.4.0 → 1.5.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 +8 -8
- package/api/partner-tags-api.ts +8 -8
- package/api/partner-types-api.ts +4 -4
- package/api/partner-version-api.ts +4 -4
- package/api/partners-api.ts +8 -8
- package/base.ts +3 -3
- package/dist/api/partner-relations-api.d.ts +8 -8
- package/dist/api/partner-relations-api.js +6 -6
- package/dist/api/partner-tags-api.d.ts +8 -8
- package/dist/api/partner-tags-api.js +7 -7
- package/dist/api/partner-types-api.d.ts +4 -4
- package/dist/api/partner-types-api.js +4 -4
- 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 +8 -8
- package/dist/api/partners-api.js +7 -7
- package/dist/base.d.ts +2 -2
- package/dist/base.js +1 -2
- package/dist/models/create-partner-type-response-class.d.ts +1 -1
- package/dist/models/get-partner-type-response-class.d.ts +1 -1
- package/dist/models/get-partner-version-response-class.d.ts +3 -3
- package/dist/models/list-partner-relation-class.d.ts +1 -1
- package/dist/models/list-partner-relation-types-class.d.ts +1 -1
- package/dist/models/list-partner-types-response-class.d.ts +1 -1
- package/dist/models/list-partner-versions-response-class.d.ts +7 -1
- package/dist/models/list-partners-response-class.d.ts +1 -1
- package/dist/models/partner-class.d.ts +12 -6
- package/dist/models/partner-relation-class.d.ts +12 -0
- package/dist/models/partner-relation-type-class.d.ts +12 -0
- package/dist/models/partner-type-class.d.ts +12 -0
- package/dist/models/tag-class.d.ts +12 -0
- package/dist/models/update-partner-type-response-class.d.ts +1 -1
- package/models/create-partner-type-response-class.ts +1 -1
- package/models/get-partner-type-response-class.ts +1 -1
- package/models/get-partner-version-response-class.ts +3 -3
- package/models/list-partner-relation-class.ts +1 -1
- package/models/list-partner-relation-types-class.ts +1 -1
- package/models/list-partner-types-response-class.ts +1 -1
- package/models/list-partner-versions-response-class.ts +7 -1
- package/models/list-partners-response-class.ts +1 -1
- package/models/partner-class.ts +12 -6
- package/models/partner-relation-class.ts +12 -0
- package/models/partner-relation-type-class.ts +12 -0
- package/models/partner-type-class.ts +12 -0
- package/models/tag-class.ts +12 -0
- package/models/update-partner-type-response-class.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/partner-sdk@1.
|
|
20
|
+
npm install @emilgroup/partner-sdk@1.5.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk@1.
|
|
24
|
+
yarn add @emilgroup/partner-sdk@1.5.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -233,7 +233,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
233
233
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
234
234
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
235
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
236
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
236
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: <i>
|
|
237
237
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality</i>
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
@@ -309,7 +309,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
309
309
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
310
310
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
311
311
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
312
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
312
|
+
* @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: partnerRelationType<i>
|
|
313
313
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
314
314
|
* @param {*} [options] Override http request option.
|
|
315
315
|
* @throws {RequiredError}
|
|
@@ -494,7 +494,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
494
494
|
* @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>
|
|
495
495
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
496
496
|
* @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>
|
|
497
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
497
|
+
* @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>
|
|
498
498
|
* @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>
|
|
499
499
|
* @param {*} [options] Override http request option.
|
|
500
500
|
* @throws {RequiredError}
|
|
@@ -512,7 +512,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
512
512
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
513
513
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
514
514
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
515
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
515
|
+
* @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: partnerRelationType<i>
|
|
516
516
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
517
517
|
* @param {*} [options] Override http request option.
|
|
518
518
|
* @throws {RequiredError}
|
|
@@ -597,7 +597,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
597
597
|
* @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>
|
|
598
598
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
599
599
|
* @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>
|
|
600
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
600
|
+
* @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>
|
|
601
601
|
* @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>
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
603
603
|
* @throws {RequiredError}
|
|
@@ -614,7 +614,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
614
614
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
615
615
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
616
616
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
617
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
617
|
+
* @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: partnerRelationType<i>
|
|
618
618
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
619
619
|
* @param {*} [options] Override http request option.
|
|
620
620
|
* @throws {RequiredError}
|
|
@@ -770,7 +770,7 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
770
770
|
readonly order?: string
|
|
771
771
|
|
|
772
772
|
/**
|
|
773
|
-
* Expand to fetch additional information about the list items.
|
|
773
|
+
* 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>
|
|
774
774
|
* @type {string}
|
|
775
775
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
776
776
|
*/
|
|
@@ -833,7 +833,7 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
833
833
|
readonly order?: string
|
|
834
834
|
|
|
835
835
|
/**
|
|
836
|
-
* Expand to fetch additional information about the list items.
|
|
836
|
+
* 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: partnerRelationType<i>
|
|
837
837
|
* @type {string}
|
|
838
838
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
839
839
|
*/
|
package/api/partner-tags-api.ts
CHANGED
|
@@ -131,7 +131,7 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
131
131
|
};
|
|
132
132
|
},
|
|
133
133
|
/**
|
|
134
|
-
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code
|
|
134
|
+
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
|
|
135
135
|
* @summary Retrieve the partner tag
|
|
136
136
|
* @param {string} code Unique identifier for the object.
|
|
137
137
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -184,7 +184,7 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
184
184
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
185
185
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
186
186
|
* @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: code, slug, label, createdAt, updatedAt</i>
|
|
187
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
187
|
+
* @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>
|
|
188
188
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
189
189
|
* @param {*} [options] Override http request option.
|
|
190
190
|
* @throws {RequiredError}
|
|
@@ -331,7 +331,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
|
|
|
331
331
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
332
332
|
},
|
|
333
333
|
/**
|
|
334
|
-
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code
|
|
334
|
+
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
|
|
335
335
|
* @summary Retrieve the partner tag
|
|
336
336
|
* @param {string} code Unique identifier for the object.
|
|
337
337
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -351,7 +351,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
|
|
|
351
351
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
352
352
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
353
353
|
* @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: code, slug, label, createdAt, updatedAt</i>
|
|
354
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
354
|
+
* @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>
|
|
355
355
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
356
356
|
* @param {*} [options] Override http request option.
|
|
357
357
|
* @throws {RequiredError}
|
|
@@ -405,7 +405,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
|
|
|
405
405
|
return localVarFp.deleteTag(code, authorization, options).then((request) => request(axios, basePath));
|
|
406
406
|
},
|
|
407
407
|
/**
|
|
408
|
-
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code
|
|
408
|
+
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
|
|
409
409
|
* @summary Retrieve the partner tag
|
|
410
410
|
* @param {string} code Unique identifier for the object.
|
|
411
411
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -424,7 +424,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
|
|
|
424
424
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
425
425
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
426
426
|
* @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: code, slug, label, createdAt, updatedAt</i>
|
|
427
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
427
|
+
* @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>
|
|
428
428
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
429
429
|
* @param {*} [options] Override http request option.
|
|
430
430
|
* @throws {RequiredError}
|
|
@@ -558,7 +558,7 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
558
558
|
readonly order?: string
|
|
559
559
|
|
|
560
560
|
/**
|
|
561
|
-
* Expand to fetch additional information about the list items.
|
|
561
|
+
* 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>
|
|
562
562
|
* @type {string}
|
|
563
563
|
* @memberof PartnerTagsApiListTags
|
|
564
564
|
*/
|
|
@@ -625,7 +625,7 @@ export class PartnerTagsApi extends BaseAPI {
|
|
|
625
625
|
}
|
|
626
626
|
|
|
627
627
|
/**
|
|
628
|
-
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code
|
|
628
|
+
* Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
|
|
629
629
|
* @summary Retrieve the partner tag
|
|
630
630
|
* @param {PartnerTagsApiGetTagRequest} requestParameters Request parameters.
|
|
631
631
|
* @param {*} [options] Override http request option.
|
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.
|
|
@@ -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.
|
|
@@ -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.
|
|
@@ -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.
|
|
@@ -89,7 +89,7 @@ export const PartnerVersionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
89
89
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
90
90
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
91
91
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
92
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
92
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType<i>
|
|
93
93
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
@@ -192,7 +192,7 @@ export const PartnerVersionApiFp = function(configuration?: Configuration) {
|
|
|
192
192
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
193
193
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
194
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
195
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
195
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType<i>
|
|
196
196
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
198
198
|
* @throws {RequiredError}
|
|
@@ -233,7 +233,7 @@ export const PartnerVersionApiFactory = function (configuration?: Configuration,
|
|
|
233
233
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
234
234
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
235
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
236
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
236
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType<i>
|
|
237
237
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
@@ -328,7 +328,7 @@ export interface PartnerVersionApiListPartnerVersionRequest {
|
|
|
328
328
|
readonly order?: string
|
|
329
329
|
|
|
330
330
|
/**
|
|
331
|
-
* Expand to fetch additional information about the list items.
|
|
331
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType<i>
|
|
332
332
|
* @type {string}
|
|
333
333
|
* @memberof PartnerVersionApiListPartnerVersion
|
|
334
334
|
*/
|
package/api/partners-api.ts
CHANGED
|
@@ -135,7 +135,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
135
135
|
};
|
|
136
136
|
},
|
|
137
137
|
/**
|
|
138
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
138
|
+
* 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.
|
|
139
139
|
* @summary Retrieve the partner
|
|
140
140
|
* @param {string} code Unique identifier for the object.
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -193,7 +193,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
193
193
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
194
194
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
195
195
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
196
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
196
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
197
197
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
198
198
|
* @param {*} [options] Override http request option.
|
|
199
199
|
* @throws {RequiredError}
|
|
@@ -397,7 +397,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
397
397
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
398
398
|
},
|
|
399
399
|
/**
|
|
400
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
400
|
+
* 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.
|
|
401
401
|
* @summary Retrieve the partner
|
|
402
402
|
* @param {string} code Unique identifier for the object.
|
|
403
403
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -418,7 +418,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
418
418
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
419
419
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
420
420
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
421
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
421
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
422
422
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
423
423
|
* @param {*} [options] Override http request option.
|
|
424
424
|
* @throws {RequiredError}
|
|
@@ -486,7 +486,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
486
486
|
return localVarFp.deletePartner(code, authorization, options).then((request) => request(axios, basePath));
|
|
487
487
|
},
|
|
488
488
|
/**
|
|
489
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
489
|
+
* 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.
|
|
490
490
|
* @summary Retrieve the partner
|
|
491
491
|
* @param {string} code Unique identifier for the object.
|
|
492
492
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -506,7 +506,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
506
506
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
507
507
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
508
508
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
509
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
509
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
510
510
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId</i>
|
|
511
511
|
* @param {*} [options] Override http request option.
|
|
512
512
|
* @throws {RequiredError}
|
|
@@ -660,7 +660,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
660
660
|
readonly order?: string
|
|
661
661
|
|
|
662
662
|
/**
|
|
663
|
-
* Expand to fetch additional information about the list items.
|
|
663
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
664
664
|
* @type {string}
|
|
665
665
|
* @memberof PartnersApiListPartners
|
|
666
666
|
*/
|
|
@@ -762,7 +762,7 @@ export class PartnersApi extends BaseAPI {
|
|
|
762
762
|
}
|
|
763
763
|
|
|
764
764
|
/**
|
|
765
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code
|
|
765
|
+
* 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.
|
|
766
766
|
* @summary Retrieve the partner
|
|
767
767
|
* @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
|
|
768
768
|
* @param {*} [options] Override http request option.
|
package/base.ts
CHANGED
|
@@ -34,7 +34,7 @@ export const COLLECTION_FORMATS = {
|
|
|
34
34
|
|
|
35
35
|
export interface LoginClass {
|
|
36
36
|
accessToken: string;
|
|
37
|
-
permissions:
|
|
37
|
+
permissions: string;
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
export enum Environment {
|
|
@@ -77,7 +77,7 @@ const TOKEN_DATA = 'APP_TOKEN';
|
|
|
77
77
|
export class BaseAPI {
|
|
78
78
|
protected configuration: Configuration | undefined;
|
|
79
79
|
private tokenData?: TokenData;
|
|
80
|
-
private permissions
|
|
80
|
+
private permissions?: string;
|
|
81
81
|
|
|
82
82
|
constructor(configuration?: Configuration,
|
|
83
83
|
protected basePath: string = BASE_PATH,
|
|
@@ -111,7 +111,7 @@ export class BaseAPI {
|
|
|
111
111
|
}
|
|
112
112
|
|
|
113
113
|
getPermissions(): Array<string> {
|
|
114
|
-
return this.permissions;
|
|
114
|
+
return this.permissions.split(',');
|
|
115
115
|
}
|
|
116
116
|
|
|
117
117
|
async authorize(username: string, password: string): Promise<void> {
|
|
@@ -70,7 +70,7 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
70
70
|
* @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>
|
|
71
71
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
72
|
* @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>
|
|
73
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
73
|
+
* @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>
|
|
74
74
|
* @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>
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
@@ -85,7 +85,7 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
85
85
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
86
86
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
87
87
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
88
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
88
|
+
* @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: partnerRelationType<i>
|
|
89
89
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
90
90
|
* @param {*} [options] Override http request option.
|
|
91
91
|
* @throws {RequiredError}
|
|
@@ -152,7 +152,7 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
152
152
|
* @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>
|
|
153
153
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
154
154
|
* @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>
|
|
155
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
155
|
+
* @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>
|
|
156
156
|
* @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>
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
@@ -167,7 +167,7 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
167
167
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
168
168
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
169
169
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
170
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
170
|
+
* @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: partnerRelationType<i>
|
|
171
171
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
172
172
|
* @param {*} [options] Override http request option.
|
|
173
173
|
* @throws {RequiredError}
|
|
@@ -234,7 +234,7 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
234
234
|
* @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>
|
|
235
235
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
236
236
|
* @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>
|
|
237
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
237
|
+
* @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>
|
|
238
238
|
* @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>
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
240
240
|
* @throws {RequiredError}
|
|
@@ -249,7 +249,7 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
249
249
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
250
250
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
251
251
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
252
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
252
|
+
* @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: partnerRelationType<i>
|
|
253
253
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
254
254
|
* @param {*} [options] Override http request option.
|
|
255
255
|
* @throws {RequiredError}
|
|
@@ -385,7 +385,7 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
385
385
|
*/
|
|
386
386
|
readonly order?: string;
|
|
387
387
|
/**
|
|
388
|
-
* Expand to fetch additional information about the list items.
|
|
388
|
+
* 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>
|
|
389
389
|
* @type {string}
|
|
390
390
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
391
391
|
*/
|
|
@@ -440,7 +440,7 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
440
440
|
*/
|
|
441
441
|
readonly order?: string;
|
|
442
442
|
/**
|
|
443
|
-
* Expand to fetch additional information about the list items.
|
|
443
|
+
* 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: partnerRelationType<i>
|
|
444
444
|
* @type {string}
|
|
445
445
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
446
446
|
*/
|
|
@@ -294,7 +294,7 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
294
294
|
* @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>
|
|
295
295
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
296
296
|
* @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>
|
|
297
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
297
|
+
* @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>
|
|
298
298
|
* @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>
|
|
299
299
|
* @param {*} [options] Override http request option.
|
|
300
300
|
* @throws {RequiredError}
|
|
@@ -366,7 +366,7 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
366
366
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
367
367
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
368
368
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
369
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
369
|
+
* @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: partnerRelationType<i>
|
|
370
370
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
371
371
|
* @param {*} [options] Override http request option.
|
|
372
372
|
* @throws {RequiredError}
|
|
@@ -585,7 +585,7 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
585
585
|
* @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>
|
|
586
586
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
587
587
|
* @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>
|
|
588
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
588
|
+
* @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>
|
|
589
589
|
* @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>
|
|
590
590
|
* @param {*} [options] Override http request option.
|
|
591
591
|
* @throws {RequiredError}
|
|
@@ -612,7 +612,7 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
612
612
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
613
613
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
614
614
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
615
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
615
|
+
* @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: partnerRelationType<i>
|
|
616
616
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
617
617
|
* @param {*} [options] Override http request option.
|
|
618
618
|
* @throws {RequiredError}
|
|
@@ -715,7 +715,7 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
715
715
|
* @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>
|
|
716
716
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
717
717
|
* @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>
|
|
718
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
718
|
+
* @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>
|
|
719
719
|
* @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>
|
|
720
720
|
* @param {*} [options] Override http request option.
|
|
721
721
|
* @throws {RequiredError}
|
|
@@ -732,7 +732,7 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
732
732
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
733
733
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
734
734
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
735
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
735
|
+
* @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: partnerRelationType<i>
|
|
736
736
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
737
737
|
* @param {*} [options] Override http request option.
|
|
738
738
|
* @throws {RequiredError}
|