@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
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/partner-sdk@1.13.1-beta.
|
|
20
|
+
npm install @emilgroup/partner-sdk@1.13.1-beta.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk@1.13.1-beta.
|
|
24
|
+
yarn add @emilgroup/partner-sdk@1.13.1-beta.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -228,17 +228,17 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
228
228
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
229
229
|
* @summary List partner relation types
|
|
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: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</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: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</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/>
|
|
237
237
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
240
|
*/
|
|
241
|
-
listPartnerRelationTypes: async (authorization?: string, pageSize?:
|
|
241
|
+
listPartnerRelationTypes: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
242
242
|
const localVarPath = `/partnerservice/v1/partners/relations/types`;
|
|
243
243
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
244
244
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -304,17 +304,17 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
304
304
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
305
305
|
* @summary List partner relations
|
|
306
306
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
307
|
-
* @param {
|
|
308
|
-
* @param {
|
|
307
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
308
|
+
* @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.
|
|
309
309
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
310
|
-
* @param {
|
|
310
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
311
311
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
312
312
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
313
313
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
314
314
|
* @param {*} [options] Override http request option.
|
|
315
315
|
* @throws {RequiredError}
|
|
316
316
|
*/
|
|
317
|
-
listPartnerRelations: async (authorization?: string, pageSize?:
|
|
317
|
+
listPartnerRelations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
318
318
|
const localVarPath = `/partnerservice/v1/partners/relations`;
|
|
319
319
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
320
320
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -489,17 +489,17 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
489
489
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
490
490
|
* @summary List partner relation types
|
|
491
491
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
492
|
-
* @param {
|
|
493
|
-
* @param {
|
|
492
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
493
|
+
* @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.
|
|
494
494
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
495
|
-
* @param {
|
|
495
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
496
496
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
497
497
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
498
498
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
499
499
|
* @param {*} [options] Override http request option.
|
|
500
500
|
* @throws {RequiredError}
|
|
501
501
|
*/
|
|
502
|
-
async listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
502
|
+
async 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>> {
|
|
503
503
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
504
504
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
505
505
|
},
|
|
@@ -507,17 +507,17 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
507
507
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
508
508
|
* @summary List partner relations
|
|
509
509
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
510
|
-
* @param {
|
|
511
|
-
* @param {
|
|
510
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
511
|
+
* @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.
|
|
512
512
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
513
|
-
* @param {
|
|
513
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
514
514
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
515
515
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
516
516
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
517
517
|
* @param {*} [options] Override http request option.
|
|
518
518
|
* @throws {RequiredError}
|
|
519
519
|
*/
|
|
520
|
-
async listPartnerRelations(authorization?: string, pageSize?:
|
|
520
|
+
async 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>> {
|
|
521
521
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
522
522
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
523
523
|
},
|
|
@@ -592,34 +592,34 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
592
592
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
593
593
|
* @summary List partner relation types
|
|
594
594
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
595
|
-
* @param {
|
|
596
|
-
* @param {
|
|
595
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
596
|
+
* @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.
|
|
597
597
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
598
|
-
* @param {
|
|
598
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
599
599
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
600
600
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
601
601
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
603
603
|
* @throws {RequiredError}
|
|
604
604
|
*/
|
|
605
|
-
listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
605
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
|
|
606
606
|
return localVarFp.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
607
607
|
},
|
|
608
608
|
/**
|
|
609
609
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
610
610
|
* @summary List partner relations
|
|
611
611
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
612
|
-
* @param {
|
|
613
|
-
* @param {
|
|
612
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
613
|
+
* @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.
|
|
614
614
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
615
|
-
* @param {
|
|
615
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
616
616
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
617
617
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
618
618
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
619
619
|
* @param {*} [options] Override http request option.
|
|
620
620
|
* @throws {RequiredError}
|
|
621
621
|
*/
|
|
622
|
-
listPartnerRelations(authorization?: string, pageSize?:
|
|
622
|
+
listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass> {
|
|
623
623
|
return localVarFp.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
624
624
|
},
|
|
625
625
|
/**
|
|
@@ -736,17 +736,17 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
736
736
|
|
|
737
737
|
/**
|
|
738
738
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
739
|
-
* @type {
|
|
739
|
+
* @type {number}
|
|
740
740
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
741
741
|
*/
|
|
742
|
-
readonly pageSize?:
|
|
742
|
+
readonly pageSize?: number
|
|
743
743
|
|
|
744
744
|
/**
|
|
745
|
-
* 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,
|
|
746
|
-
* @type {
|
|
745
|
+
* 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.
|
|
746
|
+
* @type {string}
|
|
747
747
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
748
748
|
*/
|
|
749
|
-
readonly pageToken?:
|
|
749
|
+
readonly pageToken?: string
|
|
750
750
|
|
|
751
751
|
/**
|
|
752
752
|
* 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>
|
|
@@ -757,10 +757,10 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
757
757
|
|
|
758
758
|
/**
|
|
759
759
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
760
|
-
* @type {
|
|
760
|
+
* @type {string}
|
|
761
761
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
762
762
|
*/
|
|
763
|
-
readonly search?:
|
|
763
|
+
readonly search?: string
|
|
764
764
|
|
|
765
765
|
/**
|
|
766
766
|
* 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>
|
|
@@ -799,17 +799,17 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
799
799
|
|
|
800
800
|
/**
|
|
801
801
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
802
|
-
* @type {
|
|
802
|
+
* @type {number}
|
|
803
803
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
804
804
|
*/
|
|
805
|
-
readonly pageSize?:
|
|
805
|
+
readonly pageSize?: number
|
|
806
806
|
|
|
807
807
|
/**
|
|
808
|
-
* 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,
|
|
809
|
-
* @type {
|
|
808
|
+
* 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.
|
|
809
|
+
* @type {string}
|
|
810
810
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
811
811
|
*/
|
|
812
|
-
readonly pageToken?:
|
|
812
|
+
readonly pageToken?: string
|
|
813
813
|
|
|
814
814
|
/**
|
|
815
815
|
* 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>
|
|
@@ -820,10 +820,10 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
820
820
|
|
|
821
821
|
/**
|
|
822
822
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
823
|
-
* @type {
|
|
823
|
+
* @type {string}
|
|
824
824
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
825
825
|
*/
|
|
826
|
-
readonly search?:
|
|
826
|
+
readonly search?: string
|
|
827
827
|
|
|
828
828
|
/**
|
|
829
829
|
* 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/api/partner-tags-api.ts
CHANGED
|
@@ -179,17 +179,17 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
179
179
|
* 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\"
|
|
180
180
|
* @summary List partner tags
|
|
181
181
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
182
|
-
* @param {
|
|
183
|
-
* @param {
|
|
182
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
183
|
+
* @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.
|
|
184
184
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
185
|
-
* @param {
|
|
185
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
186
186
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, slug, label, createdAt, updatedAt</i>
|
|
187
187
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
188
188
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
189
189
|
* @param {*} [options] Override http request option.
|
|
190
190
|
* @throws {RequiredError}
|
|
191
191
|
*/
|
|
192
|
-
listTags: async (authorization?: string, pageSize?:
|
|
192
|
+
listTags: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
193
193
|
const localVarPath = `/partnerservice/v1/tags`;
|
|
194
194
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
195
195
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -346,17 +346,17 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
|
|
|
346
346
|
* 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\"
|
|
347
347
|
* @summary List partner tags
|
|
348
348
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
349
|
-
* @param {
|
|
350
|
-
* @param {
|
|
349
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
350
|
+
* @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.
|
|
351
351
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
352
|
-
* @param {
|
|
352
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
353
353
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, slug, label, createdAt, updatedAt</i>
|
|
354
354
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
355
355
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
356
356
|
* @param {*} [options] Override http request option.
|
|
357
357
|
* @throws {RequiredError}
|
|
358
358
|
*/
|
|
359
|
-
async listTags(authorization?: string, pageSize?:
|
|
359
|
+
async listTags(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTagsResponseClass>> {
|
|
360
360
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listTags(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
361
361
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
362
362
|
},
|
|
@@ -419,17 +419,17 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
|
|
|
419
419
|
* 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\"
|
|
420
420
|
* @summary List partner tags
|
|
421
421
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
422
|
-
* @param {
|
|
423
|
-
* @param {
|
|
422
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
423
|
+
* @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.
|
|
424
424
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
425
|
-
* @param {
|
|
425
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
426
426
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, slug, label, createdAt, updatedAt</i>
|
|
427
427
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
428
428
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
|
|
429
429
|
* @param {*} [options] Override http request option.
|
|
430
430
|
* @throws {RequiredError}
|
|
431
431
|
*/
|
|
432
|
-
listTags(authorization?: string, pageSize?:
|
|
432
|
+
listTags(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTagsResponseClass> {
|
|
433
433
|
return localVarFp.listTags(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
434
434
|
},
|
|
435
435
|
/**
|
|
@@ -524,17 +524,17 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
524
524
|
|
|
525
525
|
/**
|
|
526
526
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
527
|
-
* @type {
|
|
527
|
+
* @type {number}
|
|
528
528
|
* @memberof PartnerTagsApiListTags
|
|
529
529
|
*/
|
|
530
|
-
readonly pageSize?:
|
|
530
|
+
readonly pageSize?: number
|
|
531
531
|
|
|
532
532
|
/**
|
|
533
|
-
* 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,
|
|
534
|
-
* @type {
|
|
533
|
+
* 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.
|
|
534
|
+
* @type {string}
|
|
535
535
|
* @memberof PartnerTagsApiListTags
|
|
536
536
|
*/
|
|
537
|
-
readonly pageToken?:
|
|
537
|
+
readonly pageToken?: string
|
|
538
538
|
|
|
539
539
|
/**
|
|
540
540
|
* 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>
|
|
@@ -545,10 +545,10 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
545
545
|
|
|
546
546
|
/**
|
|
547
547
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
548
|
-
* @type {
|
|
548
|
+
* @type {string}
|
|
549
549
|
* @memberof PartnerTagsApiListTags
|
|
550
550
|
*/
|
|
551
|
-
readonly search?:
|
|
551
|
+
readonly search?: string
|
|
552
552
|
|
|
553
553
|
/**
|
|
554
554
|
* 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>
|
package/api/partner-types-api.ts
CHANGED
|
@@ -186,17 +186,17 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
|
|
|
186
186
|
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
187
187
|
* @summary List partner-types
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @param {
|
|
190
|
-
* @param {
|
|
191
|
-
* @param {
|
|
192
|
-
* @param {
|
|
193
|
-
* @param {
|
|
194
|
-
* @param {
|
|
195
|
-
* @param {
|
|
189
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
|
+
* @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.
|
|
191
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
192
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
194
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
195
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
199
|
-
listPartnerTypes: async (authorization?: string, pageSize?:
|
|
199
|
+
listPartnerTypes: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
200
200
|
const localVarPath = `/partnerservice/v1/partner-types`;
|
|
201
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -360,17 +360,17 @@ export const PartnerTypesApiFp = function(configuration?: Configuration) {
|
|
|
360
360
|
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
361
361
|
* @summary List partner-types
|
|
362
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
|
-
* @param {
|
|
364
|
-
* @param {
|
|
365
|
-
* @param {
|
|
366
|
-
* @param {
|
|
367
|
-
* @param {
|
|
368
|
-
* @param {
|
|
369
|
-
* @param {
|
|
363
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
|
+
* @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.
|
|
365
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
366
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
367
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
368
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
369
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
372
|
*/
|
|
373
|
-
async listPartnerTypes(authorization?: string, pageSize?:
|
|
373
|
+
async listPartnerTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerTypesResponseClass>> {
|
|
374
374
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
375
375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
376
376
|
},
|
|
@@ -435,17 +435,17 @@ export const PartnerTypesApiFactory = function (configuration?: Configuration, b
|
|
|
435
435
|
* Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
436
436
|
* @summary List partner-types
|
|
437
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
|
-
* @param {
|
|
439
|
-
* @param {
|
|
440
|
-
* @param {
|
|
441
|
-
* @param {
|
|
442
|
-
* @param {
|
|
443
|
-
* @param {
|
|
444
|
-
* @param {
|
|
438
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
|
+
* @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.
|
|
440
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
441
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
442
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
443
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
444
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
448
|
-
listPartnerTypes(authorization?: string, pageSize?:
|
|
448
|
+
listPartnerTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerTypesResponseClass> {
|
|
449
449
|
return localVarFp.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
450
450
|
},
|
|
451
451
|
/**
|
|
@@ -548,52 +548,52 @@ export interface PartnerTypesApiListPartnerTypesRequest {
|
|
|
548
548
|
|
|
549
549
|
/**
|
|
550
550
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
551
|
-
* @type {
|
|
551
|
+
* @type {number}
|
|
552
552
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
553
553
|
*/
|
|
554
|
-
readonly pageSize?:
|
|
554
|
+
readonly pageSize?: number
|
|
555
555
|
|
|
556
556
|
/**
|
|
557
|
-
* 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,
|
|
558
|
-
* @type {
|
|
557
|
+
* 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.
|
|
558
|
+
* @type {string}
|
|
559
559
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
560
560
|
*/
|
|
561
|
-
readonly pageToken?:
|
|
561
|
+
readonly pageToken?: string
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
564
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
565
|
-
* @type {
|
|
565
|
+
* @type {string}
|
|
566
566
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
567
567
|
*/
|
|
568
|
-
readonly filter?:
|
|
568
|
+
readonly filter?: string
|
|
569
569
|
|
|
570
570
|
/**
|
|
571
571
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
572
|
-
* @type {
|
|
572
|
+
* @type {string}
|
|
573
573
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
574
574
|
*/
|
|
575
|
-
readonly search?:
|
|
575
|
+
readonly search?: string
|
|
576
576
|
|
|
577
577
|
/**
|
|
578
578
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
579
|
-
* @type {
|
|
579
|
+
* @type {string}
|
|
580
580
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
581
581
|
*/
|
|
582
|
-
readonly order?:
|
|
582
|
+
readonly order?: string
|
|
583
583
|
|
|
584
584
|
/**
|
|
585
|
-
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in
|
|
586
|
-
* @type {
|
|
585
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
586
|
+
* @type {string}
|
|
587
587
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
588
588
|
*/
|
|
589
|
-
readonly expand?:
|
|
589
|
+
readonly expand?: string
|
|
590
590
|
|
|
591
591
|
/**
|
|
592
592
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
593
|
-
* @type {
|
|
593
|
+
* @type {string}
|
|
594
594
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
595
595
|
*/
|
|
596
|
-
readonly filters?:
|
|
596
|
+
readonly filters?: string
|
|
597
597
|
}
|
|
598
598
|
|
|
599
599
|
/**
|