@opusdns/api 1.77.0 → 1.79.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.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.77.0",
6
+ "version": "1.79.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -277,6 +277,9 @@ import type {
277
277
  ListZonesReferencingSetRes,
278
278
  LocalPresenceBase,
279
279
  Logo,
280
+ MailTemplate,
281
+ MailTemplateBlock,
282
+ MailTemplateVariable,
280
283
  MemoryFact,
281
284
  MemoryFactCreateRequest,
282
285
  MemoryFactList,
@@ -3344,15 +3347,11 @@ export const KEYS_EVENT_RESPONSE = [
3344
3347
  KEY_EVENT_RESPONSE_TYPE,
3345
3348
  ] as const satisfies (keyof EventResponse)[];
3346
3349
 
3347
- export const KEY_FOOTER_CONTACT_EMAIL = 'contact_email' satisfies keyof Footer;
3348
- export const KEY_FOOTER_DISCLAIMER = 'disclaimer' satisfies keyof Footer;
3349
3350
  export const KEY_FOOTER_LEGAL_ENTITY = 'legal_entity' satisfies keyof Footer;
3350
3351
  export const KEY_FOOTER_LINES = 'lines' satisfies keyof Footer;
3351
3352
  export const KEY_FOOTER_VAT_ID = 'vat_id' satisfies keyof Footer;
3352
3353
 
3353
3354
  export const KEYS_FOOTER = [
3354
- KEY_FOOTER_CONTACT_EMAIL,
3355
- KEY_FOOTER_DISCLAIMER,
3356
3355
  KEY_FOOTER_LEGAL_ENTITY,
3357
3356
  KEY_FOOTER_LINES,
3358
3357
  KEY_FOOTER_VAT_ID,
@@ -3808,6 +3807,42 @@ export const KEYS_LOGO = [
3808
3807
  KEY_LOGO_LIGHT,
3809
3808
  ] as const satisfies (keyof Logo)[];
3810
3809
 
3810
+ export const KEY_MAIL_TEMPLATE_BLOCKS = 'blocks' satisfies keyof MailTemplate;
3811
+ export const KEY_MAIL_TEMPLATE_LOCALES = 'locales' satisfies keyof MailTemplate;
3812
+ export const KEY_MAIL_TEMPLATE_SUBJECT = 'subject' satisfies keyof MailTemplate;
3813
+ export const KEY_MAIL_TEMPLATE_VARIABLES = 'variables' satisfies keyof MailTemplate;
3814
+ export const KEY_MAIL_TEMPLATE_VERSION = 'version' satisfies keyof MailTemplate;
3815
+
3816
+ export const KEYS_MAIL_TEMPLATE = [
3817
+ KEY_MAIL_TEMPLATE_BLOCKS,
3818
+ KEY_MAIL_TEMPLATE_LOCALES,
3819
+ KEY_MAIL_TEMPLATE_SUBJECT,
3820
+ KEY_MAIL_TEMPLATE_VARIABLES,
3821
+ KEY_MAIL_TEMPLATE_VERSION,
3822
+ ] as const satisfies (keyof MailTemplate)[];
3823
+
3824
+ export const KEY_MAIL_TEMPLATE_BLOCK_DEFAULT = 'default' satisfies keyof MailTemplateBlock;
3825
+ export const KEY_MAIL_TEMPLATE_BLOCK_LABEL = 'label' satisfies keyof MailTemplateBlock;
3826
+ export const KEY_MAIL_TEMPLATE_BLOCK_MAX_LEN = 'max_len' satisfies keyof MailTemplateBlock;
3827
+ export const KEY_MAIL_TEMPLATE_BLOCK_MULTILINE = 'multiline' satisfies keyof MailTemplateBlock;
3828
+
3829
+ export const KEYS_MAIL_TEMPLATE_BLOCK = [
3830
+ KEY_MAIL_TEMPLATE_BLOCK_DEFAULT,
3831
+ KEY_MAIL_TEMPLATE_BLOCK_LABEL,
3832
+ KEY_MAIL_TEMPLATE_BLOCK_MAX_LEN,
3833
+ KEY_MAIL_TEMPLATE_BLOCK_MULTILINE,
3834
+ ] as const satisfies (keyof MailTemplateBlock)[];
3835
+
3836
+ export const KEY_MAIL_TEMPLATE_VARIABLE_REQUIRED = 'required' satisfies keyof MailTemplateVariable;
3837
+ export const KEY_MAIL_TEMPLATE_VARIABLE_SAMPLE = 'sample' satisfies keyof MailTemplateVariable;
3838
+ export const KEY_MAIL_TEMPLATE_VARIABLE_TYPE = 'type' satisfies keyof MailTemplateVariable;
3839
+
3840
+ export const KEYS_MAIL_TEMPLATE_VARIABLE = [
3841
+ KEY_MAIL_TEMPLATE_VARIABLE_REQUIRED,
3842
+ KEY_MAIL_TEMPLATE_VARIABLE_SAMPLE,
3843
+ KEY_MAIL_TEMPLATE_VARIABLE_TYPE,
3844
+ ] as const satisfies (keyof MailTemplateVariable)[];
3845
+
3811
3846
  export const KEY_MEMORY_FACT_CREATED_AT = 'created_at' satisfies keyof MemoryFact;
3812
3847
  export const KEY_MEMORY_FACT_EXPIRES_AT = 'expires_at' satisfies keyof MemoryFact;
3813
3848
  export const KEY_MEMORY_FACT_FACT_ID = 'fact_id' satisfies keyof MemoryFact;
@@ -53,6 +53,7 @@ import type {
53
53
  JobBatchStatus,
54
54
  ListVanityNameserverSetsRes,
55
55
  ListZonesReferencingSetRes,
56
+ MailTemplateCatalogRes,
56
57
  MemoryFact,
57
58
  MemoryFactList,
58
59
  Message,
@@ -861,8 +862,9 @@ export type GET_WhitelabelBranding_Response = GET_WhitelabelBranding_Response_20
861
862
  export type GET_WhitelabelBranding_Response_200 = WhitelabelBranding;
862
863
  export type GET_WhitelabelBranding_Response_422 = HTTPValidationError;
863
864
 
864
- export type GET_WhitelabelBrandingEmailTemplates_Response = GET_WhitelabelBrandingEmailTemplates_Response_422;
865
+ export type GET_WhitelabelBrandingEmailTemplates_Response = GET_WhitelabelBrandingEmailTemplates_Response_200 | GET_WhitelabelBrandingEmailTemplates_Response_422;
865
866
 
867
+ export type GET_WhitelabelBrandingEmailTemplates_Response_200 = MailTemplateCatalogRes;
866
868
  export type GET_WhitelabelBrandingEmailTemplates_Response_422 = HTTPValidationError;
867
869
 
868
870
  export type PATCH_AiConciergeConversationsByConversationId_Response = PATCH_AiConciergeConversationsByConversationId_Response_200 | PATCH_AiConciergeConversationsByConversationId_Response_401 | PATCH_AiConciergeConversationsByConversationId_Response_404 | PATCH_AiConciergeConversationsByConversationId_Response_422 | PATCH_AiConciergeConversationsByConversationId_Response_502;
@@ -346,6 +346,10 @@ export type ListZonesReferencingSetRes = components['schemas']['ListZonesReferen
346
346
  export type LocalPresenceBase = components['schemas']['LocalPresenceBase'];
347
347
  export type LocalPresenceRequirementType = components['schemas']['LocalPresenceRequirementType'];
348
348
  export type Logo = components['schemas']['Logo'];
349
+ export type MailTemplate = components['schemas']['MailTemplate'];
350
+ export type MailTemplateBlock = components['schemas']['MailTemplateBlock'];
351
+ export type MailTemplateCatalogRes = components['schemas']['MailTemplateCatalogRes'];
352
+ export type MailTemplateVariable = components['schemas']['MailTemplateVariable'];
349
353
  export type MemoryFact = components['schemas']['MemoryFact'];
350
354
  export type MemoryFactCreateRequest = components['schemas']['MemoryFactCreateRequest'];
351
355
  export type MemoryFactKind = components['schemas']['MemoryFactKind'];
package/src/openapi.yaml CHANGED
@@ -7527,17 +7527,6 @@ components:
7527
7527
  type: string
7528
7528
  Footer:
7529
7529
  properties:
7530
- contact_email:
7531
- anyOf:
7532
- - pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$
7533
- type: string
7534
- - type: 'null'
7535
- title: Contact Email
7536
- disclaimer:
7537
- anyOf:
7538
- - type: string
7539
- - type: 'null'
7540
- title: Disclaimer
7541
7530
  legal_entity:
7542
7531
  anyOf:
7543
7532
  - maxLength: 255
@@ -8884,6 +8873,94 @@ components:
8884
8873
  title: Light
8885
8874
  title: Logo
8886
8875
  type: object
8876
+ MailTemplate:
8877
+ description: 'One editable transactional email template. This is the public
8878
+ catalog entry:
8879
+
8880
+ mail-service''s operational fields (engine, internal, whitelabel, brand_defaults)
8881
+
8882
+ are deliberately not declared, so the response model drops them.'
8883
+ properties:
8884
+ blocks:
8885
+ additionalProperties:
8886
+ $ref: '#/components/schemas/MailTemplateBlock'
8887
+ description: Org-editable content blocks
8888
+ title: Blocks
8889
+ type: object
8890
+ locales:
8891
+ description: Supported locales, first is the fallback
8892
+ items:
8893
+ type: string
8894
+ title: Locales
8895
+ type: array
8896
+ subject:
8897
+ additionalProperties:
8898
+ type: string
8899
+ description: Subject line per locale
8900
+ title: Subject
8901
+ type: object
8902
+ variables:
8903
+ additionalProperties:
8904
+ $ref: '#/components/schemas/MailTemplateVariable'
8905
+ description: Per-send variables
8906
+ title: Variables
8907
+ type: object
8908
+ version:
8909
+ default: ''
8910
+ description: Template revision (major.minor)
8911
+ title: Version
8912
+ type: string
8913
+ title: MailTemplate
8914
+ type: object
8915
+ MailTemplateBlock:
8916
+ properties:
8917
+ default:
8918
+ additionalProperties:
8919
+ type: string
8920
+ description: Default copy per locale
8921
+ title: Default
8922
+ type: object
8923
+ label:
8924
+ default: ''
8925
+ description: Human-readable field name for the editor
8926
+ title: Label
8927
+ type: string
8928
+ max_len:
8929
+ default: 0
8930
+ description: Maximum override text length
8931
+ title: Max Len
8932
+ type: integer
8933
+ multiline:
8934
+ default: false
8935
+ description: Render the editor field as a textarea
8936
+ title: Multiline
8937
+ type: boolean
8938
+ title: MailTemplateBlock
8939
+ type: object
8940
+ MailTemplateCatalogRes:
8941
+ additionalProperties:
8942
+ $ref: '#/components/schemas/MailTemplate'
8943
+ description: The editable-template catalog keyed by template name.
8944
+ title: MailTemplateCatalogRes
8945
+ type: object
8946
+ MailTemplateVariable:
8947
+ properties:
8948
+ required:
8949
+ default: false
8950
+ title: Required
8951
+ type: boolean
8952
+ sample:
8953
+ default: ''
8954
+ description: Sample value shown in previews
8955
+ title: Sample
8956
+ type: string
8957
+ type:
8958
+ default: text
8959
+ description: Value type driving render-time escaping (text or url)
8960
+ title: Type
8961
+ type: string
8962
+ title: MailTemplateVariable
8963
+ type: object
8887
8964
  MemoryFact:
8888
8965
  properties:
8889
8966
  created_at:
@@ -14701,7 +14778,7 @@ info:
14701
14778
  \n\n"
14702
14779
  summary: OpusDNS - your gateway to a seamless domain management experience.
14703
14780
  title: OpusDNS API
14704
- version: 2026-07-24-073532
14781
+ version: 2026-07-24-121118
14705
14782
  x-logo:
14706
14783
  altText: OpusDNS API Reference
14707
14784
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -31295,10 +31372,7 @@ paths:
31295
31372
  content:
31296
31373
  application/json:
31297
31374
  schema:
31298
- additionalProperties: true
31299
- title: Response List Whitelabel Email Templates V1 Whitelabel Branding
31300
- Email Templates Get
31301
- type: object
31375
+ $ref: '#/components/schemas/MailTemplateCatalogRes'
31302
31376
  description: Successful Response
31303
31377
  '422':
31304
31378
  content:
package/src/schema.d.ts CHANGED
@@ -7840,10 +7840,6 @@ export interface components {
7840
7840
  ExecutingEntity: "user" | "organization" | "system";
7841
7841
  /** Footer */
7842
7842
  Footer: {
7843
- /** Contact Email */
7844
- contact_email?: string | null;
7845
- /** Disclaimer */
7846
- disclaimer?: string | null;
7847
7843
  /** Legal Entity */
7848
7844
  legal_entity?: string | null;
7849
7845
  /** Lines */
@@ -8724,6 +8720,101 @@ export interface components {
8724
8720
  /** Light */
8725
8721
  light?: string | null;
8726
8722
  };
8723
+ /**
8724
+ * MailTemplate
8725
+ * @description One editable transactional email template. This is the public catalog entry:
8726
+ * mail-service's operational fields (engine, internal, whitelabel, brand_defaults)
8727
+ * are deliberately not declared, so the response model drops them.
8728
+ */
8729
+ MailTemplate: {
8730
+ /**
8731
+ * Blocks
8732
+ * @description Org-editable content blocks
8733
+ */
8734
+ blocks?: {
8735
+ [key: string]: components["schemas"]["MailTemplateBlock"];
8736
+ };
8737
+ /**
8738
+ * Locales
8739
+ * @description Supported locales, first is the fallback
8740
+ */
8741
+ locales?: string[];
8742
+ /**
8743
+ * Subject
8744
+ * @description Subject line per locale
8745
+ */
8746
+ subject?: {
8747
+ [key: string]: string;
8748
+ };
8749
+ /**
8750
+ * Variables
8751
+ * @description Per-send variables
8752
+ */
8753
+ variables?: {
8754
+ [key: string]: components["schemas"]["MailTemplateVariable"];
8755
+ };
8756
+ /**
8757
+ * Version
8758
+ * @description Template revision (major.minor)
8759
+ * @default
8760
+ */
8761
+ version: string;
8762
+ };
8763
+ /** MailTemplateBlock */
8764
+ MailTemplateBlock: {
8765
+ /**
8766
+ * Default
8767
+ * @description Default copy per locale
8768
+ */
8769
+ default?: {
8770
+ [key: string]: string;
8771
+ };
8772
+ /**
8773
+ * Label
8774
+ * @description Human-readable field name for the editor
8775
+ * @default
8776
+ */
8777
+ label: string;
8778
+ /**
8779
+ * Max Len
8780
+ * @description Maximum override text length
8781
+ * @default 0
8782
+ */
8783
+ max_len: number;
8784
+ /**
8785
+ * Multiline
8786
+ * @description Render the editor field as a textarea
8787
+ * @default false
8788
+ */
8789
+ multiline: boolean;
8790
+ };
8791
+ /**
8792
+ * MailTemplateCatalogRes
8793
+ * @description The editable-template catalog keyed by template name.
8794
+ */
8795
+ MailTemplateCatalogRes: {
8796
+ [key: string]: components["schemas"]["MailTemplate"];
8797
+ };
8798
+ /** MailTemplateVariable */
8799
+ MailTemplateVariable: {
8800
+ /**
8801
+ * Required
8802
+ * @default false
8803
+ */
8804
+ required: boolean;
8805
+ /**
8806
+ * Sample
8807
+ * @description Sample value shown in previews
8808
+ * @default
8809
+ */
8810
+ sample: string;
8811
+ /**
8812
+ * Type
8813
+ * @description Value type driving render-time escaping (text or url)
8814
+ * @default text
8815
+ */
8816
+ type: string;
8817
+ };
8727
8818
  /** MemoryFact */
8728
8819
  MemoryFact: {
8729
8820
  /**
@@ -26290,9 +26381,7 @@ export interface operations {
26290
26381
  [name: string]: unknown;
26291
26382
  };
26292
26383
  content: {
26293
- "application/json": {
26294
- [key: string]: unknown;
26295
- };
26384
+ "application/json": components["schemas"]["MailTemplateCatalogRes"];
26296
26385
  };
26297
26386
  };
26298
26387
  /** @description Validation Error */