@randock/nameshift-api-client 0.0.505 → 0.0.506

package/src/models/NewsletterDto.ts

@@ -0,0 +1,400 @@
+/* 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 { NewsletterSecondaryStoryDto } from './NewsletterSecondaryStoryDto';
+import {
+    NewsletterSecondaryStoryDtoFromJSON,
+    NewsletterSecondaryStoryDtoFromJSONTyped,
+    NewsletterSecondaryStoryDtoToJSON,
+    NewsletterSecondaryStoryDtoToJSONTyped,
+} from './NewsletterSecondaryStoryDto';
+
+/**
+ * 
+ * @export
+ * @interface NewsletterDto
+ */
+export interface NewsletterDto {
+    /**
+     * Newsletter ID.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    id: string;
+    /**
+     * Internal title, also the Mailchimp campaign name.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    title: string;
+    /**
+     * Subject line.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    subject: string;
+    /**
+     * Preheader, 40 to 90 characters.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    preheader: string;
+    /**
+     * Issue label in the header; may carry HTML entities.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    issueLabel: string;
+    /**
+     * utm_campaign on every link, e.g. nl-2026-10.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    campaignSlug: string;
+    /**
+     * draft, or prepared in Mailchimp.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    status: NewsletterDtoStatusEnum;
+    /**
+     * Lead story UUID.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    leadStoryUuid: string | null;
+    /**
+     * Lead teaser, 30 to 60 words.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    leadTeaser: string;
+    /**
+     * Lead button text, 2 to 5 words.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    leadCta: string;
+    /**
+     * Secondary stories, in order.
+     * @type {Array<NewsletterSecondaryStoryDto>}
+     * @memberof NewsletterDto
+     */
+    secondaryStories: Array<NewsletterSecondaryStoryDto>;
+    /**
+     * Feature story UUID.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    featureStoryUuid: string | null;
+    /**
+     * Feature text, 1 to 2 sentences.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    featureText: string;
+    /**
+     * Feature link text.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    featureLink: string;
+    /**
+     * Event lead, e.g. "NamesCon Global, Miami, 11–12 November."
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    eventLead: string | null;
+    /**
+     * Event text, e.g. "We are at booth 214."
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    eventText: string | null;
+    /**
+     * Event link URL.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    eventUrl: string | null;
+    /**
+     * Event link text.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    eventLink: string | null;
+    /**
+     * Whether the recent-sales module is in the issue.
+     * @type {boolean}
+     * @memberof NewsletterDto
+     */
+    salesEnabled: boolean;
+    /**
+     * First day of the sales period (YYYY-MM-DD).
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    salesFrom: string | null;
+    /**
+     * Last day of the sales period (YYYY-MM-DD).
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    salesTo: string | null;
+    /**
+     * First day of the period the sales module uses when salesFrom is empty: 14 days ago (YYYY-MM-DD).
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    defaultSalesFrom: string;
+    /**
+     * Last day of the period the sales module uses when salesTo is empty: today (YYYY-MM-DD).
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    defaultSalesTo: string;
+    /**
+     * Closing band line as typed by the editor; empty means the computed line is used.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    closingLine: string;
+    /**
+     * The closing line the email gets when closingLine is empty: "Over N domains are being offered on our platform." from the live listing count. Null in the list.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    defaultClosingLine: string | null;
+    /**
+     * Closing button text.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    closingCta: string;
+    /**
+     * Closing button URL.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    closingUrl: string;
+    /**
+     * Closing note under the button.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    closingNote: string;
+    /**
+     * Why the reader receives the email.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    footerReason: string;
+    /**
+     * Mailchimp campaign ID once prepared.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    mailchimpCampaignId: string | null;
+    /**
+     * Mailchimp web ID once prepared.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    mailchimpWebId: string | null;
+    /**
+     * Where to open the draft in Mailchimp.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    mailchimpCampaignUrl: string | null;
+    /**
+     * Last prepare in Mailchimp.
+     * @type {Date}
+     * @memberof NewsletterDto
+     */
+    preparedAt: Date | null;
+    /**
+     * Name of the admin who started the issue.
+     * @type {string}
+     * @memberof NewsletterDto
+     */
+    createdByName: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof NewsletterDto
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof NewsletterDto
+     */
+    updatedAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const NewsletterDtoStatusEnum = {
+    DRAFT: 'draft',
+    PREPARED: 'prepared'
+} as const;
+export type NewsletterDtoStatusEnum = typeof NewsletterDtoStatusEnum[keyof typeof NewsletterDtoStatusEnum];
+
+
+/**
+ * Check if a given object implements the NewsletterDto interface.
+ */
+export function instanceOfNewsletterDto(value: object): value is NewsletterDto {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('subject' in value) || value['subject'] === undefined) return false;
+    if (!('preheader' in value) || value['preheader'] === undefined) return false;
+    if (!('issueLabel' in value) || value['issueLabel'] === undefined) return false;
+    if (!('campaignSlug' in value) || value['campaignSlug'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('leadStoryUuid' in value) || value['leadStoryUuid'] === undefined) return false;
+    if (!('leadTeaser' in value) || value['leadTeaser'] === undefined) return false;
+    if (!('leadCta' in value) || value['leadCta'] === undefined) return false;
+    if (!('secondaryStories' in value) || value['secondaryStories'] === undefined) return false;
+    if (!('featureStoryUuid' in value) || value['featureStoryUuid'] === undefined) return false;
+    if (!('featureText' in value) || value['featureText'] === undefined) return false;
+    if (!('featureLink' in value) || value['featureLink'] === undefined) return false;
+    if (!('eventLead' in value) || value['eventLead'] === undefined) return false;
+    if (!('eventText' in value) || value['eventText'] === undefined) return false;
+    if (!('eventUrl' in value) || value['eventUrl'] === undefined) return false;
+    if (!('eventLink' in value) || value['eventLink'] === undefined) return false;
+    if (!('salesEnabled' in value) || value['salesEnabled'] === undefined) return false;
+    if (!('salesFrom' in value) || value['salesFrom'] === undefined) return false;
+    if (!('salesTo' in value) || value['salesTo'] === undefined) return false;
+    if (!('defaultSalesFrom' in value) || value['defaultSalesFrom'] === undefined) return false;
+    if (!('defaultSalesTo' in value) || value['defaultSalesTo'] === undefined) return false;
+    if (!('closingLine' in value) || value['closingLine'] === undefined) return false;
+    if (!('defaultClosingLine' in value) || value['defaultClosingLine'] === undefined) return false;
+    if (!('closingCta' in value) || value['closingCta'] === undefined) return false;
+    if (!('closingUrl' in value) || value['closingUrl'] === undefined) return false;
+    if (!('closingNote' in value) || value['closingNote'] === undefined) return false;
+    if (!('footerReason' in value) || value['footerReason'] === undefined) return false;
+    if (!('mailchimpCampaignId' in value) || value['mailchimpCampaignId'] === undefined) return false;
+    if (!('mailchimpWebId' in value) || value['mailchimpWebId'] === undefined) return false;
+    if (!('mailchimpCampaignUrl' in value) || value['mailchimpCampaignUrl'] === undefined) return false;
+    if (!('preparedAt' in value) || value['preparedAt'] === undefined) return false;
+    if (!('createdByName' in value) || value['createdByName'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function NewsletterDtoFromJSON(json: any): NewsletterDto {
+    return NewsletterDtoFromJSONTyped(json, false);
+}
+
+export function NewsletterDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsletterDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'title': json['title'],
+        'subject': json['subject'],
+        'preheader': json['preheader'],
+        'issueLabel': json['issueLabel'],
+        'campaignSlug': json['campaignSlug'],
+        'status': json['status'],
+        'leadStoryUuid': json['leadStoryUuid'],
+        'leadTeaser': json['leadTeaser'],
+        'leadCta': json['leadCta'],
+        'secondaryStories': ((json['secondaryStories'] as Array<any>).map(NewsletterSecondaryStoryDtoFromJSON)),
+        'featureStoryUuid': json['featureStoryUuid'],
+        'featureText': json['featureText'],
+        'featureLink': json['featureLink'],
+        'eventLead': json['eventLead'],
+        'eventText': json['eventText'],
+        'eventUrl': json['eventUrl'],
+        'eventLink': json['eventLink'],
+        'salesEnabled': json['salesEnabled'],
+        'salesFrom': json['salesFrom'],
+        'salesTo': json['salesTo'],
+        'defaultSalesFrom': json['defaultSalesFrom'],
+        'defaultSalesTo': json['defaultSalesTo'],
+        'closingLine': json['closingLine'],
+        'defaultClosingLine': json['defaultClosingLine'],
+        'closingCta': json['closingCta'],
+        'closingUrl': json['closingUrl'],
+        'closingNote': json['closingNote'],
+        'footerReason': json['footerReason'],
+        'mailchimpCampaignId': json['mailchimpCampaignId'],
+        'mailchimpWebId': json['mailchimpWebId'],
+        'mailchimpCampaignUrl': json['mailchimpCampaignUrl'],
+        'preparedAt': (json['preparedAt'] == null ? null : new Date(json['preparedAt'])),
+        'createdByName': json['createdByName'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+
+export function NewsletterDtoToJSON(json: any): NewsletterDto {
+    return NewsletterDtoToJSONTyped(json, false);
+}
+
+export function NewsletterDtoToJSONTyped(value?: NewsletterDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'title': value['title'],
+        'subject': value['subject'],
+        'preheader': value['preheader'],
+        'issueLabel': value['issueLabel'],
+        'campaignSlug': value['campaignSlug'],
+        'status': value['status'],
+        'leadStoryUuid': value['leadStoryUuid'],
+        'leadTeaser': value['leadTeaser'],
+        'leadCta': value['leadCta'],
+        'secondaryStories': ((value['secondaryStories'] as Array<any>).map(NewsletterSecondaryStoryDtoToJSON)),
+        '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'],
+        'defaultSalesFrom': value['defaultSalesFrom'],
+        'defaultSalesTo': value['defaultSalesTo'],
+        'closingLine': value['closingLine'],
+        'defaultClosingLine': value['defaultClosingLine'],
+        'closingCta': value['closingCta'],
+        'closingUrl': value['closingUrl'],
+        'closingNote': value['closingNote'],
+        'footerReason': value['footerReason'],
+        'mailchimpCampaignId': value['mailchimpCampaignId'],
+        'mailchimpWebId': value['mailchimpWebId'],
+        'mailchimpCampaignUrl': value['mailchimpCampaignUrl'],
+        'preparedAt': (value['preparedAt'] == null ? null : (value['preparedAt'] as any).toISOString()),
+        'createdByName': value['createdByName'],
+        'createdAt': ((value['createdAt']).toISOString()),
+        'updatedAt': ((value['updatedAt']).toISOString()),
+    };
+}
+

package/src/models/NewsletterPreviewDto.ts

@@ -0,0 +1,84 @@
+/* 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 NewsletterPreviewDto
+ */
+export interface NewsletterPreviewDto {
+    /**
+     * Subject line of the render.
+     * @type {string}
+     * @memberof NewsletterPreviewDto
+     */
+    subject: string;
+    /**
+     * The rendered email, styles inlined, Mailchimp merge tags replaced by placeholders.
+     * @type {string}
+     * @memberof NewsletterPreviewDto
+     */
+    html: string;
+    /**
+     * What the render left out and why, e.g. a sales period without a reportable sale. Empty when every enabled module rendered.
+     * @type {Array<string>}
+     * @memberof NewsletterPreviewDto
+     */
+    notices: Array<string>;
+}
+
+/**
+ * Check if a given object implements the NewsletterPreviewDto interface.
+ */
+export function instanceOfNewsletterPreviewDto(value: object): value is NewsletterPreviewDto {
+    if (!('subject' in value) || value['subject'] === undefined) return false;
+    if (!('html' in value) || value['html'] === undefined) return false;
+    if (!('notices' in value) || value['notices'] === undefined) return false;
+    return true;
+}
+
+export function NewsletterPreviewDtoFromJSON(json: any): NewsletterPreviewDto {
+    return NewsletterPreviewDtoFromJSONTyped(json, false);
+}
+
+export function NewsletterPreviewDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsletterPreviewDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subject': json['subject'],
+        'html': json['html'],
+        'notices': json['notices'],
+    };
+}
+
+export function NewsletterPreviewDtoToJSON(json: any): NewsletterPreviewDto {
+    return NewsletterPreviewDtoToJSONTyped(json, false);
+}
+
+export function NewsletterPreviewDtoToJSONTyped(value?: NewsletterPreviewDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subject': value['subject'],
+        'html': value['html'],
+        'notices': value['notices'],
+    };
+}
+

package/src/models/NewsletterSecondaryStoryDto.ts

@@ -0,0 +1,84 @@
+/* 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 NewsletterSecondaryStoryDto
+ */
+export interface NewsletterSecondaryStoryDto {
+    /**
+     * Storyblok story UUID.
+     * @type {string}
+     * @memberof NewsletterSecondaryStoryDto
+     */
+    uuid: string;
+    /**
+     * One line of context under the headline, under 20 words.
+     * @type {string}
+     * @memberof NewsletterSecondaryStoryDto
+     */
+    line: string;
+    /**
+     * Teaser-style link text, e.g. "What changed in commissions".
+     * @type {string}
+     * @memberof NewsletterSecondaryStoryDto
+     */
+    link: string;
+}
+
+/**
+ * Check if a given object implements the NewsletterSecondaryStoryDto interface.
+ */
+export function instanceOfNewsletterSecondaryStoryDto(value: object): value is NewsletterSecondaryStoryDto {
+    if (!('uuid' in value) || value['uuid'] === undefined) return false;
+    if (!('line' in value) || value['line'] === undefined) return false;
+    if (!('link' in value) || value['link'] === undefined) return false;
+    return true;
+}
+
+export function NewsletterSecondaryStoryDtoFromJSON(json: any): NewsletterSecondaryStoryDto {
+    return NewsletterSecondaryStoryDtoFromJSONTyped(json, false);
+}
+
+export function NewsletterSecondaryStoryDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsletterSecondaryStoryDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'uuid': json['uuid'],
+        'line': json['line'],
+        'link': json['link'],
+    };
+}
+
+export function NewsletterSecondaryStoryDtoToJSON(json: any): NewsletterSecondaryStoryDto {
+    return NewsletterSecondaryStoryDtoToJSONTyped(json, false);
+}
+
+export function NewsletterSecondaryStoryDtoToJSONTyped(value?: NewsletterSecondaryStoryDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'uuid': value['uuid'],
+        'line': value['line'],
+        'link': value['link'],
+    };
+}
+

package/src/models/NewsletterSecondaryStoryInput.ts

@@ -0,0 +1,84 @@
+/* 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 NewsletterSecondaryStoryInput
+ */
+export interface NewsletterSecondaryStoryInput {
+    /**
+     * Storyblok story UUID.
+     * @type {string}
+     * @memberof NewsletterSecondaryStoryInput
+     */
+    uuid: string;
+    /**
+     * One line of context under the headline, under 20 words.
+     * @type {string}
+     * @memberof NewsletterSecondaryStoryInput
+     */
+    line: string;
+    /**
+     * Teaser-style link text.
+     * @type {string}
+     * @memberof NewsletterSecondaryStoryInput
+     */
+    link: string;
+}
+
+/**
+ * Check if a given object implements the NewsletterSecondaryStoryInput interface.
+ */
+export function instanceOfNewsletterSecondaryStoryInput(value: object): value is NewsletterSecondaryStoryInput {
+    if (!('uuid' in value) || value['uuid'] === undefined) return false;
+    if (!('line' in value) || value['line'] === undefined) return false;
+    if (!('link' in value) || value['link'] === undefined) return false;
+    return true;
+}
+
+export function NewsletterSecondaryStoryInputFromJSON(json: any): NewsletterSecondaryStoryInput {
+    return NewsletterSecondaryStoryInputFromJSONTyped(json, false);
+}
+
+export function NewsletterSecondaryStoryInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsletterSecondaryStoryInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'uuid': json['uuid'],
+        'line': json['line'],
+        'link': json['link'],
+    };
+}
+
+export function NewsletterSecondaryStoryInputToJSON(json: any): NewsletterSecondaryStoryInput {
+    return NewsletterSecondaryStoryInputToJSONTyped(json, false);
+}
+
+export function NewsletterSecondaryStoryInputToJSONTyped(value?: NewsletterSecondaryStoryInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'uuid': value['uuid'],
+        'line': value['line'],
+        'link': value['link'],
+    };
+}
+