@scout9/admin 1.0.2 → 1.0.3

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.
Files changed (85) hide show
  1. package/package.json +7 -2
  2. package/src/api.ts +2580 -262
  3. package/tsconfig.tsbuildinfo +1 -1
  4. package/build/api-openai.d.ts +0 -2992
  5. package/build/api-openai.js +0 -1968
  6. package/build/api.d.ts +0 -1162
  7. package/build/api.js +0 -553
  8. package/build/base.d.ts +0 -54
  9. package/build/base.js +0 -66
  10. package/build/common.d.ts +0 -65
  11. package/build/common.js +0 -145
  12. package/build/configuration.d.ts +0 -83
  13. package/build/configuration.js +0 -91
  14. package/build/index.d.ts +0 -13
  15. package/build/index.js +0 -31
  16. package/build/schemas/common/algolia.d.ts +0 -20
  17. package/build/schemas/common/algolia.js +0 -2
  18. package/build/schemas/common/contact-map.d.ts +0 -33
  19. package/build/schemas/common/contact-map.js +0 -2
  20. package/build/schemas/common/currency.d.ts +0 -1
  21. package/build/schemas/common/currency.js +0 -2
  22. package/build/schemas/common/index.d.ts +0 -6
  23. package/build/schemas/common/index.js +0 -22
  24. package/build/schemas/common/location.d.ts +0 -5
  25. package/build/schemas/common/location.js +0 -2
  26. package/build/schemas/common/task.d.ts +0 -20
  27. package/build/schemas/common/task.js +0 -2
  28. package/build/schemas/common/time.d.ts +0 -14
  29. package/build/schemas/common/time.js +0 -2
  30. package/build/schemas/common.d.ts +0 -77
  31. package/build/schemas/common.js +0 -8
  32. package/build/schemas/conversations/context.d.ts +0 -55
  33. package/build/schemas/conversations/context.js +0 -2
  34. package/build/schemas/conversations/conversation.d.ts +0 -53
  35. package/build/schemas/conversations/conversation.js +0 -2
  36. package/build/schemas/conversations/index.d.ts +0 -6
  37. package/build/schemas/conversations/index.js +0 -22
  38. package/build/schemas/conversations/message.d.ts +0 -62
  39. package/build/schemas/conversations/message.js +0 -2
  40. package/build/schemas/conversations/parsed.d.ts +0 -7
  41. package/build/schemas/conversations/parsed.js +0 -2
  42. package/build/schemas/conversations/scheduled-conversation.d.ts +0 -31
  43. package/build/schemas/conversations/scheduled-conversation.js +0 -2
  44. package/build/schemas/conversations/webhook.d.ts +0 -8
  45. package/build/schemas/conversations/webhook.js +0 -2
  46. package/build/schemas/index.d.ts +0 -3
  47. package/build/schemas/index.js +0 -19
  48. package/build/schemas/users/businesses/agents/agent.d.ts +0 -76
  49. package/build/schemas/users/businesses/agents/agent.js +0 -2
  50. package/build/schemas/users/businesses/agents/auth.d.ts +0 -7
  51. package/build/schemas/users/businesses/agents/auth.js +0 -2
  52. package/build/schemas/users/businesses/agents/index.d.ts +0 -2
  53. package/build/schemas/users/businesses/agents/index.js +0 -18
  54. package/build/schemas/users/businesses/business-location.d.ts +0 -10
  55. package/build/schemas/users/businesses/business-location.js +0 -2
  56. package/build/schemas/users/businesses/business.d.ts +0 -32
  57. package/build/schemas/users/businesses/business.js +0 -2
  58. package/build/schemas/users/businesses/context/context-indexed.d.ts +0 -9
  59. package/build/schemas/users/businesses/context/context-indexed.js +0 -2
  60. package/build/schemas/users/businesses/context/context-saves.d.ts +0 -12
  61. package/build/schemas/users/businesses/context/context-saves.js +0 -2
  62. package/build/schemas/users/businesses/context/context.d.ts +0 -64
  63. package/build/schemas/users/businesses/context/context.js +0 -2
  64. package/build/schemas/users/businesses/context/index.d.ts +0 -2
  65. package/build/schemas/users/businesses/context/index.js +0 -18
  66. package/build/schemas/users/businesses/index.d.ts +0 -5
  67. package/build/schemas/users/businesses/index.js +0 -21
  68. package/build/schemas/users/businesses/notifications.d.ts +0 -7
  69. package/build/schemas/users/businesses/notifications.js +0 -2
  70. package/build/schemas/users/businesses/offerings/index.d.ts +0 -2
  71. package/build/schemas/users/businesses/offerings/index.js +0 -18
  72. package/build/schemas/users/businesses/offerings/offer-indexed.d.ts +0 -34
  73. package/build/schemas/users/businesses/offerings/offer-indexed.js +0 -2
  74. package/build/schemas/users/businesses/offerings/offer.d.ts +0 -29
  75. package/build/schemas/users/businesses/offerings/offer.js +0 -2
  76. package/build/schemas/users/businesses/thread.d.ts +0 -44
  77. package/build/schemas/users/businesses/thread.js +0 -2
  78. package/build/schemas/users/customers/customer.d.ts +0 -35
  79. package/build/schemas/users/customers/customer.js +0 -2
  80. package/build/schemas/users/customers/index.d.ts +0 -1
  81. package/build/schemas/users/customers/index.js +0 -17
  82. package/build/schemas/users/index.d.ts +0 -2
  83. package/build/schemas/users/index.js +0 -18
  84. package/src/.openapi-generator/FILES +0 -9
  85. package/src/.openapi-generator/VERSION +0 -1
package/build/api.d.ts DELETED
@@ -1,1162 +0,0 @@
1
- /**
2
- * Scout9 API
3
- * APIs for managing Scout9 users and conversations
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from './configuration';
13
- import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
- import type { RequestArgs } from './base';
15
- import { BaseAPI } from './base';
16
- /**
17
- *
18
- * @export
19
- * @interface BlockInfo
20
- */
21
- export interface BlockInfo {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof BlockInfo
26
- */
27
- 'message'?: string;
28
- /**
29
- * ISO 8601 datetime string
30
- * @type {string}
31
- * @memberof BlockInfo
32
- */
33
- 'time'?: string;
34
- }
35
- /**
36
- *
37
- * @export
38
- * @interface CreateCustomerRequest
39
- */
40
- export interface CreateCustomerRequest {
41
- /**
42
- * The customers first name
43
- * @type {string}
44
- * @memberof CreateCustomerRequest
45
- */
46
- 'firstName': string;
47
- /**
48
- * The customers last name
49
- * @type {string}
50
- * @memberof CreateCustomerRequest
51
- */
52
- 'lastName': string;
53
- /**
54
- * The customers full name
55
- * @type {string}
56
- * @memberof CreateCustomerRequest
57
- */
58
- 'name'?: string;
59
- /**
60
- * The customers email address
61
- * @type {string}
62
- * @memberof CreateCustomerRequest
63
- */
64
- 'email'?: string | null;
65
- /**
66
- * The customers phone number
67
- * @type {string}
68
- * @memberof CreateCustomerRequest
69
- */
70
- 'phone'?: string | null;
71
- /**
72
- * The customers profile image
73
- * @type {string}
74
- * @memberof CreateCustomerRequest
75
- */
76
- 'img'?: string | null;
77
- /**
78
- * The customers neighborhood
79
- * @type {string}
80
- * @memberof CreateCustomerRequest
81
- */
82
- 'neighborhood'?: string | null;
83
- /**
84
- * The customers city
85
- * @type {string}
86
- * @memberof CreateCustomerRequest
87
- */
88
- 'city'?: string | null;
89
- /**
90
- * The customers 2-letter country code
91
- * @type {string}
92
- * @memberof CreateCustomerRequest
93
- */
94
- 'country'?: string | null;
95
- /**
96
- * The customers street address
97
- * @type {string}
98
- * @memberof CreateCustomerRequest
99
- */
100
- 'line1'?: string | null;
101
- /**
102
- * The customers street address
103
- * @type {string}
104
- * @memberof CreateCustomerRequest
105
- */
106
- 'line2'?: string | null;
107
- /**
108
- * The customers postal code
109
- * @type {string}
110
- * @memberof CreateCustomerRequest
111
- */
112
- 'postal_code'?: string | null;
113
- /**
114
- * The customers state, county, province, or region
115
- * @type {string}
116
- * @memberof CreateCustomerRequest
117
- */
118
- 'state'?: string | null;
119
- /**
120
- * The customers town (only used in Japan)
121
- * @type {string}
122
- * @memberof CreateCustomerRequest
123
- */
124
- 'town'?: string | null;
125
- /**
126
- *
127
- * @type {BlockInfo}
128
- * @memberof CreateCustomerRequest
129
- */
130
- 'blocked'?: BlockInfo;
131
- /**
132
- *
133
- * @type {BlockInfo}
134
- * @memberof CreateCustomerRequest
135
- */
136
- 'phoneBlocked'?: BlockInfo;
137
- /**
138
- *
139
- * @type {BlockInfo}
140
- * @memberof CreateCustomerRequest
141
- */
142
- 'emailBlocked'?: BlockInfo;
143
- /**
144
- * The date the customer joined the business
145
- * @type {string}
146
- * @memberof CreateCustomerRequest
147
- */
148
- 'joined'?: string | null;
149
- /**
150
- * The customers stripe ID
151
- * @type {string}
152
- * @memberof CreateCustomerRequest
153
- */
154
- 'stripe'?: string | null;
155
- /**
156
- * The customers stripe ID in the dev environment
157
- * @type {string}
158
- * @memberof CreateCustomerRequest
159
- */
160
- 'stripeDev'?: string | null;
161
- }
162
- /**
163
- *
164
- * @export
165
- * @interface CreateCustomerResponse
166
- */
167
- export interface CreateCustomerResponse {
168
- /**
169
- *
170
- * @type {boolean}
171
- * @memberof CreateCustomerResponse
172
- */
173
- 'success': boolean;
174
- /**
175
- *
176
- * @type {Error}
177
- * @memberof CreateCustomerResponse
178
- */
179
- 'error'?: Error;
180
- }
181
- /**
182
- *
183
- * @export
184
- * @interface CreateCustomersRequest
185
- */
186
- export interface CreateCustomersRequest {
187
- /**
188
- *
189
- * @type {Array<CreateCustomersRequestCustomersInner>}
190
- * @memberof CreateCustomersRequest
191
- */
192
- 'customers'?: Array<CreateCustomersRequestCustomersInner>;
193
- }
194
- /**
195
- *
196
- * @export
197
- * @interface CreateCustomersRequestCustomersInner
198
- */
199
- export interface CreateCustomersRequestCustomersInner {
200
- /**
201
- * The customers first name
202
- * @type {string}
203
- * @memberof CreateCustomersRequestCustomersInner
204
- */
205
- 'firstName': string;
206
- /**
207
- * The customers last name
208
- * @type {string}
209
- * @memberof CreateCustomersRequestCustomersInner
210
- */
211
- 'lastName': string;
212
- /**
213
- * The customers full name
214
- * @type {string}
215
- * @memberof CreateCustomersRequestCustomersInner
216
- */
217
- 'name'?: string;
218
- /**
219
- * The customers email address
220
- * @type {string}
221
- * @memberof CreateCustomersRequestCustomersInner
222
- */
223
- 'email'?: string | null;
224
- /**
225
- * The customers phone number
226
- * @type {string}
227
- * @memberof CreateCustomersRequestCustomersInner
228
- */
229
- 'phone'?: string | null;
230
- /**
231
- * The customers profile image
232
- * @type {string}
233
- * @memberof CreateCustomersRequestCustomersInner
234
- */
235
- 'img'?: string | null;
236
- /**
237
- * The customers neighborhood
238
- * @type {string}
239
- * @memberof CreateCustomersRequestCustomersInner
240
- */
241
- 'neighborhood'?: string | null;
242
- /**
243
- * The customers city
244
- * @type {string}
245
- * @memberof CreateCustomersRequestCustomersInner
246
- */
247
- 'city'?: string | null;
248
- /**
249
- * The customers 2-letter country code
250
- * @type {string}
251
- * @memberof CreateCustomersRequestCustomersInner
252
- */
253
- 'country'?: string | null;
254
- /**
255
- * The customers street address
256
- * @type {string}
257
- * @memberof CreateCustomersRequestCustomersInner
258
- */
259
- 'line1'?: string | null;
260
- /**
261
- * The customers street address
262
- * @type {string}
263
- * @memberof CreateCustomersRequestCustomersInner
264
- */
265
- 'line2'?: string | null;
266
- /**
267
- * The customers postal code
268
- * @type {string}
269
- * @memberof CreateCustomersRequestCustomersInner
270
- */
271
- 'postal_code'?: string | null;
272
- /**
273
- * The customers state, county, province, or region
274
- * @type {string}
275
- * @memberof CreateCustomersRequestCustomersInner
276
- */
277
- 'state'?: string | null;
278
- /**
279
- * The customers town (only used in Japan)
280
- * @type {string}
281
- * @memberof CreateCustomersRequestCustomersInner
282
- */
283
- 'town'?: string | null;
284
- /**
285
- *
286
- * @type {BlockInfo}
287
- * @memberof CreateCustomersRequestCustomersInner
288
- */
289
- 'blocked'?: BlockInfo;
290
- /**
291
- *
292
- * @type {BlockInfo}
293
- * @memberof CreateCustomersRequestCustomersInner
294
- */
295
- 'phoneBlocked'?: BlockInfo;
296
- /**
297
- *
298
- * @type {BlockInfo}
299
- * @memberof CreateCustomersRequestCustomersInner
300
- */
301
- 'emailBlocked'?: BlockInfo;
302
- /**
303
- * The date the customer joined the business
304
- * @type {string}
305
- * @memberof CreateCustomersRequestCustomersInner
306
- */
307
- 'joined'?: string | null;
308
- /**
309
- * The customers stripe ID
310
- * @type {string}
311
- * @memberof CreateCustomersRequestCustomersInner
312
- */
313
- 'stripe'?: string | null;
314
- /**
315
- * The customers stripe ID in the dev environment
316
- * @type {string}
317
- * @memberof CreateCustomersRequestCustomersInner
318
- */
319
- 'stripeDev'?: string | null;
320
- }
321
- /**
322
- *
323
- * @export
324
- * @interface CreateCustomersResponse
325
- */
326
- export interface CreateCustomersResponse {
327
- /**
328
- *
329
- * @type {boolean}
330
- * @memberof CreateCustomersResponse
331
- */
332
- 'success': boolean;
333
- /**
334
- *
335
- * @type {Error}
336
- * @memberof CreateCustomersResponse
337
- */
338
- 'error'?: Error;
339
- }
340
- /**
341
- *
342
- * @export
343
- * @interface Customer
344
- */
345
- export interface Customer {
346
- /**
347
- * The customers first name
348
- * @type {string}
349
- * @memberof Customer
350
- */
351
- 'firstName'?: string;
352
- /**
353
- * The customers last name
354
- * @type {string}
355
- * @memberof Customer
356
- */
357
- 'lastName'?: string;
358
- /**
359
- * The customers full name
360
- * @type {string}
361
- * @memberof Customer
362
- */
363
- 'name'?: string;
364
- /**
365
- * The customers email address
366
- * @type {string}
367
- * @memberof Customer
368
- */
369
- 'email'?: string | null;
370
- /**
371
- * The customers phone number
372
- * @type {string}
373
- * @memberof Customer
374
- */
375
- 'phone'?: string | null;
376
- /**
377
- * The customers profile image
378
- * @type {string}
379
- * @memberof Customer
380
- */
381
- 'img'?: string | null;
382
- /**
383
- * The customers neighborhood
384
- * @type {string}
385
- * @memberof Customer
386
- */
387
- 'neighborhood'?: string | null;
388
- /**
389
- * The customers city
390
- * @type {string}
391
- * @memberof Customer
392
- */
393
- 'city'?: string | null;
394
- /**
395
- * The customers 2-letter country code
396
- * @type {string}
397
- * @memberof Customer
398
- */
399
- 'country'?: string | null;
400
- /**
401
- * The customers street address
402
- * @type {string}
403
- * @memberof Customer
404
- */
405
- 'line1'?: string | null;
406
- /**
407
- * The customers street address
408
- * @type {string}
409
- * @memberof Customer
410
- */
411
- 'line2'?: string | null;
412
- /**
413
- * The customers postal code
414
- * @type {string}
415
- * @memberof Customer
416
- */
417
- 'postal_code'?: string | null;
418
- /**
419
- * The customers state, county, province, or region
420
- * @type {string}
421
- * @memberof Customer
422
- */
423
- 'state'?: string | null;
424
- /**
425
- * The customers town (only used in Japan)
426
- * @type {string}
427
- * @memberof Customer
428
- */
429
- 'town'?: string | null;
430
- /**
431
- *
432
- * @type {BlockInfo}
433
- * @memberof Customer
434
- */
435
- 'blocked'?: BlockInfo;
436
- /**
437
- *
438
- * @type {BlockInfo}
439
- * @memberof Customer
440
- */
441
- 'phoneBlocked'?: BlockInfo;
442
- /**
443
- *
444
- * @type {BlockInfo}
445
- * @memberof Customer
446
- */
447
- 'emailBlocked'?: BlockInfo;
448
- /**
449
- * The date the customer joined the business
450
- * @type {string}
451
- * @memberof Customer
452
- */
453
- 'joined'?: string | null;
454
- /**
455
- * The customers stripe ID
456
- * @type {string}
457
- * @memberof Customer
458
- */
459
- 'stripe'?: string | null;
460
- /**
461
- * The customers stripe ID in the dev environment
462
- * @type {string}
463
- * @memberof Customer
464
- */
465
- 'stripeDev'?: string | null;
466
- }
467
- /**
468
- *
469
- * @export
470
- * @interface DeleteCustomerResponse
471
- */
472
- export interface DeleteCustomerResponse {
473
- /**
474
- *
475
- * @type {boolean}
476
- * @memberof DeleteCustomerResponse
477
- */
478
- 'success': boolean;
479
- /**
480
- *
481
- * @type {Error}
482
- * @memberof DeleteCustomerResponse
483
- */
484
- 'error'?: Error;
485
- }
486
- /**
487
- *
488
- * @export
489
- * @interface DeleteCustomersResponse
490
- */
491
- export interface DeleteCustomersResponse {
492
- /**
493
- *
494
- * @type {boolean}
495
- * @memberof DeleteCustomersResponse
496
- */
497
- 'success': boolean;
498
- /**
499
- *
500
- * @type {Error}
501
- * @memberof DeleteCustomersResponse
502
- */
503
- 'error'?: Error;
504
- }
505
- /**
506
- *
507
- * @export
508
- * @interface ErrorResponse
509
- */
510
- export interface ErrorResponse {
511
- /**
512
- *
513
- * @type {Error}
514
- * @memberof ErrorResponse
515
- */
516
- 'error': Error;
517
- }
518
- /**
519
- *
520
- * @export
521
- * @interface GetCustomerResponse
522
- */
523
- export interface GetCustomerResponse {
524
- /**
525
- * The customers first name
526
- * @type {string}
527
- * @memberof GetCustomerResponse
528
- */
529
- 'firstName': string;
530
- /**
531
- * The customers last name
532
- * @type {string}
533
- * @memberof GetCustomerResponse
534
- */
535
- 'lastName': string;
536
- /**
537
- * The customers full name
538
- * @type {string}
539
- * @memberof GetCustomerResponse
540
- */
541
- 'name'?: string;
542
- /**
543
- * The customers email address
544
- * @type {string}
545
- * @memberof GetCustomerResponse
546
- */
547
- 'email'?: string | null;
548
- /**
549
- * The customers phone number
550
- * @type {string}
551
- * @memberof GetCustomerResponse
552
- */
553
- 'phone'?: string | null;
554
- /**
555
- * The customers profile image
556
- * @type {string}
557
- * @memberof GetCustomerResponse
558
- */
559
- 'img'?: string | null;
560
- /**
561
- * The customers neighborhood
562
- * @type {string}
563
- * @memberof GetCustomerResponse
564
- */
565
- 'neighborhood'?: string | null;
566
- /**
567
- * The customers city
568
- * @type {string}
569
- * @memberof GetCustomerResponse
570
- */
571
- 'city'?: string | null;
572
- /**
573
- * The customers 2-letter country code
574
- * @type {string}
575
- * @memberof GetCustomerResponse
576
- */
577
- 'country'?: string | null;
578
- /**
579
- * The customers street address
580
- * @type {string}
581
- * @memberof GetCustomerResponse
582
- */
583
- 'line1'?: string | null;
584
- /**
585
- * The customers street address
586
- * @type {string}
587
- * @memberof GetCustomerResponse
588
- */
589
- 'line2'?: string | null;
590
- /**
591
- * The customers postal code
592
- * @type {string}
593
- * @memberof GetCustomerResponse
594
- */
595
- 'postal_code'?: string | null;
596
- /**
597
- * The customers state, county, province, or region
598
- * @type {string}
599
- * @memberof GetCustomerResponse
600
- */
601
- 'state'?: string | null;
602
- /**
603
- * The customers town (only used in Japan)
604
- * @type {string}
605
- * @memberof GetCustomerResponse
606
- */
607
- 'town'?: string | null;
608
- /**
609
- *
610
- * @type {BlockInfo}
611
- * @memberof GetCustomerResponse
612
- */
613
- 'blocked'?: BlockInfo;
614
- /**
615
- *
616
- * @type {BlockInfo}
617
- * @memberof GetCustomerResponse
618
- */
619
- 'phoneBlocked'?: BlockInfo;
620
- /**
621
- *
622
- * @type {BlockInfo}
623
- * @memberof GetCustomerResponse
624
- */
625
- 'emailBlocked'?: BlockInfo;
626
- /**
627
- * The date the customer joined the business
628
- * @type {string}
629
- * @memberof GetCustomerResponse
630
- */
631
- 'joined'?: string | null;
632
- /**
633
- * The customers stripe ID
634
- * @type {string}
635
- * @memberof GetCustomerResponse
636
- */
637
- 'stripe'?: string | null;
638
- /**
639
- * The customers stripe ID in the dev environment
640
- * @type {string}
641
- * @memberof GetCustomerResponse
642
- */
643
- 'stripeDev'?: string | null;
644
- }
645
- /**
646
- *
647
- * @export
648
- * @interface ModelError
649
- */
650
- export interface ModelError {
651
- /**
652
- *
653
- * @type {string}
654
- * @memberof ModelError
655
- */
656
- 'type': string;
657
- /**
658
- *
659
- * @type {string}
660
- * @memberof ModelError
661
- */
662
- 'message': string;
663
- /**
664
- *
665
- * @type {string}
666
- * @memberof ModelError
667
- */
668
- 'param': string | null;
669
- /**
670
- *
671
- * @type {string}
672
- * @memberof ModelError
673
- */
674
- 'code': string | null;
675
- }
676
- /**
677
- *
678
- * @export
679
- * @interface OperationResponse
680
- */
681
- export interface OperationResponse {
682
- /**
683
- *
684
- * @type {boolean}
685
- * @memberof OperationResponse
686
- */
687
- 'success': boolean;
688
- /**
689
- *
690
- * @type {Error}
691
- * @memberof OperationResponse
692
- */
693
- 'error'?: Error;
694
- }
695
- /**
696
- *
697
- * @export
698
- * @interface UpdateCustomerRequest
699
- */
700
- export interface UpdateCustomerRequest {
701
- /**
702
- * The customers first name
703
- * @type {string}
704
- * @memberof UpdateCustomerRequest
705
- */
706
- 'firstName'?: string;
707
- /**
708
- * The customers last name
709
- * @type {string}
710
- * @memberof UpdateCustomerRequest
711
- */
712
- 'lastName'?: string;
713
- /**
714
- * The customers full name
715
- * @type {string}
716
- * @memberof UpdateCustomerRequest
717
- */
718
- 'name'?: string;
719
- /**
720
- * The customers email address
721
- * @type {string}
722
- * @memberof UpdateCustomerRequest
723
- */
724
- 'email'?: string | null;
725
- /**
726
- * The customers phone number
727
- * @type {string}
728
- * @memberof UpdateCustomerRequest
729
- */
730
- 'phone'?: string | null;
731
- /**
732
- * The customers profile image
733
- * @type {string}
734
- * @memberof UpdateCustomerRequest
735
- */
736
- 'img'?: string | null;
737
- /**
738
- * The customers neighborhood
739
- * @type {string}
740
- * @memberof UpdateCustomerRequest
741
- */
742
- 'neighborhood'?: string | null;
743
- /**
744
- * The customers city
745
- * @type {string}
746
- * @memberof UpdateCustomerRequest
747
- */
748
- 'city'?: string | null;
749
- /**
750
- * The customers 2-letter country code
751
- * @type {string}
752
- * @memberof UpdateCustomerRequest
753
- */
754
- 'country'?: string | null;
755
- /**
756
- * The customers street address
757
- * @type {string}
758
- * @memberof UpdateCustomerRequest
759
- */
760
- 'line1'?: string | null;
761
- /**
762
- * The customers street address
763
- * @type {string}
764
- * @memberof UpdateCustomerRequest
765
- */
766
- 'line2'?: string | null;
767
- /**
768
- * The customers postal code
769
- * @type {string}
770
- * @memberof UpdateCustomerRequest
771
- */
772
- 'postal_code'?: string | null;
773
- /**
774
- * The customers state, county, province, or region
775
- * @type {string}
776
- * @memberof UpdateCustomerRequest
777
- */
778
- 'state'?: string | null;
779
- /**
780
- * The customers town (only used in Japan)
781
- * @type {string}
782
- * @memberof UpdateCustomerRequest
783
- */
784
- 'town'?: string | null;
785
- /**
786
- *
787
- * @type {BlockInfo}
788
- * @memberof UpdateCustomerRequest
789
- */
790
- 'blocked'?: BlockInfo;
791
- /**
792
- *
793
- * @type {BlockInfo}
794
- * @memberof UpdateCustomerRequest
795
- */
796
- 'phoneBlocked'?: BlockInfo;
797
- /**
798
- *
799
- * @type {BlockInfo}
800
- * @memberof UpdateCustomerRequest
801
- */
802
- 'emailBlocked'?: BlockInfo;
803
- /**
804
- * The date the customer joined the business
805
- * @type {string}
806
- * @memberof UpdateCustomerRequest
807
- */
808
- 'joined'?: string | null;
809
- /**
810
- * The customers stripe ID
811
- * @type {string}
812
- * @memberof UpdateCustomerRequest
813
- */
814
- 'stripe'?: string | null;
815
- /**
816
- * The customers stripe ID in the dev environment
817
- * @type {string}
818
- * @memberof UpdateCustomerRequest
819
- */
820
- 'stripeDev'?: string | null;
821
- }
822
- /**
823
- *
824
- * @export
825
- * @interface UpdateCustomerResponse
826
- */
827
- export interface UpdateCustomerResponse {
828
- /**
829
- *
830
- * @type {boolean}
831
- * @memberof UpdateCustomerResponse
832
- */
833
- 'success': boolean;
834
- /**
835
- *
836
- * @type {Error}
837
- * @memberof UpdateCustomerResponse
838
- */
839
- 'error'?: Error;
840
- }
841
- /**
842
- *
843
- * @export
844
- * @interface UpdateCustomersRequest
845
- */
846
- export interface UpdateCustomersRequest {
847
- /**
848
- *
849
- * @type {Array<Customer>}
850
- * @memberof UpdateCustomersRequest
851
- */
852
- 'customers'?: Array<Customer>;
853
- }
854
- /**
855
- *
856
- * @export
857
- * @interface UpdateCustomersResponse
858
- */
859
- export interface UpdateCustomersResponse {
860
- /**
861
- *
862
- * @type {boolean}
863
- * @memberof UpdateCustomersResponse
864
- */
865
- 'success': boolean;
866
- /**
867
- *
868
- * @type {Error}
869
- * @memberof UpdateCustomersResponse
870
- */
871
- 'error'?: Error;
872
- }
873
- /**
874
- * Scout9Api - axios parameter creator
875
- * @export
876
- */
877
- export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration) => {
878
- /**
879
- *
880
- * @summary Creates a new customer
881
- * @param {CreateCustomerRequest} createCustomerRequest
882
- * @param {*} [options] Override http request option.
883
- * @throws {RequiredError}
884
- */
885
- createCustomer: (createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
886
- /**
887
- *
888
- * @summary Creates new customers
889
- * @param {CreateCustomersRequest} createCustomersRequest
890
- * @param {*} [options] Override http request option.
891
- * @throws {RequiredError}
892
- */
893
- createCustomers: (createCustomersRequest: CreateCustomersRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
894
- /**
895
- *
896
- * @summary Deletes a customer
897
- * @param {string} id Customer ID to delete customer
898
- * @param {*} [options] Override http request option.
899
- * @throws {RequiredError}
900
- */
901
- deleteCustomer: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
902
- /**
903
- *
904
- * @summary Deletes multiple customers
905
- * @param {string} id Customer IDs to delete multiple customer
906
- * @param {*} [options] Override http request option.
907
- * @throws {RequiredError}
908
- */
909
- deleteCustomers: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
910
- /**
911
- *
912
- * @summary Gets a customer
913
- * @param {string} id Customer ID to get customer
914
- * @param {*} [options] Override http request option.
915
- * @throws {RequiredError}
916
- */
917
- getCustomer: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
918
- /**
919
- *
920
- * @summary Gets all or specific set of customers
921
- * @param {string} [id] Optional get specific customers
922
- * @param {*} [options] Override http request option.
923
- * @throws {RequiredError}
924
- */
925
- getCustomers: (id?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
926
- /**
927
- *
928
- * @summary Updates a customer
929
- * @param {UpdateCustomerRequest} updateCustomerRequest
930
- * @param {*} [options] Override http request option.
931
- * @throws {RequiredError}
932
- */
933
- updateCustomer: (updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
934
- /**
935
- *
936
- * @summary Updates multiple customers
937
- * @param {UpdateCustomerRequest} updateCustomerRequest
938
- * @param {*} [options] Override http request option.
939
- * @throws {RequiredError}
940
- */
941
- updateCustomers: (updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
942
- };
943
- /**
944
- * Scout9Api - functional programming interface
945
- * @export
946
- */
947
- export declare const Scout9ApiFp: (configuration?: Configuration) => {
948
- /**
949
- *
950
- * @summary Creates a new customer
951
- * @param {CreateCustomerRequest} createCustomerRequest
952
- * @param {*} [options] Override http request option.
953
- * @throws {RequiredError}
954
- */
955
- createCustomer(createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerResponse>>;
956
- /**
957
- *
958
- * @summary Creates new customers
959
- * @param {CreateCustomersRequest} createCustomersRequest
960
- * @param {*} [options] Override http request option.
961
- * @throws {RequiredError}
962
- */
963
- createCustomers(createCustomersRequest: CreateCustomersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomersResponse>>;
964
- /**
965
- *
966
- * @summary Deletes a customer
967
- * @param {string} id Customer ID to delete customer
968
- * @param {*} [options] Override http request option.
969
- * @throws {RequiredError}
970
- */
971
- deleteCustomer(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerResponse>>;
972
- /**
973
- *
974
- * @summary Deletes multiple customers
975
- * @param {string} id Customer IDs to delete multiple customer
976
- * @param {*} [options] Override http request option.
977
- * @throws {RequiredError}
978
- */
979
- deleteCustomers(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomersResponse>>;
980
- /**
981
- *
982
- * @summary Gets a customer
983
- * @param {string} id Customer ID to get customer
984
- * @param {*} [options] Override http request option.
985
- * @throws {RequiredError}
986
- */
987
- getCustomer(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerRequest>>;
988
- /**
989
- *
990
- * @summary Gets all or specific set of customers
991
- * @param {string} [id] Optional get specific customers
992
- * @param {*} [options] Override http request option.
993
- * @throws {RequiredError}
994
- */
995
- getCustomers(id?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Customer>>>;
996
- /**
997
- *
998
- * @summary Updates a customer
999
- * @param {UpdateCustomerRequest} updateCustomerRequest
1000
- * @param {*} [options] Override http request option.
1001
- * @throws {RequiredError}
1002
- */
1003
- updateCustomer(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerResponse>>;
1004
- /**
1005
- *
1006
- * @summary Updates multiple customers
1007
- * @param {UpdateCustomerRequest} updateCustomerRequest
1008
- * @param {*} [options] Override http request option.
1009
- * @throws {RequiredError}
1010
- */
1011
- updateCustomers(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomersResponse>>;
1012
- };
1013
- /**
1014
- * Scout9Api - factory interface
1015
- * @export
1016
- */
1017
- export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1018
- /**
1019
- *
1020
- * @summary Creates a new customer
1021
- * @param {CreateCustomerRequest} createCustomerRequest
1022
- * @param {*} [options] Override http request option.
1023
- * @throws {RequiredError}
1024
- */
1025
- createCustomer(createCustomerRequest: CreateCustomerRequest, options?: any): AxiosPromise<CreateCustomerResponse>;
1026
- /**
1027
- *
1028
- * @summary Creates new customers
1029
- * @param {CreateCustomersRequest} createCustomersRequest
1030
- * @param {*} [options] Override http request option.
1031
- * @throws {RequiredError}
1032
- */
1033
- createCustomers(createCustomersRequest: CreateCustomersRequest, options?: any): AxiosPromise<CreateCustomersResponse>;
1034
- /**
1035
- *
1036
- * @summary Deletes a customer
1037
- * @param {string} id Customer ID to delete customer
1038
- * @param {*} [options] Override http request option.
1039
- * @throws {RequiredError}
1040
- */
1041
- deleteCustomer(id: string, options?: any): AxiosPromise<DeleteCustomerResponse>;
1042
- /**
1043
- *
1044
- * @summary Deletes multiple customers
1045
- * @param {string} id Customer IDs to delete multiple customer
1046
- * @param {*} [options] Override http request option.
1047
- * @throws {RequiredError}
1048
- */
1049
- deleteCustomers(id: string, options?: any): AxiosPromise<DeleteCustomersResponse>;
1050
- /**
1051
- *
1052
- * @summary Gets a customer
1053
- * @param {string} id Customer ID to get customer
1054
- * @param {*} [options] Override http request option.
1055
- * @throws {RequiredError}
1056
- */
1057
- getCustomer(id: string, options?: any): AxiosPromise<CreateCustomerRequest>;
1058
- /**
1059
- *
1060
- * @summary Gets all or specific set of customers
1061
- * @param {string} [id] Optional get specific customers
1062
- * @param {*} [options] Override http request option.
1063
- * @throws {RequiredError}
1064
- */
1065
- getCustomers(id?: string, options?: any): AxiosPromise<Array<Customer>>;
1066
- /**
1067
- *
1068
- * @summary Updates a customer
1069
- * @param {UpdateCustomerRequest} updateCustomerRequest
1070
- * @param {*} [options] Override http request option.
1071
- * @throws {RequiredError}
1072
- */
1073
- updateCustomer(updateCustomerRequest: UpdateCustomerRequest, options?: any): AxiosPromise<UpdateCustomerResponse>;
1074
- /**
1075
- *
1076
- * @summary Updates multiple customers
1077
- * @param {UpdateCustomerRequest} updateCustomerRequest
1078
- * @param {*} [options] Override http request option.
1079
- * @throws {RequiredError}
1080
- */
1081
- updateCustomers(updateCustomerRequest: UpdateCustomerRequest, options?: any): AxiosPromise<UpdateCustomersResponse>;
1082
- };
1083
- /**
1084
- * Scout9Api - object-oriented interface
1085
- * @export
1086
- * @class Scout9Api
1087
- * @extends {BaseAPI}
1088
- */
1089
- export declare class Scout9Api extends BaseAPI {
1090
- /**
1091
- *
1092
- * @summary Creates a new customer
1093
- * @param {CreateCustomerRequest} createCustomerRequest
1094
- * @param {*} [options] Override http request option.
1095
- * @throws {RequiredError}
1096
- * @memberof Scout9Api
1097
- */
1098
- createCustomer(createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerResponse, any>>;
1099
- /**
1100
- *
1101
- * @summary Creates new customers
1102
- * @param {CreateCustomersRequest} createCustomersRequest
1103
- * @param {*} [options] Override http request option.
1104
- * @throws {RequiredError}
1105
- * @memberof Scout9Api
1106
- */
1107
- createCustomers(createCustomersRequest: CreateCustomersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomersResponse, any>>;
1108
- /**
1109
- *
1110
- * @summary Deletes a customer
1111
- * @param {string} id Customer ID to delete customer
1112
- * @param {*} [options] Override http request option.
1113
- * @throws {RequiredError}
1114
- * @memberof Scout9Api
1115
- */
1116
- deleteCustomer(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerResponse, any>>;
1117
- /**
1118
- *
1119
- * @summary Deletes multiple customers
1120
- * @param {string} id Customer IDs to delete multiple customer
1121
- * @param {*} [options] Override http request option.
1122
- * @throws {RequiredError}
1123
- * @memberof Scout9Api
1124
- */
1125
- deleteCustomers(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomersResponse, any>>;
1126
- /**
1127
- *
1128
- * @summary Gets a customer
1129
- * @param {string} id Customer ID to get customer
1130
- * @param {*} [options] Override http request option.
1131
- * @throws {RequiredError}
1132
- * @memberof Scout9Api
1133
- */
1134
- getCustomer(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerRequest, any>>;
1135
- /**
1136
- *
1137
- * @summary Gets all or specific set of customers
1138
- * @param {string} [id] Optional get specific customers
1139
- * @param {*} [options] Override http request option.
1140
- * @throws {RequiredError}
1141
- * @memberof Scout9Api
1142
- */
1143
- getCustomers(id?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer[], any>>;
1144
- /**
1145
- *
1146
- * @summary Updates a customer
1147
- * @param {UpdateCustomerRequest} updateCustomerRequest
1148
- * @param {*} [options] Override http request option.
1149
- * @throws {RequiredError}
1150
- * @memberof Scout9Api
1151
- */
1152
- updateCustomer(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerResponse, any>>;
1153
- /**
1154
- *
1155
- * @summary Updates multiple customers
1156
- * @param {UpdateCustomerRequest} updateCustomerRequest
1157
- * @param {*} [options] Override http request option.
1158
- * @throws {RequiredError}
1159
- * @memberof Scout9Api
1160
- */
1161
- updateCustomers(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomersResponse, any>>;
1162
- }