@randock/nameshift-api-client 0.0.505 → 0.0.506

package/src/models/CreateNewsletterInput.ts

@@ -0,0 +1,258 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { NewsletterSecondaryStoryInput } from './NewsletterSecondaryStoryInput';
+import {
+    NewsletterSecondaryStoryInputFromJSON,
+    NewsletterSecondaryStoryInputFromJSONTyped,
+    NewsletterSecondaryStoryInputToJSON,
+    NewsletterSecondaryStoryInputToJSONTyped,
+} from './NewsletterSecondaryStoryInput';
+
+/**
+ * 
+ * @export
+ * @interface CreateNewsletterInput
+ */
+export interface CreateNewsletterInput {
+    /**
+     * Subject line.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    subject?: string;
+    /**
+     * Preheader, 40 to 90 characters.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    preheader?: string;
+    /**
+     * Issue label in the header; may carry HTML entities.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    issueLabel?: string;
+    /**
+     * utm_campaign on every link, e.g. nl-2026-10.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    campaignSlug?: string;
+    /**
+     * Lead story UUID.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    leadStoryUuid?: string | null;
+    /**
+     * Lead teaser, 30 to 60 words.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    leadTeaser?: string;
+    /**
+     * Lead button text, 2 to 5 words.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    leadCta?: string;
+    /**
+     * Secondary stories, in order.
+     * @type {Array<NewsletterSecondaryStoryInput>}
+     * @memberof CreateNewsletterInput
+     */
+    secondaryStories?: Array<NewsletterSecondaryStoryInput>;
+    /**
+     * Feature story UUID.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    featureStoryUuid?: string | null;
+    /**
+     * Feature text, 1 to 2 sentences.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    featureText?: string;
+    /**
+     * Feature link text.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    featureLink?: string;
+    /**
+     * Event lead line.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    eventLead?: string | null;
+    /**
+     * Event text.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    eventText?: string | null;
+    /**
+     * Event link URL.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    eventUrl?: string | null;
+    /**
+     * Event link text.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    eventLink?: string | null;
+    /**
+     * Whether the recent-sales module is in the issue.
+     * @type {boolean}
+     * @memberof CreateNewsletterInput
+     */
+    salesEnabled?: boolean;
+    /**
+     * First day of the sales period (YYYY-MM-DD).
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    salesFrom?: string | null;
+    /**
+     * Last day of the sales period (YYYY-MM-DD).
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    salesTo?: string | null;
+    /**
+     * Closing band line.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    closingLine?: string;
+    /**
+     * Closing button text.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    closingCta?: string;
+    /**
+     * Closing button URL.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    closingUrl?: string;
+    /**
+     * Closing note under the button.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    closingNote?: string;
+    /**
+     * Why the reader receives the email.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    footerReason?: string;
+    /**
+     * Internal title, also the Mailchimp campaign name.
+     * @type {string}
+     * @memberof CreateNewsletterInput
+     */
+    title: string;
+}
+
+/**
+ * Check if a given object implements the CreateNewsletterInput interface.
+ */
+export function instanceOfCreateNewsletterInput(value: object): value is CreateNewsletterInput {
+    if (!('title' in value) || value['title'] === undefined) return false;
+    return true;
+}
+
+export function CreateNewsletterInputFromJSON(json: any): CreateNewsletterInput {
+    return CreateNewsletterInputFromJSONTyped(json, false);
+}
+
+export function CreateNewsletterInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateNewsletterInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subject': json['subject'] == null ? undefined : json['subject'],
+        'preheader': json['preheader'] == null ? undefined : json['preheader'],
+        'issueLabel': json['issueLabel'] == null ? undefined : json['issueLabel'],
+        'campaignSlug': json['campaignSlug'] == null ? undefined : json['campaignSlug'],
+        'leadStoryUuid': json['leadStoryUuid'] == null ? undefined : json['leadStoryUuid'],
+        'leadTeaser': json['leadTeaser'] == null ? undefined : json['leadTeaser'],
+        'leadCta': json['leadCta'] == null ? undefined : json['leadCta'],
+        'secondaryStories': json['secondaryStories'] == null ? undefined : ((json['secondaryStories'] as Array<any>).map(NewsletterSecondaryStoryInputFromJSON)),
+        'featureStoryUuid': json['featureStoryUuid'] == null ? undefined : json['featureStoryUuid'],
+        'featureText': json['featureText'] == null ? undefined : json['featureText'],
+        'featureLink': json['featureLink'] == null ? undefined : json['featureLink'],
+        'eventLead': json['eventLead'] == null ? undefined : json['eventLead'],
+        'eventText': json['eventText'] == null ? undefined : json['eventText'],
+        'eventUrl': json['eventUrl'] == null ? undefined : json['eventUrl'],
+        'eventLink': json['eventLink'] == null ? undefined : json['eventLink'],
+        'salesEnabled': json['salesEnabled'] == null ? undefined : json['salesEnabled'],
+        'salesFrom': json['salesFrom'] == null ? undefined : json['salesFrom'],
+        'salesTo': json['salesTo'] == null ? undefined : json['salesTo'],
+        'closingLine': json['closingLine'] == null ? undefined : json['closingLine'],
+        'closingCta': json['closingCta'] == null ? undefined : json['closingCta'],
+        'closingUrl': json['closingUrl'] == null ? undefined : json['closingUrl'],
+        'closingNote': json['closingNote'] == null ? undefined : json['closingNote'],
+        'footerReason': json['footerReason'] == null ? undefined : json['footerReason'],
+        'title': json['title'],
+    };
+}
+
+export function CreateNewsletterInputToJSON(json: any): CreateNewsletterInput {
+    return CreateNewsletterInputToJSONTyped(json, false);
+}
+
+export function CreateNewsletterInputToJSONTyped(value?: CreateNewsletterInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subject': value['subject'],
+        'preheader': value['preheader'],
+        'issueLabel': value['issueLabel'],
+        'campaignSlug': value['campaignSlug'],
+        'leadStoryUuid': value['leadStoryUuid'],
+        'leadTeaser': value['leadTeaser'],
+        'leadCta': value['leadCta'],
+        'secondaryStories': value['secondaryStories'] == null ? undefined : ((value['secondaryStories'] as Array<any>).map(NewsletterSecondaryStoryInputToJSON)),
+        'featureStoryUuid': value['featureStoryUuid'],
+        'featureText': value['featureText'],
+        'featureLink': value['featureLink'],
+        'eventLead': value['eventLead'],
+        'eventText': value['eventText'],
+        'eventUrl': value['eventUrl'],
+        'eventLink': value['eventLink'],
+        'salesEnabled': value['salesEnabled'],
+        'salesFrom': value['salesFrom'],
+        'salesTo': value['salesTo'],
+        'closingLine': value['closingLine'],
+        'closingCta': value['closingCta'],
+        'closingUrl': value['closingUrl'],
+        'closingNote': value['closingNote'],
+        'footerReason': value['footerReason'],
+        'title': value['title'],
+    };
+}
+

package/src/models/NewsStoryDto.ts

@@ -0,0 +1,138 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface NewsStoryDto
+ */
+export interface NewsStoryDto {
+    /**
+     * Storyblok story UUID.
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    uuid: string;
+    /**
+     * Headline of the post.
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    title: string;
+    /**
+     * Public URL of the post.
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    url: string;
+    /**
+     * Category key, e.g. articles.
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    category: string;
+    /**
+     * Category as the email shows it, e.g. Article.
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    categoryLabel: string;
+    /**
+     * Publication date (YYYY-MM-DD).
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    date: string;
+    /**
+     * Intro paragraph of the post.
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    intro: string;
+    /**
+     * Hero image on the image CDN, without crop parameters.
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    heroImageUrl: string | null;
+    /**
+     * Alt text of the hero image.
+     * @type {string}
+     * @memberof NewsStoryDto
+     */
+    heroImageAlt: string;
+}
+
+/**
+ * Check if a given object implements the NewsStoryDto interface.
+ */
+export function instanceOfNewsStoryDto(value: object): value is NewsStoryDto {
+    if (!('uuid' in value) || value['uuid'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('category' in value) || value['category'] === undefined) return false;
+    if (!('categoryLabel' in value) || value['categoryLabel'] === undefined) return false;
+    if (!('date' in value) || value['date'] === undefined) return false;
+    if (!('intro' in value) || value['intro'] === undefined) return false;
+    if (!('heroImageUrl' in value) || value['heroImageUrl'] === undefined) return false;
+    if (!('heroImageAlt' in value) || value['heroImageAlt'] === undefined) return false;
+    return true;
+}
+
+export function NewsStoryDtoFromJSON(json: any): NewsStoryDto {
+    return NewsStoryDtoFromJSONTyped(json, false);
+}
+
+export function NewsStoryDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsStoryDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'uuid': json['uuid'],
+        'title': json['title'],
+        'url': json['url'],
+        'category': json['category'],
+        'categoryLabel': json['categoryLabel'],
+        'date': json['date'],
+        'intro': json['intro'],
+        'heroImageUrl': json['heroImageUrl'],
+        'heroImageAlt': json['heroImageAlt'],
+    };
+}
+
+export function NewsStoryDtoToJSON(json: any): NewsStoryDto {
+    return NewsStoryDtoToJSONTyped(json, false);
+}
+
+export function NewsStoryDtoToJSONTyped(value?: NewsStoryDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'uuid': value['uuid'],
+        'title': value['title'],
+        'url': value['url'],
+        'category': value['category'],
+        'categoryLabel': value['categoryLabel'],
+        'date': value['date'],
+        'intro': value['intro'],
+        'heroImageUrl': value['heroImageUrl'],
+        'heroImageAlt': value['heroImageAlt'],
+    };
+}
+