flexinet-api 0.0.764-prerelease0 → 0.0.778-prerelease0

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## flexinet-api@0.0.764-prerelease0
1
+ ## flexinet-api@0.0.778-prerelease0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install flexinet-api@0.0.764-prerelease0 --save
39
+ npm install flexinet-api@0.0.778-prerelease0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -2670,6 +2670,12 @@ export interface SystemUserDetails {
2670
2670
  * @interface Tag
2671
2671
  */
2672
2672
  export interface Tag {
2673
+ /**
2674
+ *
2675
+ * @type {string}
2676
+ * @memberof Tag
2677
+ */
2678
+ 'id': string;
2673
2679
  /**
2674
2680
  *
2675
2681
  * @type {string}
@@ -2715,6 +2721,12 @@ export interface TagCreationRequest {
2715
2721
  * @memberof TagCreationRequest
2716
2722
  */
2717
2723
  'key': string;
2724
+ /**
2725
+ *
2726
+ * @type {{ [key: string]: string; }}
2727
+ * @memberof TagCreationRequest
2728
+ */
2729
+ 'translations': { [key: string]: string; };
2718
2730
  /**
2719
2731
  *
2720
2732
  * @type {TagDataType}
@@ -2733,6 +2745,12 @@ export interface TagCreationRequest {
2733
2745
  * @memberof TagCreationRequest
2734
2746
  */
2735
2747
  'isRequired': boolean;
2748
+ /**
2749
+ *
2750
+ * @type {Array<TagValueCreationRequest>}
2751
+ * @memberof TagCreationRequest
2752
+ */
2753
+ 'values'?: Array<TagValueCreationRequest>;
2736
2754
  }
2737
2755
 
2738
2756
 
@@ -2758,6 +2776,12 @@ export type TagDataType = typeof TagDataType[keyof typeof TagDataType];
2758
2776
  * @interface TagDetailed
2759
2777
  */
2760
2778
  export interface TagDetailed {
2779
+ /**
2780
+ *
2781
+ * @type {string}
2782
+ * @memberof TagDetailed
2783
+ */
2784
+ 'id': string;
2761
2785
  /**
2762
2786
  *
2763
2787
  * @type {string}
@@ -2794,6 +2818,12 @@ export interface TagDetailed {
2794
2818
  * @memberof TagDetailed
2795
2819
  */
2796
2820
  'validators': Array<TagValidator>;
2821
+ /**
2822
+ *
2823
+ * @type {Array<TagValue>}
2824
+ * @memberof TagDetailed
2825
+ */
2826
+ 'values'?: Array<TagValue>;
2797
2827
  }
2798
2828
 
2799
2829
 
@@ -3012,13 +3042,56 @@ export interface TagValidator {
3012
3042
 
3013
3043
  export const TagValidatorType = {
3014
3044
  Pattern: 'pattern',
3015
- Range: 'range',
3016
- FixedValues: 'fixed_values'
3045
+ Range: 'range'
3017
3046
  } as const;
3018
3047
 
3019
3048
  export type TagValidatorType = typeof TagValidatorType[keyof typeof TagValidatorType];
3020
3049
 
3021
3050
 
3051
+ /**
3052
+ *
3053
+ * @export
3054
+ * @interface TagValue
3055
+ */
3056
+ export interface TagValue {
3057
+ /**
3058
+ *
3059
+ * @type {any}
3060
+ * @memberof TagValue
3061
+ */
3062
+ 'value': any;
3063
+ /**
3064
+ *
3065
+ * @type {string}
3066
+ * @memberof TagValue
3067
+ */
3068
+ 'description': string;
3069
+ }
3070
+ /**
3071
+ *
3072
+ * @export
3073
+ * @interface TagValueCreationRequest
3074
+ */
3075
+ export interface TagValueCreationRequest {
3076
+ /**
3077
+ *
3078
+ * @type {any}
3079
+ * @memberof TagValueCreationRequest
3080
+ */
3081
+ 'value': any;
3082
+ /**
3083
+ *
3084
+ * @type {string}
3085
+ * @memberof TagValueCreationRequest
3086
+ */
3087
+ 'description': string;
3088
+ /**
3089
+ *
3090
+ * @type {{ [key: string]: TagValue; }}
3091
+ * @memberof TagValueCreationRequest
3092
+ */
3093
+ 'translations': { [key: string]: TagValue; };
3094
+ }
3022
3095
  /**
3023
3096
  *
3024
3097
  * @export
@@ -9649,15 +9722,15 @@ export const TagApiAxiosParamCreator = function (configuration?: Configuration)
9649
9722
  /**
9650
9723
  * This method allows deleting a tag from the system.
9651
9724
  * @summary Method allows to delete tag.
9652
- * @param {string} key Tag key
9725
+ * @param {string} id Tag id
9653
9726
  * @param {*} [options] Override http request option.
9654
9727
  * @throws {RequiredError}
9655
9728
  */
9656
- deleteTag: async (key: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
9657
- // verify required parameter 'key' is not null or undefined
9658
- assertParamExists('deleteTag', 'key', key)
9659
- const localVarPath = `/admins/tags/{key}`
9660
- .replace(`{${"key"}}`, encodeURIComponent(String(key)));
9729
+ deleteTag: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
9730
+ // verify required parameter 'id' is not null or undefined
9731
+ assertParamExists('deleteTag', 'id', id)
9732
+ const localVarPath = `/admins/tags/{id}`
9733
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
9661
9734
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9662
9735
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9663
9736
  let baseOptions;
@@ -9687,15 +9760,15 @@ export const TagApiAxiosParamCreator = function (configuration?: Configuration)
9687
9760
  /**
9688
9761
  * This method returns all information about a specific tag.
9689
9762
  * @summary Method will return tag details.
9690
- * @param {string} key Tag key
9763
+ * @param {string} id Tag ID
9691
9764
  * @param {*} [options] Override http request option.
9692
9765
  * @throws {RequiredError}
9693
9766
  */
9694
- getTagByKey: async (key: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
9695
- // verify required parameter 'key' is not null or undefined
9696
- assertParamExists('getTagByKey', 'key', key)
9697
- const localVarPath = `/admins/tags/{key}`
9698
- .replace(`{${"key"}}`, encodeURIComponent(String(key)));
9767
+ getTagByID: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
9768
+ // verify required parameter 'id' is not null or undefined
9769
+ assertParamExists('getTagByID', 'id', id)
9770
+ const localVarPath = `/admins/tags/{id}`
9771
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
9699
9772
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9700
9773
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9701
9774
  let baseOptions;
@@ -9726,10 +9799,11 @@ export const TagApiAxiosParamCreator = function (configuration?: Configuration)
9726
9799
  * This method returns a list of all tags in the system.
9727
9800
  * @summary Method returns tags list.
9728
9801
  * @param {string} [tagKey] Tag key
9802
+ * @param {string} [search] search string
9729
9803
  * @param {*} [options] Override http request option.
9730
9804
  * @throws {RequiredError}
9731
9805
  */
9732
- listTags: async (tagKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
9806
+ listTags: async (tagKey?: string, search?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
9733
9807
  const localVarPath = `/admins/tags`;
9734
9808
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9735
9809
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -9750,6 +9824,10 @@ export const TagApiAxiosParamCreator = function (configuration?: Configuration)
9750
9824
  localVarQueryParameter['tagKey'] = tagKey;
9751
9825
  }
9752
9826
 
9827
+ if (search !== undefined) {
9828
+ localVarQueryParameter['search'] = search;
9829
+ }
9830
+
9753
9831
 
9754
9832
 
9755
9833
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -9764,16 +9842,16 @@ export const TagApiAxiosParamCreator = function (configuration?: Configuration)
9764
9842
  /**
9765
9843
  * This method allows updating a tag in the system.
9766
9844
  * @summary Method allows to update tag.
9767
- * @param {string} key Tag key
9845
+ * @param {string} id Tag id
9768
9846
  * @param {UpdateTagRequest} [updateTagRequest]
9769
9847
  * @param {*} [options] Override http request option.
9770
9848
  * @throws {RequiredError}
9771
9849
  */
9772
- updateTag: async (key: string, updateTagRequest?: UpdateTagRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
9773
- // verify required parameter 'key' is not null or undefined
9774
- assertParamExists('updateTag', 'key', key)
9775
- const localVarPath = `/admins/tags/{key}`
9776
- .replace(`{${"key"}}`, encodeURIComponent(String(key)));
9850
+ updateTag: async (id: string, updateTagRequest?: UpdateTagRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
9851
+ // verify required parameter 'id' is not null or undefined
9852
+ assertParamExists('updateTag', 'id', id)
9853
+ const localVarPath = `/admins/tags/{id}`
9854
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
9777
9855
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9778
9856
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9779
9857
  let baseOptions;
@@ -9830,46 +9908,47 @@ export const TagApiFp = function(configuration?: Configuration) {
9830
9908
  /**
9831
9909
  * This method allows deleting a tag from the system.
9832
9910
  * @summary Method allows to delete tag.
9833
- * @param {string} key Tag key
9911
+ * @param {string} id Tag id
9834
9912
  * @param {*} [options] Override http request option.
9835
9913
  * @throws {RequiredError}
9836
9914
  */
9837
- async deleteTag(key: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
9838
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTag(key, options);
9915
+ async deleteTag(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
9916
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTag(id, options);
9839
9917
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
9840
9918
  },
9841
9919
  /**
9842
9920
  * This method returns all information about a specific tag.
9843
9921
  * @summary Method will return tag details.
9844
- * @param {string} key Tag key
9922
+ * @param {string} id Tag ID
9845
9923
  * @param {*} [options] Override http request option.
9846
9924
  * @throws {RequiredError}
9847
9925
  */
9848
- async getTagByKey(key: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TagDetailed>> {
9849
- const localVarAxiosArgs = await localVarAxiosParamCreator.getTagByKey(key, options);
9926
+ async getTagByID(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TagDetailed>> {
9927
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTagByID(id, options);
9850
9928
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
9851
9929
  },
9852
9930
  /**
9853
9931
  * This method returns a list of all tags in the system.
9854
9932
  * @summary Method returns tags list.
9855
9933
  * @param {string} [tagKey] Tag key
9934
+ * @param {string} [search] search string
9856
9935
  * @param {*} [options] Override http request option.
9857
9936
  * @throws {RequiredError}
9858
9937
  */
9859
- async listTags(tagKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TagListResponse>> {
9860
- const localVarAxiosArgs = await localVarAxiosParamCreator.listTags(tagKey, options);
9938
+ async listTags(tagKey?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TagListResponse>> {
9939
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTags(tagKey, search, options);
9861
9940
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
9862
9941
  },
9863
9942
  /**
9864
9943
  * This method allows updating a tag in the system.
9865
9944
  * @summary Method allows to update tag.
9866
- * @param {string} key Tag key
9945
+ * @param {string} id Tag id
9867
9946
  * @param {UpdateTagRequest} [updateTagRequest]
9868
9947
  * @param {*} [options] Override http request option.
9869
9948
  * @throws {RequiredError}
9870
9949
  */
9871
- async updateTag(key: string, updateTagRequest?: UpdateTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>> {
9872
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateTag(key, updateTagRequest, options);
9950
+ async updateTag(id: string, updateTagRequest?: UpdateTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TagDetailed>> {
9951
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateTag(id, updateTagRequest, options);
9873
9952
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
9874
9953
  },
9875
9954
  }
@@ -9895,43 +9974,44 @@ export const TagApiFactory = function (configuration?: Configuration, basePath?:
9895
9974
  /**
9896
9975
  * This method allows deleting a tag from the system.
9897
9976
  * @summary Method allows to delete tag.
9898
- * @param {string} key Tag key
9977
+ * @param {string} id Tag id
9899
9978
  * @param {*} [options] Override http request option.
9900
9979
  * @throws {RequiredError}
9901
9980
  */
9902
- deleteTag(key: string, options?: any): AxiosPromise<void> {
9903
- return localVarFp.deleteTag(key, options).then((request) => request(axios, basePath));
9981
+ deleteTag(id: string, options?: any): AxiosPromise<void> {
9982
+ return localVarFp.deleteTag(id, options).then((request) => request(axios, basePath));
9904
9983
  },
9905
9984
  /**
9906
9985
  * This method returns all information about a specific tag.
9907
9986
  * @summary Method will return tag details.
9908
- * @param {string} key Tag key
9987
+ * @param {string} id Tag ID
9909
9988
  * @param {*} [options] Override http request option.
9910
9989
  * @throws {RequiredError}
9911
9990
  */
9912
- getTagByKey(key: string, options?: any): AxiosPromise<TagDetailed> {
9913
- return localVarFp.getTagByKey(key, options).then((request) => request(axios, basePath));
9991
+ getTagByID(id: string, options?: any): AxiosPromise<TagDetailed> {
9992
+ return localVarFp.getTagByID(id, options).then((request) => request(axios, basePath));
9914
9993
  },
9915
9994
  /**
9916
9995
  * This method returns a list of all tags in the system.
9917
9996
  * @summary Method returns tags list.
9918
9997
  * @param {string} [tagKey] Tag key
9998
+ * @param {string} [search] search string
9919
9999
  * @param {*} [options] Override http request option.
9920
10000
  * @throws {RequiredError}
9921
10001
  */
9922
- listTags(tagKey?: string, options?: any): AxiosPromise<TagListResponse> {
9923
- return localVarFp.listTags(tagKey, options).then((request) => request(axios, basePath));
10002
+ listTags(tagKey?: string, search?: string, options?: any): AxiosPromise<TagListResponse> {
10003
+ return localVarFp.listTags(tagKey, search, options).then((request) => request(axios, basePath));
9924
10004
  },
9925
10005
  /**
9926
10006
  * This method allows updating a tag in the system.
9927
10007
  * @summary Method allows to update tag.
9928
- * @param {string} key Tag key
10008
+ * @param {string} id Tag id
9929
10009
  * @param {UpdateTagRequest} [updateTagRequest]
9930
10010
  * @param {*} [options] Override http request option.
9931
10011
  * @throws {RequiredError}
9932
10012
  */
9933
- updateTag(key: string, updateTagRequest?: UpdateTagRequest, options?: any): AxiosPromise<Tag> {
9934
- return localVarFp.updateTag(key, updateTagRequest, options).then((request) => request(axios, basePath));
10013
+ updateTag(id: string, updateTagRequest?: UpdateTagRequest, options?: any): AxiosPromise<TagDetailed> {
10014
+ return localVarFp.updateTag(id, updateTagRequest, options).then((request) => request(axios, basePath));
9935
10015
  },
9936
10016
  };
9937
10017
  };
@@ -9958,50 +10038,51 @@ export class TagApi extends BaseAPI {
9958
10038
  /**
9959
10039
  * This method allows deleting a tag from the system.
9960
10040
  * @summary Method allows to delete tag.
9961
- * @param {string} key Tag key
10041
+ * @param {string} id Tag id
9962
10042
  * @param {*} [options] Override http request option.
9963
10043
  * @throws {RequiredError}
9964
10044
  * @memberof TagApi
9965
10045
  */
9966
- public deleteTag(key: string, options?: AxiosRequestConfig) {
9967
- return TagApiFp(this.configuration).deleteTag(key, options).then((request) => request(this.axios, this.basePath));
10046
+ public deleteTag(id: string, options?: AxiosRequestConfig) {
10047
+ return TagApiFp(this.configuration).deleteTag(id, options).then((request) => request(this.axios, this.basePath));
9968
10048
  }
9969
10049
 
9970
10050
  /**
9971
10051
  * This method returns all information about a specific tag.
9972
10052
  * @summary Method will return tag details.
9973
- * @param {string} key Tag key
10053
+ * @param {string} id Tag ID
9974
10054
  * @param {*} [options] Override http request option.
9975
10055
  * @throws {RequiredError}
9976
10056
  * @memberof TagApi
9977
10057
  */
9978
- public getTagByKey(key: string, options?: AxiosRequestConfig) {
9979
- return TagApiFp(this.configuration).getTagByKey(key, options).then((request) => request(this.axios, this.basePath));
10058
+ public getTagByID(id: string, options?: AxiosRequestConfig) {
10059
+ return TagApiFp(this.configuration).getTagByID(id, options).then((request) => request(this.axios, this.basePath));
9980
10060
  }
9981
10061
 
9982
10062
  /**
9983
10063
  * This method returns a list of all tags in the system.
9984
10064
  * @summary Method returns tags list.
9985
10065
  * @param {string} [tagKey] Tag key
10066
+ * @param {string} [search] search string
9986
10067
  * @param {*} [options] Override http request option.
9987
10068
  * @throws {RequiredError}
9988
10069
  * @memberof TagApi
9989
10070
  */
9990
- public listTags(tagKey?: string, options?: AxiosRequestConfig) {
9991
- return TagApiFp(this.configuration).listTags(tagKey, options).then((request) => request(this.axios, this.basePath));
10071
+ public listTags(tagKey?: string, search?: string, options?: AxiosRequestConfig) {
10072
+ return TagApiFp(this.configuration).listTags(tagKey, search, options).then((request) => request(this.axios, this.basePath));
9992
10073
  }
9993
10074
 
9994
10075
  /**
9995
10076
  * This method allows updating a tag in the system.
9996
10077
  * @summary Method allows to update tag.
9997
- * @param {string} key Tag key
10078
+ * @param {string} id Tag id
9998
10079
  * @param {UpdateTagRequest} [updateTagRequest]
9999
10080
  * @param {*} [options] Override http request option.
10000
10081
  * @throws {RequiredError}
10001
10082
  * @memberof TagApi
10002
10083
  */
10003
- public updateTag(key: string, updateTagRequest?: UpdateTagRequest, options?: AxiosRequestConfig) {
10004
- return TagApiFp(this.configuration).updateTag(key, updateTagRequest, options).then((request) => request(this.axios, this.basePath));
10084
+ public updateTag(id: string, updateTagRequest?: UpdateTagRequest, options?: AxiosRequestConfig) {
10085
+ return TagApiFp(this.configuration).updateTag(id, updateTagRequest, options).then((request) => request(this.axios, this.basePath));
10005
10086
  }
10006
10087
  }
10007
10088