@teemill/inserts 0.1.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/api.ts ADDED
@@ -0,0 +1,985 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Inserts API
5
+ * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
6
+ *
7
+ * The version of the OpenAPI document: 0.1.1
8
+ *
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 type { Configuration } from './configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
22
+ import type { RequestArgs } from './base';
23
+ // @ts-ignore
24
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
+
26
+ /**
27
+ *
28
+ * @export
29
+ * @interface ApiError
30
+ */
31
+ export interface ApiError {
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof ApiError
36
+ */
37
+ 'message': string;
38
+ /**
39
+ *
40
+ * @type {string}
41
+ * @memberof ApiError
42
+ */
43
+ 'code': string;
44
+ }
45
+ /**
46
+ *
47
+ * @export
48
+ * @interface CreateInsertRequest
49
+ */
50
+ export interface CreateInsertRequest {
51
+ /**
52
+ * Whether the insert is enabled
53
+ * @type {boolean}
54
+ * @memberof CreateInsertRequest
55
+ */
56
+ 'enabled': boolean;
57
+ /**
58
+ * A reference to the product that will be inserted into the order when this insert rule is triggered
59
+ * @type {string}
60
+ * @memberof CreateInsertRequest
61
+ */
62
+ 'productRef': string | null;
63
+ /**
64
+ * A reference to the insert type that will be inserted into the order when this insert rule is triggered
65
+ * @type {string}
66
+ * @memberof CreateInsertRequest
67
+ */
68
+ 'typeRef': string | null;
69
+ }
70
+ /**
71
+ *
72
+ * @export
73
+ * @interface Insert
74
+ */
75
+ export interface Insert {
76
+ /**
77
+ * Unique object identifier
78
+ * @type {string}
79
+ * @memberof Insert
80
+ */
81
+ 'id': string;
82
+ /**
83
+ * Whether the insert is enabled
84
+ * @type {boolean}
85
+ * @memberof Insert
86
+ */
87
+ 'enabled': boolean;
88
+ /**
89
+ * A reference to the product that will be inserted into the order when this insert rule is triggered
90
+ * @type {string}
91
+ * @memberof Insert
92
+ */
93
+ 'productRef': string | null;
94
+ /**
95
+ * A reference to the insert type that will be inserted into the order when this insert rule is triggered
96
+ * @type {string}
97
+ * @memberof Insert
98
+ */
99
+ 'typeRef': string | null;
100
+ /**
101
+ * ISO 8601 Timestamp
102
+ * @type {string}
103
+ * @memberof Insert
104
+ */
105
+ 'createdAt': string;
106
+ /**
107
+ * ISO 8601 Timestamp
108
+ * @type {string}
109
+ * @memberof Insert
110
+ */
111
+ 'updatedAt': string | null;
112
+ }
113
+ /**
114
+ *
115
+ * @export
116
+ * @interface InsertType
117
+ */
118
+ export interface InsertType {
119
+ /**
120
+ * Unique object identifier
121
+ * @type {string}
122
+ * @memberof InsertType
123
+ */
124
+ 'id': string;
125
+ /**
126
+ * The name of the insert type
127
+ * @type {string}
128
+ * @memberof InsertType
129
+ */
130
+ 'name': string;
131
+ /**
132
+ * The code of the insert type
133
+ * @type {string}
134
+ * @memberof InsertType
135
+ */
136
+ 'code': string;
137
+ /**
138
+ * The description of the insert type
139
+ * @type {string}
140
+ * @memberof InsertType
141
+ */
142
+ 'description': string;
143
+ }
144
+ /**
145
+ *
146
+ * @export
147
+ * @interface ListInsertTypes200Response
148
+ */
149
+ export interface ListInsertTypes200Response {
150
+ /**
151
+ *
152
+ * @type {Array<InsertType>}
153
+ * @memberof ListInsertTypes200Response
154
+ */
155
+ 'insertTypes': Array<InsertType>;
156
+ /**
157
+ * The token referencing the next page number
158
+ * @type {number}
159
+ * @memberof ListInsertTypes200Response
160
+ */
161
+ 'nextPageToken': number | null;
162
+ }
163
+ /**
164
+ *
165
+ * @export
166
+ * @interface ListInserts200Response
167
+ */
168
+ export interface ListInserts200Response {
169
+ /**
170
+ *
171
+ * @type {Array<Insert>}
172
+ * @memberof ListInserts200Response
173
+ */
174
+ 'inserts': Array<Insert>;
175
+ /**
176
+ * The token referencing the next page number
177
+ * @type {number}
178
+ * @memberof ListInserts200Response
179
+ */
180
+ 'nextPageToken': number | null;
181
+ }
182
+ /**
183
+ *
184
+ * @export
185
+ * @interface UpdateInsertRequest
186
+ */
187
+ export interface UpdateInsertRequest {
188
+ /**
189
+ * Whether the insert is enabled
190
+ * @type {boolean}
191
+ * @memberof UpdateInsertRequest
192
+ */
193
+ 'enabled'?: boolean;
194
+ /**
195
+ * A reference to the product that will be inserted into the order when this insert rule is triggered
196
+ * @type {string}
197
+ * @memberof UpdateInsertRequest
198
+ */
199
+ 'productRef'?: string | null;
200
+ /**
201
+ * A reference to the insert type that will be inserted into the order when this insert rule is triggered
202
+ * @type {string}
203
+ * @memberof UpdateInsertRequest
204
+ */
205
+ 'typeRef'?: string | null;
206
+ }
207
+
208
+ /**
209
+ * InsertsApi - axios parameter creator
210
+ * @export
211
+ */
212
+ export const InsertsApiAxiosParamCreator = function (configuration?: Configuration) {
213
+ return {
214
+ /**
215
+ * Create an insert for a project
216
+ * @summary Create an insert
217
+ * @param {string} project
218
+ * @param {CreateInsertRequest} createInsertRequest Create an insert
219
+ * @param {*} [options] Override http request option.
220
+ * @throws {RequiredError}
221
+ */
222
+ createInsert: async (project: string, createInsertRequest: CreateInsertRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
223
+ // verify required parameter 'project' is not null or undefined
224
+ assertParamExists('createInsert', 'project', project)
225
+ // verify required parameter 'createInsertRequest' is not null or undefined
226
+ assertParamExists('createInsert', 'createInsertRequest', createInsertRequest)
227
+ const localVarPath = `/v1/inserts`;
228
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
229
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
230
+ let baseOptions;
231
+ if (configuration) {
232
+ baseOptions = configuration.baseOptions;
233
+ }
234
+
235
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
236
+ const localVarHeaderParameter = {} as any;
237
+ const localVarQueryParameter = {} as any;
238
+
239
+ // authentication session-oauth required
240
+ // oauth required
241
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
242
+
243
+ // authentication api-key required
244
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
245
+
246
+ if (project !== undefined) {
247
+ localVarQueryParameter['project'] = project;
248
+ }
249
+
250
+
251
+
252
+ localVarHeaderParameter['Content-Type'] = 'application/json';
253
+
254
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
255
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
256
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
257
+ localVarRequestOptions.data = serializeDataIfNeeded(createInsertRequest, localVarRequestOptions, configuration)
258
+
259
+ return {
260
+ url: toPathString(localVarUrlObj),
261
+ options: localVarRequestOptions,
262
+ };
263
+ },
264
+ /**
265
+ * Retrieve details for a specific insert for a project
266
+ * @summary Retrieve an insert for a project
267
+ * @param {string} insertId Filter by insert ID
268
+ * @param {string} project
269
+ * @param {*} [options] Override http request option.
270
+ * @throws {RequiredError}
271
+ */
272
+ getInsert: async (insertId: string, project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
273
+ // verify required parameter 'insertId' is not null or undefined
274
+ assertParamExists('getInsert', 'insertId', insertId)
275
+ // verify required parameter 'project' is not null or undefined
276
+ assertParamExists('getInsert', 'project', project)
277
+ const localVarPath = `/v1/inserts/{insertId}`
278
+ .replace(`{${"insertId"}}`, encodeURIComponent(String(insertId)));
279
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
280
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
281
+ let baseOptions;
282
+ if (configuration) {
283
+ baseOptions = configuration.baseOptions;
284
+ }
285
+
286
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
287
+ const localVarHeaderParameter = {} as any;
288
+ const localVarQueryParameter = {} as any;
289
+
290
+ // authentication session-oauth required
291
+ // oauth required
292
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
293
+
294
+ // authentication api-key required
295
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
296
+
297
+ if (project !== undefined) {
298
+ localVarQueryParameter['project'] = project;
299
+ }
300
+
301
+
302
+
303
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
304
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
305
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
306
+
307
+ return {
308
+ url: toPathString(localVarUrlObj),
309
+ options: localVarRequestOptions,
310
+ };
311
+ },
312
+ /**
313
+ * List your project inserts
314
+ * @summary List project inserts
315
+ * @param {string} project
316
+ * @param {number} [pageToken] Page reference token
317
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
318
+ * @param {string} [search] Search for inserts by id or name
319
+ * @param {*} [options] Override http request option.
320
+ * @throws {RequiredError}
321
+ */
322
+ listInserts: async (project: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
323
+ // verify required parameter 'project' is not null or undefined
324
+ assertParamExists('listInserts', 'project', project)
325
+ const localVarPath = `/v1/inserts`;
326
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
327
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
328
+ let baseOptions;
329
+ if (configuration) {
330
+ baseOptions = configuration.baseOptions;
331
+ }
332
+
333
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
334
+ const localVarHeaderParameter = {} as any;
335
+ const localVarQueryParameter = {} as any;
336
+
337
+ // authentication session-oauth required
338
+ // oauth required
339
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
340
+
341
+ // authentication api-key required
342
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
343
+
344
+ if (project !== undefined) {
345
+ localVarQueryParameter['project'] = project;
346
+ }
347
+
348
+ if (pageToken !== undefined) {
349
+ localVarQueryParameter['pageToken'] = pageToken;
350
+ }
351
+
352
+ if (pageSize !== undefined) {
353
+ localVarQueryParameter['pageSize'] = pageSize;
354
+ }
355
+
356
+ if (search !== undefined) {
357
+ localVarQueryParameter['search'] = search;
358
+ }
359
+
360
+
361
+
362
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
363
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
364
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
365
+
366
+ return {
367
+ url: toPathString(localVarUrlObj),
368
+ options: localVarRequestOptions,
369
+ };
370
+ },
371
+ /**
372
+ * Update an insert for a project
373
+ * @summary Update an insert
374
+ * @param {string} insertId Filter by insert ID
375
+ * @param {string} project
376
+ * @param {UpdateInsertRequest} updateInsertRequest Update an insert
377
+ * @param {*} [options] Override http request option.
378
+ * @throws {RequiredError}
379
+ */
380
+ updateInsert: async (insertId: string, project: string, updateInsertRequest: UpdateInsertRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
381
+ // verify required parameter 'insertId' is not null or undefined
382
+ assertParamExists('updateInsert', 'insertId', insertId)
383
+ // verify required parameter 'project' is not null or undefined
384
+ assertParamExists('updateInsert', 'project', project)
385
+ // verify required parameter 'updateInsertRequest' is not null or undefined
386
+ assertParamExists('updateInsert', 'updateInsertRequest', updateInsertRequest)
387
+ const localVarPath = `/v1/inserts/{insertId}`
388
+ .replace(`{${"insertId"}}`, encodeURIComponent(String(insertId)));
389
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
390
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
391
+ let baseOptions;
392
+ if (configuration) {
393
+ baseOptions = configuration.baseOptions;
394
+ }
395
+
396
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
397
+ const localVarHeaderParameter = {} as any;
398
+ const localVarQueryParameter = {} as any;
399
+
400
+ // authentication session-oauth required
401
+ // oauth required
402
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
403
+
404
+ // authentication api-key required
405
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
406
+
407
+ if (project !== undefined) {
408
+ localVarQueryParameter['project'] = project;
409
+ }
410
+
411
+
412
+
413
+ localVarHeaderParameter['Content-Type'] = 'application/json';
414
+
415
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
416
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
417
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
418
+ localVarRequestOptions.data = serializeDataIfNeeded(updateInsertRequest, localVarRequestOptions, configuration)
419
+
420
+ return {
421
+ url: toPathString(localVarUrlObj),
422
+ options: localVarRequestOptions,
423
+ };
424
+ },
425
+ }
426
+ };
427
+
428
+ /**
429
+ * InsertsApi - functional programming interface
430
+ * @export
431
+ */
432
+ export const InsertsApiFp = function(configuration?: Configuration) {
433
+ const localVarAxiosParamCreator = InsertsApiAxiosParamCreator(configuration)
434
+ return {
435
+ /**
436
+ * Create an insert for a project
437
+ * @summary Create an insert
438
+ * @param {string} project
439
+ * @param {CreateInsertRequest} createInsertRequest Create an insert
440
+ * @param {*} [options] Override http request option.
441
+ * @throws {RequiredError}
442
+ */
443
+ async createInsert(project: string, createInsertRequest: CreateInsertRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Insert>> {
444
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createInsert(project, createInsertRequest, options);
445
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
446
+ const localVarOperationServerBasePath = operationServerMap['InsertsApi.createInsert']?.[localVarOperationServerIndex]?.url;
447
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
448
+ },
449
+ /**
450
+ * Retrieve details for a specific insert for a project
451
+ * @summary Retrieve an insert for a project
452
+ * @param {string} insertId Filter by insert ID
453
+ * @param {string} project
454
+ * @param {*} [options] Override http request option.
455
+ * @throws {RequiredError}
456
+ */
457
+ async getInsert(insertId: string, project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Insert>> {
458
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getInsert(insertId, project, options);
459
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
460
+ const localVarOperationServerBasePath = operationServerMap['InsertsApi.getInsert']?.[localVarOperationServerIndex]?.url;
461
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
462
+ },
463
+ /**
464
+ * List your project inserts
465
+ * @summary List project inserts
466
+ * @param {string} project
467
+ * @param {number} [pageToken] Page reference token
468
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
469
+ * @param {string} [search] Search for inserts by id or name
470
+ * @param {*} [options] Override http request option.
471
+ * @throws {RequiredError}
472
+ */
473
+ async listInserts(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInserts200Response>> {
474
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listInserts(project, pageToken, pageSize, search, options);
475
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
476
+ const localVarOperationServerBasePath = operationServerMap['InsertsApi.listInserts']?.[localVarOperationServerIndex]?.url;
477
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
478
+ },
479
+ /**
480
+ * Update an insert for a project
481
+ * @summary Update an insert
482
+ * @param {string} insertId Filter by insert ID
483
+ * @param {string} project
484
+ * @param {UpdateInsertRequest} updateInsertRequest Update an insert
485
+ * @param {*} [options] Override http request option.
486
+ * @throws {RequiredError}
487
+ */
488
+ async updateInsert(insertId: string, project: string, updateInsertRequest: UpdateInsertRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Insert>> {
489
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateInsert(insertId, project, updateInsertRequest, options);
490
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
491
+ const localVarOperationServerBasePath = operationServerMap['InsertsApi.updateInsert']?.[localVarOperationServerIndex]?.url;
492
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
493
+ },
494
+ }
495
+ };
496
+
497
+ /**
498
+ * InsertsApi - factory interface
499
+ * @export
500
+ */
501
+ export const InsertsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
502
+ const localVarFp = InsertsApiFp(configuration)
503
+ return {
504
+ /**
505
+ * Create an insert for a project
506
+ * @summary Create an insert
507
+ * @param {InsertsApiCreateInsertRequest} requestParameters Request parameters.
508
+ * @param {*} [options] Override http request option.
509
+ * @throws {RequiredError}
510
+ */
511
+ createInsert(requestParameters: InsertsApiCreateInsertRequest, options?: RawAxiosRequestConfig): AxiosPromise<Insert> {
512
+ return localVarFp.createInsert(requestParameters.project, requestParameters.createInsertRequest, options).then((request) => request(axios, basePath));
513
+ },
514
+ /**
515
+ * Retrieve details for a specific insert for a project
516
+ * @summary Retrieve an insert for a project
517
+ * @param {InsertsApiGetInsertRequest} requestParameters Request parameters.
518
+ * @param {*} [options] Override http request option.
519
+ * @throws {RequiredError}
520
+ */
521
+ getInsert(requestParameters: InsertsApiGetInsertRequest, options?: RawAxiosRequestConfig): AxiosPromise<Insert> {
522
+ return localVarFp.getInsert(requestParameters.insertId, requestParameters.project, options).then((request) => request(axios, basePath));
523
+ },
524
+ /**
525
+ * List your project inserts
526
+ * @summary List project inserts
527
+ * @param {InsertsApiListInsertsRequest} requestParameters Request parameters.
528
+ * @param {*} [options] Override http request option.
529
+ * @throws {RequiredError}
530
+ */
531
+ listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInserts200Response> {
532
+ return localVarFp.listInserts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
533
+ },
534
+ /**
535
+ * Update an insert for a project
536
+ * @summary Update an insert
537
+ * @param {InsertsApiUpdateInsertRequest} requestParameters Request parameters.
538
+ * @param {*} [options] Override http request option.
539
+ * @throws {RequiredError}
540
+ */
541
+ updateInsert(requestParameters: InsertsApiUpdateInsertRequest, options?: RawAxiosRequestConfig): AxiosPromise<Insert> {
542
+ return localVarFp.updateInsert(requestParameters.insertId, requestParameters.project, requestParameters.updateInsertRequest, options).then((request) => request(axios, basePath));
543
+ },
544
+ };
545
+ };
546
+
547
+ /**
548
+ * Request parameters for createInsert operation in InsertsApi.
549
+ * @export
550
+ * @interface InsertsApiCreateInsertRequest
551
+ */
552
+ export interface InsertsApiCreateInsertRequest {
553
+ /**
554
+ *
555
+ * @type {string}
556
+ * @memberof InsertsApiCreateInsert
557
+ */
558
+ readonly project: string
559
+
560
+ /**
561
+ * Create an insert
562
+ * @type {CreateInsertRequest}
563
+ * @memberof InsertsApiCreateInsert
564
+ */
565
+ readonly createInsertRequest: CreateInsertRequest
566
+ }
567
+
568
+ /**
569
+ * Request parameters for getInsert operation in InsertsApi.
570
+ * @export
571
+ * @interface InsertsApiGetInsertRequest
572
+ */
573
+ export interface InsertsApiGetInsertRequest {
574
+ /**
575
+ * Filter by insert ID
576
+ * @type {string}
577
+ * @memberof InsertsApiGetInsert
578
+ */
579
+ readonly insertId: string
580
+
581
+ /**
582
+ *
583
+ * @type {string}
584
+ * @memberof InsertsApiGetInsert
585
+ */
586
+ readonly project: string
587
+ }
588
+
589
+ /**
590
+ * Request parameters for listInserts operation in InsertsApi.
591
+ * @export
592
+ * @interface InsertsApiListInsertsRequest
593
+ */
594
+ export interface InsertsApiListInsertsRequest {
595
+ /**
596
+ *
597
+ * @type {string}
598
+ * @memberof InsertsApiListInserts
599
+ */
600
+ readonly project: string
601
+
602
+ /**
603
+ * Page reference token
604
+ * @type {number}
605
+ * @memberof InsertsApiListInserts
606
+ */
607
+ readonly pageToken?: number
608
+
609
+ /**
610
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
611
+ * @type {number}
612
+ * @memberof InsertsApiListInserts
613
+ */
614
+ readonly pageSize?: number
615
+
616
+ /**
617
+ * Search for inserts by id or name
618
+ * @type {string}
619
+ * @memberof InsertsApiListInserts
620
+ */
621
+ readonly search?: string
622
+ }
623
+
624
+ /**
625
+ * Request parameters for updateInsert operation in InsertsApi.
626
+ * @export
627
+ * @interface InsertsApiUpdateInsertRequest
628
+ */
629
+ export interface InsertsApiUpdateInsertRequest {
630
+ /**
631
+ * Filter by insert ID
632
+ * @type {string}
633
+ * @memberof InsertsApiUpdateInsert
634
+ */
635
+ readonly insertId: string
636
+
637
+ /**
638
+ *
639
+ * @type {string}
640
+ * @memberof InsertsApiUpdateInsert
641
+ */
642
+ readonly project: string
643
+
644
+ /**
645
+ * Update an insert
646
+ * @type {UpdateInsertRequest}
647
+ * @memberof InsertsApiUpdateInsert
648
+ */
649
+ readonly updateInsertRequest: UpdateInsertRequest
650
+ }
651
+
652
+ /**
653
+ * InsertsApi - object-oriented interface
654
+ * @export
655
+ * @class InsertsApi
656
+ * @extends {BaseAPI}
657
+ */
658
+ export class InsertsApi extends BaseAPI {
659
+ /**
660
+ * Create an insert for a project
661
+ * @summary Create an insert
662
+ * @param {InsertsApiCreateInsertRequest} requestParameters Request parameters.
663
+ * @param {*} [options] Override http request option.
664
+ * @throws {RequiredError}
665
+ * @memberof InsertsApi
666
+ */
667
+ public createInsert(requestParameters: InsertsApiCreateInsertRequest, options?: RawAxiosRequestConfig) {
668
+ return InsertsApiFp(this.configuration).createInsert(requestParameters.project, requestParameters.createInsertRequest, options).then((request) => request(this.axios, this.basePath));
669
+ }
670
+
671
+ /**
672
+ * Retrieve details for a specific insert for a project
673
+ * @summary Retrieve an insert for a project
674
+ * @param {InsertsApiGetInsertRequest} requestParameters Request parameters.
675
+ * @param {*} [options] Override http request option.
676
+ * @throws {RequiredError}
677
+ * @memberof InsertsApi
678
+ */
679
+ public getInsert(requestParameters: InsertsApiGetInsertRequest, options?: RawAxiosRequestConfig) {
680
+ return InsertsApiFp(this.configuration).getInsert(requestParameters.insertId, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
681
+ }
682
+
683
+ /**
684
+ * List your project inserts
685
+ * @summary List project inserts
686
+ * @param {InsertsApiListInsertsRequest} requestParameters Request parameters.
687
+ * @param {*} [options] Override http request option.
688
+ * @throws {RequiredError}
689
+ * @memberof InsertsApi
690
+ */
691
+ public listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig) {
692
+ return InsertsApiFp(this.configuration).listInserts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
693
+ }
694
+
695
+ /**
696
+ * Update an insert for a project
697
+ * @summary Update an insert
698
+ * @param {InsertsApiUpdateInsertRequest} requestParameters Request parameters.
699
+ * @param {*} [options] Override http request option.
700
+ * @throws {RequiredError}
701
+ * @memberof InsertsApi
702
+ */
703
+ public updateInsert(requestParameters: InsertsApiUpdateInsertRequest, options?: RawAxiosRequestConfig) {
704
+ return InsertsApiFp(this.configuration).updateInsert(requestParameters.insertId, requestParameters.project, requestParameters.updateInsertRequest, options).then((request) => request(this.axios, this.basePath));
705
+ }
706
+ }
707
+
708
+
709
+
710
+ /**
711
+ * InsertsTypesApi - axios parameter creator
712
+ * @export
713
+ */
714
+ export const InsertsTypesApiAxiosParamCreator = function (configuration?: Configuration) {
715
+ return {
716
+ /**
717
+ * Retrieve details for a specific insert type
718
+ * @summary Retrieve an insert type
719
+ * @param {string} insertTypeId Filter by insert type ID
720
+ * @param {string} project
721
+ * @param {*} [options] Override http request option.
722
+ * @throws {RequiredError}
723
+ */
724
+ getInsertType: async (insertTypeId: string, project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
725
+ // verify required parameter 'insertTypeId' is not null or undefined
726
+ assertParamExists('getInsertType', 'insertTypeId', insertTypeId)
727
+ // verify required parameter 'project' is not null or undefined
728
+ assertParamExists('getInsertType', 'project', project)
729
+ const localVarPath = `/v1/inserts/types/{insertTypeId}`
730
+ .replace(`{${"insertTypeId"}}`, encodeURIComponent(String(insertTypeId)));
731
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
732
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
733
+ let baseOptions;
734
+ if (configuration) {
735
+ baseOptions = configuration.baseOptions;
736
+ }
737
+
738
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
739
+ const localVarHeaderParameter = {} as any;
740
+ const localVarQueryParameter = {} as any;
741
+
742
+ // authentication session-oauth required
743
+ // oauth required
744
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
745
+
746
+ // authentication api-key required
747
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
748
+
749
+ if (project !== undefined) {
750
+ localVarQueryParameter['project'] = project;
751
+ }
752
+
753
+
754
+
755
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
756
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
757
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
758
+
759
+ return {
760
+ url: toPathString(localVarUrlObj),
761
+ options: localVarRequestOptions,
762
+ };
763
+ },
764
+ /**
765
+ * List all insert types
766
+ * @summary List insert types
767
+ * @param {string} project
768
+ * @param {number} [pageToken] Page reference token
769
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
770
+ * @param {string} [search] Search for inserts by id or name
771
+ * @param {*} [options] Override http request option.
772
+ * @throws {RequiredError}
773
+ */
774
+ listInsertTypes: async (project: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
775
+ // verify required parameter 'project' is not null or undefined
776
+ assertParamExists('listInsertTypes', 'project', project)
777
+ const localVarPath = `/v1/inserts/types`;
778
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
779
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
780
+ let baseOptions;
781
+ if (configuration) {
782
+ baseOptions = configuration.baseOptions;
783
+ }
784
+
785
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
786
+ const localVarHeaderParameter = {} as any;
787
+ const localVarQueryParameter = {} as any;
788
+
789
+ // authentication session-oauth required
790
+ // oauth required
791
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
792
+
793
+ // authentication api-key required
794
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
795
+
796
+ if (project !== undefined) {
797
+ localVarQueryParameter['project'] = project;
798
+ }
799
+
800
+ if (pageToken !== undefined) {
801
+ localVarQueryParameter['pageToken'] = pageToken;
802
+ }
803
+
804
+ if (pageSize !== undefined) {
805
+ localVarQueryParameter['pageSize'] = pageSize;
806
+ }
807
+
808
+ if (search !== undefined) {
809
+ localVarQueryParameter['search'] = search;
810
+ }
811
+
812
+
813
+
814
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
815
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
816
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
817
+
818
+ return {
819
+ url: toPathString(localVarUrlObj),
820
+ options: localVarRequestOptions,
821
+ };
822
+ },
823
+ }
824
+ };
825
+
826
+ /**
827
+ * InsertsTypesApi - functional programming interface
828
+ * @export
829
+ */
830
+ export const InsertsTypesApiFp = function(configuration?: Configuration) {
831
+ const localVarAxiosParamCreator = InsertsTypesApiAxiosParamCreator(configuration)
832
+ return {
833
+ /**
834
+ * Retrieve details for a specific insert type
835
+ * @summary Retrieve an insert type
836
+ * @param {string} insertTypeId Filter by insert type ID
837
+ * @param {string} project
838
+ * @param {*} [options] Override http request option.
839
+ * @throws {RequiredError}
840
+ */
841
+ async getInsertType(insertTypeId: string, project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsertType>> {
842
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getInsertType(insertTypeId, project, options);
843
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
844
+ const localVarOperationServerBasePath = operationServerMap['InsertsTypesApi.getInsertType']?.[localVarOperationServerIndex]?.url;
845
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
846
+ },
847
+ /**
848
+ * List all insert types
849
+ * @summary List insert types
850
+ * @param {string} project
851
+ * @param {number} [pageToken] Page reference token
852
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
853
+ * @param {string} [search] Search for inserts by id or name
854
+ * @param {*} [options] Override http request option.
855
+ * @throws {RequiredError}
856
+ */
857
+ async listInsertTypes(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInsertTypes200Response>> {
858
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listInsertTypes(project, pageToken, pageSize, search, options);
859
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
860
+ const localVarOperationServerBasePath = operationServerMap['InsertsTypesApi.listInsertTypes']?.[localVarOperationServerIndex]?.url;
861
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
862
+ },
863
+ }
864
+ };
865
+
866
+ /**
867
+ * InsertsTypesApi - factory interface
868
+ * @export
869
+ */
870
+ export const InsertsTypesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
871
+ const localVarFp = InsertsTypesApiFp(configuration)
872
+ return {
873
+ /**
874
+ * Retrieve details for a specific insert type
875
+ * @summary Retrieve an insert type
876
+ * @param {InsertsTypesApiGetInsertTypeRequest} requestParameters Request parameters.
877
+ * @param {*} [options] Override http request option.
878
+ * @throws {RequiredError}
879
+ */
880
+ getInsertType(requestParameters: InsertsTypesApiGetInsertTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<InsertType> {
881
+ return localVarFp.getInsertType(requestParameters.insertTypeId, requestParameters.project, options).then((request) => request(axios, basePath));
882
+ },
883
+ /**
884
+ * List all insert types
885
+ * @summary List insert types
886
+ * @param {InsertsTypesApiListInsertTypesRequest} requestParameters Request parameters.
887
+ * @param {*} [options] Override http request option.
888
+ * @throws {RequiredError}
889
+ */
890
+ listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInsertTypes200Response> {
891
+ return localVarFp.listInsertTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
892
+ },
893
+ };
894
+ };
895
+
896
+ /**
897
+ * Request parameters for getInsertType operation in InsertsTypesApi.
898
+ * @export
899
+ * @interface InsertsTypesApiGetInsertTypeRequest
900
+ */
901
+ export interface InsertsTypesApiGetInsertTypeRequest {
902
+ /**
903
+ * Filter by insert type ID
904
+ * @type {string}
905
+ * @memberof InsertsTypesApiGetInsertType
906
+ */
907
+ readonly insertTypeId: string
908
+
909
+ /**
910
+ *
911
+ * @type {string}
912
+ * @memberof InsertsTypesApiGetInsertType
913
+ */
914
+ readonly project: string
915
+ }
916
+
917
+ /**
918
+ * Request parameters for listInsertTypes operation in InsertsTypesApi.
919
+ * @export
920
+ * @interface InsertsTypesApiListInsertTypesRequest
921
+ */
922
+ export interface InsertsTypesApiListInsertTypesRequest {
923
+ /**
924
+ *
925
+ * @type {string}
926
+ * @memberof InsertsTypesApiListInsertTypes
927
+ */
928
+ readonly project: string
929
+
930
+ /**
931
+ * Page reference token
932
+ * @type {number}
933
+ * @memberof InsertsTypesApiListInsertTypes
934
+ */
935
+ readonly pageToken?: number
936
+
937
+ /**
938
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
939
+ * @type {number}
940
+ * @memberof InsertsTypesApiListInsertTypes
941
+ */
942
+ readonly pageSize?: number
943
+
944
+ /**
945
+ * Search for inserts by id or name
946
+ * @type {string}
947
+ * @memberof InsertsTypesApiListInsertTypes
948
+ */
949
+ readonly search?: string
950
+ }
951
+
952
+ /**
953
+ * InsertsTypesApi - object-oriented interface
954
+ * @export
955
+ * @class InsertsTypesApi
956
+ * @extends {BaseAPI}
957
+ */
958
+ export class InsertsTypesApi extends BaseAPI {
959
+ /**
960
+ * Retrieve details for a specific insert type
961
+ * @summary Retrieve an insert type
962
+ * @param {InsertsTypesApiGetInsertTypeRequest} requestParameters Request parameters.
963
+ * @param {*} [options] Override http request option.
964
+ * @throws {RequiredError}
965
+ * @memberof InsertsTypesApi
966
+ */
967
+ public getInsertType(requestParameters: InsertsTypesApiGetInsertTypeRequest, options?: RawAxiosRequestConfig) {
968
+ return InsertsTypesApiFp(this.configuration).getInsertType(requestParameters.insertTypeId, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
969
+ }
970
+
971
+ /**
972
+ * List all insert types
973
+ * @summary List insert types
974
+ * @param {InsertsTypesApiListInsertTypesRequest} requestParameters Request parameters.
975
+ * @param {*} [options] Override http request option.
976
+ * @throws {RequiredError}
977
+ * @memberof InsertsTypesApi
978
+ */
979
+ public listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig) {
980
+ return InsertsTypesApiFp(this.configuration).listInsertTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
981
+ }
982
+ }
983
+
984
+
985
+