@emilgroup/partner-sdk 1.13.1-beta.0 → 1.13.1-beta.1
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 +38 -38
- package/api/partner-tags-api.ts +19 -19
- package/api/partner-types-api.ts +40 -40
- package/api/partner-versions-api.ts +19 -19
- package/api/partners-api.ts +38 -38
- package/common.ts +2 -2
- package/configuration.ts +9 -0
- package/dist/api/partner-relations-api.d.ts +38 -38
- package/dist/api/partner-relations-api.js +18 -18
- package/dist/api/partner-tags-api.d.ts +19 -19
- package/dist/api/partner-tags-api.js +9 -9
- package/dist/api/partner-types-api.d.ts +40 -40
- package/dist/api/partner-types-api.js +21 -21
- package/dist/api/partner-versions-api.d.ts +19 -19
- package/dist/api/partner-versions-api.js +9 -9
- package/dist/api/partners-api.d.ts +38 -38
- package/dist/api/partners-api.js +18 -18
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +6 -0
- package/dist/configuration.js +8 -0
- package/package.json +1 -1
|
@@ -84,17 +84,17 @@ export const PartnerVersionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
84
84
|
* @summary List partner versions
|
|
85
85
|
* @param {string} code
|
|
86
86
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
|
-
* @param {
|
|
88
|
-
* @param {
|
|
87
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
88
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
89
89
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
90
|
-
* @param {
|
|
90
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
91
91
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
92
92
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType<i>
|
|
93
93
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
96
96
|
*/
|
|
97
|
-
listPartnerVersion: async (code: string, authorization?: string, pageSize?:
|
|
97
|
+
listPartnerVersion: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
98
98
|
// verify required parameter 'code' is not null or undefined
|
|
99
99
|
assertParamExists('listPartnerVersion', 'code', code)
|
|
100
100
|
const localVarPath = `/partnerservice/v1/partners/{code}/versions`
|
|
@@ -187,17 +187,17 @@ export const PartnerVersionsApiFp = function(configuration?: Configuration) {
|
|
|
187
187
|
* @summary List partner versions
|
|
188
188
|
* @param {string} code
|
|
189
189
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
190
|
-
* @param {
|
|
191
|
-
* @param {
|
|
190
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
191
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
192
192
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
193
|
-
* @param {
|
|
193
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
194
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
195
195
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType<i>
|
|
196
196
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
198
198
|
* @throws {RequiredError}
|
|
199
199
|
*/
|
|
200
|
-
async listPartnerVersion(code: string, authorization?: string, pageSize?:
|
|
200
|
+
async listPartnerVersion(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerVersionsResponseClass>> {
|
|
201
201
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
202
202
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
203
203
|
},
|
|
@@ -228,17 +228,17 @@ export const PartnerVersionsApiFactory = function (configuration?: Configuration
|
|
|
228
228
|
* @summary List partner versions
|
|
229
229
|
* @param {string} code
|
|
230
230
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
|
-
* @param {
|
|
232
|
-
* @param {
|
|
231
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
233
233
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
234
|
-
* @param {
|
|
234
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
235
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
|
236
236
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType<i>
|
|
237
237
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
240
|
*/
|
|
241
|
-
listPartnerVersion(code: string, authorization?: string, pageSize?:
|
|
241
|
+
listPartnerVersion(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerVersionsResponseClass> {
|
|
242
242
|
return localVarFp.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
243
243
|
},
|
|
244
244
|
};
|
|
@@ -294,17 +294,17 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
294
294
|
|
|
295
295
|
/**
|
|
296
296
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
297
|
-
* @type {
|
|
297
|
+
* @type {number}
|
|
298
298
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
299
299
|
*/
|
|
300
|
-
readonly pageSize?:
|
|
300
|
+
readonly pageSize?: number
|
|
301
301
|
|
|
302
302
|
/**
|
|
303
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
304
|
-
* @type {
|
|
303
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
304
|
+
* @type {string}
|
|
305
305
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
306
306
|
*/
|
|
307
|
-
readonly pageToken?:
|
|
307
|
+
readonly pageToken?: string
|
|
308
308
|
|
|
309
309
|
/**
|
|
310
310
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, version, displayName, updatedAt, updatedBy</i>
|
|
@@ -315,10 +315,10 @@ export interface PartnerVersionsApiListPartnerVersionRequest {
|
|
|
315
315
|
|
|
316
316
|
/**
|
|
317
317
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
318
|
-
* @type {
|
|
318
|
+
* @type {string}
|
|
319
319
|
* @memberof PartnerVersionsApiListPartnerVersion
|
|
320
320
|
*/
|
|
321
|
-
readonly search?:
|
|
321
|
+
readonly search?: string
|
|
322
322
|
|
|
323
323
|
/**
|
|
324
324
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: displayName, createdAt, updatedAt, version</i>
|
package/api/partners-api.ts
CHANGED
|
@@ -190,17 +190,17 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
190
190
|
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
191
191
|
* @summary List partners
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
-
* @param {
|
|
194
|
-
* @param {
|
|
193
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
195
195
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
196
|
-
* @param {
|
|
196
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
197
197
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
198
198
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
199
199
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
203
|
-
listPartners: async (authorization?: string, pageSize?:
|
|
203
|
+
listPartners: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
204
204
|
const localVarPath = `/partnerservice/v1/partners`;
|
|
205
205
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
206
206
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -267,17 +267,17 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
267
267
|
* @summary List grouped relations for partner
|
|
268
268
|
* @param {string} code
|
|
269
269
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
-
* @param {
|
|
271
|
-
* @param {
|
|
270
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
272
272
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
273
|
-
* @param {
|
|
273
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
274
274
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
275
275
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
276
276
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
277
277
|
* @param {*} [options] Override http request option.
|
|
278
278
|
* @throws {RequiredError}
|
|
279
279
|
*/
|
|
280
|
-
listRelationsForPartner: async (code: string, authorization?: string, pageSize?:
|
|
280
|
+
listRelationsForPartner: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
281
281
|
// verify required parameter 'code' is not null or undefined
|
|
282
282
|
assertParamExists('listRelationsForPartner', 'code', code)
|
|
283
283
|
const localVarPath = `/partnerservice/v1/partners/{code}/relations`
|
|
@@ -495,17 +495,17 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
495
495
|
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
496
496
|
* @summary List partners
|
|
497
497
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
498
|
-
* @param {
|
|
499
|
-
* @param {
|
|
498
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
499
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
500
500
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
501
|
-
* @param {
|
|
501
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
502
502
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
503
503
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
504
504
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
505
505
|
* @param {*} [options] Override http request option.
|
|
506
506
|
* @throws {RequiredError}
|
|
507
507
|
*/
|
|
508
|
-
async listPartners(authorization?: string, pageSize?:
|
|
508
|
+
async listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>> {
|
|
509
509
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
510
510
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
511
511
|
},
|
|
@@ -514,17 +514,17 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
514
514
|
* @summary List grouped relations for partner
|
|
515
515
|
* @param {string} code
|
|
516
516
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
517
|
-
* @param {
|
|
518
|
-
* @param {
|
|
517
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
518
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
519
519
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
520
|
-
* @param {
|
|
520
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
521
521
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
522
522
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
523
523
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
524
524
|
* @param {*} [options] Override http request option.
|
|
525
525
|
* @throws {RequiredError}
|
|
526
526
|
*/
|
|
527
|
-
async listRelationsForPartner(code: string, authorization?: string, pageSize?:
|
|
527
|
+
async listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRelatedPartnersResponseClass>> {
|
|
528
528
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
529
529
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
530
530
|
},
|
|
@@ -602,17 +602,17 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
602
602
|
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
603
603
|
* @summary List partners
|
|
604
604
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
605
|
-
* @param {
|
|
606
|
-
* @param {
|
|
605
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
606
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
607
607
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
608
|
-
* @param {
|
|
608
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
609
609
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
610
610
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
611
611
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
612
612
|
* @param {*} [options] Override http request option.
|
|
613
613
|
* @throws {RequiredError}
|
|
614
614
|
*/
|
|
615
|
-
listPartners(authorization?: string, pageSize?:
|
|
615
|
+
listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass> {
|
|
616
616
|
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
617
617
|
},
|
|
618
618
|
/**
|
|
@@ -620,17 +620,17 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
620
620
|
* @summary List grouped relations for partner
|
|
621
621
|
* @param {string} code
|
|
622
622
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
623
|
-
* @param {
|
|
624
|
-
* @param {
|
|
623
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
624
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
625
625
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
626
|
-
* @param {
|
|
626
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
627
627
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
628
628
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
629
629
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
630
630
|
* @param {*} [options] Override http request option.
|
|
631
631
|
* @throws {RequiredError}
|
|
632
632
|
*/
|
|
633
|
-
listRelationsForPartner(code: string, authorization?: string, pageSize?:
|
|
633
|
+
listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRelatedPartnersResponseClass> {
|
|
634
634
|
return localVarFp.listRelationsForPartner(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
635
635
|
},
|
|
636
636
|
/**
|
|
@@ -745,17 +745,17 @@ export interface PartnersApiListPartnersRequest {
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
748
|
-
* @type {
|
|
748
|
+
* @type {number}
|
|
749
749
|
* @memberof PartnersApiListPartners
|
|
750
750
|
*/
|
|
751
|
-
readonly pageSize?:
|
|
751
|
+
readonly pageSize?: number
|
|
752
752
|
|
|
753
753
|
/**
|
|
754
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
755
|
-
* @type {
|
|
754
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
755
|
+
* @type {string}
|
|
756
756
|
* @memberof PartnersApiListPartners
|
|
757
757
|
*/
|
|
758
|
-
readonly pageToken?:
|
|
758
|
+
readonly pageToken?: string
|
|
759
759
|
|
|
760
760
|
/**
|
|
761
761
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
@@ -766,10 +766,10 @@ export interface PartnersApiListPartnersRequest {
|
|
|
766
766
|
|
|
767
767
|
/**
|
|
768
768
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
769
|
-
* @type {
|
|
769
|
+
* @type {string}
|
|
770
770
|
* @memberof PartnersApiListPartners
|
|
771
771
|
*/
|
|
772
|
-
readonly search?:
|
|
772
|
+
readonly search?: string
|
|
773
773
|
|
|
774
774
|
/**
|
|
775
775
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
@@ -815,17 +815,17 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
815
815
|
|
|
816
816
|
/**
|
|
817
817
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
818
|
-
* @type {
|
|
818
|
+
* @type {number}
|
|
819
819
|
* @memberof PartnersApiListRelationsForPartner
|
|
820
820
|
*/
|
|
821
|
-
readonly pageSize?:
|
|
821
|
+
readonly pageSize?: number
|
|
822
822
|
|
|
823
823
|
/**
|
|
824
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
825
|
-
* @type {
|
|
824
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
825
|
+
* @type {string}
|
|
826
826
|
* @memberof PartnersApiListRelationsForPartner
|
|
827
827
|
*/
|
|
828
|
-
readonly pageToken?:
|
|
828
|
+
readonly pageToken?: string
|
|
829
829
|
|
|
830
830
|
/**
|
|
831
831
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
@@ -836,10 +836,10 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
836
836
|
|
|
837
837
|
/**
|
|
838
838
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
839
|
-
* @type {
|
|
839
|
+
* @type {string}
|
|
840
840
|
* @memberof PartnersApiListRelationsForPartner
|
|
841
841
|
*/
|
|
842
|
-
readonly search?:
|
|
842
|
+
readonly search?: string
|
|
843
843
|
|
|
844
844
|
/**
|
|
845
845
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
package/common.ts
CHANGED
|
@@ -65,7 +65,7 @@ export const setBearerAuthToObject = async function (object: any, configuration?
|
|
|
65
65
|
const accessToken = typeof configuration.accessToken === 'function'
|
|
66
66
|
? await configuration.accessToken()
|
|
67
67
|
: await configuration.accessToken;
|
|
68
|
-
object["Authorization"] =
|
|
68
|
+
object["Authorization"] = configuration.getBearerToken(accessToken);
|
|
69
69
|
}
|
|
70
70
|
}
|
|
71
71
|
|
|
@@ -78,7 +78,7 @@ export const setOAuthToObject = async function (object: any, name: string, scope
|
|
|
78
78
|
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
79
79
|
? await configuration.accessToken(name, scopes)
|
|
80
80
|
: await configuration.accessToken;
|
|
81
|
-
object["Authorization"] =
|
|
81
|
+
object["Authorization"] = configuration.getBearerToken(localVarAccessTokenValue);
|
|
82
82
|
}
|
|
83
83
|
}
|
|
84
84
|
|
package/configuration.ts
CHANGED
|
@@ -98,4 +98,13 @@ export class Configuration {
|
|
|
98
98
|
const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
|
|
99
99
|
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
|
|
100
100
|
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Returns "Bearer" token.
|
|
104
|
+
* @param token - access token.
|
|
105
|
+
* @return Bearer token.
|
|
106
|
+
*/
|
|
107
|
+
public getBearerToken(token?: string): string {
|
|
108
|
+
return ('' + token).startsWith("Bearer") ? token : "Bearer " + token;
|
|
109
|
+
}
|
|
101
110
|
}
|
|
@@ -65,32 +65,32 @@ export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
65
65
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
66
66
|
* @summary List partner relation types
|
|
67
67
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
68
|
-
* @param {
|
|
69
|
-
* @param {
|
|
68
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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
|
*/
|
|
78
|
-
listPartnerRelationTypes: (authorization?: string, pageSize?:
|
|
78
|
+
listPartnerRelationTypes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
79
|
/**
|
|
80
80
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
81
81
|
* @summary List partner relations
|
|
82
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
|
-
* @param {
|
|
84
|
-
* @param {
|
|
83
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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
|
*/
|
|
93
|
-
listPartnerRelations: (authorization?: string, pageSize?:
|
|
93
|
+
listPartnerRelations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
94
|
/**
|
|
95
95
|
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
96
96
|
* @summary Update the partner relation
|
|
@@ -147,32 +147,32 @@ export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
|
|
|
147
147
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
148
148
|
* @summary List partner relation types
|
|
149
149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
|
-
* @param {
|
|
151
|
-
* @param {
|
|
150
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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
|
*/
|
|
160
|
-
listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
160
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>>;
|
|
161
161
|
/**
|
|
162
162
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
163
163
|
* @summary List partner relations
|
|
164
164
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
165
|
-
* @param {
|
|
166
|
-
* @param {
|
|
165
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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
|
*/
|
|
175
|
-
listPartnerRelations(authorization?: string, pageSize?:
|
|
175
|
+
listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationClass>>;
|
|
176
176
|
/**
|
|
177
177
|
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
178
178
|
* @summary Update the partner relation
|
|
@@ -229,32 +229,32 @@ export declare const PartnerRelationsApiFactory: (configuration?: Configuration,
|
|
|
229
229
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
230
230
|
* @summary List partner relation types
|
|
231
231
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
232
|
-
* @param {
|
|
233
|
-
* @param {
|
|
232
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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
|
*/
|
|
242
|
-
listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
242
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass>;
|
|
243
243
|
/**
|
|
244
244
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
245
245
|
* @summary List partner relations
|
|
246
246
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
247
|
-
* @param {
|
|
248
|
-
* @param {
|
|
247
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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
|
*/
|
|
257
|
-
listPartnerRelations(authorization?: string, pageSize?:
|
|
257
|
+
listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass>;
|
|
258
258
|
/**
|
|
259
259
|
* Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
|
|
260
260
|
* @summary Update the partner relation
|
|
@@ -356,16 +356,16 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
356
356
|
readonly authorization?: string;
|
|
357
357
|
/**
|
|
358
358
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
359
|
-
* @type {
|
|
359
|
+
* @type {number}
|
|
360
360
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
361
361
|
*/
|
|
362
|
-
readonly pageSize?:
|
|
362
|
+
readonly pageSize?: number;
|
|
363
363
|
/**
|
|
364
|
-
* 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,
|
|
365
|
-
* @type {
|
|
364
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
365
|
+
* @type {string}
|
|
366
366
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
367
367
|
*/
|
|
368
|
-
readonly pageToken?:
|
|
368
|
+
readonly pageToken?: string;
|
|
369
369
|
/**
|
|
370
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}
|
|
@@ -374,10 +374,10 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
374
374
|
readonly filter?: string;
|
|
375
375
|
/**
|
|
376
376
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
377
|
-
* @type {
|
|
377
|
+
* @type {string}
|
|
378
378
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
379
379
|
*/
|
|
380
|
-
readonly search?:
|
|
380
|
+
readonly search?: string;
|
|
381
381
|
/**
|
|
382
382
|
* 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>
|
|
383
383
|
* @type {string}
|
|
@@ -411,16 +411,16 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
411
411
|
readonly authorization?: string;
|
|
412
412
|
/**
|
|
413
413
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
414
|
-
* @type {
|
|
414
|
+
* @type {number}
|
|
415
415
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
416
416
|
*/
|
|
417
|
-
readonly pageSize?:
|
|
417
|
+
readonly pageSize?: number;
|
|
418
418
|
/**
|
|
419
|
-
* 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,
|
|
420
|
-
* @type {
|
|
419
|
+
* 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.
|
|
420
|
+
* @type {string}
|
|
421
421
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
422
422
|
*/
|
|
423
|
-
readonly pageToken?:
|
|
423
|
+
readonly pageToken?: string;
|
|
424
424
|
/**
|
|
425
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}
|
|
@@ -429,10 +429,10 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
429
429
|
readonly filter?: string;
|
|
430
430
|
/**
|
|
431
431
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
432
|
-
* @type {
|
|
432
|
+
* @type {string}
|
|
433
433
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
434
434
|
*/
|
|
435
|
-
readonly search?:
|
|
435
|
+
readonly search?: string;
|
|
436
436
|
/**
|
|
437
437
|
* 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>
|
|
438
438
|
* @type {string}
|