@emilgroup/partner-sdk-node 1.0.0
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/.openapi-generator/FILES +41 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +51 -0
- package/api/default-api.ts +120 -0
- package/api/partner-relations-api.ts +349 -0
- package/api/partner-types-api.ts +693 -0
- package/api/partner-version-api.ts +375 -0
- package/api/partners-api.ts +693 -0
- package/api.ts +35 -0
- package/base.ts +252 -0
- package/common.ts +198 -0
- package/configuration.ts +101 -0
- package/dist/api/default-api.d.ts +66 -0
- package/dist/api/default-api.js +196 -0
- package/dist/api/partner-relations-api.d.ts +206 -0
- package/dist/api/partner-relations-api.js +352 -0
- package/dist/api/partner-types-api.d.ts +394 -0
- package/dist/api/partner-types-api.js +642 -0
- package/dist/api/partner-version-api.d.ts +224 -0
- package/dist/api/partner-version-api.js +363 -0
- package/dist/api/partners-api.d.ts +394 -0
- package/dist/api/partners-api.js +642 -0
- package/dist/api.d.ts +16 -0
- package/dist/api.js +34 -0
- package/dist/base.d.ts +74 -0
- package/dist/base.js +299 -0
- package/dist/common.d.ts +91 -0
- package/dist/common.js +276 -0
- package/dist/configuration.d.ts +83 -0
- package/dist/configuration.js +44 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +36 -0
- package/dist/models/create-partner-request-dto.d.ts +30 -0
- package/dist/models/create-partner-request-dto.js +15 -0
- package/dist/models/create-partner-response-class.d.ts +25 -0
- package/dist/models/create-partner-response-class.js +15 -0
- package/dist/models/create-partner-type-request-dto.d.ts +31 -0
- package/dist/models/create-partner-type-request-dto.js +15 -0
- package/dist/models/create-partner-type-response-class.d.ts +25 -0
- package/dist/models/create-partner-type-response-class.js +15 -0
- package/dist/models/delete-response-class.d.ts +24 -0
- package/dist/models/delete-response-class.js +15 -0
- package/dist/models/get-partner-relation-type-class.d.ts +25 -0
- package/dist/models/get-partner-relation-type-class.js +15 -0
- package/dist/models/get-partner-response-class.d.ts +25 -0
- package/dist/models/get-partner-response-class.js +15 -0
- package/dist/models/get-partner-type-response-class.d.ts +25 -0
- package/dist/models/get-partner-type-response-class.js +15 -0
- package/dist/models/get-partner-version-response-class.d.ts +25 -0
- package/dist/models/get-partner-version-response-class.js +15 -0
- package/dist/models/index.d.ts +23 -0
- package/dist/models/index.js +39 -0
- package/dist/models/inline-response200.d.ts +54 -0
- package/dist/models/inline-response200.js +15 -0
- package/dist/models/inline-response503.d.ts +54 -0
- package/dist/models/inline-response503.js +15 -0
- package/dist/models/list-partner-relation-types-class.d.ts +31 -0
- package/dist/models/list-partner-relation-types-class.js +15 -0
- package/dist/models/list-partner-types-response-class.d.ts +31 -0
- package/dist/models/list-partner-types-response-class.js +15 -0
- package/dist/models/list-partner-versions-response-class.d.ts +25 -0
- package/dist/models/list-partner-versions-response-class.js +15 -0
- package/dist/models/list-partners-response-class.d.ts +31 -0
- package/dist/models/list-partners-response-class.js +15 -0
- package/dist/models/partner-class.d.ts +79 -0
- package/dist/models/partner-class.js +15 -0
- package/dist/models/partner-relation-type-class.d.ts +66 -0
- package/dist/models/partner-relation-type-class.js +15 -0
- package/dist/models/partner-type-class.d.ts +60 -0
- package/dist/models/partner-type-class.js +15 -0
- package/dist/models/partner-type-custom-schema-dto.d.ts +66 -0
- package/dist/models/partner-type-custom-schema-dto.js +15 -0
- package/dist/models/update-partner-request-dto.d.ts +24 -0
- package/dist/models/update-partner-request-dto.js +15 -0
- package/dist/models/update-partner-response-class.d.ts +25 -0
- package/dist/models/update-partner-response-class.js +15 -0
- package/dist/models/update-partner-type-request-dto.d.ts +31 -0
- package/dist/models/update-partner-type-request-dto.js +15 -0
- package/dist/models/update-partner-type-response-class.d.ts +25 -0
- package/dist/models/update-partner-type-response-class.js +15 -0
- package/git_push.sh +57 -0
- package/index.ts +19 -0
- package/models/create-partner-request-dto.ts +36 -0
- package/models/create-partner-response-class.ts +31 -0
- package/models/create-partner-type-request-dto.ts +37 -0
- package/models/create-partner-type-response-class.ts +31 -0
- package/models/delete-response-class.ts +30 -0
- package/models/get-partner-relation-type-class.ts +31 -0
- package/models/get-partner-response-class.ts +31 -0
- package/models/get-partner-type-response-class.ts +31 -0
- package/models/get-partner-version-response-class.ts +31 -0
- package/models/index.ts +23 -0
- package/models/inline-response200.ts +48 -0
- package/models/inline-response503.ts +48 -0
- package/models/list-partner-relation-types-class.ts +37 -0
- package/models/list-partner-types-response-class.ts +37 -0
- package/models/list-partner-versions-response-class.ts +31 -0
- package/models/list-partners-response-class.ts +37 -0
- package/models/partner-class.ts +85 -0
- package/models/partner-relation-type-class.ts +72 -0
- package/models/partner-type-class.ts +66 -0
- package/models/partner-type-custom-schema-dto.ts +72 -0
- package/models/update-partner-request-dto.ts +30 -0
- package/models/update-partner-response-class.ts +31 -0
- package/models/update-partner-type-request-dto.ts +37 -0
- package/models/update-partner-type-response-class.ts +31 -0
- package/package.json +29 -0
- package/tsconfig.json +22 -0
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
.npmignore
|
|
3
|
+
.openapi-generator-ignore
|
|
4
|
+
README.md
|
|
5
|
+
api.ts
|
|
6
|
+
api/default-api.ts
|
|
7
|
+
api/partner-relations-api.ts
|
|
8
|
+
api/partner-types-api.ts
|
|
9
|
+
api/partner-version-api.ts
|
|
10
|
+
api/partners-api.ts
|
|
11
|
+
base.ts
|
|
12
|
+
common.ts
|
|
13
|
+
configuration.ts
|
|
14
|
+
git_push.sh
|
|
15
|
+
index.ts
|
|
16
|
+
models/create-partner-request-dto.ts
|
|
17
|
+
models/create-partner-response-class.ts
|
|
18
|
+
models/create-partner-type-request-dto.ts
|
|
19
|
+
models/create-partner-type-response-class.ts
|
|
20
|
+
models/delete-response-class.ts
|
|
21
|
+
models/get-partner-relation-type-class.ts
|
|
22
|
+
models/get-partner-response-class.ts
|
|
23
|
+
models/get-partner-type-response-class.ts
|
|
24
|
+
models/get-partner-version-response-class.ts
|
|
25
|
+
models/index.ts
|
|
26
|
+
models/inline-response200.ts
|
|
27
|
+
models/inline-response503.ts
|
|
28
|
+
models/list-partner-relation-types-class.ts
|
|
29
|
+
models/list-partner-types-response-class.ts
|
|
30
|
+
models/list-partner-versions-response-class.ts
|
|
31
|
+
models/list-partners-response-class.ts
|
|
32
|
+
models/partner-class.ts
|
|
33
|
+
models/partner-relation-type-class.ts
|
|
34
|
+
models/partner-type-class.ts
|
|
35
|
+
models/partner-type-custom-schema-dto.ts
|
|
36
|
+
models/update-partner-request-dto.ts
|
|
37
|
+
models/update-partner-response-class.ts
|
|
38
|
+
models/update-partner-type-request-dto.ts
|
|
39
|
+
models/update-partner-type-response-class.ts
|
|
40
|
+
package.json
|
|
41
|
+
tsconfig.json
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
5.4.0
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# OpenAPI Generator Ignore
|
|
2
|
+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
|
3
|
+
|
|
4
|
+
# Use this file to prevent files from being overwritten by the generator.
|
|
5
|
+
# The patterns follow closely to .gitignore or .dockerignore.
|
|
6
|
+
|
|
7
|
+
# As an example, the C# client generator defines ApiClient.cs.
|
|
8
|
+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
|
9
|
+
#ApiClient.cs
|
|
10
|
+
|
|
11
|
+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
|
12
|
+
#foo/*/qux
|
|
13
|
+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
|
14
|
+
|
|
15
|
+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
|
16
|
+
#foo/**/qux
|
|
17
|
+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
|
18
|
+
|
|
19
|
+
# You can also negate patterns with an exclamation (!).
|
|
20
|
+
# For example, you can ignore all files in a docs folder with the file extension .md:
|
|
21
|
+
#docs/*.md
|
|
22
|
+
# Then explicitly reverse the ignore rule for a single file:
|
|
23
|
+
#!docs/README.md
|
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Emil Partner SDK
|
|
2
|
+
|
|
3
|
+
This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated module can be used with client-based applications (i.e. React).
|
|
4
|
+
|
|
5
|
+
Language level
|
|
6
|
+
* ES5 - you must have a Promises/A+ library installed
|
|
7
|
+
* ES6
|
|
8
|
+
|
|
9
|
+
Module system
|
|
10
|
+
* CommonJS
|
|
11
|
+
* ES6 module system
|
|
12
|
+
|
|
13
|
+
Although this package can be used in both TypeScript and JavaScript, it is intended to be used with TypeScript. The definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html)). For more information, you can go to [Emil Api documentation](https://emil.stoplight.io/docs/emil-api/).
|
|
14
|
+
|
|
15
|
+
## Consuming
|
|
16
|
+
|
|
17
|
+
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
npm install @emilgroup/partner-sdk-node@1.0.0 --save
|
|
21
|
+
```
|
|
22
|
+
or
|
|
23
|
+
```
|
|
24
|
+
yarn add @emilgroup/partner-sdk-node@1.0.0
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
And then you can import `PartnersApi`.
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { PartnersApi } from '@emilgroup/partner-sdk-node'
|
|
31
|
+
|
|
32
|
+
const partnersApi = new PartnersApi();
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `PartnersApi`:
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
async function listPartners(): Promise<Void> {
|
|
39
|
+
try {
|
|
40
|
+
const partnersApi = new PartnersApi();
|
|
41
|
+
|
|
42
|
+
await partnersApi.authorize('username', 'password');
|
|
43
|
+
|
|
44
|
+
const { data: { items } } = await partnersApi.listPartners();
|
|
45
|
+
|
|
46
|
+
console.log(items);
|
|
47
|
+
} catch(error) {
|
|
48
|
+
// process error
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
```
|
|
@@ -0,0 +1,120 @@
|
|
|
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 { InlineResponse200 } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { InlineResponse503 } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* DefaultApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @param {*} [options] Override http request option.
|
|
36
|
+
* @throws {RequiredError}
|
|
37
|
+
*/
|
|
38
|
+
check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39
|
+
const localVarPath = `/partnerservice/health`;
|
|
40
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42
|
+
let baseOptions;
|
|
43
|
+
let baseAccessToken;
|
|
44
|
+
if (configuration) {
|
|
45
|
+
baseOptions = configuration.baseOptions;
|
|
46
|
+
baseAccessToken = configuration.accessToken;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
50
|
+
const localVarHeaderParameter = {} as any;
|
|
51
|
+
const localVarQueryParameter = {} as any;
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
58
|
+
|
|
59
|
+
return {
|
|
60
|
+
url: toPathString(localVarUrlObj),
|
|
61
|
+
options: localVarRequestOptions,
|
|
62
|
+
};
|
|
63
|
+
},
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* DefaultApi - functional programming interface
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
export const DefaultApiFp = function(configuration?: Configuration) {
|
|
72
|
+
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
|
|
73
|
+
return {
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
async check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
|
|
80
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.check(options);
|
|
81
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
82
|
+
},
|
|
83
|
+
}
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* DefaultApi - factory interface
|
|
88
|
+
* @export
|
|
89
|
+
*/
|
|
90
|
+
export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
91
|
+
const localVarFp = DefaultApiFp(configuration)
|
|
92
|
+
return {
|
|
93
|
+
/**
|
|
94
|
+
*
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
check(options?: any): AxiosPromise<InlineResponse200> {
|
|
99
|
+
return localVarFp.check(options).then((request) => request(axios, basePath));
|
|
100
|
+
},
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* DefaultApi - object-oriented interface
|
|
106
|
+
* @export
|
|
107
|
+
* @class DefaultApi
|
|
108
|
+
* @extends {BaseAPI}
|
|
109
|
+
*/
|
|
110
|
+
export class DefaultApi extends BaseAPI {
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
* @memberof DefaultApi
|
|
116
|
+
*/
|
|
117
|
+
public check(options?: AxiosRequestConfig) {
|
|
118
|
+
return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
119
|
+
}
|
|
120
|
+
}
|
|
@@ -0,0 +1,349 @@
|
|
|
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 { GetPartnerRelationTypeClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { ListPartnerRelationTypesClass } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* PartnerRelationsApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
35
|
+
* @summary Retrieve the partner relation type
|
|
36
|
+
* @param {string} slug Identifying slug of the partner relation type
|
|
37
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
getPartnerRelationType: async (slug: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
42
|
+
// verify required parameter 'slug' is not null or undefined
|
|
43
|
+
assertParamExists('getPartnerRelationType', 'slug', slug)
|
|
44
|
+
const localVarPath = `/partnerservice/v1/partners/relations/types/{slug}`
|
|
45
|
+
.replace(`{${"slug"}}`, encodeURIComponent(String(slug)));
|
|
46
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48
|
+
let baseOptions;
|
|
49
|
+
let baseAccessToken;
|
|
50
|
+
if (configuration) {
|
|
51
|
+
baseOptions = configuration.baseOptions;
|
|
52
|
+
baseAccessToken = configuration.accessToken;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
56
|
+
const localVarHeaderParameter = {} as any;
|
|
57
|
+
const localVarQueryParameter = {} as any;
|
|
58
|
+
|
|
59
|
+
// authentication bearer required
|
|
60
|
+
// http bearer authentication required
|
|
61
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
62
|
+
|
|
63
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
64
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
70
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
72
|
+
|
|
73
|
+
return {
|
|
74
|
+
url: toPathString(localVarUrlObj),
|
|
75
|
+
options: localVarRequestOptions,
|
|
76
|
+
};
|
|
77
|
+
},
|
|
78
|
+
/**
|
|
79
|
+
* List all partner relation types - is used to create partner relations
|
|
80
|
+
* @summary List partner relation types
|
|
81
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
|
+
* @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.
|
|
84
|
+
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseCardinality</i>
|
|
85
|
+
* @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.
|
|
86
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
87
|
+
* @param {number} [expand] Allowed expands for the partner relation types - there are no possible expands for partner relation types
|
|
88
|
+
* @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.
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
listPartnerVersion: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: number, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
|
+
const localVarPath = `/partnerservice/v1/partners/relations/types`;
|
|
94
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
95
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
96
|
+
let baseOptions;
|
|
97
|
+
let baseAccessToken;
|
|
98
|
+
if (configuration) {
|
|
99
|
+
baseOptions = configuration.baseOptions;
|
|
100
|
+
baseAccessToken = configuration.accessToken;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
104
|
+
const localVarHeaderParameter = {} as any;
|
|
105
|
+
const localVarQueryParameter = {} as any;
|
|
106
|
+
|
|
107
|
+
// authentication bearer required
|
|
108
|
+
// http bearer authentication required
|
|
109
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
110
|
+
|
|
111
|
+
if (pageSize !== undefined) {
|
|
112
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
if (pageToken !== undefined) {
|
|
116
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
if (filter !== undefined) {
|
|
120
|
+
localVarQueryParameter['filter'] = filter;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
if (search !== undefined) {
|
|
124
|
+
localVarQueryParameter['search'] = search;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
if (order !== undefined) {
|
|
128
|
+
localVarQueryParameter['order'] = order;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
if (expand !== undefined) {
|
|
132
|
+
localVarQueryParameter['expand'] = expand;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
if (filters !== undefined) {
|
|
136
|
+
localVarQueryParameter['filters'] = filters;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
140
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
146
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
147
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
148
|
+
|
|
149
|
+
return {
|
|
150
|
+
url: toPathString(localVarUrlObj),
|
|
151
|
+
options: localVarRequestOptions,
|
|
152
|
+
};
|
|
153
|
+
},
|
|
154
|
+
}
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* PartnerRelationsApi - functional programming interface
|
|
159
|
+
* @export
|
|
160
|
+
*/
|
|
161
|
+
export const PartnerRelationsApiFp = function(configuration?: Configuration) {
|
|
162
|
+
const localVarAxiosParamCreator = PartnerRelationsApiAxiosParamCreator(configuration)
|
|
163
|
+
return {
|
|
164
|
+
/**
|
|
165
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
166
|
+
* @summary Retrieve the partner relation type
|
|
167
|
+
* @param {string} slug Identifying slug of the partner relation type
|
|
168
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
async getPartnerRelationType(slug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationTypeClass>> {
|
|
173
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerRelationType(slug, authorization, options);
|
|
174
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
175
|
+
},
|
|
176
|
+
/**
|
|
177
|
+
* List all partner relation types - is used to create partner relations
|
|
178
|
+
* @summary List partner relation types
|
|
179
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
181
|
+
* @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.
|
|
182
|
+
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseCardinality</i>
|
|
183
|
+
* @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.
|
|
184
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
185
|
+
* @param {number} [expand] Allowed expands for the partner relation types - there are no possible expands for partner relation types
|
|
186
|
+
* @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.
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
async listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: number, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>> {
|
|
191
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
192
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
193
|
+
},
|
|
194
|
+
}
|
|
195
|
+
};
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* PartnerRelationsApi - factory interface
|
|
199
|
+
* @export
|
|
200
|
+
*/
|
|
201
|
+
export const PartnerRelationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
202
|
+
const localVarFp = PartnerRelationsApiFp(configuration)
|
|
203
|
+
return {
|
|
204
|
+
/**
|
|
205
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
206
|
+
* @summary Retrieve the partner relation type
|
|
207
|
+
* @param {string} slug Identifying slug of the partner relation type
|
|
208
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
209
|
+
* @param {*} [options] Override http request option.
|
|
210
|
+
* @throws {RequiredError}
|
|
211
|
+
*/
|
|
212
|
+
getPartnerRelationType(slug: string, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationTypeClass> {
|
|
213
|
+
return localVarFp.getPartnerRelationType(slug, authorization, options).then((request) => request(axios, basePath));
|
|
214
|
+
},
|
|
215
|
+
/**
|
|
216
|
+
* List all partner relation types - is used to create partner relations
|
|
217
|
+
* @summary List partner relation types
|
|
218
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
219
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
220
|
+
* @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.
|
|
221
|
+
* @param {any} [filter] Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseCardinality</i>
|
|
222
|
+
* @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.
|
|
223
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
224
|
+
* @param {number} [expand] Allowed expands for the partner relation types - there are no possible expands for partner relation types
|
|
225
|
+
* @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.
|
|
226
|
+
* @param {*} [options] Override http request option.
|
|
227
|
+
* @throws {RequiredError}
|
|
228
|
+
*/
|
|
229
|
+
listPartnerVersion(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: number, filters?: any, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
|
|
230
|
+
return localVarFp.listPartnerVersion(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
231
|
+
},
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* Request parameters for getPartnerRelationType operation in PartnerRelationsApi.
|
|
237
|
+
* @export
|
|
238
|
+
* @interface PartnerRelationsApiGetPartnerRelationTypeRequest
|
|
239
|
+
*/
|
|
240
|
+
export interface PartnerRelationsApiGetPartnerRelationTypeRequest {
|
|
241
|
+
/**
|
|
242
|
+
* Identifying slug of the partner relation type
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof PartnerRelationsApiGetPartnerRelationType
|
|
245
|
+
*/
|
|
246
|
+
readonly slug: string
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof PartnerRelationsApiGetPartnerRelationType
|
|
252
|
+
*/
|
|
253
|
+
readonly authorization?: string
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* Request parameters for listPartnerVersion operation in PartnerRelationsApi.
|
|
258
|
+
* @export
|
|
259
|
+
* @interface PartnerRelationsApiListPartnerVersionRequest
|
|
260
|
+
*/
|
|
261
|
+
export interface PartnerRelationsApiListPartnerVersionRequest {
|
|
262
|
+
/**
|
|
263
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
264
|
+
* @type {string}
|
|
265
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
266
|
+
*/
|
|
267
|
+
readonly authorization?: string
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
|
+
* @type {any}
|
|
272
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
273
|
+
*/
|
|
274
|
+
readonly pageSize?: any
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* 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.
|
|
278
|
+
* @type {any}
|
|
279
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
280
|
+
*/
|
|
281
|
+
readonly pageToken?: any
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Filter the response by one or multiple fields<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseCardinality</i>
|
|
285
|
+
* @type {any}
|
|
286
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
287
|
+
*/
|
|
288
|
+
readonly filter?: any
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
292
|
+
* @type {any}
|
|
293
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
294
|
+
*/
|
|
295
|
+
readonly search?: any
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
|
|
299
|
+
* @type {any}
|
|
300
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
301
|
+
*/
|
|
302
|
+
readonly order?: any
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Allowed expands for the partner relation types - there are no possible expands for partner relation types
|
|
306
|
+
* @type {number}
|
|
307
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
308
|
+
*/
|
|
309
|
+
readonly expand?: number
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* 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.
|
|
313
|
+
* @type {any}
|
|
314
|
+
* @memberof PartnerRelationsApiListPartnerVersion
|
|
315
|
+
*/
|
|
316
|
+
readonly filters?: any
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* PartnerRelationsApi - object-oriented interface
|
|
321
|
+
* @export
|
|
322
|
+
* @class PartnerRelationsApi
|
|
323
|
+
* @extends {BaseAPI}
|
|
324
|
+
*/
|
|
325
|
+
export class PartnerRelationsApi extends BaseAPI {
|
|
326
|
+
/**
|
|
327
|
+
* Retrieve a single partner relation type identified with a slug - can be used to create partner relations
|
|
328
|
+
* @summary Retrieve the partner relation type
|
|
329
|
+
* @param {PartnerRelationsApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
* @memberof PartnerRelationsApi
|
|
333
|
+
*/
|
|
334
|
+
public getPartnerRelationType(requestParameters: PartnerRelationsApiGetPartnerRelationTypeRequest, options?: AxiosRequestConfig) {
|
|
335
|
+
return PartnerRelationsApiFp(this.configuration).getPartnerRelationType(requestParameters.slug, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* List all partner relation types - is used to create partner relations
|
|
340
|
+
* @summary List partner relation types
|
|
341
|
+
* @param {PartnerRelationsApiListPartnerVersionRequest} requestParameters Request parameters.
|
|
342
|
+
* @param {*} [options] Override http request option.
|
|
343
|
+
* @throws {RequiredError}
|
|
344
|
+
* @memberof PartnerRelationsApi
|
|
345
|
+
*/
|
|
346
|
+
public listPartnerVersion(requestParameters: PartnerRelationsApiListPartnerVersionRequest = {}, options?: AxiosRequestConfig) {
|
|
347
|
+
return PartnerRelationsApiFp(this.configuration).listPartnerVersion(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
348
|
+
}
|
|
349
|
+
}
|