@randock/nameshift-api-client 0.0.505 → 0.0.506

package/.openapi-generator/FILES

@@ -114,6 +114,7 @@ src/models/AdminLeadListItemDomainDto.ts
 src/models/AdminLeadListItemDto.ts
 src/models/AdminListAccountDto.ts
 src/models/AdminMarketplaceDto.ts
+src/models/AdminUserNewsletterInput.ts
 src/models/AdminUserSecurityDto.ts
 src/models/AdminVerificationDepositDto.ts
 src/models/AffiliatesStatsDto.ts
@@ -243,6 +244,7 @@ src/models/CreateLeadInput.ts
 src/models/CreateLeadMessageInput.ts
 src/models/CreateManualLeadInput.ts
 src/models/CreateManualTransactionInput.ts
+src/models/CreateNewsletterInput.ts
 src/models/CreateOrderInput.ts
 src/models/CreateSubscriptionBillingPeriodicityInput.ts
 src/models/CreateSubscriptionInput.ts
@@ -463,6 +465,11 @@ src/models/MoneyDecimalDto.ts
 src/models/MoneyDto.ts
 src/models/MoneyInput.ts
 src/models/MozMetrics.ts
+src/models/NewsStoryDto.ts
+src/models/NewsletterDto.ts
+src/models/NewsletterPreviewDto.ts
+src/models/NewsletterSecondaryStoryDto.ts
+src/models/NewsletterSecondaryStoryInput.ts
 src/models/NotificationsUnsubscribeResultDto.ts
 src/models/ObjectId.ts
 src/models/OrderCompanyInfoDto.ts
@@ -571,6 +578,7 @@ src/models/SellerTotalEarningsByCurrencyStatsItemDto.ts
 src/models/SellerTotalRentMonthlyIncomeByCurrencyStatsItemDto.ts
 src/models/SendAdminLeadAiPriceNegotiatorAgentChatMessageInput.ts
 src/models/SendAdminLeadAiPriceNegotiatorAgentChatMessageInputAiModel.ts
+src/models/SendNewsletterPreviewInput.ts
 src/models/SeoMetricsDto.ts
 src/models/SetAccountMarketplaceInput.ts
 src/models/SetDomainTransferConfirmationInput.ts
@@ -637,6 +645,7 @@ src/models/UpdateLeadMuteStatusForBuyerInput.ts
 src/models/UpdateLeadMuteStatusInput.ts
 src/models/UpdateLeaseToOwnConfigurationDto.ts
 src/models/UpdateMarketplaceInput.ts
+src/models/UpdateNewsletterInput.ts
 src/models/UpdateOrderInput.ts
 src/models/UpdateRentConfigurationDto.ts
 src/models/UpdateSubscriptionBillingPeriodicityInput.ts

package/README.md

@@ -1,4 +1,4 @@
-## @randock/nameshift-api-client@0.0.505
+## @randock/nameshift-api-client@0.0.506
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @randock/nameshift-api-client@0.0.505 --save
+npm install @randock/nameshift-api-client@0.0.506 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
-21090f00f434eb586609919b92f9223ba13fff5928311f2bcd77341ac2151ca4c2fd04f7a8240da4b62db5a4e9a26f53
+09ddfd85dfec90d7df4147983a74430e220e8dccce850f2734fab3120ead7e00a1433901ec8aa47bd51b289e8f84beae

package/dist/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AccountNameshiftCommissionByTypeDto, AccountNoteListDto, AccountPaymentMethodProfileDto, AccountSettingsDto, AdminAccountLoginDto, AdminAccountSettingsInput, AdminBuyerLoginDto, AdminChallengeListDto, AdminCompanyStatsDto, AdminDashboardStatsDto, AdminGetAllDomainTransfers200Response, AdminLandingDesignStatsDto, AdminMarketplaceDto, AdminUserSecurityDto, BulkCommissionActionsInput, ChangeInvoiceStatusInput, ChangeOrderStatusInput, ChangeSubscriptionStatusInput, CommissionListDto, CommissionSimulationResultDto, CreateAccountNoteInput, CreateChallengeInput, DomainLockDto, DomainStatsDto, DomainTldsDto, DomainTransferDetailsDto, GetAccountChallengeRewardUsagesListDto, GetAdminDomainAppraisalRequests200Response, GetAllAuctions200Response, GetAllFeatureFlags200Response, GetAllInvoices200Response, GetAllOrders200Response, GetAllOwnedDomains200Response, GetAllSubscriptions200Response, IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto, LeadEnrichmentDto, LeadMessageDto, LedgerMutationsDto, LinkBankDepositToBankAccountInput, LinkBankDepositToInvoiceInput, ListAccounts200Response, ListAdminLandingDesignAccounts200Response, ListAdminRelatedLeads200Response, ListBankAccounts200Response, ListBankDeposits200Response, ListDomains200Response, ListLeadMessagesDto, ListLeads200Response, ListUserLoginAttempts200Response, ObjectId, PaySellerInvoicesInput, SellerLeadDetails, SellerPayoutPreviewDto, SellerSalesByTldStatsItemDto, SellerSalesCountStatsItemDto, SendAdminLeadAiPriceNegotiatorAgentChatMessageInput, SimulateCommissionInput, StatsFilterInputDateRange, SubscriptionDetailsDto, UpdateAccountChallengeRewardBalanceInput, UpdateAccountNoteInput, UpdateAdminDomainTransferBuyerCompanyInfoInput, UpdateAdminDomainTransferBuyerInfoInput, UpdateChallengeInput, UpdateFeatureFlagInput, UpdateMarketplaceInput, UpdateSubscriptionBuyerInformationInput } from '../models/index';
+import type { AccountNameshiftCommissionByTypeDto, AccountNoteListDto, AccountPaymentMethodProfileDto, AccountSettingsDto, AdminAccountLoginDto, AdminAccountSettingsInput, AdminBuyerLoginDto, AdminChallengeListDto, AdminCompanyStatsDto, AdminDashboardStatsDto, AdminGetAllDomainTransfers200Response, AdminLandingDesignStatsDto, AdminMarketplaceDto, AdminUserNewsletterInput, AdminUserSecurityDto, BulkCommissionActionsInput, ChangeInvoiceStatusInput, ChangeOrderStatusInput, ChangeSubscriptionStatusInput, CommissionListDto, CommissionSimulationResultDto, CreateAccountNoteInput, CreateChallengeInput, CreateNewsletterInput, DomainLockDto, DomainStatsDto, DomainTldsDto, DomainTransferDetailsDto, GetAccountChallengeRewardUsagesListDto, GetAdminDomainAppraisalRequests200Response, GetAllAuctions200Response, GetAllFeatureFlags200Response, GetAllInvoices200Response, GetAllOrders200Response, GetAllOwnedDomains200Response, GetAllSubscriptions200Response, IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto, LeadEnrichmentDto, LeadMessageDto, LedgerMutationsDto, LinkBankDepositToBankAccountInput, LinkBankDepositToInvoiceInput, ListAccounts200Response, ListAdminLandingDesignAccounts200Response, ListAdminRelatedLeads200Response, ListBankAccounts200Response, ListBankDeposits200Response, ListDomains200Response, ListLeadMessagesDto, ListLeads200Response, ListUserLoginAttempts200Response, NewsStoryDto, NewsletterDto, NewsletterPreviewDto, ObjectId, PaySellerInvoicesInput, SellerLeadDetails, SellerPayoutPreviewDto, SellerSalesByTldStatsItemDto, SellerSalesCountStatsItemDto, SendAdminLeadAiPriceNegotiatorAgentChatMessageInput, SendNewsletterPreviewInput, SimulateCommissionInput, StatsFilterInputDateRange, SubscriptionDetailsDto, UpdateAccountChallengeRewardBalanceInput, UpdateAccountNoteInput, UpdateAdminDomainTransferBuyerCompanyInfoInput, UpdateAdminDomainTransferBuyerInfoInput, UpdateChallengeInput, UpdateFeatureFlagInput, UpdateMarketplaceInput, UpdateNewsletterInput, UpdateSubscriptionBuyerInformationInput } from '../models/index';
 export interface AdminApiAdminDeleteAuctionRequest {
     auctionId: string;
 }
@@ -63,6 +63,9 @@ export interface AdminApiCreateChallengeRequest {
 export interface AdminApiCreateNegativeInvoiceRequest {
     invoiceId: string;
 }
+export interface AdminApiCreateNewsletterRequest {
+    createNewsletterInput: CreateNewsletterInput;
+}
 export interface AdminApiDeleteAccountNoteRequest {
     accountId: string;
     noteId: string;
@@ -198,6 +201,9 @@ export interface AdminApiGetDomainStatsRequest {
 export interface AdminApiGetLedgerMutationAttachmentRequest {
     attachmentId: string;
 }
+export interface AdminApiGetNewsletterRequest {
+    newsletterId: string;
+}
 export interface AdminApiGetSubscriptionDetailsRequest {
     subscriptionId: string;
 }
@@ -334,6 +340,12 @@ export interface AdminApiPostAdminExecuteDomainTransferStepActionRequest {
 export interface AdminApiPostAiPriceNegotiatorAgentChatMessageRequest {
     sendAdminLeadAiPriceNegotiatorAgentChatMessageInput: SendAdminLeadAiPriceNegotiatorAgentChatMessageInput;
 }
+export interface AdminApiPrepareNewsletterRequest {
+    newsletterId: string;
+}
+export interface AdminApiPreviewNewsletterRequest {
+    newsletterId: string;
+}
 export interface AdminApiPreviewSellerPayoutRequest {
     paySellerInvoicesInput: PaySellerInvoicesInput;
 }
@@ -356,6 +368,10 @@ export interface AdminApiReopenAdminLeadRequest {
 export interface AdminApiResetUserSecondFactorsRequest {
     userId: string;
 }
+export interface AdminApiSendNewsletterTestRequest {
+    newsletterId: string;
+    sendNewsletterPreviewInput: SendNewsletterPreviewInput;
+}
 export interface AdminApiShowcaseDomainRequest {
     domainId: string;
 }
@@ -399,10 +415,18 @@ export interface AdminApiUpdateMarketplaceRequest {
     code: UpdateMarketplaceCodeEnum;
     updateMarketplaceInput: UpdateMarketplaceInput;
 }
+export interface AdminApiUpdateNewsletterRequest {
+    newsletterId: string;
+    updateNewsletterInput: UpdateNewsletterInput;
+}
 export interface AdminApiUpdateSubscriptionBuyerInformationRequest {
     subscriptionId: string;
     updateSubscriptionBuyerInformationInput: UpdateSubscriptionBuyerInformationInput;
 }
+export interface AdminApiUpdateUserNewsletterStatusRequest {
+    userId: object;
+    adminUserNewsletterInput: AdminUserNewsletterInput;
+}
 export interface AdminApiVerifyAccountAliasRequest {
     accountId: string;
 }
@@ -543,6 +567,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Create negative invoice
      */
     createNegativeInvoice(requestParameters: AdminApiCreateNegativeInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectId>;
+    /**
+     * Creates a draft issue with the default closing band and footer; everything can be edited afterwards.
+     * Start a newsletter
+     */
+    createNewsletterRaw(requestParameters: AdminApiCreateNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NewsletterDto>>;
+    /**
+     * Creates a draft issue with the default closing band and footer; everything can be edited afterwards.
+     * Start a newsletter
+     */
+    createNewsletter(requestParameters: AdminApiCreateNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NewsletterDto>;
     /**
      * Soft-deletes a note. Only its author, or a super admin, may do so.
      * Delete account note
@@ -813,6 +847,14 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Download ledger mutation attachment
      */
     getLedgerMutationAttachment(requestParameters: AdminApiGetLedgerMutationAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Get a newsletter
+     */
+    getNewsletterRaw(requestParameters: AdminApiGetNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NewsletterDto>>;
+    /**
+     * Get a newsletter
+     */
+    getNewsletter(requestParameters: AdminApiGetNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NewsletterDto>;
     /**
      * Returns subscription information.
      * Get subscription details
@@ -1001,6 +1043,26 @@ export declare class AdminApi extends runtime.BaseAPI {
      * List ledger mutations
      */
     listLedgerMutations(requestParameters: AdminApiListLedgerMutationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LedgerMutationsDto>;
+    /**
+     * The published news articles, newest first.
+     * List the blog posts a newsletter can pick
+     */
+    listNewsletterStoriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NewsStoryDto>>>;
+    /**
+     * The published news articles, newest first.
+     * List the blog posts a newsletter can pick
+     */
+    listNewsletterStories(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NewsStoryDto>>;
+    /**
+     * Every newsletter issue, newest first.
+     * List newsletters
+     */
+    listNewslettersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NewsletterDto>>>;
+    /**
+     * Every newsletter issue, newest first.
+     * List newsletters
+     */
+    listNewsletters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NewsletterDto>>;
     /**
      * List the sign-ins of a user
      */
@@ -1079,6 +1141,26 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Test AI price negotiator agent
      */
     postAiPriceNegotiatorAgentChatMessage(requestParameters: AdminApiPostAiPriceNegotiatorAgentChatMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<LeadMessageDto>>;
+    /**
+     * Creates the Mailchimp draft campaign, or refreshes the existing one, with the current render. The campaign is never sent or scheduled from here.
+     * Prepare the newsletter in Mailchimp
+     */
+    prepareNewsletterRaw(requestParameters: AdminApiPrepareNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NewsletterDto>>;
+    /**
+     * Creates the Mailchimp draft campaign, or refreshes the existing one, with the current render. The campaign is never sent or scheduled from here.
+     * Prepare the newsletter in Mailchimp
+     */
+    prepareNewsletter(requestParameters: AdminApiPrepareNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NewsletterDto>;
+    /**
+     * The email as it would go to Mailchimp, with the merge tags replaced by placeholders, for the live preview.
+     * Render a newsletter
+     */
+    previewNewsletterRaw(requestParameters: AdminApiPreviewNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NewsletterPreviewDto>>;
+    /**
+     * The email as it would go to Mailchimp, with the merge tags replaced by placeholders, for the live preview.
+     * Render a newsletter
+     */
+    previewNewsletter(requestParameters: AdminApiPreviewNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NewsletterPreviewDto>;
     /**
      * Tells what paying these invoices out together would do, without doing it: the bank account the transfer goes to, and the fee taken out of what the seller receives. Refuses what paying them would refuse.
      * Preview a payout of seller invoices
@@ -1149,6 +1231,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Remove every second factor of a user
      */
     resetUserSecondFactors(requestParameters: AdminApiResetUserSecondFactorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Sends the current render to one address through the normal mailer, subject prefixed with [Preview]. Not a Mailchimp send.
+     * Mail a preview of the newsletter
+     */
+    sendNewsletterTestRaw(requestParameters: AdminApiSendNewsletterTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sends the current render to one address through the normal mailer, subject prefixed with [Preview]. Not a Mailchimp send.
+     * Mail a preview of the newsletter
+     */
+    sendNewsletterTest(requestParameters: AdminApiSendNewsletterTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Picks the domain for the public showcase on the website. Idempotent: showcasing an already showcased domain keeps its original position in the showcase.
      * Showcase domain
@@ -1269,6 +1361,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Update a marketplace
      */
     updateMarketplace(requestParameters: AdminApiUpdateMarketplaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Saves the given fields. Any edit puts a prepared issue back to draft until it is prepared again.
+     * Update a newsletter
+     */
+    updateNewsletterRaw(requestParameters: AdminApiUpdateNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NewsletterDto>>;
+    /**
+     * Saves the given fields. Any edit puts a prepared issue back to draft until it is prepared again.
+     * Update a newsletter
+     */
+    updateNewsletter(requestParameters: AdminApiUpdateNewsletterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NewsletterDto>;
     /**
      * Updates the buyer information stored on the subscription. The change is applied from the next renewal onwards: the already issued invoices, including the active one, are left untouched. Note that the emails related to the current invoice are still sent to the email of that invoice.
      * Update subscription buyer information
@@ -1279,6 +1381,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Update subscription buyer information
      */
     updateSubscriptionBuyerInformation(requestParameters: AdminApiUpdateSubscriptionBuyerInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
+     * Update the seller newsletter consent of a user
+     */
+    updateUserNewsletterStatusRaw(requestParameters: AdminApiUpdateUserNewsletterStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
+     * Update the seller newsletter consent of a user
+     */
+    updateUserNewsletterStatus(requestParameters: AdminApiUpdateUserNewsletterStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Marks the account alias as verified, so it is shown on the landing pages instead of the official name. Also lifts a previous rejection.
      * Verify account alias