@emilgroup/partner-sdk 1.19.0 → 1.20.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 +16 -16
- package/api/partner-tags-api.ts +12 -12
- package/api/partner-versions-api.ts +12 -12
- package/api/partners-api.ts +24 -24
- package/dist/api/partner-relations-api.d.ts +16 -16
- package/dist/api/partner-relations-api.js +12 -12
- package/dist/api/partner-tags-api.d.ts +12 -12
- package/dist/api/partner-tags-api.js +10 -10
- package/dist/api/partner-versions-api.d.ts +12 -12
- package/dist/api/partner-versions-api.js +10 -10
- package/dist/api/partners-api.d.ts +24 -24
- package/dist/api/partners-api.js +20 -20
- package/package.json +1 -1
|
@@ -67,11 +67,11 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
67
67
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
68
68
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
69
69
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
70
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
71
71
|
* @param {string} [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
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/>
|
|
74
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
77
77
|
*/
|
|
@@ -82,11 +82,11 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
82
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
83
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
84
84
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
85
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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 {string} [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
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: partner1, partner2, partnerRelationType<i>
|
|
89
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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}
|
|
92
92
|
*/
|
|
@@ -149,11 +149,11 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
149
149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
150
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
151
151
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
152
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
153
153
|
* @param {string} [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
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/>
|
|
156
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
159
159
|
*/
|
|
@@ -164,11 +164,11 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
164
164
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
165
165
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
166
166
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
167
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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 {string} [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
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: partner1, partner2, partnerRelationType<i>
|
|
171
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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}
|
|
174
174
|
*/
|
|
@@ -231,11 +231,11 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
231
231
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
232
232
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
233
233
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
234
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
235
235
|
* @param {string} [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
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/>
|
|
238
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
240
240
|
* @throws {RequiredError}
|
|
241
241
|
*/
|
|
@@ -246,11 +246,11 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
246
246
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
247
247
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
248
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
249
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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 {string} [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
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: partner1, partner2, partnerRelationType<i>
|
|
253
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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}
|
|
256
256
|
*/
|
|
@@ -367,7 +367,7 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
367
367
|
*/
|
|
368
368
|
readonly pageToken?: string;
|
|
369
369
|
/**
|
|
370
|
-
* Filter the response by one or multiple fields.
|
|
370
|
+
* 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, partnerName</i>
|
|
371
371
|
* @type {string}
|
|
372
372
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
373
373
|
*/
|
|
@@ -391,7 +391,7 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
391
391
|
*/
|
|
392
392
|
readonly expand?: string;
|
|
393
393
|
/**
|
|
394
|
-
* Filters the response by one or multiple fields.
|
|
394
|
+
* 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, partnerName</i>
|
|
395
395
|
* @type {string}
|
|
396
396
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
397
397
|
*/
|
|
@@ -422,7 +422,7 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
422
422
|
*/
|
|
423
423
|
readonly pageToken?: string;
|
|
424
424
|
/**
|
|
425
|
-
* Filter the response by one or multiple fields.
|
|
425
|
+
* 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>
|
|
426
426
|
* @type {string}
|
|
427
427
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
428
428
|
*/
|
|
@@ -446,7 +446,7 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
446
446
|
*/
|
|
447
447
|
readonly expand?: string;
|
|
448
448
|
/**
|
|
449
|
-
* Filters the response by one or multiple fields.
|
|
449
|
+
* 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>
|
|
450
450
|
* @type {string}
|
|
451
451
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
452
452
|
*/
|
|
@@ -291,11 +291,11 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
291
291
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
292
292
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
293
293
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
294
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
295
295
|
* @param {string} [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
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/>
|
|
298
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
299
299
|
* @param {*} [options] Override http request option.
|
|
300
300
|
* @throws {RequiredError}
|
|
301
301
|
*/
|
|
@@ -363,11 +363,11 @@ var PartnerRelationsApiAxiosParamCreator = function (configuration) {
|
|
|
363
363
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
364
364
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
365
365
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
366
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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 {string} [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
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: partner1, partner2, partnerRelationType<i>
|
|
370
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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}
|
|
373
373
|
*/
|
|
@@ -582,11 +582,11 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
582
582
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
583
583
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
584
584
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
585
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
586
586
|
* @param {string} [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
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/>
|
|
589
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
590
590
|
* @param {*} [options] Override http request option.
|
|
591
591
|
* @throws {RequiredError}
|
|
592
592
|
*/
|
|
@@ -609,11 +609,11 @@ var PartnerRelationsApiFp = function (configuration) {
|
|
|
609
609
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
610
610
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
611
611
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
612
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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 {string} [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
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: partner1, partner2, partnerRelationType<i>
|
|
616
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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}
|
|
619
619
|
*/
|
|
@@ -712,11 +712,11 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
712
712
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
713
713
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
714
714
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
715
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
716
716
|
* @param {string} [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
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/>
|
|
719
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, partnerName</i>
|
|
720
720
|
* @param {*} [options] Override http request option.
|
|
721
721
|
* @throws {RequiredError}
|
|
722
722
|
*/
|
|
@@ -729,11 +729,11 @@ var PartnerRelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
729
729
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
730
730
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
731
731
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
732
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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 {string} [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
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: partner1, partner2, partnerRelationType<i>
|
|
736
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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}
|
|
739
739
|
*/
|
|
@@ -51,16 +51,16 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
|
|
|
51
51
|
*/
|
|
52
52
|
getTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
* Returns a list of partner tags you have previously created.
|
|
54
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
55
55
|
* @summary List partner tags
|
|
56
56
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
57
57
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
58
58
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
59
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
59
|
+
* @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>
|
|
60
60
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
61
61
|
* @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>
|
|
62
62
|
* @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/>
|
|
63
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
63
|
+
* @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>
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
@@ -108,16 +108,16 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
|
|
|
108
108
|
*/
|
|
109
109
|
getTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTagResponseClass>>;
|
|
110
110
|
/**
|
|
111
|
-
* Returns a list of partner tags you have previously created.
|
|
111
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
112
112
|
* @summary List partner tags
|
|
113
113
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
114
114
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
115
115
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
116
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
116
|
+
* @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>
|
|
117
117
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
118
118
|
* @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>
|
|
119
119
|
* @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/>
|
|
120
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
120
|
+
* @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>
|
|
121
121
|
* @param {*} [options] Override http request option.
|
|
122
122
|
* @throws {RequiredError}
|
|
123
123
|
*/
|
|
@@ -165,16 +165,16 @@ export declare const PartnerTagsApiFactory: (configuration?: Configuration, base
|
|
|
165
165
|
*/
|
|
166
166
|
getTag(code: string, authorization?: string, options?: any): AxiosPromise<GetTagResponseClass>;
|
|
167
167
|
/**
|
|
168
|
-
* Returns a list of partner tags you have previously created.
|
|
168
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
169
169
|
* @summary List partner tags
|
|
170
170
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
171
171
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
172
172
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
173
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
173
|
+
* @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>
|
|
174
174
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
175
175
|
* @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>
|
|
176
176
|
* @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/>
|
|
177
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
177
|
+
* @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>
|
|
178
178
|
* @param {*} [options] Override http request option.
|
|
179
179
|
* @throws {RequiredError}
|
|
180
180
|
*/
|
|
@@ -271,7 +271,7 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
271
271
|
*/
|
|
272
272
|
readonly pageToken?: string;
|
|
273
273
|
/**
|
|
274
|
-
* Filter the response by one or multiple fields.
|
|
274
|
+
* 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>
|
|
275
275
|
* @type {string}
|
|
276
276
|
* @memberof PartnerTagsApiListTags
|
|
277
277
|
*/
|
|
@@ -295,7 +295,7 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
295
295
|
*/
|
|
296
296
|
readonly expand?: string;
|
|
297
297
|
/**
|
|
298
|
-
* Filters the response by one or multiple fields.
|
|
298
|
+
* 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>
|
|
299
299
|
* @type {string}
|
|
300
300
|
* @memberof PartnerTagsApiListTags
|
|
301
301
|
*/
|
|
@@ -355,7 +355,7 @@ export declare class PartnerTagsApi extends BaseAPI {
|
|
|
355
355
|
*/
|
|
356
356
|
getTag(requestParameters: PartnerTagsApiGetTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTagResponseClass, any, {}>>;
|
|
357
357
|
/**
|
|
358
|
-
* Returns a list of partner tags you have previously created.
|
|
358
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
359
359
|
* @summary List partner tags
|
|
360
360
|
* @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
|
|
361
361
|
* @param {*} [options] Override http request option.
|
|
@@ -238,16 +238,16 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
|
|
|
238
238
|
});
|
|
239
239
|
},
|
|
240
240
|
/**
|
|
241
|
-
* Returns a list of partner tags you have previously created.
|
|
241
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
242
242
|
* @summary List partner tags
|
|
243
243
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
244
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
245
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
246
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
246
|
+
* @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>
|
|
247
247
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
248
248
|
* @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>
|
|
249
249
|
* @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/>
|
|
250
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
250
|
+
* @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>
|
|
251
251
|
* @param {*} [options] Override http request option.
|
|
252
252
|
* @throws {RequiredError}
|
|
253
253
|
*/
|
|
@@ -431,16 +431,16 @@ var PartnerTagsApiFp = function (configuration) {
|
|
|
431
431
|
});
|
|
432
432
|
},
|
|
433
433
|
/**
|
|
434
|
-
* Returns a list of partner tags you have previously created.
|
|
434
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
435
435
|
* @summary List partner tags
|
|
436
436
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
437
437
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
438
438
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
439
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
439
|
+
* @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>
|
|
440
440
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
441
441
|
* @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>
|
|
442
442
|
* @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/>
|
|
443
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
443
|
+
* @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>
|
|
444
444
|
* @param {*} [options] Override http request option.
|
|
445
445
|
* @throws {RequiredError}
|
|
446
446
|
*/
|
|
@@ -522,16 +522,16 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
|
|
|
522
522
|
return localVarFp.getTag(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
523
523
|
},
|
|
524
524
|
/**
|
|
525
|
-
* Returns a list of partner tags you have previously created.
|
|
525
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
526
526
|
* @summary List partner tags
|
|
527
527
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
528
528
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
529
529
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
530
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
530
|
+
* @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>
|
|
531
531
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
532
532
|
* @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>
|
|
533
533
|
* @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/>
|
|
534
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
534
|
+
* @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>
|
|
535
535
|
* @param {*} [options] Override http request option.
|
|
536
536
|
* @throws {RequiredError}
|
|
537
537
|
*/
|
|
@@ -600,7 +600,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
|
|
|
600
600
|
return (0, exports.PartnerTagsApiFp)(this.configuration).getTag(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
601
601
|
};
|
|
602
602
|
/**
|
|
603
|
-
* Returns a list of partner tags you have previously created.
|
|
603
|
+
* Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
604
604
|
* @summary List partner tags
|
|
605
605
|
* @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
|
|
606
606
|
* @param {*} [options] Override http request option.
|
|
@@ -30,17 +30,17 @@ export declare const PartnerVersionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
30
30
|
*/
|
|
31
31
|
getPartnerVersion: (code: string, version: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
33
|
-
* Returns a list of partner versions you have previously created.
|
|
33
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
34
34
|
* @summary List partner versions
|
|
35
35
|
* @param {string} code
|
|
36
36
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
37
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
38
38
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
39
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
39
|
+
* @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>
|
|
40
40
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
41
41
|
* @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>
|
|
42
42
|
* @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>
|
|
43
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
43
|
+
* @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>
|
|
44
44
|
* @param {*} [options] Override http request option.
|
|
45
45
|
* @throws {RequiredError}
|
|
46
46
|
*/
|
|
@@ -62,17 +62,17 @@ export declare const PartnerVersionsApiFp: (configuration?: Configuration) => {
|
|
|
62
62
|
*/
|
|
63
63
|
getPartnerVersion(code: string, version: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerVersionResponseClass>>;
|
|
64
64
|
/**
|
|
65
|
-
* Returns a list of partner versions you have previously created.
|
|
65
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
66
66
|
* @summary List partner versions
|
|
67
67
|
* @param {string} code
|
|
68
68
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
69
69
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
70
70
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
71
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
71
|
+
* @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>
|
|
72
72
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
73
73
|
* @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>
|
|
74
74
|
* @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>
|
|
75
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
75
|
+
* @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>
|
|
76
76
|
* @param {*} [options] Override http request option.
|
|
77
77
|
* @throws {RequiredError}
|
|
78
78
|
*/
|
|
@@ -94,17 +94,17 @@ export declare const PartnerVersionsApiFactory: (configuration?: Configuration,
|
|
|
94
94
|
*/
|
|
95
95
|
getPartnerVersion(code: string, version: number, authorization?: string, options?: any): AxiosPromise<GetPartnerVersionResponseClass>;
|
|
96
96
|
/**
|
|
97
|
-
* Returns a list of partner versions you have previously created.
|
|
97
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
98
98
|
* @summary List partner versions
|
|
99
99
|
* @param {string} code
|
|
100
100
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
101
101
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
102
102
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
103
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
103
|
+
* @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>
|
|
104
104
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
105
105
|
* @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>
|
|
106
106
|
* @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>
|
|
107
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
107
|
+
* @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>
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
109
109
|
* @throws {RequiredError}
|
|
110
110
|
*/
|
|
@@ -166,7 +166,7 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
166
166
|
*/
|
|
167
167
|
readonly pageToken?: string;
|
|
168
168
|
/**
|
|
169
|
-
* Filter the response by one or multiple fields.
|
|
169
|
+
* 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>
|
|
170
170
|
* @type {string}
|
|
171
171
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
172
172
|
*/
|
|
@@ -190,7 +190,7 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
190
190
|
*/
|
|
191
191
|
readonly expand?: string;
|
|
192
192
|
/**
|
|
193
|
-
* Filters the response by one or multiple fields.
|
|
193
|
+
* 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>
|
|
194
194
|
* @type {string}
|
|
195
195
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
196
196
|
*/
|
|
@@ -213,7 +213,7 @@ export declare class PartnerVersionsApi extends BaseAPI {
|
|
|
213
213
|
*/
|
|
214
214
|
getPartnerVersion(requestParameters: PartnerVersionsApiGetPartnerVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerVersionResponseClass, any, {}>>;
|
|
215
215
|
/**
|
|
216
|
-
* Returns a list of partner versions you have previously created.
|
|
216
|
+
* Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
217
217
|
* @summary List partner versions
|
|
218
218
|
* @param {PartnerVersionsApiListPartnerVersionRequest} requestParameters Request parameters.
|
|
219
219
|
* @param {*} [options] Override http request option.
|