@emilgroup/partner-sdk 1.13.0 → 1.13.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/partner-invitations-api.ts +4 -4
- package/api/partner-relations-api.ts +66 -66
- package/api/partner-tags-api.ts +43 -43
- package/api/partner-types-api.ts +60 -60
- package/api/partner-versions-api.ts +27 -27
- package/api/partners-api.ts +66 -66
- package/common.ts +2 -2
- package/configuration.ts +9 -0
- package/dist/api/partner-invitations-api.d.ts +4 -4
- package/dist/api/partner-invitations-api.js +4 -4
- package/dist/api/partner-relations-api.d.ts +66 -66
- package/dist/api/partner-relations-api.js +46 -46
- package/dist/api/partner-tags-api.d.ts +43 -43
- package/dist/api/partner-tags-api.js +32 -32
- package/dist/api/partner-types-api.d.ts +60 -60
- package/dist/api/partner-types-api.js +41 -41
- package/dist/api/partner-versions-api.d.ts +27 -27
- package/dist/api/partner-versions-api.js +17 -17
- package/dist/api/partners-api.d.ts +66 -66
- package/dist/api/partners-api.js +46 -46
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +6 -0
- package/dist/configuration.js +8 -0
- package/package.json +1 -1
|
@@ -27,7 +27,7 @@ import { UpdatePartnerResponseClass } from '../models';
|
|
|
27
27
|
*/
|
|
28
28
|
export declare const PartnersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29
29
|
/**
|
|
30
|
-
* This will create a partner.
|
|
30
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
31
31
|
* @summary Create the partner
|
|
32
32
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
33
33
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -36,7 +36,7 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
36
36
|
*/
|
|
37
37
|
createPartner: (createPartnerRequestDto: CreatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
38
|
/**
|
|
39
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
39
|
+
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
40
40
|
* @summary Delete the partner
|
|
41
41
|
* @param {string} code
|
|
42
42
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -45,7 +45,7 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
45
45
|
*/
|
|
46
46
|
deletePartner: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
47
|
/**
|
|
48
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
48
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information. **Required Permissions** \"partner-management.partners.view\"
|
|
49
49
|
* @summary Retrieve the partner
|
|
50
50
|
* @param {string} code Unique identifier for the object.
|
|
51
51
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -55,38 +55,38 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
55
55
|
*/
|
|
56
56
|
getPartner: (code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
57
|
/**
|
|
58
|
-
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
58
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
59
59
|
* @summary List partners
|
|
60
60
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
61
|
-
* @param {
|
|
62
|
-
* @param {
|
|
61
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
62
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
63
63
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
64
|
-
* @param {
|
|
64
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
65
65
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
66
66
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
67
67
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
68
68
|
* @param {*} [options] Override http request option.
|
|
69
69
|
* @throws {RequiredError}
|
|
70
70
|
*/
|
|
71
|
-
listPartners: (authorization?: string, pageSize?:
|
|
71
|
+
listPartners: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
72
|
/**
|
|
73
|
-
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
73
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
74
74
|
* @summary List grouped relations for partner
|
|
75
75
|
* @param {string} code
|
|
76
76
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
77
|
-
* @param {
|
|
78
|
-
* @param {
|
|
77
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
78
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
79
79
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
80
|
-
* @param {
|
|
80
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
81
81
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
82
82
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
83
83
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
84
84
|
* @param {*} [options] Override http request option.
|
|
85
85
|
* @throws {RequiredError}
|
|
86
86
|
*/
|
|
87
|
-
listRelationsForPartner: (code: string, authorization?: string, pageSize?:
|
|
87
|
+
listRelationsForPartner: (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
89
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
90
90
|
* @summary Update the partner
|
|
91
91
|
* @param {string} code
|
|
92
92
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -96,7 +96,7 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
96
96
|
*/
|
|
97
97
|
tagPartner: (code: string, tagPartnerRequestDtoRest: TagPartnerRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
98
98
|
/**
|
|
99
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
99
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
100
100
|
* @summary Update the partner
|
|
101
101
|
* @param {string} code Unique identifier for the object.
|
|
102
102
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -112,7 +112,7 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
112
112
|
*/
|
|
113
113
|
export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
114
114
|
/**
|
|
115
|
-
* This will create a partner.
|
|
115
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
116
116
|
* @summary Create the partner
|
|
117
117
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
118
118
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -121,7 +121,7 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
121
121
|
*/
|
|
122
122
|
createPartner(createPartnerRequestDto: CreatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerResponseClass>>;
|
|
123
123
|
/**
|
|
124
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
124
|
+
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
125
125
|
* @summary Delete the partner
|
|
126
126
|
* @param {string} code
|
|
127
127
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -130,7 +130,7 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
130
130
|
*/
|
|
131
131
|
deletePartner(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
132
132
|
/**
|
|
133
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
133
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information. **Required Permissions** \"partner-management.partners.view\"
|
|
134
134
|
* @summary Retrieve the partner
|
|
135
135
|
* @param {string} code Unique identifier for the object.
|
|
136
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -140,38 +140,38 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
140
140
|
*/
|
|
141
141
|
getPartner(code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerResponseClass>>;
|
|
142
142
|
/**
|
|
143
|
-
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
143
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
144
144
|
* @summary List partners
|
|
145
145
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
146
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
147
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
148
148
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
149
|
-
* @param {
|
|
149
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
150
150
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
151
151
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
152
152
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
153
153
|
* @param {*} [options] Override http request option.
|
|
154
154
|
* @throws {RequiredError}
|
|
155
155
|
*/
|
|
156
|
-
listPartners(authorization?: string, pageSize?:
|
|
156
|
+
listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>>;
|
|
157
157
|
/**
|
|
158
|
-
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
158
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
159
159
|
* @summary List grouped relations for partner
|
|
160
160
|
* @param {string} code
|
|
161
161
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
|
-
* @param {
|
|
163
|
-
* @param {
|
|
162
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
163
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
164
164
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
165
|
-
* @param {
|
|
165
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
166
166
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
167
167
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
168
168
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
169
169
|
* @param {*} [options] Override http request option.
|
|
170
170
|
* @throws {RequiredError}
|
|
171
171
|
*/
|
|
172
|
-
listRelationsForPartner(code: string, authorization?: string, pageSize?:
|
|
172
|
+
listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRelatedPartnersResponseClass>>;
|
|
173
173
|
/**
|
|
174
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
174
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
175
175
|
* @summary Update the partner
|
|
176
176
|
* @param {string} code
|
|
177
177
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -181,7 +181,7 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
181
181
|
*/
|
|
182
182
|
tagPartner(code: string, tagPartnerRequestDtoRest: TagPartnerRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerResponseClass>>;
|
|
183
183
|
/**
|
|
184
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
184
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
185
185
|
* @summary Update the partner
|
|
186
186
|
* @param {string} code Unique identifier for the object.
|
|
187
187
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -197,7 +197,7 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
197
197
|
*/
|
|
198
198
|
export declare const PartnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
199
199
|
/**
|
|
200
|
-
* This will create a partner.
|
|
200
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
201
201
|
* @summary Create the partner
|
|
202
202
|
* @param {CreatePartnerRequestDto} createPartnerRequestDto
|
|
203
203
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -206,7 +206,7 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
206
206
|
*/
|
|
207
207
|
createPartner(createPartnerRequestDto: CreatePartnerRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerResponseClass>;
|
|
208
208
|
/**
|
|
209
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
209
|
+
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
210
210
|
* @summary Delete the partner
|
|
211
211
|
* @param {string} code
|
|
212
212
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -215,7 +215,7 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
215
215
|
*/
|
|
216
216
|
deletePartner(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
217
217
|
/**
|
|
218
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
218
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information. **Required Permissions** \"partner-management.partners.view\"
|
|
219
219
|
* @summary Retrieve the partner
|
|
220
220
|
* @param {string} code Unique identifier for the object.
|
|
221
221
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -225,38 +225,38 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
225
225
|
*/
|
|
226
226
|
getPartner(code: string, authorization?: string, expand?: any, options?: any): AxiosPromise<GetPartnerResponseClass>;
|
|
227
227
|
/**
|
|
228
|
-
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
228
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
229
229
|
* @summary List partners
|
|
230
230
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
|
-
* @param {
|
|
232
|
-
* @param {
|
|
231
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
233
233
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
234
|
-
* @param {
|
|
234
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
235
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
236
236
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags<i>
|
|
237
237
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
240
|
*/
|
|
241
|
-
listPartners(authorization?: string, pageSize?:
|
|
241
|
+
listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass>;
|
|
242
242
|
/**
|
|
243
|
-
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
243
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
244
244
|
* @summary List grouped relations for partner
|
|
245
245
|
* @param {string} code
|
|
246
246
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
247
|
-
* @param {
|
|
248
|
-
* @param {
|
|
247
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
249
249
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
250
|
-
* @param {
|
|
250
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
251
251
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
252
252
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner1, partner2, partnerRelationType<i>
|
|
253
253
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
254
254
|
* @param {*} [options] Override http request option.
|
|
255
255
|
* @throws {RequiredError}
|
|
256
256
|
*/
|
|
257
|
-
listRelationsForPartner(code: string, authorization?: string, pageSize?:
|
|
257
|
+
listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRelatedPartnersResponseClass>;
|
|
258
258
|
/**
|
|
259
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
259
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
260
260
|
* @summary Update the partner
|
|
261
261
|
* @param {string} code
|
|
262
262
|
* @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest
|
|
@@ -266,7 +266,7 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
266
266
|
*/
|
|
267
267
|
tagPartner(code: string, tagPartnerRequestDtoRest: TagPartnerRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetPartnerResponseClass>;
|
|
268
268
|
/**
|
|
269
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
269
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
270
270
|
* @summary Update the partner
|
|
271
271
|
* @param {string} code Unique identifier for the object.
|
|
272
272
|
* @param {UpdatePartnerRequestDto} updatePartnerRequestDto
|
|
@@ -353,16 +353,16 @@ export interface PartnersApiListPartnersRequest {
|
|
|
353
353
|
readonly authorization?: string;
|
|
354
354
|
/**
|
|
355
355
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
356
|
-
* @type {
|
|
356
|
+
* @type {number}
|
|
357
357
|
* @memberof PartnersApiListPartners
|
|
358
358
|
*/
|
|
359
|
-
readonly pageSize?:
|
|
359
|
+
readonly pageSize?: number;
|
|
360
360
|
/**
|
|
361
|
-
* 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,
|
|
362
|
-
* @type {
|
|
361
|
+
* 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.
|
|
362
|
+
* @type {string}
|
|
363
363
|
* @memberof PartnersApiListPartners
|
|
364
364
|
*/
|
|
365
|
-
readonly pageToken?:
|
|
365
|
+
readonly pageToken?: string;
|
|
366
366
|
/**
|
|
367
367
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
368
368
|
* @type {string}
|
|
@@ -371,10 +371,10 @@ export interface PartnersApiListPartnersRequest {
|
|
|
371
371
|
readonly filter?: string;
|
|
372
372
|
/**
|
|
373
373
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
374
|
-
* @type {
|
|
374
|
+
* @type {string}
|
|
375
375
|
* @memberof PartnersApiListPartners
|
|
376
376
|
*/
|
|
377
|
-
readonly search?:
|
|
377
|
+
readonly search?: string;
|
|
378
378
|
/**
|
|
379
379
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs</i>
|
|
380
380
|
* @type {string}
|
|
@@ -414,16 +414,16 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
414
414
|
readonly authorization?: string;
|
|
415
415
|
/**
|
|
416
416
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
417
|
-
* @type {
|
|
417
|
+
* @type {number}
|
|
418
418
|
* @memberof PartnersApiListRelationsForPartner
|
|
419
419
|
*/
|
|
420
|
-
readonly pageSize?:
|
|
420
|
+
readonly pageSize?: number;
|
|
421
421
|
/**
|
|
422
|
-
* 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,
|
|
423
|
-
* @type {
|
|
422
|
+
* 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.
|
|
423
|
+
* @type {string}
|
|
424
424
|
* @memberof PartnersApiListRelationsForPartner
|
|
425
425
|
*/
|
|
426
|
-
readonly pageToken?:
|
|
426
|
+
readonly pageToken?: string;
|
|
427
427
|
/**
|
|
428
428
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId</i>
|
|
429
429
|
* @type {string}
|
|
@@ -432,10 +432,10 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
432
432
|
readonly filter?: string;
|
|
433
433
|
/**
|
|
434
434
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
435
|
-
* @type {
|
|
435
|
+
* @type {string}
|
|
436
436
|
* @memberof PartnersApiListRelationsForPartner
|
|
437
437
|
*/
|
|
438
|
-
readonly search?:
|
|
438
|
+
readonly search?: string;
|
|
439
439
|
/**
|
|
440
440
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt</i>
|
|
441
441
|
* @type {string}
|
|
@@ -513,7 +513,7 @@ export interface PartnersApiUpdatePartnerRequest {
|
|
|
513
513
|
*/
|
|
514
514
|
export declare class PartnersApi extends BaseAPI {
|
|
515
515
|
/**
|
|
516
|
-
* This will create a partner.
|
|
516
|
+
* This will create a partner. **Required Permissions** \"partner-management.partners.create\"
|
|
517
517
|
* @summary Create the partner
|
|
518
518
|
* @param {PartnersApiCreatePartnerRequest} requestParameters Request parameters.
|
|
519
519
|
* @param {*} [options] Override http request option.
|
|
@@ -522,7 +522,7 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
522
522
|
*/
|
|
523
523
|
createPartner(requestParameters: PartnersApiCreatePartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerResponseClass, any>>;
|
|
524
524
|
/**
|
|
525
|
-
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
|
|
525
|
+
* Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
|
|
526
526
|
* @summary Delete the partner
|
|
527
527
|
* @param {PartnersApiDeletePartnerRequest} requestParameters Request parameters.
|
|
528
528
|
* @param {*} [options] Override http request option.
|
|
@@ -531,7 +531,7 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
531
531
|
*/
|
|
532
532
|
deletePartner(requestParameters: PartnersApiDeletePartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
533
533
|
/**
|
|
534
|
-
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
534
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information. **Required Permissions** \"partner-management.partners.view\"
|
|
535
535
|
* @summary Retrieve the partner
|
|
536
536
|
* @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
|
|
537
537
|
* @param {*} [options] Override http request option.
|
|
@@ -540,7 +540,7 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
540
540
|
*/
|
|
541
541
|
getPartner(requestParameters: PartnersApiGetPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerResponseClass, any>>;
|
|
542
542
|
/**
|
|
543
|
-
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
543
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
544
544
|
* @summary List partners
|
|
545
545
|
* @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
|
|
546
546
|
* @param {*} [options] Override http request option.
|
|
@@ -549,7 +549,7 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
549
549
|
*/
|
|
550
550
|
listPartners(requestParameters?: PartnersApiListPartnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnersResponseClass, any>>;
|
|
551
551
|
/**
|
|
552
|
-
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
552
|
+
* Returns a list of grouped relations for partner you have previously created. The grouped relations for partner are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
|
|
553
553
|
* @summary List grouped relations for partner
|
|
554
554
|
* @param {PartnersApiListRelationsForPartnerRequest} requestParameters Request parameters.
|
|
555
555
|
* @param {*} [options] Override http request option.
|
|
@@ -558,7 +558,7 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
558
558
|
*/
|
|
559
559
|
listRelationsForPartner(requestParameters: PartnersApiListRelationsForPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRelatedPartnersResponseClass, any>>;
|
|
560
560
|
/**
|
|
561
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
561
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
562
562
|
* @summary Update the partner
|
|
563
563
|
* @param {PartnersApiTagPartnerRequest} requestParameters Request parameters.
|
|
564
564
|
* @param {*} [options] Override http request option.
|
|
@@ -567,7 +567,7 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
567
567
|
*/
|
|
568
568
|
tagPartner(requestParameters: PartnersApiTagPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerResponseClass, any>>;
|
|
569
569
|
/**
|
|
570
|
-
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
570
|
+
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
|
|
571
571
|
* @summary Update the partner
|
|
572
572
|
* @param {PartnersApiUpdatePartnerRequest} requestParameters Request parameters.
|
|
573
573
|
* @param {*} [options] Override http request option.
|