@opusdns/api 1.195.0 → 1.197.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.197.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,18 @@ 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
+ BrandingDesignNotice,
26
+ BrandingDesignPreview,
27
+ BrandingDesignSource,
28
+ BrandingDesignSwatches,
29
+ BrandingDesignVariant,
30
+ BrandingDesignWrite,
19
31
  BrandingDocument,
20
32
  BrowserStatsBucket,
21
33
  BulkObjectTagChanges,
@@ -425,6 +437,7 @@ import type {
425
437
  TrademarkClaimsBase,
426
438
  TransferLockPolicyBase,
427
439
  TransferPoliciesBase,
440
+ UnknownContext,
428
441
  User,
429
442
  UserAgentStatsBucket,
430
443
  UserAgreementAcceptance,
@@ -689,6 +702,170 @@ export const KEYS_BRANDING_ASSET = [
689
702
  KEY_BRANDING_ASSET_UPDATED_ON,
690
703
  ] as const satisfies (keyof BrandingAsset)[];
691
704
 
705
+ export const KEY_BRANDING_DESIGN_ACTIONS_CAN_ACTIVATE = 'can_activate' satisfies keyof BrandingDesignActions;
706
+ export const KEY_BRANDING_DESIGN_ACTIONS_DOWNLOAD_FILENAME = 'download_filename' satisfies keyof BrandingDesignActions;
707
+ export const KEY_BRANDING_DESIGN_ACTIONS_WRITE = 'write' satisfies keyof BrandingDesignActions;
708
+
709
+ export const KEYS_BRANDING_DESIGN_ACTIONS = [
710
+ KEY_BRANDING_DESIGN_ACTIONS_CAN_ACTIVATE,
711
+ KEY_BRANDING_DESIGN_ACTIONS_DOWNLOAD_FILENAME,
712
+ KEY_BRANDING_DESIGN_ACTIONS_WRITE,
713
+ ] as const satisfies (keyof BrandingDesignActions)[];
714
+
715
+ export const KEY_BRANDING_DESIGN_CONTEXT_CONTEXT_ID = 'context_id' satisfies keyof BrandingDesignContext;
716
+ export const KEY_BRANDING_DESIGN_CONTEXT_CONVERSATION_ID = 'conversation_id' satisfies keyof BrandingDesignContext;
717
+ export const KEY_BRANDING_DESIGN_CONTEXT_CREATED_AT = 'created_at' satisfies keyof BrandingDesignContext;
718
+ export const KEY_BRANDING_DESIGN_CONTEXT_KIND = 'kind' satisfies keyof BrandingDesignContext;
719
+ export const KEY_BRANDING_DESIGN_CONTEXT_ORGANIZATION_ID = 'organization_id' satisfies keyof BrandingDesignContext;
720
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD = 'payload' satisfies keyof BrandingDesignContext;
721
+ export const KEY_BRANDING_DESIGN_CONTEXT_USER_ID = 'user_id' satisfies keyof BrandingDesignContext;
722
+
723
+ export const KEYS_BRANDING_DESIGN_CONTEXT = [
724
+ KEY_BRANDING_DESIGN_CONTEXT_CONTEXT_ID,
725
+ KEY_BRANDING_DESIGN_CONTEXT_CONVERSATION_ID,
726
+ KEY_BRANDING_DESIGN_CONTEXT_CREATED_AT,
727
+ KEY_BRANDING_DESIGN_CONTEXT_KIND,
728
+ KEY_BRANDING_DESIGN_CONTEXT_ORGANIZATION_ID,
729
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD,
730
+ KEY_BRANDING_DESIGN_CONTEXT_USER_ID,
731
+ ] as const satisfies (keyof BrandingDesignContext)[];
732
+
733
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_ACTIONS = 'actions' satisfies keyof BrandingDesignContextPayload;
734
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_DIFF = 'diff' satisfies keyof BrandingDesignContextPayload;
735
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_NOTICES = 'notices' satisfies keyof BrandingDesignContextPayload;
736
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_RESULTS = 'results' satisfies keyof BrandingDesignContextPayload;
737
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_SOURCE = 'source' satisfies keyof BrandingDesignContextPayload;
738
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_SUMMARY = 'summary' satisfies keyof BrandingDesignContextPayload;
739
+ export const KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_WARNINGS = 'warnings' satisfies keyof BrandingDesignContextPayload;
740
+
741
+ export const KEYS_BRANDING_DESIGN_CONTEXT_PAYLOAD = [
742
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_ACTIONS,
743
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_DIFF,
744
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_NOTICES,
745
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_RESULTS,
746
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_SOURCE,
747
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_SUMMARY,
748
+ KEY_BRANDING_DESIGN_CONTEXT_PAYLOAD_WARNINGS,
749
+ ] as const satisfies (keyof BrandingDesignContextPayload)[];
750
+
751
+ export const KEY_BRANDING_DESIGN_CONTRAST_ALL_PASS = 'all_pass' satisfies keyof BrandingDesignContrast;
752
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECKS = 'checks' satisfies keyof BrandingDesignContrast;
753
+ export const KEY_BRANDING_DESIGN_CONTRAST_MIN_RATIO = 'min_ratio' satisfies keyof BrandingDesignContrast;
754
+
755
+ export const KEYS_BRANDING_DESIGN_CONTRAST = [
756
+ KEY_BRANDING_DESIGN_CONTRAST_ALL_PASS,
757
+ KEY_BRANDING_DESIGN_CONTRAST_CHECKS,
758
+ KEY_BRANDING_DESIGN_CONTRAST_MIN_RATIO,
759
+ ] as const satisfies (keyof BrandingDesignContrast)[];
760
+
761
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_BG = 'bg' satisfies keyof BrandingDesignContrastCheck;
762
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_FG = 'fg' satisfies keyof BrandingDesignContrastCheck;
763
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_HARD = 'hard' satisfies keyof BrandingDesignContrastCheck;
764
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_KIND = 'kind' satisfies keyof BrandingDesignContrastCheck;
765
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_MAX = 'max' satisfies keyof BrandingDesignContrastCheck;
766
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_MIN = 'min' satisfies keyof BrandingDesignContrastCheck;
767
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_MODE = 'mode' satisfies keyof BrandingDesignContrastCheck;
768
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_OK = 'ok' satisfies keyof BrandingDesignContrastCheck;
769
+ export const KEY_BRANDING_DESIGN_CONTRAST_CHECK_RATIO = 'ratio' satisfies keyof BrandingDesignContrastCheck;
770
+
771
+ export const KEYS_BRANDING_DESIGN_CONTRAST_CHECK = [
772
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_BG,
773
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_FG,
774
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_HARD,
775
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_KIND,
776
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_MAX,
777
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_MIN,
778
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_MODE,
779
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_OK,
780
+ KEY_BRANDING_DESIGN_CONTRAST_CHECK_RATIO,
781
+ ] as const satisfies (keyof BrandingDesignContrastCheck)[];
782
+
783
+ export const KEY_BRANDING_DESIGN_DIFF_CHANGED_PATHS = 'changed_paths' satisfies keyof BrandingDesignDiff;
784
+ export const KEY_BRANDING_DESIGN_DIFF_MERGED_WITH_CURRENT = 'merged_with_current' satisfies keyof BrandingDesignDiff;
785
+
786
+ export const KEYS_BRANDING_DESIGN_DIFF = [
787
+ KEY_BRANDING_DESIGN_DIFF_CHANGED_PATHS,
788
+ KEY_BRANDING_DESIGN_DIFF_MERGED_WITH_CURRENT,
789
+ ] as const satisfies (keyof BrandingDesignDiff)[];
790
+
791
+ export const KEY_BRANDING_DESIGN_NOTICE_CODE = 'code' satisfies keyof BrandingDesignNotice;
792
+ export const KEY_BRANDING_DESIGN_NOTICE_MESSAGE = 'message' satisfies keyof BrandingDesignNotice;
793
+ export const KEY_BRANDING_DESIGN_NOTICE_PARAMS = 'params' satisfies keyof BrandingDesignNotice;
794
+ export const KEY_BRANDING_DESIGN_NOTICE_SEVERITY = 'severity' satisfies keyof BrandingDesignNotice;
795
+
796
+ export const KEYS_BRANDING_DESIGN_NOTICE = [
797
+ KEY_BRANDING_DESIGN_NOTICE_CODE,
798
+ KEY_BRANDING_DESIGN_NOTICE_MESSAGE,
799
+ KEY_BRANDING_DESIGN_NOTICE_PARAMS,
800
+ KEY_BRANDING_DESIGN_NOTICE_SEVERITY,
801
+ ] as const satisfies (keyof BrandingDesignNotice)[];
802
+
803
+ export const KEY_BRANDING_DESIGN_PREVIEW_FONT_FAMILY = 'font_family' satisfies keyof BrandingDesignPreview;
804
+ export const KEY_BRANDING_DESIGN_PREVIEW_MOOD = 'mood' satisfies keyof BrandingDesignPreview;
805
+ export const KEY_BRANDING_DESIGN_PREVIEW_PRESET_BASE = 'preset_base' satisfies keyof BrandingDesignPreview;
806
+ export const KEY_BRANDING_DESIGN_PREVIEW_RADIUS_REM = 'radius_rem' satisfies keyof BrandingDesignPreview;
807
+ export const KEY_BRANDING_DESIGN_PREVIEW_SWATCHES = 'swatches' satisfies keyof BrandingDesignPreview;
808
+
809
+ export const KEYS_BRANDING_DESIGN_PREVIEW = [
810
+ KEY_BRANDING_DESIGN_PREVIEW_FONT_FAMILY,
811
+ KEY_BRANDING_DESIGN_PREVIEW_MOOD,
812
+ KEY_BRANDING_DESIGN_PREVIEW_PRESET_BASE,
813
+ KEY_BRANDING_DESIGN_PREVIEW_RADIUS_REM,
814
+ KEY_BRANDING_DESIGN_PREVIEW_SWATCHES,
815
+ ] as const satisfies (keyof BrandingDesignPreview)[];
816
+
817
+ export const KEY_BRANDING_DESIGN_SOURCE_CONFIDENCE = 'confidence' satisfies keyof BrandingDesignSource;
818
+ export const KEY_BRANDING_DESIGN_SOURCE_KIND = 'kind' satisfies keyof BrandingDesignSource;
819
+ export const KEY_BRANDING_DESIGN_SOURCE_LOGO_ASSET_URL = 'logo_asset_url' satisfies keyof BrandingDesignSource;
820
+ export const KEY_BRANDING_DESIGN_SOURCE_PRESET_ID = 'preset_id' satisfies keyof BrandingDesignSource;
821
+ export const KEY_BRANDING_DESIGN_SOURCE_SIGNALS = 'signals' satisfies keyof BrandingDesignSource;
822
+ export const KEY_BRANDING_DESIGN_SOURCE_URL = 'url' satisfies keyof BrandingDesignSource;
823
+
824
+ export const KEYS_BRANDING_DESIGN_SOURCE = [
825
+ KEY_BRANDING_DESIGN_SOURCE_CONFIDENCE,
826
+ KEY_BRANDING_DESIGN_SOURCE_KIND,
827
+ KEY_BRANDING_DESIGN_SOURCE_LOGO_ASSET_URL,
828
+ KEY_BRANDING_DESIGN_SOURCE_PRESET_ID,
829
+ KEY_BRANDING_DESIGN_SOURCE_SIGNALS,
830
+ KEY_BRANDING_DESIGN_SOURCE_URL,
831
+ ] as const satisfies (keyof BrandingDesignSource)[];
832
+
833
+ export const KEY_BRANDING_DESIGN_SWATCHES_DARK = 'dark' satisfies keyof BrandingDesignSwatches;
834
+ export const KEY_BRANDING_DESIGN_SWATCHES_LIGHT = 'light' satisfies keyof BrandingDesignSwatches;
835
+
836
+ export const KEYS_BRANDING_DESIGN_SWATCHES = [
837
+ KEY_BRANDING_DESIGN_SWATCHES_DARK,
838
+ KEY_BRANDING_DESIGN_SWATCHES_LIGHT,
839
+ ] as const satisfies (keyof BrandingDesignSwatches)[];
840
+
841
+ export const KEY_BRANDING_DESIGN_VARIANT_CHANGED_SEEDS = 'changed_seeds' satisfies keyof BrandingDesignVariant;
842
+ export const KEY_BRANDING_DESIGN_VARIANT_CONTRAST = 'contrast' satisfies keyof BrandingDesignVariant;
843
+ export const KEY_BRANDING_DESIGN_VARIANT_DOCUMENT = 'document' satisfies keyof BrandingDesignVariant;
844
+ export const KEY_BRANDING_DESIGN_VARIANT_LABEL = 'label' satisfies keyof BrandingDesignVariant;
845
+ export const KEY_BRANDING_DESIGN_VARIANT_PREVIEW = 'preview' satisfies keyof BrandingDesignVariant;
846
+ export const KEY_BRANDING_DESIGN_VARIANT_RATIONALE = 'rationale' satisfies keyof BrandingDesignVariant;
847
+ export const KEY_BRANDING_DESIGN_VARIANT_VARIANT_ID = 'variant_id' satisfies keyof BrandingDesignVariant;
848
+
849
+ export const KEYS_BRANDING_DESIGN_VARIANT = [
850
+ KEY_BRANDING_DESIGN_VARIANT_CHANGED_SEEDS,
851
+ KEY_BRANDING_DESIGN_VARIANT_CONTRAST,
852
+ KEY_BRANDING_DESIGN_VARIANT_DOCUMENT,
853
+ KEY_BRANDING_DESIGN_VARIANT_LABEL,
854
+ KEY_BRANDING_DESIGN_VARIANT_PREVIEW,
855
+ KEY_BRANDING_DESIGN_VARIANT_RATIONALE,
856
+ KEY_BRANDING_DESIGN_VARIANT_VARIANT_ID,
857
+ ] as const satisfies (keyof BrandingDesignVariant)[];
858
+
859
+ export const KEY_BRANDING_DESIGN_WRITE_METHOD = 'method' satisfies keyof BrandingDesignWrite;
860
+ export const KEY_BRANDING_DESIGN_WRITE_PATH = 'path' satisfies keyof BrandingDesignWrite;
861
+ export const KEY_BRANDING_DESIGN_WRITE_PERMISSION = 'permission' satisfies keyof BrandingDesignWrite;
862
+
863
+ export const KEYS_BRANDING_DESIGN_WRITE = [
864
+ KEY_BRANDING_DESIGN_WRITE_METHOD,
865
+ KEY_BRANDING_DESIGN_WRITE_PATH,
866
+ KEY_BRANDING_DESIGN_WRITE_PERMISSION,
867
+ ] as const satisfies (keyof BrandingDesignWrite)[];
868
+
692
869
  export const KEY_BRANDING_DOCUMENT_AUTH = 'auth' satisfies keyof BrandingDocument;
693
870
  export const KEY_BRANDING_DOCUMENT_BRAND = 'brand' satisfies keyof BrandingDocument;
694
871
  export const KEY_BRANDING_DOCUMENT_CONTENT = 'content' satisfies keyof BrandingDocument;
@@ -5795,6 +5972,24 @@ export const KEYS_TRANSFER_POLICIES_BASE = [
5795
5972
  KEY_TRANSFER_POLICIES_BASE_TRANSFER_TIME,
5796
5973
  ] as const satisfies (keyof TransferPoliciesBase)[];
5797
5974
 
5975
+ export const KEY_UNKNOWN_CONTEXT_CONTEXT_ID = 'context_id' satisfies keyof UnknownContext;
5976
+ export const KEY_UNKNOWN_CONTEXT_CONVERSATION_ID = 'conversation_id' satisfies keyof UnknownContext;
5977
+ export const KEY_UNKNOWN_CONTEXT_CREATED_AT = 'created_at' satisfies keyof UnknownContext;
5978
+ export const KEY_UNKNOWN_CONTEXT_KIND = 'kind' satisfies keyof UnknownContext;
5979
+ export const KEY_UNKNOWN_CONTEXT_ORGANIZATION_ID = 'organization_id' satisfies keyof UnknownContext;
5980
+ export const KEY_UNKNOWN_CONTEXT_PAYLOAD = 'payload' satisfies keyof UnknownContext;
5981
+ export const KEY_UNKNOWN_CONTEXT_USER_ID = 'user_id' satisfies keyof UnknownContext;
5982
+
5983
+ export const KEYS_UNKNOWN_CONTEXT = [
5984
+ KEY_UNKNOWN_CONTEXT_CONTEXT_ID,
5985
+ KEY_UNKNOWN_CONTEXT_CONVERSATION_ID,
5986
+ KEY_UNKNOWN_CONTEXT_CREATED_AT,
5987
+ KEY_UNKNOWN_CONTEXT_KIND,
5988
+ KEY_UNKNOWN_CONTEXT_ORGANIZATION_ID,
5989
+ KEY_UNKNOWN_CONTEXT_PAYLOAD,
5990
+ KEY_UNKNOWN_CONTEXT_USER_ID,
5991
+ ] as const satisfies (keyof UnknownContext)[];
5992
+
5798
5993
  export const KEY_USER_CREATED_ON = 'created_on' satisfies keyof User;
5799
5994
  export const KEY_USER_EMAIL = 'email' satisfies keyof User;
5800
5995
  export const KEY_USER_FIRST_NAME = 'first_name' satisfies keyof User;
@@ -28,6 +28,19 @@ 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 BrandingDesignNotice = components['schemas']['BrandingDesignNotice'];
39
+ export type BrandingDesignPreview = components['schemas']['BrandingDesignPreview'];
40
+ export type BrandingDesignSource = components['schemas']['BrandingDesignSource'];
41
+ export type BrandingDesignSwatches = components['schemas']['BrandingDesignSwatches'];
42
+ export type BrandingDesignVariant = components['schemas']['BrandingDesignVariant'];
43
+ export type BrandingDesignWrite = components['schemas']['BrandingDesignWrite'];
31
44
  export type BrandingDocument = components['schemas']['BrandingDocument'];
32
45
  export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
33
46
  export type BulkObjectTagChanges = components['schemas']['BulkObjectTagChanges'];
@@ -564,6 +577,7 @@ export type TrademarkClaimsBase = components['schemas']['TrademarkClaimsBase'];
564
577
  export type TransferAckType = components['schemas']['TransferAckType'];
565
578
  export type TransferLockPolicyBase = components['schemas']['TransferLockPolicyBase'];
566
579
  export type TransferPoliciesBase = components['schemas']['TransferPoliciesBase'];
580
+ export type UnknownContext = components['schemas']['UnknownContext'];
567
581
  export type UsageGranularity = components['schemas']['UsageGranularity'];
568
582
  export type UsageProduct = components['schemas']['UsageProduct'];
569
583
  export type User = components['schemas']['User'];
package/src/openapi.yaml CHANGED
@@ -594,6 +594,353 @@ 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
+ notices:
675
+ items:
676
+ $ref: '#/components/schemas/BrandingDesignNotice'
677
+ title: Notices
678
+ type: array
679
+ results:
680
+ items:
681
+ $ref: '#/components/schemas/BrandingDesignVariant'
682
+ title: Results
683
+ type: array
684
+ source:
685
+ anyOf:
686
+ - $ref: '#/components/schemas/BrandingDesignSource'
687
+ - type: 'null'
688
+ summary:
689
+ default: ''
690
+ title: Summary
691
+ type: string
692
+ warnings:
693
+ items:
694
+ type: string
695
+ title: Warnings
696
+ type: array
697
+ required:
698
+ - results
699
+ title: BrandingDesignContextPayload
700
+ type: object
701
+ BrandingDesignContrast:
702
+ properties:
703
+ all_pass:
704
+ anyOf:
705
+ - type: boolean
706
+ - type: 'null'
707
+ title: All Pass
708
+ checks:
709
+ items:
710
+ $ref: '#/components/schemas/BrandingDesignContrastCheck'
711
+ title: Checks
712
+ type: array
713
+ min_ratio:
714
+ anyOf:
715
+ - type: number
716
+ - type: 'null'
717
+ title: Min Ratio
718
+ title: BrandingDesignContrast
719
+ type: object
720
+ BrandingDesignContrastCheck:
721
+ properties:
722
+ bg:
723
+ anyOf:
724
+ - type: string
725
+ - type: 'null'
726
+ title: Bg
727
+ fg:
728
+ anyOf:
729
+ - type: string
730
+ - type: 'null'
731
+ title: Fg
732
+ hard:
733
+ anyOf:
734
+ - type: boolean
735
+ - type: 'null'
736
+ title: Hard
737
+ kind:
738
+ anyOf:
739
+ - type: string
740
+ - type: 'null'
741
+ title: Kind
742
+ max:
743
+ anyOf:
744
+ - type: number
745
+ - type: 'null'
746
+ title: Max
747
+ min:
748
+ anyOf:
749
+ - type: number
750
+ - type: 'null'
751
+ title: Min
752
+ mode:
753
+ anyOf:
754
+ - type: string
755
+ - type: 'null'
756
+ title: Mode
757
+ ok:
758
+ anyOf:
759
+ - type: boolean
760
+ - type: 'null'
761
+ title: Ok
762
+ ratio:
763
+ anyOf:
764
+ - type: number
765
+ - type: 'null'
766
+ title: Ratio
767
+ title: BrandingDesignContrastCheck
768
+ type: object
769
+ BrandingDesignDiff:
770
+ properties:
771
+ changed_paths:
772
+ items:
773
+ type: string
774
+ title: Changed Paths
775
+ type: array
776
+ merged_with_current:
777
+ anyOf:
778
+ - type: boolean
779
+ - type: 'null'
780
+ title: Merged With Current
781
+ title: BrandingDesignDiff
782
+ type: object
783
+ BrandingDesignDocument:
784
+ additionalProperties: true
785
+ title: BrandingDesignDocument
786
+ type: object
787
+ BrandingDesignNotice:
788
+ properties:
789
+ code:
790
+ title: Code
791
+ type: string
792
+ message:
793
+ default: ''
794
+ title: Message
795
+ type: string
796
+ params:
797
+ additionalProperties:
798
+ anyOf:
799
+ - type: string
800
+ - type: integer
801
+ - type: number
802
+ - type: boolean
803
+ - items:
804
+ type: string
805
+ type: array
806
+ title: Params
807
+ type: object
808
+ severity:
809
+ title: Severity
810
+ type: string
811
+ required:
812
+ - code
813
+ - severity
814
+ title: BrandingDesignNotice
815
+ type: object
816
+ BrandingDesignPreview:
817
+ properties:
818
+ font_family:
819
+ anyOf:
820
+ - type: string
821
+ - type: 'null'
822
+ title: Font Family
823
+ mood:
824
+ anyOf:
825
+ - type: string
826
+ - type: 'null'
827
+ title: Mood
828
+ preset_base:
829
+ anyOf:
830
+ - type: string
831
+ - type: 'null'
832
+ title: Preset Base
833
+ radius_rem:
834
+ anyOf:
835
+ - type: number
836
+ - type: 'null'
837
+ title: Radius Rem
838
+ swatches:
839
+ anyOf:
840
+ - $ref: '#/components/schemas/BrandingDesignSwatches'
841
+ - type: 'null'
842
+ title: BrandingDesignPreview
843
+ type: object
844
+ BrandingDesignSource:
845
+ properties:
846
+ confidence:
847
+ anyOf:
848
+ - type: string
849
+ - type: 'null'
850
+ title: Confidence
851
+ kind:
852
+ anyOf:
853
+ - type: string
854
+ - type: 'null'
855
+ title: Kind
856
+ logo_asset_url:
857
+ anyOf:
858
+ - type: string
859
+ - type: 'null'
860
+ title: Logo Asset Url
861
+ preset_id:
862
+ anyOf:
863
+ - type: string
864
+ - type: 'null'
865
+ title: Preset Id
866
+ signals:
867
+ items:
868
+ type: string
869
+ title: Signals
870
+ type: array
871
+ url:
872
+ anyOf:
873
+ - type: string
874
+ - type: 'null'
875
+ title: Url
876
+ title: BrandingDesignSource
877
+ type: object
878
+ BrandingDesignSwatches:
879
+ properties:
880
+ dark:
881
+ additionalProperties:
882
+ type: string
883
+ title: Dark
884
+ type: object
885
+ light:
886
+ additionalProperties:
887
+ type: string
888
+ title: Light
889
+ type: object
890
+ title: BrandingDesignSwatches
891
+ type: object
892
+ BrandingDesignVariant:
893
+ properties:
894
+ changed_seeds:
895
+ items:
896
+ type: string
897
+ title: Changed Seeds
898
+ type: array
899
+ contrast:
900
+ anyOf:
901
+ - $ref: '#/components/schemas/BrandingDesignContrast'
902
+ - type: 'null'
903
+ document:
904
+ $ref: '#/components/schemas/BrandingDesignDocument'
905
+ label:
906
+ default: ''
907
+ title: Label
908
+ type: string
909
+ preview:
910
+ anyOf:
911
+ - $ref: '#/components/schemas/BrandingDesignPreview'
912
+ - type: 'null'
913
+ rationale:
914
+ default: ''
915
+ title: Rationale
916
+ type: string
917
+ variant_id:
918
+ title: Variant Id
919
+ type: string
920
+ required:
921
+ - variant_id
922
+ - document
923
+ title: BrandingDesignVariant
924
+ type: object
925
+ BrandingDesignWrite:
926
+ properties:
927
+ method:
928
+ anyOf:
929
+ - type: string
930
+ - type: 'null'
931
+ title: Method
932
+ path:
933
+ anyOf:
934
+ - type: string
935
+ - type: 'null'
936
+ title: Path
937
+ permission:
938
+ anyOf:
939
+ - type: string
940
+ - type: 'null'
941
+ title: Permission
942
+ title: BrandingDesignWrite
943
+ type: object
597
944
  BrandingDocument:
598
945
  properties:
599
946
  auth:
@@ -2294,6 +2641,7 @@ components:
2294
2641
  discriminator:
2295
2642
  mapping:
2296
2643
  aggregations: '#/components/schemas/AggregationsContext'
2644
+ branding_design: '#/components/schemas/BrandingDesignContext'
2297
2645
  contacts: '#/components/schemas/ContactsContext'
2298
2646
  domain_forwards: '#/components/schemas/DomainForwardsContext'
2299
2647
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -2309,6 +2657,7 @@ components:
2309
2657
  - $ref: '#/components/schemas/EmailForwardsContext'
2310
2658
  - $ref: '#/components/schemas/DomainRecommendationsContext'
2311
2659
  - $ref: '#/components/schemas/AggregationsContext'
2660
+ - $ref: '#/components/schemas/BrandingDesignContext'
2312
2661
  title: Results
2313
2662
  type: array
2314
2663
  required:
@@ -14914,6 +15263,56 @@ components:
14914
15263
  - authinfo_required
14915
15264
  title: TransferPoliciesBase
14916
15265
  type: object
15266
+ UnknownContext:
15267
+ properties:
15268
+ context_id:
15269
+ examples:
15270
+ - ctx_01h45ytscbebyvny4gc8cr8ma2
15271
+ format: typeid
15272
+ pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15273
+ title: Context Id
15274
+ type: string
15275
+ x-typeid-prefix: ctx
15276
+ conversation_id:
15277
+ examples:
15278
+ - conv_01h45ytscbebyvny4gc8cr8ma2
15279
+ format: typeid
15280
+ pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15281
+ title: Conversation Id
15282
+ type: string
15283
+ x-typeid-prefix: conv
15284
+ created_at:
15285
+ format: date-time
15286
+ title: Created At
15287
+ type: string
15288
+ kind:
15289
+ title: Kind
15290
+ type: string
15291
+ organization_id:
15292
+ examples:
15293
+ - organization_01h45ytscbebyvny4gc8cr8ma2
15294
+ format: typeid
15295
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15296
+ title: Organization Id
15297
+ type: string
15298
+ x-typeid-prefix: organization
15299
+ payload:
15300
+ additionalProperties: true
15301
+ title: Payload
15302
+ type: object
15303
+ user_id:
15304
+ title: User Id
15305
+ type: string
15306
+ required:
15307
+ - context_id
15308
+ - conversation_id
15309
+ - organization_id
15310
+ - user_id
15311
+ - created_at
15312
+ - kind
15313
+ - payload
15314
+ title: UnknownContext
15315
+ type: object
14917
15316
  UsageGranularity:
14918
15317
  enum:
14919
15318
  - day
@@ -17193,7 +17592,7 @@ info:
17193
17592
  \n\n"
17194
17593
  summary: OpusDNS - your gateway to a seamless domain management experience.
17195
17594
  title: OpusDNS API
17196
- version: 2026-09-24-012549
17595
+ version: 2026-09-24-132444
17197
17596
  x-logo:
17198
17597
  altText: OpusDNS API Reference
17199
17598
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -17223,6 +17622,7 @@ paths:
17223
17622
  discriminator:
17224
17623
  mapping:
17225
17624
  aggregations: '#/components/schemas/AggregationsContext'
17625
+ branding_design: '#/components/schemas/BrandingDesignContext'
17226
17626
  contacts: '#/components/schemas/ContactsContext'
17227
17627
  domain_forwards: '#/components/schemas/DomainForwardsContext'
17228
17628
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -17238,6 +17638,7 @@ paths:
17238
17638
  - $ref: '#/components/schemas/EmailForwardsContext'
17239
17639
  - $ref: '#/components/schemas/DomainRecommendationsContext'
17240
17640
  - $ref: '#/components/schemas/AggregationsContext'
17641
+ - $ref: '#/components/schemas/BrandingDesignContext'
17241
17642
  title: Response Get Context V1 Ai Concierge Contexts Context Id Get
17242
17643
  description: Successful Response
17243
17644
  '401':
@@ -17825,6 +18226,7 @@ paths:
17825
18226
  discriminator:
17826
18227
  mapping:
17827
18228
  aggregations: '#/components/schemas/AggregationsContext'
18229
+ branding_design: '#/components/schemas/BrandingDesignContext'
17828
18230
  contacts: '#/components/schemas/ContactsContext'
17829
18231
  domain_forwards: '#/components/schemas/DomainForwardsContext'
17830
18232
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -17840,6 +18242,7 @@ paths:
17840
18242
  - $ref: '#/components/schemas/EmailForwardsContext'
17841
18243
  - $ref: '#/components/schemas/DomainRecommendationsContext'
17842
18244
  - $ref: '#/components/schemas/AggregationsContext'
18245
+ - $ref: '#/components/schemas/BrandingDesignContext'
17843
18246
  title: Response Create Context V1 Ai Concierge Conversations Conversation
17844
18247
  Id Contexts Post
17845
18248
  description: Successful Response
package/src/schema.d.ts CHANGED
@@ -3624,6 +3624,189 @@ 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
+ /** Notices */
3674
+ notices?: components["schemas"]["BrandingDesignNotice"][];
3675
+ /** Results */
3676
+ results: components["schemas"]["BrandingDesignVariant"][];
3677
+ source?: components["schemas"]["BrandingDesignSource"] | null;
3678
+ /**
3679
+ * Summary
3680
+ * @default
3681
+ */
3682
+ summary: string;
3683
+ /** Warnings */
3684
+ warnings?: string[];
3685
+ };
3686
+ /** BrandingDesignContrast */
3687
+ BrandingDesignContrast: {
3688
+ /** All Pass */
3689
+ all_pass?: boolean | null;
3690
+ /** Checks */
3691
+ checks?: components["schemas"]["BrandingDesignContrastCheck"][];
3692
+ /** Min Ratio */
3693
+ min_ratio?: number | null;
3694
+ };
3695
+ /** BrandingDesignContrastCheck */
3696
+ BrandingDesignContrastCheck: {
3697
+ /** Bg */
3698
+ bg?: string | null;
3699
+ /** Fg */
3700
+ fg?: string | null;
3701
+ /** Hard */
3702
+ hard?: boolean | null;
3703
+ /** Kind */
3704
+ kind?: string | null;
3705
+ /** Max */
3706
+ max?: number | null;
3707
+ /** Min */
3708
+ min?: number | null;
3709
+ /** Mode */
3710
+ mode?: string | null;
3711
+ /** Ok */
3712
+ ok?: boolean | null;
3713
+ /** Ratio */
3714
+ ratio?: number | null;
3715
+ };
3716
+ /** BrandingDesignDiff */
3717
+ BrandingDesignDiff: {
3718
+ /** Changed Paths */
3719
+ changed_paths?: string[];
3720
+ /** Merged With Current */
3721
+ merged_with_current?: boolean | null;
3722
+ };
3723
+ /** BrandingDesignDocument */
3724
+ BrandingDesignDocument: {
3725
+ [key: string]: unknown;
3726
+ };
3727
+ /** BrandingDesignNotice */
3728
+ BrandingDesignNotice: {
3729
+ /** Code */
3730
+ code: string;
3731
+ /**
3732
+ * Message
3733
+ * @default
3734
+ */
3735
+ message: string;
3736
+ /** Params */
3737
+ params?: {
3738
+ [key: string]: string | number | boolean | string[];
3739
+ };
3740
+ /** Severity */
3741
+ severity: string;
3742
+ };
3743
+ /** BrandingDesignPreview */
3744
+ BrandingDesignPreview: {
3745
+ /** Font Family */
3746
+ font_family?: string | null;
3747
+ /** Mood */
3748
+ mood?: string | null;
3749
+ /** Preset Base */
3750
+ preset_base?: string | null;
3751
+ /** Radius Rem */
3752
+ radius_rem?: number | null;
3753
+ swatches?: components["schemas"]["BrandingDesignSwatches"] | null;
3754
+ };
3755
+ /** BrandingDesignSource */
3756
+ BrandingDesignSource: {
3757
+ /** Confidence */
3758
+ confidence?: string | null;
3759
+ /** Kind */
3760
+ kind?: string | null;
3761
+ /** Logo Asset Url */
3762
+ logo_asset_url?: string | null;
3763
+ /** Preset Id */
3764
+ preset_id?: string | null;
3765
+ /** Signals */
3766
+ signals?: string[];
3767
+ /** Url */
3768
+ url?: string | null;
3769
+ };
3770
+ /** BrandingDesignSwatches */
3771
+ BrandingDesignSwatches: {
3772
+ /** Dark */
3773
+ dark?: {
3774
+ [key: string]: string;
3775
+ };
3776
+ /** Light */
3777
+ light?: {
3778
+ [key: string]: string;
3779
+ };
3780
+ };
3781
+ /** BrandingDesignVariant */
3782
+ BrandingDesignVariant: {
3783
+ /** Changed Seeds */
3784
+ changed_seeds?: string[];
3785
+ contrast?: components["schemas"]["BrandingDesignContrast"] | null;
3786
+ document: components["schemas"]["BrandingDesignDocument"];
3787
+ /**
3788
+ * Label
3789
+ * @default
3790
+ */
3791
+ label: string;
3792
+ preview?: components["schemas"]["BrandingDesignPreview"] | null;
3793
+ /**
3794
+ * Rationale
3795
+ * @default
3796
+ */
3797
+ rationale: string;
3798
+ /** Variant Id */
3799
+ variant_id: string;
3800
+ };
3801
+ /** BrandingDesignWrite */
3802
+ BrandingDesignWrite: {
3803
+ /** Method */
3804
+ method?: string | null;
3805
+ /** Path */
3806
+ path?: string | null;
3807
+ /** Permission */
3808
+ permission?: string | null;
3809
+ };
3627
3810
  /** BrandingDocument */
3628
3811
  BrandingDocument: {
3629
3812
  auth?: components["schemas"]["Auth"] | null;
@@ -4779,7 +4962,7 @@ export interface components {
4779
4962
  ContextListResponse: {
4780
4963
  pagination: components["schemas"]["PaginationMetadata"];
4781
4964
  /** Results */
4782
- results: (components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"])[];
4965
+ 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
4966
  };
4784
4967
  /** ContextMeta */
4785
4968
  ContextMeta: {
@@ -13063,6 +13246,40 @@ export interface components {
13063
13246
  */
13064
13247
  transfer_time?: string | null;
13065
13248
  };
13249
+ /** UnknownContext */
13250
+ UnknownContext: {
13251
+ /**
13252
+ * Context Id
13253
+ * Format: typeid
13254
+ * @example ctx_01h45ytscbebyvny4gc8cr8ma2
13255
+ */
13256
+ context_id: TypeId<"ctx">;
13257
+ /**
13258
+ * Conversation Id
13259
+ * Format: typeid
13260
+ * @example conv_01h45ytscbebyvny4gc8cr8ma2
13261
+ */
13262
+ conversation_id: TypeId<"conv">;
13263
+ /**
13264
+ * Created At
13265
+ * Format: date-time
13266
+ */
13267
+ created_at: Date;
13268
+ /** Kind */
13269
+ kind: string;
13270
+ /**
13271
+ * Organization Id
13272
+ * Format: typeid
13273
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
13274
+ */
13275
+ organization_id: TypeId<"organization">;
13276
+ /** Payload */
13277
+ payload: {
13278
+ [key: string]: unknown;
13279
+ };
13280
+ /** User Id */
13281
+ user_id: string;
13282
+ };
13066
13283
  /**
13067
13284
  * UsageGranularity
13068
13285
  * @enum {string}
@@ -14680,7 +14897,7 @@ export interface operations {
14680
14897
  [name: string]: unknown;
14681
14898
  };
14682
14899
  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"];
14900
+ "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
14901
  };
14685
14902
  };
14686
14903
  /** @description Unauthorized */
@@ -15292,7 +15509,7 @@ export interface operations {
15292
15509
  [name: string]: unknown;
15293
15510
  };
15294
15511
  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"];
15512
+ "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
15513
  };
15297
15514
  };
15298
15515
  /** @description Unauthorized */