@emilgroup/partner-sdk 1.0.1 → 1.2.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.
Files changed (97) hide show
  1. package/.openapi-generator/FILES +21 -1
  2. package/README.md +2 -2
  3. package/api/default-api.ts +8 -4
  4. package/api/partner-relations-api.ts +968 -0
  5. package/api/partner-tags-api.ts +662 -0
  6. package/api/partner-types-api.ts +36 -22
  7. package/api/partner-version-api.ts +375 -0
  8. package/api/partners-api.ts +154 -22
  9. package/api.ts +6 -0
  10. package/base.ts +6 -1
  11. package/dist/api/default-api.d.ts +8 -4
  12. package/dist/api/default-api.js +8 -4
  13. package/dist/api/partner-relations-api.d.ts +550 -0
  14. package/dist/api/partner-relations-api.js +857 -0
  15. package/dist/api/partner-tags-api.d.ts +375 -0
  16. package/dist/api/partner-tags-api.js +629 -0
  17. package/dist/api/partner-types-api.d.ts +28 -19
  18. package/dist/api/partner-types-api.js +26 -20
  19. package/dist/api/partner-version-api.d.ts +224 -0
  20. package/dist/api/partner-version-api.js +363 -0
  21. package/dist/api/partners-api.d.ts +93 -19
  22. package/dist/api/partners-api.js +125 -20
  23. package/dist/api.d.ts +3 -0
  24. package/dist/api.js +3 -0
  25. package/dist/base.d.ts +1 -0
  26. package/dist/base.js +5 -1
  27. package/dist/models/create-partner-relation-request-dto-rest.d.ts +65 -0
  28. package/dist/models/create-partner-relation-request-dto-rest.js +26 -0
  29. package/dist/models/create-partner-relation-response-class.d.ts +25 -0
  30. package/dist/models/create-partner-type-request-dto.d.ts +13 -3
  31. package/dist/models/create-partner-type-request-dto.js +5 -0
  32. package/dist/models/create-tag-request-dto.d.ts +36 -0
  33. package/dist/models/create-tag-request-dto.js +15 -0
  34. package/dist/models/create-tag-response-class.d.ts +25 -0
  35. package/dist/models/create-tag-response-class.js +15 -0
  36. package/dist/models/get-partner-relation-class.d.ts +25 -0
  37. package/dist/models/get-partner-relation-class.js +15 -0
  38. package/dist/models/get-partner-relation-type-class.d.ts +25 -0
  39. package/dist/models/get-partner-relation-type-class.js +15 -0
  40. package/dist/models/get-partner-version-response-class.d.ts +25 -0
  41. package/dist/models/get-partner-version-response-class.js +15 -0
  42. package/dist/models/get-tag-response-class.d.ts +25 -0
  43. package/dist/models/get-tag-response-class.js +15 -0
  44. package/dist/models/index.d.ts +18 -1
  45. package/dist/models/index.js +18 -1
  46. package/dist/models/list-partner-relation-class.d.ts +31 -0
  47. package/dist/models/list-partner-relation-class.js +15 -0
  48. package/dist/models/list-partner-relation-types-class.d.ts +31 -0
  49. package/dist/models/list-partner-relation-types-class.js +15 -0
  50. package/dist/models/list-partner-versions-response-class.d.ts +25 -0
  51. package/dist/models/list-partner-versions-response-class.js +15 -0
  52. package/dist/models/list-tags-response-class.d.ts +31 -0
  53. package/dist/models/list-tags-response-class.js +15 -0
  54. package/dist/models/partner-class.d.ts +18 -0
  55. package/dist/models/partner-relation-class.d.ts +72 -0
  56. package/dist/models/partner-relation-class.js +15 -0
  57. package/dist/models/partner-relation-type-class.d.ts +66 -0
  58. package/dist/models/partner-relation-type-class.js +15 -0
  59. package/dist/models/partner-type-class.d.ts +11 -0
  60. package/dist/models/partner-type-class.js +5 -0
  61. package/dist/models/tag-class.d.ts +54 -0
  62. package/dist/models/tag-class.js +15 -0
  63. package/dist/models/tag-partner-request-dto-rest.d.ts +24 -0
  64. package/dist/models/tag-partner-request-dto-rest.js +15 -0
  65. package/dist/models/update-partner-relation-request-dto-rest.d.ts +36 -0
  66. package/dist/models/update-partner-relation-request-dto-rest.js +15 -0
  67. package/dist/models/update-partner-type-request-dto.d.ts +20 -4
  68. package/dist/models/update-partner-type-request-dto.js +5 -0
  69. package/dist/models/update-tag-response-class.d.ts +25 -0
  70. package/dist/models/update-tag-response-class.js +15 -0
  71. package/models/create-partner-relation-request-dto-rest.ts +74 -0
  72. package/models/create-partner-relation-response-class.ts +31 -0
  73. package/models/create-partner-type-request-dto.ts +16 -3
  74. package/models/create-tag-request-dto.ts +42 -0
  75. package/models/create-tag-response-class.ts +31 -0
  76. package/models/get-partner-relation-class.ts +31 -0
  77. package/models/get-partner-relation-type-class.ts +31 -0
  78. package/models/get-partner-version-response-class.ts +31 -0
  79. package/models/get-tag-response-class.ts +31 -0
  80. package/models/index.ts +18 -1
  81. package/models/list-partner-relation-class.ts +37 -0
  82. package/models/list-partner-relation-types-class.ts +37 -0
  83. package/models/list-partner-versions-response-class.ts +31 -0
  84. package/models/list-tags-response-class.ts +37 -0
  85. package/models/partner-class.ts +18 -0
  86. package/models/partner-relation-class.ts +78 -0
  87. package/models/partner-relation-type-class.ts +72 -0
  88. package/models/partner-type-class.ts +14 -0
  89. package/models/tag-class.ts +60 -0
  90. package/models/tag-partner-request-dto-rest.ts +30 -0
  91. package/models/update-partner-relation-request-dto-rest.ts +42 -0
  92. package/models/update-partner-type-request-dto.ts +23 -4
  93. package/models/update-tag-response-class.ts +31 -0
  94. package/package.json +1 -1
  95. package/dist/models/partner-type-custom-schema-dto.d.ts +0 -66
  96. package/models/partner-type-custom-schema-dto.ts +0 -72
  97. /package/dist/models/{partner-type-custom-schema-dto.js → create-partner-relation-response-class.js} +0 -0
@@ -133,7 +133,7 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
133
133
  };
134
134
  },
135
135
  /**
136
- * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
136
+ * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
137
137
  * @summary Retrieve the partner-types
138
138
  * @param {string} code Unique identifier for the object.
139
139
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -183,19 +183,20 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
183
183
  };
184
184
  },
185
185
  /**
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.
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.
187
187
  * @summary List partner-types
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
189
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
190
  * @param {any} [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
191
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
192
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
193
193
  * @param {any} [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
194
  * @param {any} [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 {any} [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.
195
196
  * @param {*} [options] Override http request option.
196
197
  * @throws {RequiredError}
197
198
  */
198
- listPartnerTypes: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
+ listPartnerTypes: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
200
  const localVarPath = `/partnerservice/v1/partner-types`;
200
201
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
201
202
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -238,6 +239,10 @@ export const PartnerTypesApiAxiosParamCreator = function (configuration?: Config
238
239
  localVarQueryParameter['expand'] = expand;
239
240
  }
240
241
 
242
+ if (filters !== undefined) {
243
+ localVarQueryParameter['filters'] = filters;
244
+ }
245
+
241
246
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
242
247
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
243
248
  }
@@ -339,7 +344,7 @@ export const PartnerTypesApiFp = function(configuration?: Configuration) {
339
344
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
340
345
  },
341
346
  /**
342
- * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
347
+ * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
343
348
  * @summary Retrieve the partner-types
344
349
  * @param {string} code Unique identifier for the object.
345
350
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -352,20 +357,21 @@ export const PartnerTypesApiFp = function(configuration?: Configuration) {
352
357
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
353
358
  },
354
359
  /**
355
- * 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.
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.
356
361
  * @summary List partner-types
357
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
358
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
363
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
359
364
  * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
360
365
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
361
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
366
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
362
367
  * @param {any} [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.
363
368
  * @param {any} [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 {any} [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.
364
370
  * @param {*} [options] Override http request option.
365
371
  * @throws {RequiredError}
366
372
  */
367
- async listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerTypesResponseClass>> {
368
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, options);
373
+ async listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerTypesResponseClass>> {
374
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
369
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
370
376
  },
371
377
  /**
@@ -414,7 +420,7 @@ export const PartnerTypesApiFactory = function (configuration?: Configuration, b
414
420
  return localVarFp.deletePartnerType(code, authorization, options).then((request) => request(axios, basePath));
415
421
  },
416
422
  /**
417
- * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
423
+ * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
418
424
  * @summary Retrieve the partner-types
419
425
  * @param {string} code Unique identifier for the object.
420
426
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -426,20 +432,21 @@ export const PartnerTypesApiFactory = function (configuration?: Configuration, b
426
432
  return localVarFp.getPartnerType(code, authorization, expand, options).then((request) => request(axios, basePath));
427
433
  },
428
434
  /**
429
- * 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.
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.
430
436
  * @summary List partner-types
431
437
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
432
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
438
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
433
439
  * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
434
440
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
435
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
441
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
436
442
  * @param {any} [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.
437
443
  * @param {any} [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 {any} [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.
438
445
  * @param {*} [options] Override http request option.
439
446
  * @throws {RequiredError}
440
447
  */
441
- listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPartnerTypesResponseClass> {
442
- return localVarFp.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
448
+ listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPartnerTypesResponseClass> {
449
+ return localVarFp.listPartnerTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
443
450
  },
444
451
  /**
445
452
  * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -540,7 +547,7 @@ export interface PartnerTypesApiListPartnerTypesRequest {
540
547
  readonly authorization?: string
541
548
 
542
549
  /**
543
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
550
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
544
551
  * @type {any}
545
552
  * @memberof PartnerTypesApiListPartnerTypes
546
553
  */
@@ -561,7 +568,7 @@ export interface PartnerTypesApiListPartnerTypesRequest {
561
568
  readonly filter?: any
562
569
 
563
570
  /**
564
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
571
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
565
572
  * @type {any}
566
573
  * @memberof PartnerTypesApiListPartnerTypes
567
574
  */
@@ -580,6 +587,13 @@ export interface PartnerTypesApiListPartnerTypesRequest {
580
587
  * @memberof PartnerTypesApiListPartnerTypes
581
588
  */
582
589
  readonly expand?: any
590
+
591
+ /**
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 {any}
594
+ * @memberof PartnerTypesApiListPartnerTypes
595
+ */
596
+ readonly filters?: any
583
597
  }
584
598
 
585
599
  /**
@@ -642,7 +656,7 @@ export class PartnerTypesApi extends BaseAPI {
642
656
  }
643
657
 
644
658
  /**
645
- * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
659
+ * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
646
660
  * @summary Retrieve the partner-types
647
661
  * @param {PartnerTypesApiGetPartnerTypeRequest} requestParameters Request parameters.
648
662
  * @param {*} [options] Override http request option.
@@ -654,7 +668,7 @@ export class PartnerTypesApi extends BaseAPI {
654
668
  }
655
669
 
656
670
  /**
657
- * 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.
671
+ * 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.
658
672
  * @summary List partner-types
659
673
  * @param {PartnerTypesApiListPartnerTypesRequest} requestParameters Request parameters.
660
674
  * @param {*} [options] Override http request option.
@@ -662,7 +676,7 @@ export class PartnerTypesApi extends BaseAPI {
662
676
  * @memberof PartnerTypesApi
663
677
  */
664
678
  public listPartnerTypes(requestParameters: PartnerTypesApiListPartnerTypesRequest = {}, options?: AxiosRequestConfig) {
665
- return PartnerTypesApiFp(this.configuration).listPartnerTypes(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
679
+ return PartnerTypesApiFp(this.configuration).listPartnerTypes(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
666
680
  }
667
681
 
668
682
  /**
@@ -0,0 +1,375 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL PartnerService
5
+ * The EMIL PartnerService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { GetPartnerVersionResponseClass } from '../models';
25
+ // @ts-ignore
26
+ import { ListPartnerVersionsResponseClass } from '../models';
27
+ /**
28
+ * PartnerVersionApi - axios parameter creator
29
+ * @export
30
+ */
31
+ export const PartnerVersionApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * Retrieve a partner version by providing partner code and version number
35
+ * @summary Retrieve the partner version
36
+ * @param {string} code Unique identifier for the object.
37
+ * @param {number} version
38
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ getPartnerVersion: async (code: string, version: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
43
+ // verify required parameter 'code' is not null or undefined
44
+ assertParamExists('getPartnerVersion', 'code', code)
45
+ // verify required parameter 'version' is not null or undefined
46
+ assertParamExists('getPartnerVersion', 'version', version)
47
+ const localVarPath = `/partnerservice/v1/partners/{code}/versions/{version}`
48
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)))
49
+ .replace(`{${"version"}}`, encodeURIComponent(String(version)));
50
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
51
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
52
+ let baseOptions;
53
+ let baseAccessToken;
54
+ if (configuration) {
55
+ baseOptions = configuration.baseOptions;
56
+ baseAccessToken = configuration.accessToken;
57
+ }
58
+
59
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
60
+ const localVarHeaderParameter = {} as any;
61
+ const localVarQueryParameter = {} as any;
62
+
63
+ // authentication bearer required
64
+ // http bearer authentication required
65
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
66
+
67
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
68
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
69
+ }
70
+
71
+
72
+
73
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
74
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
75
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
76
+
77
+ return {
78
+ url: toPathString(localVarUrlObj),
79
+ options: localVarRequestOptions,
80
+ };
81
+ },
82
+ /**
83
+ * Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
84
+ * @summary List partner versions
85
+ * @param {string} code
86
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
87
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
88
+ * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
89
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
90
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
91
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: displayName, createdAt, updatedAt, version&lt;/i&gt;
92
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType.&lt;i&gt;
93
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
94
+ * @param {*} [options] Override http request option.
95
+ * @throws {RequiredError}
96
+ */
97
+ listPartnerVersion: async (code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
98
+ // verify required parameter 'code' is not null or undefined
99
+ assertParamExists('listPartnerVersion', 'code', code)
100
+ const localVarPath = `/partnerservice/v1/partners/{code}/versions`
101
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
102
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
103
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
104
+ let baseOptions;
105
+ let baseAccessToken;
106
+ if (configuration) {
107
+ baseOptions = configuration.baseOptions;
108
+ baseAccessToken = configuration.accessToken;
109
+ }
110
+
111
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
112
+ const localVarHeaderParameter = {} as any;
113
+ const localVarQueryParameter = {} as any;
114
+
115
+ // authentication bearer required
116
+ // http bearer authentication required
117
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
118
+
119
+ if (pageSize !== undefined) {
120
+ localVarQueryParameter['pageSize'] = pageSize;
121
+ }
122
+
123
+ if (pageToken !== undefined) {
124
+ localVarQueryParameter['pageToken'] = pageToken;
125
+ }
126
+
127
+ if (filter !== undefined) {
128
+ localVarQueryParameter['filter'] = filter;
129
+ }
130
+
131
+ if (search !== undefined) {
132
+ localVarQueryParameter['search'] = search;
133
+ }
134
+
135
+ if (order !== undefined) {
136
+ localVarQueryParameter['order'] = order;
137
+ }
138
+
139
+ if (expand !== undefined) {
140
+ localVarQueryParameter['expand'] = expand;
141
+ }
142
+
143
+ if (filters !== undefined) {
144
+ localVarQueryParameter['filters'] = filters;
145
+ }
146
+
147
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
148
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
149
+ }
150
+
151
+
152
+
153
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
154
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
155
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
156
+
157
+ return {
158
+ url: toPathString(localVarUrlObj),
159
+ options: localVarRequestOptions,
160
+ };
161
+ },
162
+ }
163
+ };
164
+
165
+ /**
166
+ * PartnerVersionApi - functional programming interface
167
+ * @export
168
+ */
169
+ export const PartnerVersionApiFp = function(configuration?: Configuration) {
170
+ const localVarAxiosParamCreator = PartnerVersionApiAxiosParamCreator(configuration)
171
+ return {
172
+ /**
173
+ * Retrieve a partner version by providing partner code and version number
174
+ * @summary Retrieve the partner version
175
+ * @param {string} code Unique identifier for the object.
176
+ * @param {number} version
177
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
178
+ * @param {*} [options] Override http request option.
179
+ * @throws {RequiredError}
180
+ */
181
+ async getPartnerVersion(code: string, version: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerVersionResponseClass>> {
182
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerVersion(code, version, authorization, options);
183
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
184
+ },
185
+ /**
186
+ * Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
187
+ * @summary List partner versions
188
+ * @param {string} code
189
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
190
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
191
+ * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
192
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
193
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
194
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: displayName, createdAt, updatedAt, version&lt;/i&gt;
195
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType.&lt;i&gt;
196
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
197
+ * @param {*} [options] Override http request option.
198
+ * @throws {RequiredError}
199
+ */
200
+ async listPartnerVersion(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerVersionsResponseClass>> {
201
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
202
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
203
+ },
204
+ }
205
+ };
206
+
207
+ /**
208
+ * PartnerVersionApi - factory interface
209
+ * @export
210
+ */
211
+ export const PartnerVersionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
212
+ const localVarFp = PartnerVersionApiFp(configuration)
213
+ return {
214
+ /**
215
+ * Retrieve a partner version by providing partner code and version number
216
+ * @summary Retrieve the partner version
217
+ * @param {string} code Unique identifier for the object.
218
+ * @param {number} version
219
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
220
+ * @param {*} [options] Override http request option.
221
+ * @throws {RequiredError}
222
+ */
223
+ getPartnerVersion(code: string, version: number, authorization?: string, options?: any): AxiosPromise<GetPartnerVersionResponseClass> {
224
+ return localVarFp.getPartnerVersion(code, version, authorization, options).then((request) => request(axios, basePath));
225
+ },
226
+ /**
227
+ * Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
228
+ * @summary List partner versions
229
+ * @param {string} code
230
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
231
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
232
+ * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
233
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
234
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: displayName, createdAt, updatedAt, version&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType.&lt;i&gt;
237
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
238
+ * @param {*} [options] Override http request option.
239
+ * @throws {RequiredError}
240
+ */
241
+ listPartnerVersion(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerVersionsResponseClass> {
242
+ return localVarFp.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
243
+ },
244
+ };
245
+ };
246
+
247
+ /**
248
+ * Request parameters for getPartnerVersion operation in PartnerVersionApi.
249
+ * @export
250
+ * @interface PartnerVersionApiGetPartnerVersionRequest
251
+ */
252
+ export interface PartnerVersionApiGetPartnerVersionRequest {
253
+ /**
254
+ * Unique identifier for the object.
255
+ * @type {string}
256
+ * @memberof PartnerVersionApiGetPartnerVersion
257
+ */
258
+ readonly code: string
259
+
260
+ /**
261
+ *
262
+ * @type {number}
263
+ * @memberof PartnerVersionApiGetPartnerVersion
264
+ */
265
+ readonly version: number
266
+
267
+ /**
268
+ * Bearer Token: provided by the login endpoint under the name accessToken.
269
+ * @type {string}
270
+ * @memberof PartnerVersionApiGetPartnerVersion
271
+ */
272
+ readonly authorization?: string
273
+ }
274
+
275
+ /**
276
+ * Request parameters for listPartnerVersion operation in PartnerVersionApi.
277
+ * @export
278
+ * @interface PartnerVersionApiListPartnerVersionRequest
279
+ */
280
+ export interface PartnerVersionApiListPartnerVersionRequest {
281
+ /**
282
+ *
283
+ * @type {string}
284
+ * @memberof PartnerVersionApiListPartnerVersion
285
+ */
286
+ readonly code: string
287
+
288
+ /**
289
+ * Bearer Token: provided by the login endpoint under the name accessToken.
290
+ * @type {string}
291
+ * @memberof PartnerVersionApiListPartnerVersion
292
+ */
293
+ readonly authorization?: string
294
+
295
+ /**
296
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
297
+ * @type {any}
298
+ * @memberof PartnerVersionApiListPartnerVersion
299
+ */
300
+ readonly pageSize?: any
301
+
302
+ /**
303
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
304
+ * @type {any}
305
+ * @memberof PartnerVersionApiListPartnerVersion
306
+ */
307
+ readonly pageToken?: any
308
+
309
+ /**
310
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
311
+ * @type {string}
312
+ * @memberof PartnerVersionApiListPartnerVersion
313
+ */
314
+ readonly filter?: string
315
+
316
+ /**
317
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
318
+ * @type {any}
319
+ * @memberof PartnerVersionApiListPartnerVersion
320
+ */
321
+ readonly search?: any
322
+
323
+ /**
324
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: displayName, createdAt, updatedAt, version&lt;/i&gt;
325
+ * @type {string}
326
+ * @memberof PartnerVersionApiListPartnerVersion
327
+ */
328
+ readonly order?: string
329
+
330
+ /**
331
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: partnerType.&lt;i&gt;
332
+ * @type {string}
333
+ * @memberof PartnerVersionApiListPartnerVersion
334
+ */
335
+ readonly expand?: string
336
+
337
+ /**
338
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
339
+ * @type {string}
340
+ * @memberof PartnerVersionApiListPartnerVersion
341
+ */
342
+ readonly filters?: string
343
+ }
344
+
345
+ /**
346
+ * PartnerVersionApi - object-oriented interface
347
+ * @export
348
+ * @class PartnerVersionApi
349
+ * @extends {BaseAPI}
350
+ */
351
+ export class PartnerVersionApi extends BaseAPI {
352
+ /**
353
+ * Retrieve a partner version by providing partner code and version number
354
+ * @summary Retrieve the partner version
355
+ * @param {PartnerVersionApiGetPartnerVersionRequest} requestParameters Request parameters.
356
+ * @param {*} [options] Override http request option.
357
+ * @throws {RequiredError}
358
+ * @memberof PartnerVersionApi
359
+ */
360
+ public getPartnerVersion(requestParameters: PartnerVersionApiGetPartnerVersionRequest, options?: AxiosRequestConfig) {
361
+ return PartnerVersionApiFp(this.configuration).getPartnerVersion(requestParameters.code, requestParameters.version, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
362
+ }
363
+
364
+ /**
365
+ * Returns a list of partner versions you have previously created. The partner versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
366
+ * @summary List partner versions
367
+ * @param {PartnerVersionApiListPartnerVersionRequest} requestParameters Request parameters.
368
+ * @param {*} [options] Override http request option.
369
+ * @throws {RequiredError}
370
+ * @memberof PartnerVersionApi
371
+ */
372
+ public listPartnerVersion(requestParameters: PartnerVersionApiListPartnerVersionRequest, options?: AxiosRequestConfig) {
373
+ return PartnerVersionApiFp(this.configuration).listPartnerVersion(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
374
+ }
375
+ }