@emilgroup/partner-sdk-node 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/base.ts +1 -1
- 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/base.js +1 -1
- 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-node@1.13.1-beta.
|
|
20
|
+
npm install @emilgroup/partner-sdk-node@1.13.1-beta.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/partner-sdk-node@1.13.1-beta.
|
|
24
|
+
yarn add @emilgroup/partner-sdk-node@1.13.1-beta.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PartnersApi`.
|
|
@@ -232,17 +232,17 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
232
232
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
233
233
|
* @summary List partner relation types
|
|
234
234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
235
|
-
* @param {
|
|
236
|
-
* @param {
|
|
235
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
236
|
+
* @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.
|
|
237
237
|
* @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>
|
|
238
|
-
* @param {
|
|
238
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
239
239
|
* @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>
|
|
240
240
|
* @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/>
|
|
241
241
|
* @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>
|
|
242
242
|
* @param {*} [options] Override http request option.
|
|
243
243
|
* @throws {RequiredError}
|
|
244
244
|
*/
|
|
245
|
-
listPartnerRelationTypes: async (authorization?: string, pageSize?:
|
|
245
|
+
listPartnerRelationTypes: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
246
246
|
const localVarPath = `/partnerservice/v1/partners/relations/types`;
|
|
247
247
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
248
248
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -308,17 +308,17 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
|
|
|
308
308
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
309
309
|
* @summary List partner relations
|
|
310
310
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
311
|
-
* @param {
|
|
312
|
-
* @param {
|
|
311
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
312
|
+
* @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.
|
|
313
313
|
* @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>
|
|
314
|
-
* @param {
|
|
314
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
315
315
|
* @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>
|
|
316
316
|
* @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>
|
|
317
317
|
* @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>
|
|
318
318
|
* @param {*} [options] Override http request option.
|
|
319
319
|
* @throws {RequiredError}
|
|
320
320
|
*/
|
|
321
|
-
listPartnerRelations: async (authorization?: string, pageSize?:
|
|
321
|
+
listPartnerRelations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
322
322
|
const localVarPath = `/partnerservice/v1/partners/relations`;
|
|
323
323
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
324
324
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -493,17 +493,17 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
493
493
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
494
494
|
* @summary List partner relation types
|
|
495
495
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
496
|
-
* @param {
|
|
497
|
-
* @param {
|
|
496
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
497
|
+
* @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.
|
|
498
498
|
* @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>
|
|
499
|
-
* @param {
|
|
499
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
500
500
|
* @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>
|
|
501
501
|
* @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/>
|
|
502
502
|
* @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>
|
|
503
503
|
* @param {*} [options] Override http request option.
|
|
504
504
|
* @throws {RequiredError}
|
|
505
505
|
*/
|
|
506
|
-
async listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
506
|
+
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>> {
|
|
507
507
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
508
508
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
509
509
|
},
|
|
@@ -511,17 +511,17 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
|
511
511
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
512
512
|
* @summary List partner relations
|
|
513
513
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
514
|
-
* @param {
|
|
515
|
-
* @param {
|
|
514
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
515
|
+
* @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.
|
|
516
516
|
* @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>
|
|
517
|
-
* @param {
|
|
517
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
518
518
|
* @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>
|
|
519
519
|
* @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>
|
|
520
520
|
* @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>
|
|
521
521
|
* @param {*} [options] Override http request option.
|
|
522
522
|
* @throws {RequiredError}
|
|
523
523
|
*/
|
|
524
|
-
async listPartnerRelations(authorization?: string, pageSize?:
|
|
524
|
+
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>> {
|
|
525
525
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
526
526
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
527
527
|
},
|
|
@@ -596,34 +596,34 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
|
|
|
596
596
|
* List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
597
597
|
* @summary List partner relation types
|
|
598
598
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
599
|
-
* @param {
|
|
600
|
-
* @param {
|
|
599
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
600
|
+
* @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.
|
|
601
601
|
* @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>
|
|
602
|
-
* @param {
|
|
602
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
603
603
|
* @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>
|
|
604
604
|
* @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/>
|
|
605
605
|
* @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>
|
|
606
606
|
* @param {*} [options] Override http request option.
|
|
607
607
|
* @throws {RequiredError}
|
|
608
608
|
*/
|
|
609
|
-
listPartnerRelationTypes(authorization?: string, pageSize?:
|
|
609
|
+
listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
|
|
610
610
|
return localVarFp.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
611
611
|
},
|
|
612
612
|
/**
|
|
613
613
|
* List all partner relations **Required Permissions** \"partner-management.partners.view\"
|
|
614
614
|
* @summary List partner relations
|
|
615
615
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
616
|
-
* @param {
|
|
617
|
-
* @param {
|
|
616
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
617
|
+
* @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.
|
|
618
618
|
* @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>
|
|
619
|
-
* @param {
|
|
619
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
620
620
|
* @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>
|
|
621
621
|
* @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>
|
|
622
622
|
* @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>
|
|
623
623
|
* @param {*} [options] Override http request option.
|
|
624
624
|
* @throws {RequiredError}
|
|
625
625
|
*/
|
|
626
|
-
listPartnerRelations(authorization?: string, pageSize?:
|
|
626
|
+
listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass> {
|
|
627
627
|
return localVarFp.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
628
628
|
},
|
|
629
629
|
/**
|
|
@@ -740,17 +740,17 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
740
740
|
|
|
741
741
|
/**
|
|
742
742
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
743
|
-
* @type {
|
|
743
|
+
* @type {number}
|
|
744
744
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
745
745
|
*/
|
|
746
|
-
readonly pageSize?:
|
|
746
|
+
readonly pageSize?: number
|
|
747
747
|
|
|
748
748
|
/**
|
|
749
|
-
* 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,
|
|
750
|
-
* @type {
|
|
749
|
+
* 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.
|
|
750
|
+
* @type {string}
|
|
751
751
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
752
752
|
*/
|
|
753
|
-
readonly pageToken?:
|
|
753
|
+
readonly pageToken?: string
|
|
754
754
|
|
|
755
755
|
/**
|
|
756
756
|
* 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>
|
|
@@ -761,10 +761,10 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
|
|
|
761
761
|
|
|
762
762
|
/**
|
|
763
763
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
764
|
-
* @type {
|
|
764
|
+
* @type {string}
|
|
765
765
|
* @memberof PartnerRelationsApiListPartnerRelationTypes
|
|
766
766
|
*/
|
|
767
|
-
readonly search?:
|
|
767
|
+
readonly search?: string
|
|
768
768
|
|
|
769
769
|
/**
|
|
770
770
|
* 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>
|
|
@@ -803,17 +803,17 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
803
803
|
|
|
804
804
|
/**
|
|
805
805
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
806
|
-
* @type {
|
|
806
|
+
* @type {number}
|
|
807
807
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
808
808
|
*/
|
|
809
|
-
readonly pageSize?:
|
|
809
|
+
readonly pageSize?: number
|
|
810
810
|
|
|
811
811
|
/**
|
|
812
|
-
* 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,
|
|
813
|
-
* @type {
|
|
812
|
+
* 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.
|
|
813
|
+
* @type {string}
|
|
814
814
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
815
815
|
*/
|
|
816
|
-
readonly pageToken?:
|
|
816
|
+
readonly pageToken?: string
|
|
817
817
|
|
|
818
818
|
/**
|
|
819
819
|
* 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>
|
|
@@ -824,10 +824,10 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
|
|
|
824
824
|
|
|
825
825
|
/**
|
|
826
826
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
827
|
-
* @type {
|
|
827
|
+
* @type {string}
|
|
828
828
|
* @memberof PartnerRelationsApiListPartnerRelations
|
|
829
829
|
*/
|
|
830
|
-
readonly search?:
|
|
830
|
+
readonly search?: string
|
|
831
831
|
|
|
832
832
|
/**
|
|
833
833
|
* 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
|
@@ -183,17 +183,17 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
183
183
|
* 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\"
|
|
184
184
|
* @summary List partner tags
|
|
185
185
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
|
-
* @param {
|
|
187
|
-
* @param {
|
|
186
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
187
|
+
* @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.
|
|
188
188
|
* @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>
|
|
189
|
-
* @param {
|
|
189
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
190
190
|
* @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>
|
|
191
191
|
* @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/>
|
|
192
192
|
* @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>
|
|
193
193
|
* @param {*} [options] Override http request option.
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
*/
|
|
196
|
-
listTags: async (authorization?: string, pageSize?:
|
|
196
|
+
listTags: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
197
197
|
const localVarPath = `/partnerservice/v1/tags`;
|
|
198
198
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
199
199
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -350,17 +350,17 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
|
|
|
350
350
|
* 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\"
|
|
351
351
|
* @summary List partner tags
|
|
352
352
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
|
-
* @param {
|
|
354
|
-
* @param {
|
|
353
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
354
|
+
* @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.
|
|
355
355
|
* @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>
|
|
356
|
-
* @param {
|
|
356
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
357
357
|
* @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>
|
|
358
358
|
* @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/>
|
|
359
359
|
* @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>
|
|
360
360
|
* @param {*} [options] Override http request option.
|
|
361
361
|
* @throws {RequiredError}
|
|
362
362
|
*/
|
|
363
|
-
async listTags(authorization?: string, pageSize?:
|
|
363
|
+
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>> {
|
|
364
364
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listTags(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
365
365
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
366
366
|
},
|
|
@@ -423,17 +423,17 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
|
|
|
423
423
|
* 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\"
|
|
424
424
|
* @summary List partner tags
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
426
|
-
* @param {
|
|
427
|
-
* @param {
|
|
426
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
427
|
+
* @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.
|
|
428
428
|
* @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>
|
|
429
|
-
* @param {
|
|
429
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
430
430
|
* @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>
|
|
431
431
|
* @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/>
|
|
432
432
|
* @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>
|
|
433
433
|
* @param {*} [options] Override http request option.
|
|
434
434
|
* @throws {RequiredError}
|
|
435
435
|
*/
|
|
436
|
-
listTags(authorization?: string, pageSize?:
|
|
436
|
+
listTags(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTagsResponseClass> {
|
|
437
437
|
return localVarFp.listTags(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
438
438
|
},
|
|
439
439
|
/**
|
|
@@ -528,17 +528,17 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
528
528
|
|
|
529
529
|
/**
|
|
530
530
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
531
|
-
* @type {
|
|
531
|
+
* @type {number}
|
|
532
532
|
* @memberof PartnerTagsApiListTags
|
|
533
533
|
*/
|
|
534
|
-
readonly pageSize?:
|
|
534
|
+
readonly pageSize?: number
|
|
535
535
|
|
|
536
536
|
/**
|
|
537
|
-
* 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,
|
|
538
|
-
* @type {
|
|
537
|
+
* 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.
|
|
538
|
+
* @type {string}
|
|
539
539
|
* @memberof PartnerTagsApiListTags
|
|
540
540
|
*/
|
|
541
|
-
readonly pageToken?:
|
|
541
|
+
readonly pageToken?: string
|
|
542
542
|
|
|
543
543
|
/**
|
|
544
544
|
* 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>
|
|
@@ -549,10 +549,10 @@ export interface PartnerTagsApiListTagsRequest {
|
|
|
549
549
|
|
|
550
550
|
/**
|
|
551
551
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
552
|
-
* @type {
|
|
552
|
+
* @type {string}
|
|
553
553
|
* @memberof PartnerTagsApiListTags
|
|
554
554
|
*/
|
|
555
|
-
readonly search?:
|
|
555
|
+
readonly search?: string
|
|
556
556
|
|
|
557
557
|
/**
|
|
558
558
|
* 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
|
@@ -190,17 +190,17 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
|
|
|
190
190
|
* 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\"
|
|
191
191
|
* @summary List partner-types
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
-
* @param {
|
|
194
|
-
* @param {
|
|
195
|
-
* @param {
|
|
196
|
-
* @param {
|
|
197
|
-
* @param {
|
|
198
|
-
* @param {
|
|
199
|
-
* @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
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
196
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
197
|
+
* @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.
|
|
198
|
+
* @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.
|
|
199
|
+
* @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.
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
203
|
-
listPartnerTypes: async (authorization?: string, pageSize?:
|
|
203
|
+
listPartnerTypes: 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/partner-types`;
|
|
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);
|
|
@@ -364,17 +364,17 @@ export const PartnerTypesApiFp = function(configuration?: Configuration) {
|
|
|
364
364
|
* 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\"
|
|
365
365
|
* @summary List partner-types
|
|
366
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
|
-
* @param {
|
|
368
|
-
* @param {
|
|
369
|
-
* @param {
|
|
370
|
-
* @param {
|
|
371
|
-
* @param {
|
|
372
|
-
* @param {
|
|
373
|
-
* @param {
|
|
367
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
|
+
* @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.
|
|
369
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
370
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
371
|
+
* @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.
|
|
372
|
+
* @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.
|
|
373
|
+
* @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.
|
|
374
374
|
* @param {*} [options] Override http request option.
|
|
375
375
|
* @throws {RequiredError}
|
|
376
376
|
*/
|
|
377
|
-
async listPartnerTypes(authorization?: string, pageSize?:
|
|
377
|
+
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>> {
|
|
378
378
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
379
379
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
380
380
|
},
|
|
@@ -439,17 +439,17 @@ export const PartnerTypesApiFactory = function (configuration?: Configuration, b
|
|
|
439
439
|
* 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\"
|
|
440
440
|
* @summary List partner-types
|
|
441
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
|
-
* @param {
|
|
443
|
-
* @param {
|
|
444
|
-
* @param {
|
|
445
|
-
* @param {
|
|
446
|
-
* @param {
|
|
447
|
-
* @param {
|
|
448
|
-
* @param {
|
|
442
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
|
+
* @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.
|
|
444
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
445
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
446
|
+
* @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.
|
|
447
|
+
* @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.
|
|
448
|
+
* @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.
|
|
449
449
|
* @param {*} [options] Override http request option.
|
|
450
450
|
* @throws {RequiredError}
|
|
451
451
|
*/
|
|
452
|
-
listPartnerTypes(authorization?: string, pageSize?:
|
|
452
|
+
listPartnerTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerTypesResponseClass> {
|
|
453
453
|
return localVarFp.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
454
454
|
},
|
|
455
455
|
/**
|
|
@@ -552,52 +552,52 @@ export interface PartnerTypesApiListPartnerTypesRequest {
|
|
|
552
552
|
|
|
553
553
|
/**
|
|
554
554
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
555
|
-
* @type {
|
|
555
|
+
* @type {number}
|
|
556
556
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
557
557
|
*/
|
|
558
|
-
readonly pageSize?:
|
|
558
|
+
readonly pageSize?: number
|
|
559
559
|
|
|
560
560
|
/**
|
|
561
|
-
* 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,
|
|
562
|
-
* @type {
|
|
561
|
+
* 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.
|
|
562
|
+
* @type {string}
|
|
563
563
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
564
564
|
*/
|
|
565
|
-
readonly pageToken?:
|
|
565
|
+
readonly pageToken?: string
|
|
566
566
|
|
|
567
567
|
/**
|
|
568
568
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
569
|
-
* @type {
|
|
569
|
+
* @type {string}
|
|
570
570
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
571
571
|
*/
|
|
572
|
-
readonly filter?:
|
|
572
|
+
readonly filter?: string
|
|
573
573
|
|
|
574
574
|
/**
|
|
575
575
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
576
|
-
* @type {
|
|
576
|
+
* @type {string}
|
|
577
577
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
578
578
|
*/
|
|
579
|
-
readonly search?:
|
|
579
|
+
readonly search?: string
|
|
580
580
|
|
|
581
581
|
/**
|
|
582
582
|
* 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.
|
|
583
|
-
* @type {
|
|
583
|
+
* @type {string}
|
|
584
584
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
585
585
|
*/
|
|
586
|
-
readonly order?:
|
|
586
|
+
readonly order?: string
|
|
587
587
|
|
|
588
588
|
/**
|
|
589
|
-
* 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
|
|
590
|
-
* @type {
|
|
589
|
+
* 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.
|
|
590
|
+
* @type {string}
|
|
591
591
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
592
592
|
*/
|
|
593
|
-
readonly expand?:
|
|
593
|
+
readonly expand?: string
|
|
594
594
|
|
|
595
595
|
/**
|
|
596
596
|
* 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.
|
|
597
|
-
* @type {
|
|
597
|
+
* @type {string}
|
|
598
598
|
* @memberof PartnerTypesApiListPartnerTypes
|
|
599
599
|
*/
|
|
600
|
-
readonly filters?:
|
|
600
|
+
readonly filters?: string
|
|
601
601
|
}
|
|
602
602
|
|
|
603
603
|
/**
|