@opusdns/api 1.195.0 → 1.196.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/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^1.6.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.195.0",
6
+ "version": "1.196.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -16,6 +16,17 @@ import type {
16
16
  Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post,
17
17
  Brand,
18
18
  BrandingAsset,
19
+ BrandingDesignActions,
20
+ BrandingDesignContext,
21
+ BrandingDesignContextPayload,
22
+ BrandingDesignContrast,
23
+ BrandingDesignContrastCheck,
24
+ BrandingDesignDiff,
25
+ BrandingDesignPreview,
26
+ BrandingDesignSource,
27
+ BrandingDesignSwatches,
28
+ BrandingDesignVariant,
29
+ BrandingDesignWrite,
19
30
  BrandingDocument,
20
31
  BrowserStatsBucket,
21
32
  BulkObjectTagChanges,
@@ -425,6 +436,7 @@ import type {
425
436
  TrademarkClaimsBase,
426
437
  TransferLockPolicyBase,
427
438
  TransferPoliciesBase,
439
+ UnknownContext,
428
440
  User,
429
441
  UserAgentStatsBucket,
430
442
  UserAgreementAcceptance,
@@ -689,6 +701,154 @@ export const KEYS_BRANDING_ASSET = [
689
701
  KEY_BRANDING_ASSET_UPDATED_ON,
690
702
  ] as const satisfies (keyof BrandingAsset)[];
691
703
 
704
+ export const KEY_BRANDING_DESIGN_ACTIONS_CAN_ACTIVATE = 'can_activate' satisfies keyof BrandingDesignActions;
705
+ export const KEY_BRANDING_DESIGN_ACTIONS_DOWNLOAD_FILENAME = 'download_filename' satisfies keyof BrandingDesignActions;
706
+ export const KEY_BRANDING_DESIGN_ACTIONS_WRITE = 'write' satisfies keyof BrandingDesignActions;
707
+
708
+ export const KEYS_BRANDING_DESIGN_ACTIONS = [
709
+ KEY_BRANDING_DESIGN_ACTIONS_CAN_ACTIVATE,
710
+ KEY_BRANDING_DESIGN_ACTIONS_DOWNLOAD_FILENAME,
711
+ KEY_BRANDING_DESIGN_ACTIONS_WRITE,
712
+ ] as const satisfies (keyof BrandingDesignActions)[];
713
+
714
+ export const KEY_BRANDING_DESIGN_CONTEXT_CONTEXT_ID = 'context_id' satisfies keyof BrandingDesignContext;
715
+ export const KEY_BRANDING_DESIGN_CONTEXT_CONVERSATION_ID = 'conversation_id' satisfies keyof BrandingDesignContext;
716
+ export const KEY_BRANDING_DESIGN_CONTEXT_CREATED_AT = 'created_at' satisfies keyof BrandingDesignContext;
717
+ export const KEY_BRANDING_DESIGN_CONTEXT_KIND = 'kind' satisfies keyof BrandingDesignContext;
718
+ export const KEY_BRANDING_DESIGN_CONTEXT_ORGANIZATION_ID = 'organization_id' satisfies keyof BrandingDesignContext;
719
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD = 'payload' satisfies keyof BrandingDesignContext;
720
+ export const KEY_BRANDING_DESIGN_CONTEXT_USER_ID = 'user_id' satisfies keyof BrandingDesignContext;
721
+
722
+ export const KEYS_BRANDING_DESIGN_CONTEXT = [
723
+ KEY_BRANDING_DESIGN_CONTEXT_CONTEXT_ID,
724
+ KEY_BRANDING_DESIGN_CONTEXT_CONVERSATION_ID,
725
+ KEY_BRANDING_DESIGN_CONTEXT_CREATED_AT,
726
+ KEY_BRANDING_DESIGN_CONTEXT_KIND,
727
+ KEY_BRANDING_DESIGN_CONTEXT_ORGANIZATION_ID,
728
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD,
729
+ KEY_BRANDING_DESIGN_CONTEXT_USER_ID,
730
+ ] as const satisfies (keyof BrandingDesignContext)[];
731
+
732
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_ACTIONS = 'actions' satisfies keyof BrandingDesignContextPayload;
733
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_DIFF = 'diff' satisfies keyof BrandingDesignContextPayload;
734
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_RESULTS = 'results' satisfies keyof BrandingDesignContextPayload;
735
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_SOURCE = 'source' satisfies keyof BrandingDesignContextPayload;
736
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_SUMMARY = 'summary' satisfies keyof BrandingDesignContextPayload;
737
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_WARNINGS = 'warnings' satisfies keyof BrandingDesignContextPayload;
738
+
739
+ export const KEYS_BRANDING_DESIGN_CONTEXT_PAYLOAD = [
740
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_ACTIONS,
741
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_DIFF,
742
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_RESULTS,
743
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_SOURCE,
744
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_SUMMARY,
745
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_WARNINGS,
746
+ ] as const satisfies (keyof BrandingDesignContextPayload)[];
747
+
748
+ export const KEY_BRANDING_DESIGN_CONTRAST_ALL_PASS = 'all_pass' satisfies keyof BrandingDesignContrast;
749
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECKS = 'checks' satisfies keyof BrandingDesignContrast;
750
+ export const KEY_BRANDING_DESIGN_CONTRAST_MIN_RATIO = 'min_ratio' satisfies keyof BrandingDesignContrast;
751
+
752
+ export const KEYS_BRANDING_DESIGN_CONTRAST = [
753
+ KEY_BRANDING_DESIGN_CONTRAST_ALL_PASS,
754
+ KEY_BRANDING_DESIGN_CONTRAST_CHECKS,
755
+ KEY_BRANDING_DESIGN_CONTRAST_MIN_RATIO,
756
+ ] as const satisfies (keyof BrandingDesignContrast)[];
757
+
758
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_BG = 'bg' satisfies keyof BrandingDesignContrastCheck;
759
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_FG = 'fg' satisfies keyof BrandingDesignContrastCheck;
760
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_HARD = 'hard' satisfies keyof BrandingDesignContrastCheck;
761
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_KIND = 'kind' satisfies keyof BrandingDesignContrastCheck;
762
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_MAX = 'max' satisfies keyof BrandingDesignContrastCheck;
763
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_MIN = 'min' satisfies keyof BrandingDesignContrastCheck;
764
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_MODE = 'mode' satisfies keyof BrandingDesignContrastCheck;
765
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_OK = 'ok' satisfies keyof BrandingDesignContrastCheck;
766
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_RATIO = 'ratio' satisfies keyof BrandingDesignContrastCheck;
767
+
768
+ export const KEYS_BRANDING_DESIGN_CONTRAST_CHECK = [
769
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_BG,
770
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_FG,
771
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_HARD,
772
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_KIND,
773
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_MAX,
774
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_MIN,
775
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_MODE,
776
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_OK,
777
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_RATIO,
778
+ ] as const satisfies (keyof BrandingDesignContrastCheck)[];
779
+
780
+ export const KEY_BRANDING_DESIGN_DIFF_CHANGED_PATHS = 'changed_paths' satisfies keyof BrandingDesignDiff;
781
+ export const KEY_BRANDING_DESIGN_DIFF_MERGED_WITH_CURRENT = 'merged_with_current' satisfies keyof BrandingDesignDiff;
782
+
783
+ export const KEYS_BRANDING_DESIGN_DIFF = [
784
+ KEY_BRANDING_DESIGN_DIFF_CHANGED_PATHS,
785
+ KEY_BRANDING_DESIGN_DIFF_MERGED_WITH_CURRENT,
786
+ ] as const satisfies (keyof BrandingDesignDiff)[];
787
+
788
+ export const KEY_BRANDING_DESIGN_PREVIEW_FONT_FAMILY = 'font_family' satisfies keyof BrandingDesignPreview;
789
+ export const KEY_BRANDING_DESIGN_PREVIEW_MOOD = 'mood' satisfies keyof BrandingDesignPreview;
790
+ export const KEY_BRANDING_DESIGN_PREVIEW_PRESET_BASE = 'preset_base' satisfies keyof BrandingDesignPreview;
791
+ export const KEY_BRANDING_DESIGN_PREVIEW_RADIUS_REM = 'radius_rem' satisfies keyof BrandingDesignPreview;
792
+ export const KEY_BRANDING_DESIGN_PREVIEW_SWATCHES = 'swatches' satisfies keyof BrandingDesignPreview;
793
+
794
+ export const KEYS_BRANDING_DESIGN_PREVIEW = [
795
+ KEY_BRANDING_DESIGN_PREVIEW_FONT_FAMILY,
796
+ KEY_BRANDING_DESIGN_PREVIEW_MOOD,
797
+ KEY_BRANDING_DESIGN_PREVIEW_PRESET_BASE,
798
+ KEY_BRANDING_DESIGN_PREVIEW_RADIUS_REM,
799
+ KEY_BRANDING_DESIGN_PREVIEW_SWATCHES,
800
+ ] as const satisfies (keyof BrandingDesignPreview)[];
801
+
802
+ export const KEY_BRANDING_DESIGN_SOURCE_CONFIDENCE = 'confidence' satisfies keyof BrandingDesignSource;
803
+ export const KEY_BRANDING_DESIGN_SOURCE_KIND = 'kind' satisfies keyof BrandingDesignSource;
804
+ export const KEY_BRANDING_DESIGN_SOURCE_LOGO_ASSET_URL = 'logo_asset_url' satisfies keyof BrandingDesignSource;
805
+ export const KEY_BRANDING_DESIGN_SOURCE_PRESET_ID = 'preset_id' satisfies keyof BrandingDesignSource;
806
+ export const KEY_BRANDING_DESIGN_SOURCE_SIGNALS = 'signals' satisfies keyof BrandingDesignSource;
807
+ export const KEY_BRANDING_DESIGN_SOURCE_URL = 'url' satisfies keyof BrandingDesignSource;
808
+
809
+ export const KEYS_BRANDING_DESIGN_SOURCE = [
810
+ KEY_BRANDING_DESIGN_SOURCE_CONFIDENCE,
811
+ KEY_BRANDING_DESIGN_SOURCE_KIND,
812
+ KEY_BRANDING_DESIGN_SOURCE_LOGO_ASSET_URL,
813
+ KEY_BRANDING_DESIGN_SOURCE_PRESET_ID,
814
+ KEY_BRANDING_DESIGN_SOURCE_SIGNALS,
815
+ KEY_BRANDING_DESIGN_SOURCE_URL,
816
+ ] as const satisfies (keyof BrandingDesignSource)[];
817
+
818
+ export const KEY_BRANDING_DESIGN_SWATCHES_DARK = 'dark' satisfies keyof BrandingDesignSwatches;
819
+ export const KEY_BRANDING_DESIGN_SWATCHES_LIGHT = 'light' satisfies keyof BrandingDesignSwatches;
820
+
821
+ export const KEYS_BRANDING_DESIGN_SWATCHES = [
822
+ KEY_BRANDING_DESIGN_SWATCHES_DARK,
823
+ KEY_BRANDING_DESIGN_SWATCHES_LIGHT,
824
+ ] as const satisfies (keyof BrandingDesignSwatches)[];
825
+
826
+ export const KEY_BRANDING_DESIGN_VARIANT_CONTRAST = 'contrast' satisfies keyof BrandingDesignVariant;
827
+ export const KEY_BRANDING_DESIGN_VARIANT_DOCUMENT = 'document' satisfies keyof BrandingDesignVariant;
828
+ export const KEY_BRANDING_DESIGN_VARIANT_LABEL = 'label' satisfies keyof BrandingDesignVariant;
829
+ export const KEY_BRANDING_DESIGN_VARIANT_PREVIEW = 'preview' satisfies keyof BrandingDesignVariant;
830
+ export const KEY_BRANDING_DESIGN_VARIANT_RATIONALE = 'rationale' satisfies keyof BrandingDesignVariant;
831
+ export const KEY_BRANDING_DESIGN_VARIANT_VARIANT_ID = 'variant_id' satisfies keyof BrandingDesignVariant;
832
+
833
+ export const KEYS_BRANDING_DESIGN_VARIANT = [
834
+ KEY_BRANDING_DESIGN_VARIANT_CONTRAST,
835
+ KEY_BRANDING_DESIGN_VARIANT_DOCUMENT,
836
+ KEY_BRANDING_DESIGN_VARIANT_LABEL,
837
+ KEY_BRANDING_DESIGN_VARIANT_PREVIEW,
838
+ KEY_BRANDING_DESIGN_VARIANT_RATIONALE,
839
+ KEY_BRANDING_DESIGN_VARIANT_VARIANT_ID,
840
+ ] as const satisfies (keyof BrandingDesignVariant)[];
841
+
842
+ export const KEY_BRANDING_DESIGN_WRITE_METHOD = 'method' satisfies keyof BrandingDesignWrite;
843
+ export const KEY_BRANDING_DESIGN_WRITE_PATH = 'path' satisfies keyof BrandingDesignWrite;
844
+ export const KEY_BRANDING_DESIGN_WRITE_PERMISSION = 'permission' satisfies keyof BrandingDesignWrite;
845
+
846
+ export const KEYS_BRANDING_DESIGN_WRITE = [
847
+ KEY_BRANDING_DESIGN_WRITE_METHOD,
848
+ KEY_BRANDING_DESIGN_WRITE_PATH,
849
+ KEY_BRANDING_DESIGN_WRITE_PERMISSION,
850
+ ] as const satisfies (keyof BrandingDesignWrite)[];
851
+
692
852
  export const KEY_BRANDING_DOCUMENT_AUTH = 'auth' satisfies keyof BrandingDocument;
693
853
  export const KEY_BRANDING_DOCUMENT_BRAND = 'brand' satisfies keyof BrandingDocument;
694
854
  export const KEY_BRANDING_DOCUMENT_CONTENT = 'content' satisfies keyof BrandingDocument;
@@ -5795,6 +5955,24 @@ export const KEYS_TRANSFER_POLICIES_BASE = [
5795
5955
  KEY_TRANSFER_POLICIES_BASE_TRANSFER_TIME,
5796
5956
  ] as const satisfies (keyof TransferPoliciesBase)[];
5797
5957
 
5958
+ export const KEY_UNKNOWN_CONTEXT_CONTEXT_ID = 'context_id' satisfies keyof UnknownContext;
5959
+ export const KEY_UNKNOWN_CONTEXT_CONVERSATION_ID = 'conversation_id' satisfies keyof UnknownContext;
5960
+ export const KEY_UNKNOWN_CONTEXT_CREATED_AT = 'created_at' satisfies keyof UnknownContext;
5961
+ export const KEY_UNKNOWN_CONTEXT_KIND = 'kind' satisfies keyof UnknownContext;
5962
+ export const KEY_UNKNOWN_CONTEXT_ORGANIZATION_ID = 'organization_id' satisfies keyof UnknownContext;
5963
+ export const KEY_UNKNOWN_CONTEXT_PAYLOAD = 'payload' satisfies keyof UnknownContext;
5964
+ export const KEY_UNKNOWN_CONTEXT_USER_ID = 'user_id' satisfies keyof UnknownContext;
5965
+
5966
+ export const KEYS_UNKNOWN_CONTEXT = [
5967
+ KEY_UNKNOWN_CONTEXT_CONTEXT_ID,
5968
+ KEY_UNKNOWN_CONTEXT_CONVERSATION_ID,
5969
+ KEY_UNKNOWN_CONTEXT_CREATED_AT,
5970
+ KEY_UNKNOWN_CONTEXT_KIND,
5971
+ KEY_UNKNOWN_CONTEXT_ORGANIZATION_ID,
5972
+ KEY_UNKNOWN_CONTEXT_PAYLOAD,
5973
+ KEY_UNKNOWN_CONTEXT_USER_ID,
5974
+ ] as const satisfies (keyof UnknownContext)[];
5975
+
5798
5976
  export const KEY_USER_CREATED_ON = 'created_on' satisfies keyof User;
5799
5977
  export const KEY_USER_EMAIL = 'email' satisfies keyof User;
5800
5978
  export const KEY_USER_FIRST_NAME = 'first_name' satisfies keyof User;
@@ -28,6 +28,18 @@ export type BillingTransactionStatus = components['schemas']['BillingTransaction
28
28
  export type Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post = components['schemas']['Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post'];
29
29
  export type Brand = components['schemas']['Brand'];
30
30
  export type BrandingAsset = components['schemas']['BrandingAsset'];
31
+ export type BrandingDesignActions = components['schemas']['BrandingDesignActions'];
32
+ export type BrandingDesignContext = components['schemas']['BrandingDesignContext'];
33
+ export type BrandingDesignContextPayload = components['schemas']['BrandingDesignContextPayload'];
34
+ export type BrandingDesignContrast = components['schemas']['BrandingDesignContrast'];
35
+ export type BrandingDesignContrastCheck = components['schemas']['BrandingDesignContrastCheck'];
36
+ export type BrandingDesignDiff = components['schemas']['BrandingDesignDiff'];
37
+ export type BrandingDesignDocument = components['schemas']['BrandingDesignDocument'];
38
+ export type BrandingDesignPreview = components['schemas']['BrandingDesignPreview'];
39
+ export type BrandingDesignSource = components['schemas']['BrandingDesignSource'];
40
+ export type BrandingDesignSwatches = components['schemas']['BrandingDesignSwatches'];
41
+ export type BrandingDesignVariant = components['schemas']['BrandingDesignVariant'];
42
+ export type BrandingDesignWrite = components['schemas']['BrandingDesignWrite'];
31
43
  export type BrandingDocument = components['schemas']['BrandingDocument'];
32
44
  export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
33
45
  export type BulkObjectTagChanges = components['schemas']['BulkObjectTagChanges'];
@@ -564,6 +576,7 @@ export type TrademarkClaimsBase = components['schemas']['TrademarkClaimsBase'];
564
576
  export type TransferAckType = components['schemas']['TransferAckType'];
565
577
  export type TransferLockPolicyBase = components['schemas']['TransferLockPolicyBase'];
566
578
  export type TransferPoliciesBase = components['schemas']['TransferPoliciesBase'];
579
+ export type UnknownContext = components['schemas']['UnknownContext'];
567
580
  export type UsageGranularity = components['schemas']['UsageGranularity'];
568
581
  export type UsageProduct = components['schemas']['UsageProduct'];
569
582
  export type User = components['schemas']['User'];
package/src/openapi.yaml CHANGED
@@ -594,6 +594,314 @@ components:
594
594
  - updated_on
595
595
  title: BrandingAsset
596
596
  type: object
597
+ BrandingDesignActions:
598
+ properties:
599
+ can_activate:
600
+ anyOf:
601
+ - type: boolean
602
+ - type: 'null'
603
+ title: Can Activate
604
+ download_filename:
605
+ anyOf:
606
+ - type: string
607
+ - type: 'null'
608
+ title: Download Filename
609
+ write:
610
+ anyOf:
611
+ - $ref: '#/components/schemas/BrandingDesignWrite'
612
+ - type: 'null'
613
+ title: BrandingDesignActions
614
+ type: object
615
+ BrandingDesignContext:
616
+ properties:
617
+ context_id:
618
+ examples:
619
+ - ctx_01h45ytscbebyvny4gc8cr8ma2
620
+ format: typeid
621
+ pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$
622
+ title: Context Id
623
+ type: string
624
+ x-typeid-prefix: ctx
625
+ conversation_id:
626
+ examples:
627
+ - conv_01h45ytscbebyvny4gc8cr8ma2
628
+ format: typeid
629
+ pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
630
+ title: Conversation Id
631
+ type: string
632
+ x-typeid-prefix: conv
633
+ created_at:
634
+ format: date-time
635
+ title: Created At
636
+ type: string
637
+ kind:
638
+ const: branding_design
639
+ default: branding_design
640
+ title: Kind
641
+ type: string
642
+ organization_id:
643
+ examples:
644
+ - organization_01h45ytscbebyvny4gc8cr8ma2
645
+ format: typeid
646
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
647
+ title: Organization Id
648
+ type: string
649
+ x-typeid-prefix: organization
650
+ payload:
651
+ $ref: '#/components/schemas/BrandingDesignContextPayload'
652
+ user_id:
653
+ title: User Id
654
+ type: string
655
+ required:
656
+ - context_id
657
+ - conversation_id
658
+ - organization_id
659
+ - user_id
660
+ - created_at
661
+ - payload
662
+ title: BrandingDesignContext
663
+ type: object
664
+ BrandingDesignContextPayload:
665
+ properties:
666
+ actions:
667
+ anyOf:
668
+ - $ref: '#/components/schemas/BrandingDesignActions'
669
+ - type: 'null'
670
+ diff:
671
+ anyOf:
672
+ - $ref: '#/components/schemas/BrandingDesignDiff'
673
+ - type: 'null'
674
+ results:
675
+ items:
676
+ $ref: '#/components/schemas/BrandingDesignVariant'
677
+ title: Results
678
+ type: array
679
+ source:
680
+ anyOf:
681
+ - $ref: '#/components/schemas/BrandingDesignSource'
682
+ - type: 'null'
683
+ summary:
684
+ default: ''
685
+ title: Summary
686
+ type: string
687
+ warnings:
688
+ items:
689
+ type: string
690
+ title: Warnings
691
+ type: array
692
+ required:
693
+ - results
694
+ title: BrandingDesignContextPayload
695
+ type: object
696
+ BrandingDesignContrast:
697
+ properties:
698
+ all_pass:
699
+ anyOf:
700
+ - type: boolean
701
+ - type: 'null'
702
+ title: All Pass
703
+ checks:
704
+ items:
705
+ $ref: '#/components/schemas/BrandingDesignContrastCheck'
706
+ title: Checks
707
+ type: array
708
+ min_ratio:
709
+ anyOf:
710
+ - type: number
711
+ - type: 'null'
712
+ title: Min Ratio
713
+ title: BrandingDesignContrast
714
+ type: object
715
+ BrandingDesignContrastCheck:
716
+ properties:
717
+ bg:
718
+ anyOf:
719
+ - type: string
720
+ - type: 'null'
721
+ title: Bg
722
+ fg:
723
+ anyOf:
724
+ - type: string
725
+ - type: 'null'
726
+ title: Fg
727
+ hard:
728
+ anyOf:
729
+ - type: boolean
730
+ - type: 'null'
731
+ title: Hard
732
+ kind:
733
+ anyOf:
734
+ - type: string
735
+ - type: 'null'
736
+ title: Kind
737
+ max:
738
+ anyOf:
739
+ - type: number
740
+ - type: 'null'
741
+ title: Max
742
+ min:
743
+ anyOf:
744
+ - type: number
745
+ - type: 'null'
746
+ title: Min
747
+ mode:
748
+ anyOf:
749
+ - type: string
750
+ - type: 'null'
751
+ title: Mode
752
+ ok:
753
+ anyOf:
754
+ - type: boolean
755
+ - type: 'null'
756
+ title: Ok
757
+ ratio:
758
+ anyOf:
759
+ - type: number
760
+ - type: 'null'
761
+ title: Ratio
762
+ title: BrandingDesignContrastCheck
763
+ type: object
764
+ BrandingDesignDiff:
765
+ properties:
766
+ changed_paths:
767
+ items:
768
+ type: string
769
+ title: Changed Paths
770
+ type: array
771
+ merged_with_current:
772
+ anyOf:
773
+ - type: boolean
774
+ - type: 'null'
775
+ title: Merged With Current
776
+ title: BrandingDesignDiff
777
+ type: object
778
+ BrandingDesignDocument:
779
+ additionalProperties: true
780
+ title: BrandingDesignDocument
781
+ type: object
782
+ BrandingDesignPreview:
783
+ properties:
784
+ font_family:
785
+ anyOf:
786
+ - type: string
787
+ - type: 'null'
788
+ title: Font Family
789
+ mood:
790
+ anyOf:
791
+ - type: string
792
+ - type: 'null'
793
+ title: Mood
794
+ preset_base:
795
+ anyOf:
796
+ - type: string
797
+ - type: 'null'
798
+ title: Preset Base
799
+ radius_rem:
800
+ anyOf:
801
+ - type: number
802
+ - type: 'null'
803
+ title: Radius Rem
804
+ swatches:
805
+ anyOf:
806
+ - $ref: '#/components/schemas/BrandingDesignSwatches'
807
+ - type: 'null'
808
+ title: BrandingDesignPreview
809
+ type: object
810
+ BrandingDesignSource:
811
+ properties:
812
+ confidence:
813
+ anyOf:
814
+ - type: string
815
+ - type: 'null'
816
+ title: Confidence
817
+ kind:
818
+ anyOf:
819
+ - type: string
820
+ - type: 'null'
821
+ title: Kind
822
+ logo_asset_url:
823
+ anyOf:
824
+ - type: string
825
+ - type: 'null'
826
+ title: Logo Asset Url
827
+ preset_id:
828
+ anyOf:
829
+ - type: string
830
+ - type: 'null'
831
+ title: Preset Id
832
+ signals:
833
+ items:
834
+ type: string
835
+ title: Signals
836
+ type: array
837
+ url:
838
+ anyOf:
839
+ - type: string
840
+ - type: 'null'
841
+ title: Url
842
+ title: BrandingDesignSource
843
+ type: object
844
+ BrandingDesignSwatches:
845
+ properties:
846
+ dark:
847
+ additionalProperties:
848
+ type: string
849
+ title: Dark
850
+ type: object
851
+ light:
852
+ additionalProperties:
853
+ type: string
854
+ title: Light
855
+ type: object
856
+ title: BrandingDesignSwatches
857
+ type: object
858
+ BrandingDesignVariant:
859
+ properties:
860
+ contrast:
861
+ anyOf:
862
+ - $ref: '#/components/schemas/BrandingDesignContrast'
863
+ - type: 'null'
864
+ document:
865
+ $ref: '#/components/schemas/BrandingDesignDocument'
866
+ label:
867
+ default: ''
868
+ title: Label
869
+ type: string
870
+ preview:
871
+ anyOf:
872
+ - $ref: '#/components/schemas/BrandingDesignPreview'
873
+ - type: 'null'
874
+ rationale:
875
+ default: ''
876
+ title: Rationale
877
+ type: string
878
+ variant_id:
879
+ title: Variant Id
880
+ type: string
881
+ required:
882
+ - variant_id
883
+ - document
884
+ title: BrandingDesignVariant
885
+ type: object
886
+ BrandingDesignWrite:
887
+ properties:
888
+ method:
889
+ anyOf:
890
+ - type: string
891
+ - type: 'null'
892
+ title: Method
893
+ path:
894
+ anyOf:
895
+ - type: string
896
+ - type: 'null'
897
+ title: Path
898
+ permission:
899
+ anyOf:
900
+ - type: string
901
+ - type: 'null'
902
+ title: Permission
903
+ title: BrandingDesignWrite
904
+ type: object
597
905
  BrandingDocument:
598
906
  properties:
599
907
  auth:
@@ -2294,6 +2602,7 @@ components:
2294
2602
  discriminator:
2295
2603
  mapping:
2296
2604
  aggregations: '#/components/schemas/AggregationsContext'
2605
+ branding_design: '#/components/schemas/BrandingDesignContext'
2297
2606
  contacts: '#/components/schemas/ContactsContext'
2298
2607
  domain_forwards: '#/components/schemas/DomainForwardsContext'
2299
2608
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -2309,6 +2618,7 @@ components:
2309
2618
  - $ref: '#/components/schemas/EmailForwardsContext'
2310
2619
  - $ref: '#/components/schemas/DomainRecommendationsContext'
2311
2620
  - $ref: '#/components/schemas/AggregationsContext'
2621
+ - $ref: '#/components/schemas/BrandingDesignContext'
2312
2622
  title: Results
2313
2623
  type: array
2314
2624
  required:
@@ -14914,6 +15224,56 @@ components:
14914
15224
  - authinfo_required
14915
15225
  title: TransferPoliciesBase
14916
15226
  type: object
15227
+ UnknownContext:
15228
+ properties:
15229
+ context_id:
15230
+ examples:
15231
+ - ctx_01h45ytscbebyvny4gc8cr8ma2
15232
+ format: typeid
15233
+ pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15234
+ title: Context Id
15235
+ type: string
15236
+ x-typeid-prefix: ctx
15237
+ conversation_id:
15238
+ examples:
15239
+ - conv_01h45ytscbebyvny4gc8cr8ma2
15240
+ format: typeid
15241
+ pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15242
+ title: Conversation Id
15243
+ type: string
15244
+ x-typeid-prefix: conv
15245
+ created_at:
15246
+ format: date-time
15247
+ title: Created At
15248
+ type: string
15249
+ kind:
15250
+ title: Kind
15251
+ type: string
15252
+ organization_id:
15253
+ examples:
15254
+ - organization_01h45ytscbebyvny4gc8cr8ma2
15255
+ format: typeid
15256
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15257
+ title: Organization Id
15258
+ type: string
15259
+ x-typeid-prefix: organization
15260
+ payload:
15261
+ additionalProperties: true
15262
+ title: Payload
15263
+ type: object
15264
+ user_id:
15265
+ title: User Id
15266
+ type: string
15267
+ required:
15268
+ - context_id
15269
+ - conversation_id
15270
+ - organization_id
15271
+ - user_id
15272
+ - created_at
15273
+ - kind
15274
+ - payload
15275
+ title: UnknownContext
15276
+ type: object
14917
15277
  UsageGranularity:
14918
15278
  enum:
14919
15279
  - day
@@ -17193,7 +17553,7 @@ info:
17193
17553
  \n\n"
17194
17554
  summary: OpusDNS - your gateway to a seamless domain management experience.
17195
17555
  title: OpusDNS API
17196
- version: 2026-09-24-012549
17556
+ version: 2026-09-24-121530
17197
17557
  x-logo:
17198
17558
  altText: OpusDNS API Reference
17199
17559
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -17223,6 +17583,7 @@ paths:
17223
17583
  discriminator:
17224
17584
  mapping:
17225
17585
  aggregations: '#/components/schemas/AggregationsContext'
17586
+ branding_design: '#/components/schemas/BrandingDesignContext'
17226
17587
  contacts: '#/components/schemas/ContactsContext'
17227
17588
  domain_forwards: '#/components/schemas/DomainForwardsContext'
17228
17589
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -17238,6 +17599,7 @@ paths:
17238
17599
  - $ref: '#/components/schemas/EmailForwardsContext'
17239
17600
  - $ref: '#/components/schemas/DomainRecommendationsContext'
17240
17601
  - $ref: '#/components/schemas/AggregationsContext'
17602
+ - $ref: '#/components/schemas/BrandingDesignContext'
17241
17603
  title: Response Get Context V1 Ai Concierge Contexts Context Id Get
17242
17604
  description: Successful Response
17243
17605
  '401':
@@ -17825,6 +18187,7 @@ paths:
17825
18187
  discriminator:
17826
18188
  mapping:
17827
18189
  aggregations: '#/components/schemas/AggregationsContext'
18190
+ branding_design: '#/components/schemas/BrandingDesignContext'
17828
18191
  contacts: '#/components/schemas/ContactsContext'
17829
18192
  domain_forwards: '#/components/schemas/DomainForwardsContext'
17830
18193
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -17840,6 +18203,7 @@ paths:
17840
18203
  - $ref: '#/components/schemas/EmailForwardsContext'
17841
18204
  - $ref: '#/components/schemas/DomainRecommendationsContext'
17842
18205
  - $ref: '#/components/schemas/AggregationsContext'
18206
+ - $ref: '#/components/schemas/BrandingDesignContext'
17843
18207
  title: Response Create Context V1 Ai Concierge Conversations Conversation
17844
18208
  Id Contexts Post
17845
18209
  description: Successful Response
package/src/schema.d.ts CHANGED
@@ -3624,6 +3624,169 @@ export interface components {
3624
3624
  */
3625
3625
  updated_on: Date;
3626
3626
  };
3627
+ /** BrandingDesignActions */
3628
+ BrandingDesignActions: {
3629
+ /** Can Activate */
3630
+ can_activate?: boolean | null;
3631
+ /** Download Filename */
3632
+ download_filename?: string | null;
3633
+ write?: components["schemas"]["BrandingDesignWrite"] | null;
3634
+ };
3635
+ /** BrandingDesignContext */
3636
+ BrandingDesignContext: {
3637
+ /**
3638
+ * Context Id
3639
+ * Format: typeid
3640
+ * @example ctx_01h45ytscbebyvny4gc8cr8ma2
3641
+ */
3642
+ context_id: TypeId<"ctx">;
3643
+ /**
3644
+ * Conversation Id
3645
+ * Format: typeid
3646
+ * @example conv_01h45ytscbebyvny4gc8cr8ma2
3647
+ */
3648
+ conversation_id: TypeId<"conv">;
3649
+ /**
3650
+ * Created At
3651
+ * Format: date-time
3652
+ */
3653
+ created_at: Date;
3654
+ /**
3655
+ * @description discriminator enum property added by openapi-typescript
3656
+ * @enum {string}
3657
+ */
3658
+ kind: "branding_design";
3659
+ /**
3660
+ * Organization Id
3661
+ * Format: typeid
3662
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3663
+ */
3664
+ organization_id: TypeId<"organization">;
3665
+ payload: components["schemas"]["BrandingDesignContextPayload"];
3666
+ /** User Id */
3667
+ user_id: string;
3668
+ };
3669
+ /** BrandingDesignContextPayload */
3670
+ BrandingDesignContextPayload: {
3671
+ actions?: components["schemas"]["BrandingDesignActions"] | null;
3672
+ diff?: components["schemas"]["BrandingDesignDiff"] | null;
3673
+ /** Results */
3674
+ results: components["schemas"]["BrandingDesignVariant"][];
3675
+ source?: components["schemas"]["BrandingDesignSource"] | null;
3676
+ /**
3677
+ * Summary
3678
+ * @default
3679
+ */
3680
+ summary: string;
3681
+ /** Warnings */
3682
+ warnings?: string[];
3683
+ };
3684
+ /** BrandingDesignContrast */
3685
+ BrandingDesignContrast: {
3686
+ /** All Pass */
3687
+ all_pass?: boolean | null;
3688
+ /** Checks */
3689
+ checks?: components["schemas"]["BrandingDesignContrastCheck"][];
3690
+ /** Min Ratio */
3691
+ min_ratio?: number | null;
3692
+ };
3693
+ /** BrandingDesignContrastCheck */
3694
+ BrandingDesignContrastCheck: {
3695
+ /** Bg */
3696
+ bg?: string | null;
3697
+ /** Fg */
3698
+ fg?: string | null;
3699
+ /** Hard */
3700
+ hard?: boolean | null;
3701
+ /** Kind */
3702
+ kind?: string | null;
3703
+ /** Max */
3704
+ max?: number | null;
3705
+ /** Min */
3706
+ min?: number | null;
3707
+ /** Mode */
3708
+ mode?: string | null;
3709
+ /** Ok */
3710
+ ok?: boolean | null;
3711
+ /** Ratio */
3712
+ ratio?: number | null;
3713
+ };
3714
+ /** BrandingDesignDiff */
3715
+ BrandingDesignDiff: {
3716
+ /** Changed Paths */
3717
+ changed_paths?: string[];
3718
+ /** Merged With Current */
3719
+ merged_with_current?: boolean | null;
3720
+ };
3721
+ /** BrandingDesignDocument */
3722
+ BrandingDesignDocument: {
3723
+ [key: string]: unknown;
3724
+ };
3725
+ /** BrandingDesignPreview */
3726
+ BrandingDesignPreview: {
3727
+ /** Font Family */
3728
+ font_family?: string | null;
3729
+ /** Mood */
3730
+ mood?: string | null;
3731
+ /** Preset Base */
3732
+ preset_base?: string | null;
3733
+ /** Radius Rem */
3734
+ radius_rem?: number | null;
3735
+ swatches?: components["schemas"]["BrandingDesignSwatches"] | null;
3736
+ };
3737
+ /** BrandingDesignSource */
3738
+ BrandingDesignSource: {
3739
+ /** Confidence */
3740
+ confidence?: string | null;
3741
+ /** Kind */
3742
+ kind?: string | null;
3743
+ /** Logo Asset Url */
3744
+ logo_asset_url?: string | null;
3745
+ /** Preset Id */
3746
+ preset_id?: string | null;
3747
+ /** Signals */
3748
+ signals?: string[];
3749
+ /** Url */
3750
+ url?: string | null;
3751
+ };
3752
+ /** BrandingDesignSwatches */
3753
+ BrandingDesignSwatches: {
3754
+ /** Dark */
3755
+ dark?: {
3756
+ [key: string]: string;
3757
+ };
3758
+ /** Light */
3759
+ light?: {
3760
+ [key: string]: string;
3761
+ };
3762
+ };
3763
+ /** BrandingDesignVariant */
3764
+ BrandingDesignVariant: {
3765
+ contrast?: components["schemas"]["BrandingDesignContrast"] | null;
3766
+ document: components["schemas"]["BrandingDesignDocument"];
3767
+ /**
3768
+ * Label
3769
+ * @default
3770
+ */
3771
+ label: string;
3772
+ preview?: components["schemas"]["BrandingDesignPreview"] | null;
3773
+ /**
3774
+ * Rationale
3775
+ * @default
3776
+ */
3777
+ rationale: string;
3778
+ /** Variant Id */
3779
+ variant_id: string;
3780
+ };
3781
+ /** BrandingDesignWrite */
3782
+ BrandingDesignWrite: {
3783
+ /** Method */
3784
+ method?: string | null;
3785
+ /** Path */
3786
+ path?: string | null;
3787
+ /** Permission */
3788
+ permission?: string | null;
3789
+ };
3627
3790
  /** BrandingDocument */
3628
3791
  BrandingDocument: {
3629
3792
  auth?: components["schemas"]["Auth"] | null;
@@ -4779,7 +4942,7 @@ export interface components {
4779
4942
  ContextListResponse: {
4780
4943
  pagination: components["schemas"]["PaginationMetadata"];
4781
4944
  /** Results */
4782
- results: (components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"])[];
4945
+ results: (components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"] | components["schemas"]["BrandingDesignContext"])[];
4783
4946
  };
4784
4947
  /** ContextMeta */
4785
4948
  ContextMeta: {
@@ -13063,6 +13226,40 @@ export interface components {
13063
13226
  */
13064
13227
  transfer_time?: string | null;
13065
13228
  };
13229
+ /** UnknownContext */
13230
+ UnknownContext: {
13231
+ /**
13232
+ * Context Id
13233
+ * Format: typeid
13234
+ * @example ctx_01h45ytscbebyvny4gc8cr8ma2
13235
+ */
13236
+ context_id: TypeId<"ctx">;
13237
+ /**
13238
+ * Conversation Id
13239
+ * Format: typeid
13240
+ * @example conv_01h45ytscbebyvny4gc8cr8ma2
13241
+ */
13242
+ conversation_id: TypeId<"conv">;
13243
+ /**
13244
+ * Created At
13245
+ * Format: date-time
13246
+ */
13247
+ created_at: Date;
13248
+ /** Kind */
13249
+ kind: string;
13250
+ /**
13251
+ * Organization Id
13252
+ * Format: typeid
13253
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
13254
+ */
13255
+ organization_id: TypeId<"organization">;
13256
+ /** Payload */
13257
+ payload: {
13258
+ [key: string]: unknown;
13259
+ };
13260
+ /** User Id */
13261
+ user_id: string;
13262
+ };
13066
13263
  /**
13067
13264
  * UsageGranularity
13068
13265
  * @enum {string}
@@ -14680,7 +14877,7 @@ export interface operations {
14680
14877
  [name: string]: unknown;
14681
14878
  };
14682
14879
  content: {
14683
- "application/json": components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"];
14880
+ "application/json": components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"] | components["schemas"]["BrandingDesignContext"];
14684
14881
  };
14685
14882
  };
14686
14883
  /** @description Unauthorized */
@@ -15292,7 +15489,7 @@ export interface operations {
15292
15489
  [name: string]: unknown;
15293
15490
  };
15294
15491
  content: {
15295
- "application/json": components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"];
15492
+ "application/json": components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"] | components["schemas"]["BrandingDesignContext"];
15296
15493
  };
15297
15494
  };
15298
15495
  /** @description Unauthorized */