@opusdns/api 1.76.0 → 1.78.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.76.0",
6
+ "version": "1.78.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,
@@ -3808,6 +3811,42 @@ export const KEYS_LOGO = [
3808
3811
  KEY_LOGO_LIGHT,
3809
3812
  ] as const satisfies (keyof Logo)[];
3810
3813
 
3814
+ export const KEY_MAIL_TEMPLATE_BLOCKS = 'blocks' satisfies keyof MailTemplate;
3815
+ export const KEY_MAIL_TEMPLATE_LOCALES = 'locales' satisfies keyof MailTemplate;
3816
+ export const KEY_MAIL_TEMPLATE_SUBJECT = 'subject' satisfies keyof MailTemplate;
3817
+ export const KEY_MAIL_TEMPLATE_VARIABLES = 'variables' satisfies keyof MailTemplate;
3818
+ export const KEY_MAIL_TEMPLATE_VERSION = 'version' satisfies keyof MailTemplate;
3819
+
3820
+ export const KEYS_MAIL_TEMPLATE = [
3821
+ KEY_MAIL_TEMPLATE_BLOCKS,
3822
+ KEY_MAIL_TEMPLATE_LOCALES,
3823
+ KEY_MAIL_TEMPLATE_SUBJECT,
3824
+ KEY_MAIL_TEMPLATE_VARIABLES,
3825
+ KEY_MAIL_TEMPLATE_VERSION,
3826
+ ] as const satisfies (keyof MailTemplate)[];
3827
+
3828
+ export const KEY_MAIL_TEMPLATE_BLOCK_DEFAULT = 'default' satisfies keyof MailTemplateBlock;
3829
+ export const KEY_MAIL_TEMPLATE_BLOCK_LABEL = 'label' satisfies keyof MailTemplateBlock;
3830
+ export const KEY_MAIL_TEMPLATE_BLOCK_MAX_LEN = 'max_len' satisfies keyof MailTemplateBlock;
3831
+ export const KEY_MAIL_TEMPLATE_BLOCK_MULTILINE = 'multiline' satisfies keyof MailTemplateBlock;
3832
+
3833
+ export const KEYS_MAIL_TEMPLATE_BLOCK = [
3834
+ KEY_MAIL_TEMPLATE_BLOCK_DEFAULT,
3835
+ KEY_MAIL_TEMPLATE_BLOCK_LABEL,
3836
+ KEY_MAIL_TEMPLATE_BLOCK_MAX_LEN,
3837
+ KEY_MAIL_TEMPLATE_BLOCK_MULTILINE,
3838
+ ] as const satisfies (keyof MailTemplateBlock)[];
3839
+
3840
+ export const KEY_MAIL_TEMPLATE_VARIABLE_REQUIRED = 'required' satisfies keyof MailTemplateVariable;
3841
+ export const KEY_MAIL_TEMPLATE_VARIABLE_SAMPLE = 'sample' satisfies keyof MailTemplateVariable;
3842
+ export const KEY_MAIL_TEMPLATE_VARIABLE_TYPE = 'type' satisfies keyof MailTemplateVariable;
3843
+
3844
+ export const KEYS_MAIL_TEMPLATE_VARIABLE = [
3845
+ KEY_MAIL_TEMPLATE_VARIABLE_REQUIRED,
3846
+ KEY_MAIL_TEMPLATE_VARIABLE_SAMPLE,
3847
+ KEY_MAIL_TEMPLATE_VARIABLE_TYPE,
3848
+ ] as const satisfies (keyof MailTemplateVariable)[];
3849
+
3811
3850
  export const KEY_MEMORY_FACT_CREATED_AT = 'created_at' satisfies keyof MemoryFact;
3812
3851
  export const KEY_MEMORY_FACT_EXPIRES_AT = 'expires_at' satisfies keyof MemoryFact;
3813
3852
  export const KEY_MEMORY_FACT_FACT_ID = 'fact_id' satisfies keyof MemoryFact;
@@ -5716,10 +5755,12 @@ export const KEYS_VISITS_BY_KEY_BUCKET = [
5716
5755
 
5717
5756
  export const KEY_WHITELABEL_BRANDING_CREATE_AUTH_HOSTNAME = 'auth_hostname' satisfies keyof WhitelabelBrandingCreate;
5718
5757
  export const KEY_WHITELABEL_BRANDING_CREATE_HOSTNAME = 'hostname' satisfies keyof WhitelabelBrandingCreate;
5758
+ export const KEY_WHITELABEL_BRANDING_CREATE_PERIOD = 'period' satisfies keyof WhitelabelBrandingCreate;
5719
5759
 
5720
5760
  export const KEYS_WHITELABEL_BRANDING_CREATE = [
5721
5761
  KEY_WHITELABEL_BRANDING_CREATE_AUTH_HOSTNAME,
5722
5762
  KEY_WHITELABEL_BRANDING_CREATE_HOSTNAME,
5763
+ KEY_WHITELABEL_BRANDING_CREATE_PERIOD,
5723
5764
  ] as const satisfies (keyof WhitelabelBrandingCreate)[];
5724
5765
 
5725
5766
  export const KEY_WHITELABEL_BRANDING_AUTH_HOSTNAME = 'auth_hostname' satisfies keyof WhitelabelBranding;
@@ -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
@@ -8884,6 +8884,94 @@ components:
8884
8884
  title: Light
8885
8885
  title: Logo
8886
8886
  type: object
8887
+ MailTemplate:
8888
+ description: 'One editable transactional email template. This is the public
8889
+ catalog entry:
8890
+
8891
+ mail-service''s operational fields (engine, internal, whitelabel, brand_defaults)
8892
+
8893
+ are deliberately not declared, so the response model drops them.'
8894
+ properties:
8895
+ blocks:
8896
+ additionalProperties:
8897
+ $ref: '#/components/schemas/MailTemplateBlock'
8898
+ description: Org-editable content blocks
8899
+ title: Blocks
8900
+ type: object
8901
+ locales:
8902
+ description: Supported locales, first is the fallback
8903
+ items:
8904
+ type: string
8905
+ title: Locales
8906
+ type: array
8907
+ subject:
8908
+ additionalProperties:
8909
+ type: string
8910
+ description: Subject line per locale
8911
+ title: Subject
8912
+ type: object
8913
+ variables:
8914
+ additionalProperties:
8915
+ $ref: '#/components/schemas/MailTemplateVariable'
8916
+ description: Per-send variables
8917
+ title: Variables
8918
+ type: object
8919
+ version:
8920
+ default: ''
8921
+ description: Template revision (major.minor)
8922
+ title: Version
8923
+ type: string
8924
+ title: MailTemplate
8925
+ type: object
8926
+ MailTemplateBlock:
8927
+ properties:
8928
+ default:
8929
+ additionalProperties:
8930
+ type: string
8931
+ description: Default copy per locale
8932
+ title: Default
8933
+ type: object
8934
+ label:
8935
+ default: ''
8936
+ description: Human-readable field name for the editor
8937
+ title: Label
8938
+ type: string
8939
+ max_len:
8940
+ default: 0
8941
+ description: Maximum override text length
8942
+ title: Max Len
8943
+ type: integer
8944
+ multiline:
8945
+ default: false
8946
+ description: Render the editor field as a textarea
8947
+ title: Multiline
8948
+ type: boolean
8949
+ title: MailTemplateBlock
8950
+ type: object
8951
+ MailTemplateCatalogRes:
8952
+ additionalProperties:
8953
+ $ref: '#/components/schemas/MailTemplate'
8954
+ description: The editable-template catalog keyed by template name.
8955
+ title: MailTemplateCatalogRes
8956
+ type: object
8957
+ MailTemplateVariable:
8958
+ properties:
8959
+ required:
8960
+ default: false
8961
+ title: Required
8962
+ type: boolean
8963
+ sample:
8964
+ default: ''
8965
+ description: Sample value shown in previews
8966
+ title: Sample
8967
+ type: string
8968
+ type:
8969
+ default: text
8970
+ description: Value type driving render-time escaping (text or url)
8971
+ title: Type
8972
+ type: string
8973
+ title: MailTemplateVariable
8974
+ type: object
8887
8975
  MemoryFact:
8888
8976
  properties:
8889
8977
  created_at:
@@ -14287,9 +14375,14 @@ components:
14287
14375
  minLength: 1
14288
14376
  title: Hostname
14289
14377
  type: string
14378
+ period:
14379
+ $ref: '#/components/schemas/Period'
14380
+ description: 'Billing period for the subscription; offered: 1 month or 1
14381
+ year'
14290
14382
  required:
14291
14383
  - hostname
14292
14384
  - auth_hostname
14385
+ - period
14293
14386
  title: WhitelabelBrandingCreate
14294
14387
  type: object
14295
14388
  WhitelabelBrandingResponse:
@@ -14696,7 +14789,7 @@ info:
14696
14789
  \n\n"
14697
14790
  summary: OpusDNS - your gateway to a seamless domain management experience.
14698
14791
  title: OpusDNS API
14699
- version: 2026-07-23-122300
14792
+ version: 2026-07-24-083226
14700
14793
  x-logo:
14701
14794
  altText: OpusDNS API Reference
14702
14795
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -31290,10 +31383,7 @@ paths:
31290
31383
  content:
31291
31384
  application/json:
31292
31385
  schema:
31293
- additionalProperties: true
31294
- title: Response List Whitelabel Email Templates V1 Whitelabel Branding
31295
- Email Templates Get
31296
- type: object
31386
+ $ref: '#/components/schemas/MailTemplateCatalogRes'
31297
31387
  description: Successful Response
31298
31388
  '422':
31299
31389
  content:
package/src/schema.d.ts CHANGED
@@ -8724,6 +8724,101 @@ export interface components {
8724
8724
  /** Light */
8725
8725
  light?: string | null;
8726
8726
  };
8727
+ /**
8728
+ * MailTemplate
8729
+ * @description One editable transactional email template. This is the public catalog entry:
8730
+ * mail-service's operational fields (engine, internal, whitelabel, brand_defaults)
8731
+ * are deliberately not declared, so the response model drops them.
8732
+ */
8733
+ MailTemplate: {
8734
+ /**
8735
+ * Blocks
8736
+ * @description Org-editable content blocks
8737
+ */
8738
+ blocks?: {
8739
+ [key: string]: components["schemas"]["MailTemplateBlock"];
8740
+ };
8741
+ /**
8742
+ * Locales
8743
+ * @description Supported locales, first is the fallback
8744
+ */
8745
+ locales?: string[];
8746
+ /**
8747
+ * Subject
8748
+ * @description Subject line per locale
8749
+ */
8750
+ subject?: {
8751
+ [key: string]: string;
8752
+ };
8753
+ /**
8754
+ * Variables
8755
+ * @description Per-send variables
8756
+ */
8757
+ variables?: {
8758
+ [key: string]: components["schemas"]["MailTemplateVariable"];
8759
+ };
8760
+ /**
8761
+ * Version
8762
+ * @description Template revision (major.minor)
8763
+ * @default
8764
+ */
8765
+ version: string;
8766
+ };
8767
+ /** MailTemplateBlock */
8768
+ MailTemplateBlock: {
8769
+ /**
8770
+ * Default
8771
+ * @description Default copy per locale
8772
+ */
8773
+ default?: {
8774
+ [key: string]: string;
8775
+ };
8776
+ /**
8777
+ * Label
8778
+ * @description Human-readable field name for the editor
8779
+ * @default
8780
+ */
8781
+ label: string;
8782
+ /**
8783
+ * Max Len
8784
+ * @description Maximum override text length
8785
+ * @default 0
8786
+ */
8787
+ max_len: number;
8788
+ /**
8789
+ * Multiline
8790
+ * @description Render the editor field as a textarea
8791
+ * @default false
8792
+ */
8793
+ multiline: boolean;
8794
+ };
8795
+ /**
8796
+ * MailTemplateCatalogRes
8797
+ * @description The editable-template catalog keyed by template name.
8798
+ */
8799
+ MailTemplateCatalogRes: {
8800
+ [key: string]: components["schemas"]["MailTemplate"];
8801
+ };
8802
+ /** MailTemplateVariable */
8803
+ MailTemplateVariable: {
8804
+ /**
8805
+ * Required
8806
+ * @default false
8807
+ */
8808
+ required: boolean;
8809
+ /**
8810
+ * Sample
8811
+ * @description Sample value shown in previews
8812
+ * @default
8813
+ */
8814
+ sample: string;
8815
+ /**
8816
+ * Type
8817
+ * @description Value type driving render-time escaping (text or url)
8818
+ * @default text
8819
+ */
8820
+ type: string;
8821
+ };
8727
8822
  /** MemoryFact */
8728
8823
  MemoryFact: {
8729
8824
  /**
@@ -12300,6 +12395,8 @@ export interface components {
12300
12395
  * @description Dashboard hostname the customer wants to brand (e.g. dash.customer.com)
12301
12396
  */
12302
12397
  hostname: string;
12398
+ /** @description Billing period for the subscription; offered: 1 month or 1 year */
12399
+ period: components["schemas"]["Period"];
12303
12400
  };
12304
12401
  /**
12305
12402
  * WhitelabelBrandingResponse
@@ -26288,9 +26385,7 @@ export interface operations {
26288
26385
  [name: string]: unknown;
26289
26386
  };
26290
26387
  content: {
26291
- "application/json": {
26292
- [key: string]: unknown;
26293
- };
26388
+ "application/json": components["schemas"]["MailTemplateCatalogRes"];
26294
26389
  };
26295
26390
  };
26296
26391
  /** @description Validation Error */