@opusdns/api 1.159.0 → 1.161.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.5.0"
   },
   "name": "@opusdns/api",
-  "version": "1.159.0",
+  "version": "1.161.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/endpoints.ts

@@ -147,6 +147,9 @@ export const VANITY_NAMESERVER_SETS_BY_SET_ID_RESTORE_ENDPOINT = '/v1/vanity-nam
 export const VANITY_NAMESERVER_SETS_BY_SET_ID_RETRY_ENDPOINT = '/v1/vanity-nameserver-sets/{set_id}/retry';
 export const VANITY_NAMESERVER_SETS_BY_SET_ID_ZONES_ENDPOINT = '/v1/vanity-nameserver-sets/{set_id}/zones';
 export const WHITELABEL_BRANDING_ENDPOINT = '/v1/whitelabel-branding';
+export const WHITELABEL_BRANDING_ASSETS_ENDPOINT = '/v1/whitelabel-branding/assets';
+export const WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT = '/v1/whitelabel-branding/assets/{asset_id}';
+export const WHITELABEL_BRANDING_DOCUMENT_ENDPOINT = '/v1/whitelabel-branding/document';
 export const WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT = '/v1/whitelabel-branding/email/preview';
 export const WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT = '/v1/whitelabel-branding/email/templates';
 export const WHITELABEL_BRANDING_RECHECK_ENDPOINT = '/v1/whitelabel-branding/recheck';
@@ -303,6 +306,9 @@ export type Endpoint =
   | typeof VANITY_NAMESERVER_SETS_BY_SET_ID_RETRY_ENDPOINT
   | typeof VANITY_NAMESERVER_SETS_BY_SET_ID_ZONES_ENDPOINT
   | typeof WHITELABEL_BRANDING_ENDPOINT
+  | typeof WHITELABEL_BRANDING_ASSETS_ENDPOINT
+  | typeof WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT
+  | typeof WHITELABEL_BRANDING_DOCUMENT_ENDPOINT
   | typeof WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT
   | typeof WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT
   | typeof WHITELABEL_BRANDING_RECHECK_ENDPOINT

package/src/helpers/keys.ts

@@ -13,7 +13,9 @@ import type {
   Auth,
   BillingMetadata,
   BillingTransaction,
+  Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post,
   Brand,
+  BrandingAsset,
   BrandingDocument,
   BrowserStatsBucket,
   BulkObjectTagChanges,
@@ -281,6 +283,7 @@ import type {
   LaunchPhasesBase,
   Legal,
   LegalRequirementBase,
+  ListBrandingAssets,
   ListVanityNameserverSetsRes,
   ListZonesReferencingSetRes,
   LocalPresenceBase,
@@ -645,6 +648,12 @@ export const KEYS_BILLING_TRANSACTION = [
   KEY_BILLING_TRANSACTION_VOLUME,
 ] as const satisfies (keyof BillingTransaction)[];
 
+export const KEY_BODY_UPLOAD_WHITELABEL_ASSET_V1_WHITELABEL_BRANDING_ASSETS_POST_FILE = 'file' satisfies keyof Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post;
+
+export const KEYS_BODY_UPLOAD_WHITELABEL_ASSET_V1_WHITELABEL_BRANDING_ASSETS_POST = [
+  KEY_BODY_UPLOAD_WHITELABEL_ASSET_V1_WHITELABEL_BRANDING_ASSETS_POST_FILE,
+] as const satisfies (keyof Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post)[];
+
 export const KEY_BRAND_LOGO = 'logo' satisfies keyof Brand;
 export const KEY_BRAND_NAME = 'name' satisfies keyof Brand;
 
@@ -653,6 +662,20 @@ export const KEYS_BRAND = [
   KEY_BRAND_NAME,
 ] as const satisfies (keyof Brand)[];
 
+export const KEY_BRANDING_ASSET_ASSET_ID = 'asset_id' satisfies keyof BrandingAsset;
+export const KEY_BRANDING_ASSET_ASSET_URL = 'asset_url' satisfies keyof BrandingAsset;
+export const KEY_BRANDING_ASSET_CONTENT_TYPE = 'content_type' satisfies keyof BrandingAsset;
+export const KEY_BRANDING_ASSET_SIZE_BYTES = 'size_bytes' satisfies keyof BrandingAsset;
+export const KEY_BRANDING_ASSET_UPDATED_ON = 'updated_on' satisfies keyof BrandingAsset;
+
+export const KEYS_BRANDING_ASSET = [
+  KEY_BRANDING_ASSET_ASSET_ID,
+  KEY_BRANDING_ASSET_ASSET_URL,
+  KEY_BRANDING_ASSET_CONTENT_TYPE,
+  KEY_BRANDING_ASSET_SIZE_BYTES,
+  KEY_BRANDING_ASSET_UPDATED_ON,
+] as const satisfies (keyof BrandingAsset)[];
+
 export const KEY_BRANDING_DOCUMENT_AUTH = 'auth' satisfies keyof BrandingDocument;
 export const KEY_BRANDING_DOCUMENT_BRAND = 'brand' satisfies keyof BrandingDocument;
 export const KEY_BRANDING_DOCUMENT_CONTENT = 'content' satisfies keyof BrandingDocument;
@@ -3911,6 +3934,12 @@ export const KEYS_LEGAL_REQUIREMENT_BASE = [
   KEY_LEGAL_REQUIREMENT_BASE_URL,
 ] as const satisfies (keyof LegalRequirementBase)[];
 
+export const KEY_LIST_BRANDING_ASSETS_ASSETS = 'assets' satisfies keyof ListBrandingAssets;
+
+export const KEYS_LIST_BRANDING_ASSETS = [
+  KEY_LIST_BRANDING_ASSETS_ASSETS,
+] as const satisfies (keyof ListBrandingAssets)[];
+
 export const KEY_LIST_VANITY_NAMESERVER_SETS_RES_PAGINATION = 'pagination' satisfies keyof ListVanityNameserverSetsRes;
 export const KEY_LIST_VANITY_NAMESERVER_SETS_RES_RESULTS = 'results' satisfies keyof ListVanityNameserverSetsRes;
 

package/src/helpers/permissions.ts

@@ -150,6 +150,9 @@ import {
   VANITY_NAMESERVER_SETS_CHECK_ENDPOINT,
   VANITY_NAMESERVER_SETS_DEFAULT_ENDPOINT,
   VANITY_NAMESERVER_SETS_ENDPOINT,
+  WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT,
+  WHITELABEL_BRANDING_ASSETS_ENDPOINT,
+  WHITELABEL_BRANDING_DOCUMENT_ENDPOINT,
   WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT,
   WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT,
   WHITELABEL_BRANDING_ENDPOINT,
@@ -1260,6 +1263,27 @@ export const REQUIRED_PERMISSIONS = {
     patch: [],
     delete: [],
   },
+  [WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT]: {
+    get: [],
+    post: [],
+    put: [],
+    patch: [],
+    delete: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_MANAGE],
+  },
+  [WHITELABEL_BRANDING_ASSETS_ENDPOINT]: {
+    get: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_READ],
+    post: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_MANAGE],
+    put: [],
+    patch: [],
+    delete: [],
+  },
+  [WHITELABEL_BRANDING_DOCUMENT_ENDPOINT]: {
+    get: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_READ],
+    post: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_MANAGE],
+    put: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_MANAGE],
+    patch: [],
+    delete: [],
+  },
   [WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT]: {
     get: [],
     post: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_MANAGE],

package/src/helpers/requests.d.ts

@@ -1,5 +1,6 @@
 import type { operations } from '../schema';
 import type {
+  BrandingDocument,
   BulkObjectTagChanges,
   ClaimsNoticesRequest,
   ContactAttestReq,
@@ -1191,6 +1192,30 @@ export type PATCH_WhitelabelBranding_Request_Body = PATCH_WhitelabelBranding_Req
 export type POST_WhitelabelBranding_Request = {
 };
 
+export type GET_WhitelabelBrandingAssets_Request = {
+};
+
+export type POST_WhitelabelBrandingAssets_Request = {
+};
+
+export type DELETE_WhitelabelBrandingAssetsByAssetId_Request = {
+  parameters: operations['delete_whitelabel_asset_v1_whitelabel_branding_assets__asset_id__delete']['parameters'];
+};
+export type DELETE_WhitelabelBrandingAssetsByAssetId_Request_Path = DELETE_WhitelabelBrandingAssetsByAssetId_Request['parameters']['path'];
+
+export type GET_WhitelabelBrandingDocument_Request = {
+};
+
+export type POST_WhitelabelBrandingDocument_Request = {
+  requestBody: BrandingDocument;
+};
+export type POST_WhitelabelBrandingDocument_Request_Body = POST_WhitelabelBrandingDocument_Request['requestBody'];
+
+export type PUT_WhitelabelBrandingDocument_Request = {
+  requestBody: BrandingDocument;
+};
+export type PUT_WhitelabelBrandingDocument_Request_Body = PUT_WhitelabelBrandingDocument_Request['requestBody'];
+
 export type POST_WhitelabelBrandingEmailPreview_Request = {
   requestBody: PreviewMailReq;
 };

package/src/helpers/responses.d.ts

@@ -2,6 +2,8 @@ import type {
   AiInferenceUsageSeries,
   AiInferenceUsageSummary,
   BillingTransaction,
+  BrandingAsset,
+  BrandingDocument,
   ClaimsNotices,
   ClearVanityNameserverSetDefaultRes,
   Contact,
@@ -51,6 +53,7 @@ import type {
   Job,
   JobBatchRetry,
   JobBatchStatus,
+  ListBrandingAssets,
   ListVanityNameserverSetsRes,
   ListZonesReferencingSetRes,
   MailTemplateCatalogRes,
@@ -256,6 +259,10 @@ export type DELETE_VanityNameserverSetsDefault_Response = DELETE_VanityNameserve
 export type DELETE_VanityNameserverSetsDefault_Response_200 = ClearVanityNameserverSetDefaultRes;
 export type DELETE_VanityNameserverSetsDefault_Response_422 = HTTPValidationError;
 
+export type DELETE_WhitelabelBrandingAssetsByAssetId_Response = DELETE_WhitelabelBrandingAssetsByAssetId_Response_422;
+
+export type DELETE_WhitelabelBrandingAssetsByAssetId_Response_422 = HTTPValidationError;
+
 export type GET_AiConciergeContextsByContextId_Response = GET_AiConciergeContextsByContextId_Response_401 | GET_AiConciergeContextsByContextId_Response_404 | GET_AiConciergeContextsByContextId_Response_422 | GET_AiConciergeContextsByContextId_Response_502;
 
 export type GET_AiConciergeContextsByContextId_Response_401 = Problem;
@@ -875,6 +882,16 @@ export type GET_WhitelabelBranding_Response = GET_WhitelabelBranding_Response_20
 export type GET_WhitelabelBranding_Response_200 = WhitelabelBranding;
 export type GET_WhitelabelBranding_Response_422 = HTTPValidationError;
 
+export type GET_WhitelabelBrandingAssets_Response = GET_WhitelabelBrandingAssets_Response_200 | GET_WhitelabelBrandingAssets_Response_422;
+
+export type GET_WhitelabelBrandingAssets_Response_200 = ListBrandingAssets;
+export type GET_WhitelabelBrandingAssets_Response_422 = HTTPValidationError;
+
+export type GET_WhitelabelBrandingDocument_Response = GET_WhitelabelBrandingDocument_Response_200 | GET_WhitelabelBrandingDocument_Response_422;
+
+export type GET_WhitelabelBrandingDocument_Response_200 = BrandingDocument;
+export type GET_WhitelabelBrandingDocument_Response_422 = HTTPValidationError;
+
 export type GET_WhitelabelBrandingEmailTemplates_Response = GET_WhitelabelBrandingEmailTemplates_Response_200 | GET_WhitelabelBrandingEmailTemplates_Response_422;
 
 export type GET_WhitelabelBrandingEmailTemplates_Response_200 = MailTemplateCatalogRes;
@@ -1446,6 +1463,16 @@ export type POST_WhitelabelBranding_Response = POST_WhitelabelBranding_Response_
 export type POST_WhitelabelBranding_Response_202 = ProductCreateRes;
 export type POST_WhitelabelBranding_Response_422 = HTTPValidationError;
 
+export type POST_WhitelabelBrandingAssets_Response = POST_WhitelabelBrandingAssets_Response_200 | POST_WhitelabelBrandingAssets_Response_422;
+
+export type POST_WhitelabelBrandingAssets_Response_200 = BrandingAsset;
+export type POST_WhitelabelBrandingAssets_Response_422 = HTTPValidationError;
+
+export type POST_WhitelabelBrandingDocument_Response = POST_WhitelabelBrandingDocument_Response_200 | POST_WhitelabelBrandingDocument_Response_422;
+
+export type POST_WhitelabelBrandingDocument_Response_200 = BrandingDocument;
+export type POST_WhitelabelBrandingDocument_Response_422 = HTTPValidationError;
+
 export type POST_WhitelabelBrandingEmailPreview_Response = POST_WhitelabelBrandingEmailPreview_Response_200 | POST_WhitelabelBrandingEmailPreview_Response_422;
 
 export type POST_WhitelabelBrandingEmailPreview_Response_200 = PreviewMailRes;
@@ -1529,3 +1556,8 @@ export type PUT_UsersByUserIdRole_Response_200 = PublicRoleAssignment;
 export type PUT_UsersByUserIdRole_Response_403 = Problem;
 export type PUT_UsersByUserIdRole_Response_404 = Problem;
 export type PUT_UsersByUserIdRole_Response_422 = HTTPValidationError;
+
+export type PUT_WhitelabelBrandingDocument_Response = PUT_WhitelabelBrandingDocument_Response_200 | PUT_WhitelabelBrandingDocument_Response_422;
+
+export type PUT_WhitelabelBrandingDocument_Response_200 = BrandingDocument;
+export type PUT_WhitelabelBrandingDocument_Response_422 = HTTPValidationError;

package/src/helpers/schemas.d.ts

@@ -25,7 +25,9 @@ export type BillingTransactionProductType = components['schemas']['BillingTransa
 export type BillingTransaction = components['schemas']['BillingTransactionResponse'];
 export type BillingTransactionSortField = components['schemas']['BillingTransactionSortField'];
 export type BillingTransactionStatus = components['schemas']['BillingTransactionStatus'];
+export type Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post = components['schemas']['Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post'];
 export type Brand = components['schemas']['Brand'];
+export type BrandingAsset = components['schemas']['BrandingAsset'];
 export type BrandingDocument = components['schemas']['BrandingDocument'];
 export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
 export type BulkObjectTagChanges = components['schemas']['BulkObjectTagChanges'];
@@ -352,6 +354,7 @@ export type Legal = components['schemas']['Legal'];
 export type LegalRequirementBase = components['schemas']['LegalRequirementBase'];
 export type LegalRequirementOperationType = components['schemas']['LegalRequirementOperationType'];
 export type LegalRequirementType = components['schemas']['LegalRequirementType'];
+export type ListBrandingAssets = components['schemas']['ListBrandingAssetsResponse'];
 export type ListVanityNameserverSetsRes = components['schemas']['ListVanityNameserverSetsRes'];
 export type ListZonesReferencingSetRes = components['schemas']['ListZonesReferencingSetRes'];
 export type LocalPresenceBase = components['schemas']['LocalPresenceBase'];