ultracart_rest_api_v2_typescript 4.1.102 → 4.1.103

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.
@@ -38,6 +38,8 @@ src/models/Activity.ts
38
38
  src/models/AddLibraryItemRequest.ts
39
39
  src/models/AdjustInternalCertificateRequest.ts
40
40
  src/models/AdjustInternalCertificateResponse.ts
41
+ src/models/Affiliate.ts
42
+ src/models/AffiliateAttribute.ts
41
43
  src/models/AffiliateClick.ts
42
44
  src/models/AffiliateClickQuery.ts
43
45
  src/models/AffiliateClicksResponse.ts
@@ -45,6 +47,11 @@ src/models/AffiliateLedger.ts
45
47
  src/models/AffiliateLedgerQuery.ts
46
48
  src/models/AffiliateLedgersResponse.ts
47
49
  src/models/AffiliateLink.ts
50
+ src/models/AffiliateMarketingStrategy.ts
51
+ src/models/AffiliateQuery.ts
52
+ src/models/AffiliateResponse.ts
53
+ src/models/AffiliateTierRelationship.ts
54
+ src/models/AffiliatesResponse.ts
48
55
  src/models/AgentSummary.ts
49
56
  src/models/ApiUserApplicationProfile.ts
50
57
  src/models/ApplyLibraryItemRequest.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.102
2
+ ## ultracart_rest_api_v2_typescript@4.1.103
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.102 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.103 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.103 | 06/18/2026 | affiliate api alpha |
88
89
  | 4.1.102 | 06/17/2026 | storefront communications - new single email enrollment method |
89
90
  | 4.1.101 | 06/10/2026 | conversation pbx call notes fields |
90
91
  | 4.1.100 | 06/05/2026 | webhook log summary filtering |
@@ -10,7 +10,20 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AffiliateClickQuery, AffiliateClicksResponse, AffiliateLedgerQuery, AffiliateLedgersResponse } from '../models';
13
+ import { Affiliate, AffiliateClickQuery, AffiliateClicksResponse, AffiliateLedgerQuery, AffiliateLedgersResponse, AffiliateQuery, AffiliateResponse, AffiliatesResponse } from '../models';
14
+ export interface DeleteAffiliateRequest {
15
+ affiliateOid: number;
16
+ }
17
+ export interface GetAffiliateRequest {
18
+ affiliateOid: number;
19
+ expand?: string;
20
+ }
21
+ export interface GetAffiliatesByQueryRequest {
22
+ affiliateQuery: AffiliateQuery;
23
+ limit?: number;
24
+ offset?: number;
25
+ sort?: string;
26
+ }
14
27
  export interface GetClicksByQueryRequest {
15
28
  clickQuery: AffiliateClickQuery;
16
29
  limit?: number;
@@ -23,6 +36,15 @@ export interface GetLedgersByQueryRequest {
23
36
  offset?: number;
24
37
  expand?: string;
25
38
  }
39
+ export interface InsertAffiliateRequest {
40
+ affiliate: Affiliate;
41
+ expand?: string;
42
+ }
43
+ export interface UpdateAffiliateRequest {
44
+ affiliateOid: number;
45
+ affiliate: Affiliate;
46
+ expand?: string;
47
+ }
26
48
  /**
27
49
  * AffiliateApi - interface
28
50
  *
@@ -30,6 +52,52 @@ export interface GetLedgersByQueryRequest {
30
52
  * @interface AffiliateApiInterface
31
53
  */
32
54
  export interface AffiliateApiInterface {
55
+ /**
56
+ * Delete an affiliate on the UltraCart account. The affiliate is disabled within the active affiliate program; their ledger and click history is preserved.
57
+ * @summary Delete an affiliate
58
+ * @param {number} affiliateOid The affiliate oid to delete.
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ * @memberof AffiliateApiInterface
62
+ */
63
+ deleteAffiliateRaw(requestParameters: DeleteAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
64
+ /**
65
+ * Delete an affiliate on the UltraCart account. The affiliate is disabled within the active affiliate program; their ledger and click history is preserved.
66
+ * Delete an affiliate
67
+ */
68
+ deleteAffiliate(requestParameters: DeleteAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
69
+ /**
70
+ * Retrieves a single affiliate using the specified affiliate oid.
71
+ * @summary Retrieve an affiliate
72
+ * @param {number} affiliateOid The affiliate oid to retrieve.
73
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ * @memberof AffiliateApiInterface
77
+ */
78
+ getAffiliateRaw(requestParameters: GetAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AffiliateResponse>>;
79
+ /**
80
+ * Retrieves a single affiliate using the specified affiliate oid.
81
+ * Retrieve an affiliate
82
+ */
83
+ getAffiliate(requestParameters: GetAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
84
+ /**
85
+ * Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
86
+ * @summary Retrieve affiliates
87
+ * @param {AffiliateQuery} affiliateQuery Affiliate query
88
+ * @param {number} [limit] The maximum number of records to return on this one API call. (Maximum 200)
89
+ * @param {number} [offset] Pagination of the record set. Offset is a zero based index.
90
+ * @param {string} [sort] The sort order of the affiliates. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ * @memberof AffiliateApiInterface
94
+ */
95
+ getAffiliatesByQueryRaw(requestParameters: GetAffiliatesByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AffiliatesResponse>>;
96
+ /**
97
+ * Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
98
+ * Retrieve affiliates
99
+ */
100
+ getAffiliatesByQuery(requestParameters: GetAffiliatesByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliatesResponse>;
33
101
  /**
34
102
  * Retrieves a group of clicks from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
35
103
  * @summary Retrieve clicks
@@ -64,11 +132,72 @@ export interface AffiliateApiInterface {
64
132
  * Retrieve ledger entries
65
133
  */
66
134
  getLedgersByQuery(requestParameters: GetLedgersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateLedgersResponse>;
135
+ /**
136
+ * Insert an affiliate on the UltraCart account. The affiliate is created within the merchant\'s active affiliate program.
137
+ * @summary Insert an affiliate
138
+ * @param {Affiliate} affiliate Affiliate to insert
139
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
140
+ * @param {*} [options] Override http request option.
141
+ * @throws {RequiredError}
142
+ * @memberof AffiliateApiInterface
143
+ */
144
+ insertAffiliateRaw(requestParameters: InsertAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AffiliateResponse>>;
145
+ /**
146
+ * Insert an affiliate on the UltraCart account. The affiliate is created within the merchant\'s active affiliate program.
147
+ * Insert an affiliate
148
+ */
149
+ insertAffiliate(requestParameters: InsertAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
150
+ /**
151
+ * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
152
+ * @summary Update an affiliate
153
+ * @param {number} affiliateOid The affiliate oid to update.
154
+ * @param {Affiliate} affiliate Affiliate to update
155
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ * @memberof AffiliateApiInterface
159
+ */
160
+ updateAffiliateRaw(requestParameters: UpdateAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AffiliateResponse>>;
161
+ /**
162
+ * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
163
+ * Update an affiliate
164
+ */
165
+ updateAffiliate(requestParameters: UpdateAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
67
166
  }
68
167
  /**
69
168
  *
70
169
  */
71
170
  export declare class AffiliateApi extends runtime.BaseAPI implements AffiliateApiInterface {
171
+ /**
172
+ * Delete an affiliate on the UltraCart account. The affiliate is disabled within the active affiliate program; their ledger and click history is preserved.
173
+ * Delete an affiliate
174
+ */
175
+ deleteAffiliateRaw(requestParameters: DeleteAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
176
+ /**
177
+ * Delete an affiliate on the UltraCart account. The affiliate is disabled within the active affiliate program; their ledger and click history is preserved.
178
+ * Delete an affiliate
179
+ */
180
+ deleteAffiliate(requestParameters: DeleteAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
181
+ /**
182
+ * Retrieves a single affiliate using the specified affiliate oid.
183
+ * Retrieve an affiliate
184
+ */
185
+ getAffiliateRaw(requestParameters: GetAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AffiliateResponse>>;
186
+ /**
187
+ * Retrieves a single affiliate using the specified affiliate oid.
188
+ * Retrieve an affiliate
189
+ */
190
+ getAffiliate(requestParameters: GetAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
191
+ /**
192
+ * Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
193
+ * Retrieve affiliates
194
+ */
195
+ getAffiliatesByQueryRaw(requestParameters: GetAffiliatesByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AffiliatesResponse>>;
196
+ /**
197
+ * Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
198
+ * Retrieve affiliates
199
+ */
200
+ getAffiliatesByQuery(requestParameters: GetAffiliatesByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliatesResponse>;
72
201
  /**
73
202
  * Retrieves a group of clicks from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
74
203
  * Retrieve clicks
@@ -89,4 +218,24 @@ export declare class AffiliateApi extends runtime.BaseAPI implements AffiliateAp
89
218
  * Retrieve ledger entries
90
219
  */
91
220
  getLedgersByQuery(requestParameters: GetLedgersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateLedgersResponse>;
221
+ /**
222
+ * Insert an affiliate on the UltraCart account. The affiliate is created within the merchant\'s active affiliate program.
223
+ * Insert an affiliate
224
+ */
225
+ insertAffiliateRaw(requestParameters: InsertAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AffiliateResponse>>;
226
+ /**
227
+ * Insert an affiliate on the UltraCart account. The affiliate is created within the merchant\'s active affiliate program.
228
+ * Insert an affiliate
229
+ */
230
+ insertAffiliate(requestParameters: InsertAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
231
+ /**
232
+ * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
233
+ * Update an affiliate
234
+ */
235
+ updateAffiliateRaw(requestParameters: UpdateAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AffiliateResponse>>;
236
+ /**
237
+ * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
238
+ * Update an affiliate
239
+ */
240
+ updateAffiliate(requestParameters: UpdateAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
92
241
  }
@@ -75,6 +75,195 @@ var AffiliateApi = /** @class */ (function (_super) {
75
75
  function AffiliateApi() {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
+ /**
79
+ * Delete an affiliate on the UltraCart account. The affiliate is disabled within the active affiliate program; their ledger and click history is preserved.
80
+ * Delete an affiliate
81
+ */
82
+ AffiliateApi.prototype.deleteAffiliateRaw = function (requestParameters, initOverrides) {
83
+ return __awaiter(this, void 0, void 0, function () {
84
+ var queryParameters, headerParameters, _a, _b, response;
85
+ return __generator(this, function (_c) {
86
+ switch (_c.label) {
87
+ case 0:
88
+ if (requestParameters.affiliateOid === null || requestParameters.affiliateOid === undefined) {
89
+ throw new runtime.RequiredError('affiliateOid', 'Required parameter requestParameters.affiliateOid was null or undefined when calling deleteAffiliate.');
90
+ }
91
+ queryParameters = {};
92
+ headerParameters = {};
93
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
94
+ // oauth required
95
+ _a = headerParameters;
96
+ _b = "Authorization";
97
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_write"])];
98
+ case 1:
99
+ // oauth required
100
+ _a[_b] = _c.sent();
101
+ _c.label = 2;
102
+ case 2:
103
+ if (this.configuration && this.configuration.apiKey) {
104
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
105
+ }
106
+ return [4 /*yield*/, this.request({
107
+ path: "/affiliate/affiliates/{affiliate_oid}".replace("{".concat("affiliate_oid", "}"), encodeURIComponent(String(requestParameters.affiliateOid))),
108
+ method: 'DELETE',
109
+ headers: headerParameters,
110
+ query: queryParameters,
111
+ }, initOverrides)];
112
+ case 3:
113
+ response = _c.sent();
114
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
115
+ }
116
+ });
117
+ });
118
+ };
119
+ /**
120
+ * Delete an affiliate on the UltraCart account. The affiliate is disabled within the active affiliate program; their ledger and click history is preserved.
121
+ * Delete an affiliate
122
+ */
123
+ AffiliateApi.prototype.deleteAffiliate = function (requestParameters, initOverrides) {
124
+ return __awaiter(this, void 0, void 0, function () {
125
+ return __generator(this, function (_a) {
126
+ switch (_a.label) {
127
+ case 0: return [4 /*yield*/, this.deleteAffiliateRaw(requestParameters, initOverrides)];
128
+ case 1:
129
+ _a.sent();
130
+ return [2 /*return*/];
131
+ }
132
+ });
133
+ });
134
+ };
135
+ /**
136
+ * Retrieves a single affiliate using the specified affiliate oid.
137
+ * Retrieve an affiliate
138
+ */
139
+ AffiliateApi.prototype.getAffiliateRaw = function (requestParameters, initOverrides) {
140
+ return __awaiter(this, void 0, void 0, function () {
141
+ var queryParameters, headerParameters, _a, _b, response;
142
+ return __generator(this, function (_c) {
143
+ switch (_c.label) {
144
+ case 0:
145
+ if (requestParameters.affiliateOid === null || requestParameters.affiliateOid === undefined) {
146
+ throw new runtime.RequiredError('affiliateOid', 'Required parameter requestParameters.affiliateOid was null or undefined when calling getAffiliate.');
147
+ }
148
+ queryParameters = {};
149
+ if (requestParameters.expand !== undefined) {
150
+ queryParameters['_expand'] = requestParameters.expand;
151
+ }
152
+ headerParameters = {};
153
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
154
+ // oauth required
155
+ _a = headerParameters;
156
+ _b = "Authorization";
157
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read"])];
158
+ case 1:
159
+ // oauth required
160
+ _a[_b] = _c.sent();
161
+ _c.label = 2;
162
+ case 2:
163
+ if (this.configuration && this.configuration.apiKey) {
164
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
165
+ }
166
+ return [4 /*yield*/, this.request({
167
+ path: "/affiliate/affiliates/{affiliate_oid}".replace("{".concat("affiliate_oid", "}"), encodeURIComponent(String(requestParameters.affiliateOid))),
168
+ method: 'GET',
169
+ headers: headerParameters,
170
+ query: queryParameters,
171
+ }, initOverrides)];
172
+ case 3:
173
+ response = _c.sent();
174
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AffiliateResponseFromJSON)(jsonValue); })];
175
+ }
176
+ });
177
+ });
178
+ };
179
+ /**
180
+ * Retrieves a single affiliate using the specified affiliate oid.
181
+ * Retrieve an affiliate
182
+ */
183
+ AffiliateApi.prototype.getAffiliate = function (requestParameters, initOverrides) {
184
+ return __awaiter(this, void 0, void 0, function () {
185
+ var response;
186
+ return __generator(this, function (_a) {
187
+ switch (_a.label) {
188
+ case 0: return [4 /*yield*/, this.getAffiliateRaw(requestParameters, initOverrides)];
189
+ case 1:
190
+ response = _a.sent();
191
+ return [4 /*yield*/, response.value()];
192
+ case 2: return [2 /*return*/, _a.sent()];
193
+ }
194
+ });
195
+ });
196
+ };
197
+ /**
198
+ * Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
199
+ * Retrieve affiliates
200
+ */
201
+ AffiliateApi.prototype.getAffiliatesByQueryRaw = function (requestParameters, initOverrides) {
202
+ return __awaiter(this, void 0, void 0, function () {
203
+ var queryParameters, headerParameters, _a, _b, response;
204
+ return __generator(this, function (_c) {
205
+ switch (_c.label) {
206
+ case 0:
207
+ if (requestParameters.affiliateQuery === null || requestParameters.affiliateQuery === undefined) {
208
+ throw new runtime.RequiredError('affiliateQuery', 'Required parameter requestParameters.affiliateQuery was null or undefined when calling getAffiliatesByQuery.');
209
+ }
210
+ queryParameters = {};
211
+ if (requestParameters.limit !== undefined) {
212
+ queryParameters['_limit'] = requestParameters.limit;
213
+ }
214
+ if (requestParameters.offset !== undefined) {
215
+ queryParameters['_offset'] = requestParameters.offset;
216
+ }
217
+ if (requestParameters.sort !== undefined) {
218
+ queryParameters['_sort'] = requestParameters.sort;
219
+ }
220
+ headerParameters = {};
221
+ headerParameters['Content-Type'] = 'application/json';
222
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
223
+ // oauth required
224
+ _a = headerParameters;
225
+ _b = "Authorization";
226
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read"])];
227
+ case 1:
228
+ // oauth required
229
+ _a[_b] = _c.sent();
230
+ _c.label = 2;
231
+ case 2:
232
+ if (this.configuration && this.configuration.apiKey) {
233
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
234
+ }
235
+ return [4 /*yield*/, this.request({
236
+ path: "/affiliate/affiliates/query",
237
+ method: 'POST',
238
+ headers: headerParameters,
239
+ query: queryParameters,
240
+ body: (0, models_1.AffiliateQueryToJSON)(requestParameters.affiliateQuery),
241
+ }, initOverrides)];
242
+ case 3:
243
+ response = _c.sent();
244
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AffiliatesResponseFromJSON)(jsonValue); })];
245
+ }
246
+ });
247
+ });
248
+ };
249
+ /**
250
+ * Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
251
+ * Retrieve affiliates
252
+ */
253
+ AffiliateApi.prototype.getAffiliatesByQuery = function (requestParameters, initOverrides) {
254
+ return __awaiter(this, void 0, void 0, function () {
255
+ var response;
256
+ return __generator(this, function (_a) {
257
+ switch (_a.label) {
258
+ case 0: return [4 /*yield*/, this.getAffiliatesByQueryRaw(requestParameters, initOverrides)];
259
+ case 1:
260
+ response = _a.sent();
261
+ return [4 /*yield*/, response.value()];
262
+ case 2: return [2 /*return*/, _a.sent()];
263
+ }
264
+ });
265
+ });
266
+ };
78
267
  /**
79
268
  * Retrieves a group of clicks from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
80
269
  * Retrieve clicks
@@ -215,6 +404,137 @@ var AffiliateApi = /** @class */ (function (_super) {
215
404
  });
216
405
  });
217
406
  };
407
+ /**
408
+ * Insert an affiliate on the UltraCart account. The affiliate is created within the merchant\'s active affiliate program.
409
+ * Insert an affiliate
410
+ */
411
+ AffiliateApi.prototype.insertAffiliateRaw = function (requestParameters, initOverrides) {
412
+ return __awaiter(this, void 0, void 0, function () {
413
+ var queryParameters, headerParameters, _a, _b, response;
414
+ return __generator(this, function (_c) {
415
+ switch (_c.label) {
416
+ case 0:
417
+ if (requestParameters.affiliate === null || requestParameters.affiliate === undefined) {
418
+ throw new runtime.RequiredError('affiliate', 'Required parameter requestParameters.affiliate was null or undefined when calling insertAffiliate.');
419
+ }
420
+ queryParameters = {};
421
+ if (requestParameters.expand !== undefined) {
422
+ queryParameters['_expand'] = requestParameters.expand;
423
+ }
424
+ headerParameters = {};
425
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
426
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
427
+ // oauth required
428
+ _a = headerParameters;
429
+ _b = "Authorization";
430
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_write"])];
431
+ case 1:
432
+ // oauth required
433
+ _a[_b] = _c.sent();
434
+ _c.label = 2;
435
+ case 2:
436
+ if (this.configuration && this.configuration.apiKey) {
437
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
438
+ }
439
+ return [4 /*yield*/, this.request({
440
+ path: "/affiliate/affiliates",
441
+ method: 'POST',
442
+ headers: headerParameters,
443
+ query: queryParameters,
444
+ body: (0, models_1.AffiliateToJSON)(requestParameters.affiliate),
445
+ }, initOverrides)];
446
+ case 3:
447
+ response = _c.sent();
448
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AffiliateResponseFromJSON)(jsonValue); })];
449
+ }
450
+ });
451
+ });
452
+ };
453
+ /**
454
+ * Insert an affiliate on the UltraCart account. The affiliate is created within the merchant\'s active affiliate program.
455
+ * Insert an affiliate
456
+ */
457
+ AffiliateApi.prototype.insertAffiliate = function (requestParameters, initOverrides) {
458
+ return __awaiter(this, void 0, void 0, function () {
459
+ var response;
460
+ return __generator(this, function (_a) {
461
+ switch (_a.label) {
462
+ case 0: return [4 /*yield*/, this.insertAffiliateRaw(requestParameters, initOverrides)];
463
+ case 1:
464
+ response = _a.sent();
465
+ return [4 /*yield*/, response.value()];
466
+ case 2: return [2 /*return*/, _a.sent()];
467
+ }
468
+ });
469
+ });
470
+ };
471
+ /**
472
+ * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
473
+ * Update an affiliate
474
+ */
475
+ AffiliateApi.prototype.updateAffiliateRaw = function (requestParameters, initOverrides) {
476
+ return __awaiter(this, void 0, void 0, function () {
477
+ var queryParameters, headerParameters, _a, _b, response;
478
+ return __generator(this, function (_c) {
479
+ switch (_c.label) {
480
+ case 0:
481
+ if (requestParameters.affiliateOid === null || requestParameters.affiliateOid === undefined) {
482
+ throw new runtime.RequiredError('affiliateOid', 'Required parameter requestParameters.affiliateOid was null or undefined when calling updateAffiliate.');
483
+ }
484
+ if (requestParameters.affiliate === null || requestParameters.affiliate === undefined) {
485
+ throw new runtime.RequiredError('affiliate', 'Required parameter requestParameters.affiliate was null or undefined when calling updateAffiliate.');
486
+ }
487
+ queryParameters = {};
488
+ if (requestParameters.expand !== undefined) {
489
+ queryParameters['_expand'] = requestParameters.expand;
490
+ }
491
+ headerParameters = {};
492
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
493
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
494
+ // oauth required
495
+ _a = headerParameters;
496
+ _b = "Authorization";
497
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_write"])];
498
+ case 1:
499
+ // oauth required
500
+ _a[_b] = _c.sent();
501
+ _c.label = 2;
502
+ case 2:
503
+ if (this.configuration && this.configuration.apiKey) {
504
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
505
+ }
506
+ return [4 /*yield*/, this.request({
507
+ path: "/affiliate/affiliates/{affiliate_oid}".replace("{".concat("affiliate_oid", "}"), encodeURIComponent(String(requestParameters.affiliateOid))),
508
+ method: 'PUT',
509
+ headers: headerParameters,
510
+ query: queryParameters,
511
+ body: (0, models_1.AffiliateToJSON)(requestParameters.affiliate),
512
+ }, initOverrides)];
513
+ case 3:
514
+ response = _c.sent();
515
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AffiliateResponseFromJSON)(jsonValue); })];
516
+ }
517
+ });
518
+ });
519
+ };
520
+ /**
521
+ * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
522
+ * Update an affiliate
523
+ */
524
+ AffiliateApi.prototype.updateAffiliate = function (requestParameters, initOverrides) {
525
+ return __awaiter(this, void 0, void 0, function () {
526
+ var response;
527
+ return __generator(this, function (_a) {
528
+ switch (_a.label) {
529
+ case 0: return [4 /*yield*/, this.updateAffiliateRaw(requestParameters, initOverrides)];
530
+ case 1:
531
+ response = _a.sent();
532
+ return [4 /*yield*/, response.value()];
533
+ case 2: return [2 /*return*/, _a.sent()];
534
+ }
535
+ });
536
+ });
537
+ };
218
538
  return AffiliateApi;
219
539
  }(runtime.BaseAPI));
220
540
  exports.AffiliateApi = AffiliateApi;