@vibexp/api-client 0.90.0 → 0.92.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/axios/index.d.ts +2 -2
- package/dist/axios/index.js +1 -1
- package/dist/axios/sdk.gen.d.ts +59 -1
- package/dist/axios/sdk.gen.js +130 -0
- package/dist/axios/types.gen.d.ts +399 -9
- package/dist/schema.d.ts +604 -11
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -3525,6 +3525,97 @@ export interface paths {
|
|
|
3525
3525
|
patch?: never;
|
|
3526
3526
|
trace?: never;
|
|
3527
3527
|
};
|
|
3528
|
+
"/api/v1/admin/settings/email": {
|
|
3529
|
+
parameters: {
|
|
3530
|
+
query?: never;
|
|
3531
|
+
header?: never;
|
|
3532
|
+
path?: never;
|
|
3533
|
+
cookie?: never;
|
|
3534
|
+
};
|
|
3535
|
+
/**
|
|
3536
|
+
* Get the instance email provider settings
|
|
3537
|
+
* @description Returns the instance's stored email provider configuration, its delivery
|
|
3538
|
+
* health and whether a credential is stored. Always 200: an instance with
|
|
3539
|
+
* nothing stored reports `configured: false`. The credential is never
|
|
3540
|
+
* returned.
|
|
3541
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404.
|
|
3542
|
+
*/
|
|
3543
|
+
get: operations["getAdminInstanceEmailSettings"];
|
|
3544
|
+
/**
|
|
3545
|
+
* Create or replace the instance email provider settings
|
|
3546
|
+
* @description Validates, encrypts and stores the instance's email provider, taking
|
|
3547
|
+
* effect on the next send with no restart, and appends one redacted entry
|
|
3548
|
+
* to the audit log. Idempotent: the same body creates or replaces. Omitting
|
|
3549
|
+
* `secret` keeps the stored credential when the provider type is
|
|
3550
|
+
* unchanged; an empty `secret` is rejected. A body carrying an unknown
|
|
3551
|
+
* field is rejected with 400.
|
|
3552
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404.
|
|
3553
|
+
*/
|
|
3554
|
+
put: operations["upsertAdminInstanceEmailSettings"];
|
|
3555
|
+
post?: never;
|
|
3556
|
+
/**
|
|
3557
|
+
* Remove the instance email provider settings
|
|
3558
|
+
* @description Removes the stored instance email provider and appends one redacted
|
|
3559
|
+
* entry to the audit log. Instance mail is then discarded until a provider
|
|
3560
|
+
* is configured again. Returns 409 when nothing is stored.
|
|
3561
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404.
|
|
3562
|
+
*/
|
|
3563
|
+
delete: operations["deleteAdminInstanceEmailSettings"];
|
|
3564
|
+
options?: never;
|
|
3565
|
+
head?: never;
|
|
3566
|
+
patch?: never;
|
|
3567
|
+
trace?: never;
|
|
3568
|
+
};
|
|
3569
|
+
"/api/v1/admin/settings/email/test": {
|
|
3570
|
+
parameters: {
|
|
3571
|
+
query?: never;
|
|
3572
|
+
header?: never;
|
|
3573
|
+
path?: never;
|
|
3574
|
+
cookie?: never;
|
|
3575
|
+
};
|
|
3576
|
+
get?: never;
|
|
3577
|
+
put?: never;
|
|
3578
|
+
/**
|
|
3579
|
+
* Send a test message through the instance email provider
|
|
3580
|
+
* @description Sends a fixed test message to the calling admin's own account email,
|
|
3581
|
+
* through the stored configuration (empty body) or through a candidate
|
|
3582
|
+
* configuration (see `AdminInstanceEmailTestRequest`). Nothing is stored
|
|
3583
|
+
* and nothing is audited. A failed send is still a 200, reported with
|
|
3584
|
+
* `is_valid: false`. A body carrying an unknown field (including a
|
|
3585
|
+
* `recipient`) is rejected with 400.
|
|
3586
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404.
|
|
3587
|
+
*/
|
|
3588
|
+
post: operations["testAdminInstanceEmailSettings"];
|
|
3589
|
+
delete?: never;
|
|
3590
|
+
options?: never;
|
|
3591
|
+
head?: never;
|
|
3592
|
+
patch?: never;
|
|
3593
|
+
trace?: never;
|
|
3594
|
+
};
|
|
3595
|
+
"/api/v1/admin/settings/email/audit": {
|
|
3596
|
+
parameters: {
|
|
3597
|
+
query?: never;
|
|
3598
|
+
header?: never;
|
|
3599
|
+
path?: never;
|
|
3600
|
+
cookie?: never;
|
|
3601
|
+
};
|
|
3602
|
+
/**
|
|
3603
|
+
* List the instance email provider settings audit log
|
|
3604
|
+
* @description Returns one page of the instance email provider's audit log, newest
|
|
3605
|
+
* first. Every entry's `before`/`after` snapshot is redacted: it never
|
|
3606
|
+
* contains a credential. Pass the previous page's `next_cursor` to
|
|
3607
|
+
* continue.
|
|
3608
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404.
|
|
3609
|
+
*/
|
|
3610
|
+
get: operations["listAdminInstanceEmailSettingsAudit"];
|
|
3611
|
+
put?: never;
|
|
3612
|
+
post?: never;
|
|
3613
|
+
delete?: never;
|
|
3614
|
+
options?: never;
|
|
3615
|
+
head?: never;
|
|
3616
|
+
patch?: never;
|
|
3617
|
+
trace?: never;
|
|
3618
|
+
};
|
|
3528
3619
|
"/api/v1/{team_id}/comments": {
|
|
3529
3620
|
parameters: {
|
|
3530
3621
|
query?: never;
|
|
@@ -10784,26 +10875,28 @@ export interface components {
|
|
|
10784
10875
|
*/
|
|
10785
10876
|
rank_half_life_days: number;
|
|
10786
10877
|
};
|
|
10787
|
-
/** @description The AI summary settings in effect for a team, with enough context for a client to render the whole settings surface from this one response: the effective values, where they came from, the instance defaults to preview a reset against,
|
|
10878
|
+
/** @description The AI summary settings in effect for a team, with enough context for a client to render the whole settings surface from this one response: the effective values, where they came from, the instance defaults to preview a reset against, and whether the team can currently use AI summaries at all. `max_top_n` and `max_output_tokens_ceiling` are deprecated and report the hard code limits. */
|
|
10788
10879
|
TeamAISummarySettings: {
|
|
10789
10880
|
/**
|
|
10790
|
-
* @description Where the effective values come from. `instance` means the team has no override and inherits the
|
|
10881
|
+
* @description Where the effective values come from. `instance` means the team has no override and inherits the instance defaults; `team` means the team has stored its own profile.
|
|
10791
10882
|
* @example instance
|
|
10792
10883
|
* @enum {string}
|
|
10793
10884
|
*/
|
|
10794
10885
|
source: "instance" | "team";
|
|
10795
10886
|
/** @description Effective values — the team's when source is `team`, otherwise the instance default. */
|
|
10796
10887
|
values: components["schemas"]["TeamAISummarySettingsValues"];
|
|
10797
|
-
/** @description The
|
|
10888
|
+
/** @description The defaults from the instance settings (Admin → Settings → AI Summary), or the built-in defaults when none are stored, so a client can preview what "reset to defaults" would produce without a second request. Equal to `values` when source is `instance`. */
|
|
10798
10889
|
instance_defaults: components["schemas"]["TeamAISummarySettingsValues"];
|
|
10799
10890
|
/**
|
|
10800
|
-
* @
|
|
10891
|
+
* @deprecated
|
|
10892
|
+
* @description The hard code limit on `top_n` (always 10); kept for client compatibility, to be removed in a later minor. No instance setting narrows it any more.
|
|
10801
10893
|
* @example 10
|
|
10802
10894
|
*/
|
|
10803
10895
|
max_top_n: number;
|
|
10804
10896
|
/**
|
|
10805
|
-
* @
|
|
10806
|
-
* @
|
|
10897
|
+
* @deprecated
|
|
10898
|
+
* @description The hard code limit on `max_output_tokens` (always 32768); kept for client compatibility, to be removed in a later minor. No instance setting narrows it any more.
|
|
10899
|
+
* @example 32768
|
|
10807
10900
|
*/
|
|
10808
10901
|
max_output_tokens_ceiling: number;
|
|
10809
10902
|
/**
|
|
@@ -10826,7 +10919,7 @@ export interface components {
|
|
|
10826
10919
|
*/
|
|
10827
10920
|
model_provider_id: string | null;
|
|
10828
10921
|
/**
|
|
10829
|
-
* @description How many top-ranked documents are fed to the summarizer.
|
|
10922
|
+
* @description How many top-ranked documents are fed to the summarizer. At most 10 (the hard limit).
|
|
10830
10923
|
* @example 5
|
|
10831
10924
|
*/
|
|
10832
10925
|
top_n: number;
|
|
@@ -10837,12 +10930,12 @@ export interface components {
|
|
|
10837
10930
|
*/
|
|
10838
10931
|
style: "concise" | "balanced" | "detailed";
|
|
10839
10932
|
/**
|
|
10840
|
-
* @description Upper bound on tokens the summarizer may generate
|
|
10933
|
+
* @description Upper bound on tokens the summarizer may generate. At most 32768 (the hard limit).
|
|
10841
10934
|
* @example 800
|
|
10842
10935
|
*/
|
|
10843
10936
|
max_output_tokens: number;
|
|
10844
10937
|
};
|
|
10845
|
-
/** @description A complete replacement AI summary profile for the team. There is no partial update: every field is required, and the whole profile is stored or replaced atomically. `max_top_n`, `max_output_tokens_ceiling` and `available` are deliberately absent — all are computed, not settable. */
|
|
10938
|
+
/** @description A complete replacement AI summary profile for the team. There is no partial update: every field is required, and the whole profile is stored or replaced atomically. `top_n` is at most 10 and `max_output_tokens` at most 32768 (the hard limits; a larger value is rejected with 400). `max_top_n`, `max_output_tokens_ceiling` and `available` are deliberately absent — all are computed, not settable. */
|
|
10846
10939
|
UpdateTeamAISummarySettingsRequest: {
|
|
10847
10940
|
/** @example true */
|
|
10848
10941
|
enabled: boolean;
|
|
@@ -12023,9 +12116,15 @@ export interface components {
|
|
|
12023
12116
|
* providers.
|
|
12024
12117
|
*/
|
|
12025
12118
|
model_provider_name: string | null;
|
|
12026
|
-
/**
|
|
12119
|
+
/**
|
|
12120
|
+
* @deprecated
|
|
12121
|
+
* @description The hard code limit on `top_n` (always 10); kept for client compatibility, to be removed in a later minor.
|
|
12122
|
+
*/
|
|
12027
12123
|
max_top_n: number;
|
|
12028
|
-
/**
|
|
12124
|
+
/**
|
|
12125
|
+
* @deprecated
|
|
12126
|
+
* @description The hard code limit on `max_output_tokens` (always 32768); kept for client compatibility, to be removed in a later minor.
|
|
12127
|
+
*/
|
|
12029
12128
|
max_output_tokens_ceiling: number;
|
|
12030
12129
|
/** @description Whether the team has at least one model provider (existence, not health). */
|
|
12031
12130
|
available: boolean;
|
|
@@ -12486,6 +12585,256 @@ export interface components {
|
|
|
12486
12585
|
*/
|
|
12487
12586
|
version: number;
|
|
12488
12587
|
};
|
|
12588
|
+
/**
|
|
12589
|
+
* @description Which provider the instance sends through. Matched case-insensitively.
|
|
12590
|
+
* @example smtp
|
|
12591
|
+
* @enum {string}
|
|
12592
|
+
*/
|
|
12593
|
+
AdminInstanceEmailProviderType: "smtp" | "mailgun" | "postmark" | "sendgrid";
|
|
12594
|
+
/**
|
|
12595
|
+
* @description The instance's email provider configuration. This is an upsert, so the same
|
|
12596
|
+
* body creates or replaces. The per-type `settings` and the write-only
|
|
12597
|
+
* `secret` follow the team email provider request exactly. A body carrying an
|
|
12598
|
+
* unknown field is rejected with 400.
|
|
12599
|
+
*/
|
|
12600
|
+
AdminInstanceEmailSettingsRequest: {
|
|
12601
|
+
provider_type: components["schemas"]["AdminInstanceEmailProviderType"];
|
|
12602
|
+
settings?: components["schemas"]["TeamEmailProviderSettings"];
|
|
12603
|
+
/**
|
|
12604
|
+
* @description The provider's single credential (SMTP password, Mailgun sending key,
|
|
12605
|
+
* Postmark server token, or SendGrid API key). It is write-only: never
|
|
12606
|
+
* returned by any endpoint.
|
|
12607
|
+
*
|
|
12608
|
+
* OMIT it to keep the stored credential, which is allowed only when the
|
|
12609
|
+
* provider type is unchanged; a new configuration or a change of provider
|
|
12610
|
+
* type must carry its own. An explicitly empty string is rejected.
|
|
12611
|
+
* @example key-abc123
|
|
12612
|
+
*/
|
|
12613
|
+
secret?: string;
|
|
12614
|
+
/**
|
|
12615
|
+
* Format: email
|
|
12616
|
+
* @description The address instance mail is sent from.
|
|
12617
|
+
* @example noreply@vibexp.example.com
|
|
12618
|
+
*/
|
|
12619
|
+
from_address: string;
|
|
12620
|
+
/**
|
|
12621
|
+
* @description Optional display name shown beside the from address.
|
|
12622
|
+
* @example VibeXP
|
|
12623
|
+
*/
|
|
12624
|
+
from_name?: string | null;
|
|
12625
|
+
/**
|
|
12626
|
+
* Format: email
|
|
12627
|
+
* @description Optional Reply-To address.
|
|
12628
|
+
* @example support@vibexp.example.com
|
|
12629
|
+
*/
|
|
12630
|
+
reply_to?: string | null;
|
|
12631
|
+
/**
|
|
12632
|
+
* Format: email
|
|
12633
|
+
* @description Where the contact form delivers. Omitted or null falls back to the from
|
|
12634
|
+
* address.
|
|
12635
|
+
* @example hello@vibexp.example.com
|
|
12636
|
+
*/
|
|
12637
|
+
contact_recipient_address?: string | null;
|
|
12638
|
+
/**
|
|
12639
|
+
* @description Absolute http(s) URL of the privacy policy linked from outbound mail.
|
|
12640
|
+
* Omitted or null links none.
|
|
12641
|
+
* @example https://vibexp.example.com/privacy
|
|
12642
|
+
*/
|
|
12643
|
+
privacy_policy_url?: string | null;
|
|
12644
|
+
};
|
|
12645
|
+
/**
|
|
12646
|
+
* @description An optional candidate configuration for a test send. An empty body (or an
|
|
12647
|
+
* empty object) tests the STORED configuration. A body with any field set is
|
|
12648
|
+
* tested as a full configuration, validated like an upsert; if it omits
|
|
12649
|
+
* `secret`, the stored credential is used only when the candidate targets
|
|
12650
|
+
* the same destination (same provider type and, for SMTP, the same
|
|
12651
|
+
* host/port/username; for Mailgun, the same domain/base URL).
|
|
12652
|
+
*
|
|
12653
|
+
* There is no recipient field: the test message always goes to the calling
|
|
12654
|
+
* admin's own account email. A body carrying an unknown field is rejected
|
|
12655
|
+
* with 400.
|
|
12656
|
+
*/
|
|
12657
|
+
AdminInstanceEmailTestRequest: {
|
|
12658
|
+
provider_type?: components["schemas"]["AdminInstanceEmailProviderType"];
|
|
12659
|
+
settings?: components["schemas"]["TeamEmailProviderSettings"];
|
|
12660
|
+
/**
|
|
12661
|
+
* @description The candidate credential. Omit it to test with the stored credential
|
|
12662
|
+
* (same destination only, see above). Never returned.
|
|
12663
|
+
* @example key-abc123
|
|
12664
|
+
*/
|
|
12665
|
+
secret?: string;
|
|
12666
|
+
/**
|
|
12667
|
+
* Format: email
|
|
12668
|
+
* @description The from address to test with.
|
|
12669
|
+
* @example noreply@vibexp.example.com
|
|
12670
|
+
*/
|
|
12671
|
+
from_address?: string;
|
|
12672
|
+
/**
|
|
12673
|
+
* @description Optional display name to test with.
|
|
12674
|
+
* @example VibeXP
|
|
12675
|
+
*/
|
|
12676
|
+
from_name?: string | null;
|
|
12677
|
+
/**
|
|
12678
|
+
* Format: email
|
|
12679
|
+
* @description Optional Reply-To address to test with.
|
|
12680
|
+
* @example support@vibexp.example.com
|
|
12681
|
+
*/
|
|
12682
|
+
reply_to?: string | null;
|
|
12683
|
+
/**
|
|
12684
|
+
* Format: email
|
|
12685
|
+
* @description Accepted for parity with the upsert body; a test send does not use it.
|
|
12686
|
+
* @example hello@vibexp.example.com
|
|
12687
|
+
*/
|
|
12688
|
+
contact_recipient_address?: string | null;
|
|
12689
|
+
/**
|
|
12690
|
+
* @description Accepted for parity with the upsert body; a test send does not use it.
|
|
12691
|
+
* @example https://vibexp.example.com/privacy
|
|
12692
|
+
*/
|
|
12693
|
+
privacy_policy_url?: string | null;
|
|
12694
|
+
};
|
|
12695
|
+
/**
|
|
12696
|
+
* @description The instance's stored email configuration. This is never a 404: an
|
|
12697
|
+
* instance with nothing stored reports `configured: false`, with every other
|
|
12698
|
+
* field null or absent, and discards its mail.
|
|
12699
|
+
*
|
|
12700
|
+
* No field here can carry the credential; `has_credential` reports only that
|
|
12701
|
+
* one is stored.
|
|
12702
|
+
*/
|
|
12703
|
+
AdminInstanceEmailSettings: {
|
|
12704
|
+
/**
|
|
12705
|
+
* @description Whether an instance email provider is stored.
|
|
12706
|
+
* @example true
|
|
12707
|
+
*/
|
|
12708
|
+
configured: boolean;
|
|
12709
|
+
/**
|
|
12710
|
+
* @description The stored provider type, or null when nothing is configured.
|
|
12711
|
+
* @example smtp
|
|
12712
|
+
* @enum {string|null}
|
|
12713
|
+
*/
|
|
12714
|
+
provider_type: "smtp" | "mailgun" | "postmark" | "sendgrid" | null;
|
|
12715
|
+
settings?: components["schemas"]["TeamEmailProviderSettings"];
|
|
12716
|
+
/**
|
|
12717
|
+
* @description Whether a credential is stored. The credential itself is never
|
|
12718
|
+
* returned. An SMTP relay without authentication legitimately has none.
|
|
12719
|
+
* @example true
|
|
12720
|
+
*/
|
|
12721
|
+
has_credential: boolean;
|
|
12722
|
+
/**
|
|
12723
|
+
* @description The configured from address; null when nothing is configured.
|
|
12724
|
+
* @example noreply@vibexp.example.com
|
|
12725
|
+
*/
|
|
12726
|
+
from_address?: string | null;
|
|
12727
|
+
/**
|
|
12728
|
+
* @description The configured display name.
|
|
12729
|
+
* @example VibeXP
|
|
12730
|
+
*/
|
|
12731
|
+
from_name?: string | null;
|
|
12732
|
+
/**
|
|
12733
|
+
* @description The configured Reply-To address.
|
|
12734
|
+
* @example support@vibexp.example.com
|
|
12735
|
+
*/
|
|
12736
|
+
reply_to?: string | null;
|
|
12737
|
+
/**
|
|
12738
|
+
* @description Where the contact form delivers; null falls back to the from address.
|
|
12739
|
+
* @example hello@vibexp.example.com
|
|
12740
|
+
*/
|
|
12741
|
+
contact_recipient_address?: string | null;
|
|
12742
|
+
/**
|
|
12743
|
+
* @description The privacy policy URL linked from outbound mail; null links none.
|
|
12744
|
+
* @example https://vibexp.example.com/privacy
|
|
12745
|
+
*/
|
|
12746
|
+
privacy_policy_url?: string | null;
|
|
12747
|
+
/**
|
|
12748
|
+
* @description Whether the last observed send succeeded, derived by comparing
|
|
12749
|
+
* `last_success_at` with `last_error_at` (a provider that has never sent
|
|
12750
|
+
* is healthy). Null when nothing is configured.
|
|
12751
|
+
* @example true
|
|
12752
|
+
*/
|
|
12753
|
+
is_healthy: boolean | null;
|
|
12754
|
+
/**
|
|
12755
|
+
* Format: date-time
|
|
12756
|
+
* @description When a send through the instance provider last succeeded.
|
|
12757
|
+
*/
|
|
12758
|
+
last_success_at?: string | null;
|
|
12759
|
+
/**
|
|
12760
|
+
* @description The last delivery error, retained after recovery for diagnosis; use
|
|
12761
|
+
* `is_healthy` to tell whether the provider is currently failing.
|
|
12762
|
+
* @example smtp: connection refused
|
|
12763
|
+
*/
|
|
12764
|
+
last_error?: string | null;
|
|
12765
|
+
/**
|
|
12766
|
+
* Format: date-time
|
|
12767
|
+
* @description When the last delivery error occurred.
|
|
12768
|
+
*/
|
|
12769
|
+
last_error_at?: string | null;
|
|
12770
|
+
/**
|
|
12771
|
+
* Format: date-time
|
|
12772
|
+
* @description When the configuration was last saved; null when nothing is configured.
|
|
12773
|
+
*/
|
|
12774
|
+
updated_at?: string | null;
|
|
12775
|
+
/**
|
|
12776
|
+
* Format: uuid
|
|
12777
|
+
* @description The admin who last saved the configuration. Null for the boot-time
|
|
12778
|
+
* import from config.yaml, or once that user has been deleted.
|
|
12779
|
+
*/
|
|
12780
|
+
updated_by?: string | null;
|
|
12781
|
+
};
|
|
12782
|
+
/**
|
|
12783
|
+
* @description One append-only change to an instance setting. `before` and `after` are
|
|
12784
|
+
* REDACTED snapshots: they never contain a credential, only
|
|
12785
|
+
* `has_credential` and, on an upsert's `after`, a `secret` marker saying
|
|
12786
|
+
* whether the credential was `changed` or `unchanged`.
|
|
12787
|
+
*/
|
|
12788
|
+
AdminInstanceSettingsAuditEntry: {
|
|
12789
|
+
/**
|
|
12790
|
+
* Format: uuid
|
|
12791
|
+
* @description Audit entry id.
|
|
12792
|
+
*/
|
|
12793
|
+
id: string;
|
|
12794
|
+
/**
|
|
12795
|
+
* @description The instance setting the entry describes.
|
|
12796
|
+
* @example email_provider
|
|
12797
|
+
*/
|
|
12798
|
+
setting: string;
|
|
12799
|
+
/**
|
|
12800
|
+
* @description `upsert` (created or replaced by an admin), `delete` (removed by an
|
|
12801
|
+
* admin) or `import` (the boot-time import from config.yaml, which has no
|
|
12802
|
+
* actor).
|
|
12803
|
+
* @example upsert
|
|
12804
|
+
* @enum {string}
|
|
12805
|
+
*/
|
|
12806
|
+
action: "upsert" | "delete" | "import";
|
|
12807
|
+
/**
|
|
12808
|
+
* Format: uuid
|
|
12809
|
+
* @description The admin who made the change. Null for an import, or once that user
|
|
12810
|
+
* has been deleted.
|
|
12811
|
+
*/
|
|
12812
|
+
actor_user_id: string | null;
|
|
12813
|
+
/**
|
|
12814
|
+
* @description The actor's display name (or email), when it could be resolved.
|
|
12815
|
+
* @example Ada Admin
|
|
12816
|
+
*/
|
|
12817
|
+
actor_name: string | null;
|
|
12818
|
+
/** @description The redacted setting before the change; null when the change created it. */
|
|
12819
|
+
before: {
|
|
12820
|
+
[key: string]: unknown;
|
|
12821
|
+
} | null;
|
|
12822
|
+
/** @description The redacted setting after the change; null when the change deleted it. */
|
|
12823
|
+
after: {
|
|
12824
|
+
[key: string]: unknown;
|
|
12825
|
+
} | null;
|
|
12826
|
+
/**
|
|
12827
|
+
* Format: date-time
|
|
12828
|
+
* @description When the change was made.
|
|
12829
|
+
*/
|
|
12830
|
+
created_at: string;
|
|
12831
|
+
};
|
|
12832
|
+
/** @description One page of an instance setting's audit log, newest first. */
|
|
12833
|
+
AdminInstanceSettingsAuditPage: {
|
|
12834
|
+
entries: components["schemas"]["AdminInstanceSettingsAuditEntry"][];
|
|
12835
|
+
/** @description Opaque cursor for the next page; null on the last page. */
|
|
12836
|
+
next_cursor: string | null;
|
|
12837
|
+
};
|
|
12489
12838
|
ProjectResponse: components["schemas"]["Project"] & {
|
|
12490
12839
|
/**
|
|
12491
12840
|
* @description Whether the project's git URL matches a repository accessible via the team's GitHub App installation
|
|
@@ -24075,6 +24424,250 @@ export interface operations {
|
|
|
24075
24424
|
};
|
|
24076
24425
|
};
|
|
24077
24426
|
};
|
|
24427
|
+
getAdminInstanceEmailSettings: {
|
|
24428
|
+
parameters: {
|
|
24429
|
+
query?: never;
|
|
24430
|
+
header?: never;
|
|
24431
|
+
path?: never;
|
|
24432
|
+
cookie?: never;
|
|
24433
|
+
};
|
|
24434
|
+
requestBody?: never;
|
|
24435
|
+
responses: {
|
|
24436
|
+
/** @description The instance email provider settings */
|
|
24437
|
+
200: {
|
|
24438
|
+
headers: {
|
|
24439
|
+
[name: string]: unknown;
|
|
24440
|
+
};
|
|
24441
|
+
content: {
|
|
24442
|
+
"application/json": components["schemas"]["AdminInstanceEmailSettings"];
|
|
24443
|
+
};
|
|
24444
|
+
};
|
|
24445
|
+
/** @description Not found — the caller is not an instance admin */
|
|
24446
|
+
404: {
|
|
24447
|
+
headers: {
|
|
24448
|
+
[name: string]: unknown;
|
|
24449
|
+
};
|
|
24450
|
+
content: {
|
|
24451
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24452
|
+
};
|
|
24453
|
+
};
|
|
24454
|
+
/** @description Internal server error */
|
|
24455
|
+
500: {
|
|
24456
|
+
headers: {
|
|
24457
|
+
[name: string]: unknown;
|
|
24458
|
+
};
|
|
24459
|
+
content: {
|
|
24460
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24461
|
+
};
|
|
24462
|
+
};
|
|
24463
|
+
};
|
|
24464
|
+
};
|
|
24465
|
+
upsertAdminInstanceEmailSettings: {
|
|
24466
|
+
parameters: {
|
|
24467
|
+
query?: never;
|
|
24468
|
+
header?: never;
|
|
24469
|
+
path?: never;
|
|
24470
|
+
cookie?: never;
|
|
24471
|
+
};
|
|
24472
|
+
requestBody: {
|
|
24473
|
+
content: {
|
|
24474
|
+
"application/json": components["schemas"]["AdminInstanceEmailSettingsRequest"];
|
|
24475
|
+
};
|
|
24476
|
+
};
|
|
24477
|
+
responses: {
|
|
24478
|
+
/** @description The stored settings */
|
|
24479
|
+
200: {
|
|
24480
|
+
headers: {
|
|
24481
|
+
[name: string]: unknown;
|
|
24482
|
+
};
|
|
24483
|
+
content: {
|
|
24484
|
+
"application/json": components["schemas"]["AdminInstanceEmailSettings"];
|
|
24485
|
+
};
|
|
24486
|
+
};
|
|
24487
|
+
/**
|
|
24488
|
+
* @description Bad request — the configuration is invalid (`INSTANCE_EMAIL_PROVIDER_VALIDATION_FAILED`,
|
|
24489
|
+
* with `validation_errors`), or the body carries an unknown field
|
|
24490
|
+
*/
|
|
24491
|
+
400: {
|
|
24492
|
+
headers: {
|
|
24493
|
+
[name: string]: unknown;
|
|
24494
|
+
};
|
|
24495
|
+
content: {
|
|
24496
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24497
|
+
};
|
|
24498
|
+
};
|
|
24499
|
+
/** @description Not found — the caller is not an instance admin */
|
|
24500
|
+
404: {
|
|
24501
|
+
headers: {
|
|
24502
|
+
[name: string]: unknown;
|
|
24503
|
+
};
|
|
24504
|
+
content: {
|
|
24505
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24506
|
+
};
|
|
24507
|
+
};
|
|
24508
|
+
/** @description Internal server error */
|
|
24509
|
+
500: {
|
|
24510
|
+
headers: {
|
|
24511
|
+
[name: string]: unknown;
|
|
24512
|
+
};
|
|
24513
|
+
content: {
|
|
24514
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24515
|
+
};
|
|
24516
|
+
};
|
|
24517
|
+
};
|
|
24518
|
+
};
|
|
24519
|
+
deleteAdminInstanceEmailSettings: {
|
|
24520
|
+
parameters: {
|
|
24521
|
+
query?: never;
|
|
24522
|
+
header?: never;
|
|
24523
|
+
path?: never;
|
|
24524
|
+
cookie?: never;
|
|
24525
|
+
};
|
|
24526
|
+
requestBody?: never;
|
|
24527
|
+
responses: {
|
|
24528
|
+
/** @description The settings were removed */
|
|
24529
|
+
204: {
|
|
24530
|
+
headers: {
|
|
24531
|
+
[name: string]: unknown;
|
|
24532
|
+
};
|
|
24533
|
+
content?: never;
|
|
24534
|
+
};
|
|
24535
|
+
/** @description Not found — the caller is not an instance admin */
|
|
24536
|
+
404: {
|
|
24537
|
+
headers: {
|
|
24538
|
+
[name: string]: unknown;
|
|
24539
|
+
};
|
|
24540
|
+
content: {
|
|
24541
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24542
|
+
};
|
|
24543
|
+
};
|
|
24544
|
+
/** @description Conflict — no instance email provider is configured (`INSTANCE_EMAIL_PROVIDER_NOT_CONFIGURED`) */
|
|
24545
|
+
409: {
|
|
24546
|
+
headers: {
|
|
24547
|
+
[name: string]: unknown;
|
|
24548
|
+
};
|
|
24549
|
+
content: {
|
|
24550
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24551
|
+
};
|
|
24552
|
+
};
|
|
24553
|
+
/** @description Internal server error */
|
|
24554
|
+
500: {
|
|
24555
|
+
headers: {
|
|
24556
|
+
[name: string]: unknown;
|
|
24557
|
+
};
|
|
24558
|
+
content: {
|
|
24559
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24560
|
+
};
|
|
24561
|
+
};
|
|
24562
|
+
};
|
|
24563
|
+
};
|
|
24564
|
+
testAdminInstanceEmailSettings: {
|
|
24565
|
+
parameters: {
|
|
24566
|
+
query?: never;
|
|
24567
|
+
header?: never;
|
|
24568
|
+
path?: never;
|
|
24569
|
+
cookie?: never;
|
|
24570
|
+
};
|
|
24571
|
+
requestBody?: {
|
|
24572
|
+
content: {
|
|
24573
|
+
"application/json": components["schemas"]["AdminInstanceEmailTestRequest"];
|
|
24574
|
+
};
|
|
24575
|
+
};
|
|
24576
|
+
responses: {
|
|
24577
|
+
/** @description The outcome of the test send */
|
|
24578
|
+
200: {
|
|
24579
|
+
headers: {
|
|
24580
|
+
[name: string]: unknown;
|
|
24581
|
+
};
|
|
24582
|
+
content: {
|
|
24583
|
+
"application/json": components["schemas"]["TeamEmailProviderTestResponse"];
|
|
24584
|
+
};
|
|
24585
|
+
};
|
|
24586
|
+
/**
|
|
24587
|
+
* @description Bad request — the candidate configuration is invalid, nothing is stored to
|
|
24588
|
+
* test (`INSTANCE_EMAIL_PROVIDER_VALIDATION_FAILED`), or the body carries an
|
|
24589
|
+
* unknown field
|
|
24590
|
+
*/
|
|
24591
|
+
400: {
|
|
24592
|
+
headers: {
|
|
24593
|
+
[name: string]: unknown;
|
|
24594
|
+
};
|
|
24595
|
+
content: {
|
|
24596
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24597
|
+
};
|
|
24598
|
+
};
|
|
24599
|
+
/** @description Not found — the caller is not an instance admin */
|
|
24600
|
+
404: {
|
|
24601
|
+
headers: {
|
|
24602
|
+
[name: string]: unknown;
|
|
24603
|
+
};
|
|
24604
|
+
content: {
|
|
24605
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24606
|
+
};
|
|
24607
|
+
};
|
|
24608
|
+
/** @description Internal server error */
|
|
24609
|
+
500: {
|
|
24610
|
+
headers: {
|
|
24611
|
+
[name: string]: unknown;
|
|
24612
|
+
};
|
|
24613
|
+
content: {
|
|
24614
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24615
|
+
};
|
|
24616
|
+
};
|
|
24617
|
+
};
|
|
24618
|
+
};
|
|
24619
|
+
listAdminInstanceEmailSettingsAudit: {
|
|
24620
|
+
parameters: {
|
|
24621
|
+
query?: {
|
|
24622
|
+
/** @description Opaque cursor from a previous page's `next_cursor`. */
|
|
24623
|
+
cursor?: string;
|
|
24624
|
+
/** @description Page size. */
|
|
24625
|
+
limit?: number;
|
|
24626
|
+
};
|
|
24627
|
+
header?: never;
|
|
24628
|
+
path?: never;
|
|
24629
|
+
cookie?: never;
|
|
24630
|
+
};
|
|
24631
|
+
requestBody?: never;
|
|
24632
|
+
responses: {
|
|
24633
|
+
/** @description One page of audit entries, newest first */
|
|
24634
|
+
200: {
|
|
24635
|
+
headers: {
|
|
24636
|
+
[name: string]: unknown;
|
|
24637
|
+
};
|
|
24638
|
+
content: {
|
|
24639
|
+
"application/json": components["schemas"]["AdminInstanceSettingsAuditPage"];
|
|
24640
|
+
};
|
|
24641
|
+
};
|
|
24642
|
+
/** @description Bad request — malformed cursor, or `limit` out of range */
|
|
24643
|
+
400: {
|
|
24644
|
+
headers: {
|
|
24645
|
+
[name: string]: unknown;
|
|
24646
|
+
};
|
|
24647
|
+
content: {
|
|
24648
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24649
|
+
};
|
|
24650
|
+
};
|
|
24651
|
+
/** @description Not found — the caller is not an instance admin */
|
|
24652
|
+
404: {
|
|
24653
|
+
headers: {
|
|
24654
|
+
[name: string]: unknown;
|
|
24655
|
+
};
|
|
24656
|
+
content: {
|
|
24657
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24658
|
+
};
|
|
24659
|
+
};
|
|
24660
|
+
/** @description Internal server error */
|
|
24661
|
+
500: {
|
|
24662
|
+
headers: {
|
|
24663
|
+
[name: string]: unknown;
|
|
24664
|
+
};
|
|
24665
|
+
content: {
|
|
24666
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
24667
|
+
};
|
|
24668
|
+
};
|
|
24669
|
+
};
|
|
24670
|
+
};
|
|
24078
24671
|
listComments: {
|
|
24079
24672
|
parameters: {
|
|
24080
24673
|
query: {
|
package/package.json
CHANGED