@randock/nameshift-api-client 0.0.448 → 0.0.450

package/dist/apis/AccountsApi.d.ts

@@ -84,182 +84,182 @@ export interface AccountsApiUpdateSettingsRequest {
  */
 export declare class AccountsApi extends runtime.BaseAPI {
     /**
-     * Creates a new account payment for a feature or service purchase.
+     * Creates a new account payment for a feature or service purchase.  **API key scope required:** `PAYMENTS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Create account payment
      */
     createAccountPaymentRaw(requestParameters: AccountsApiCreateAccountPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectId>>;
     /**
-     * Creates a new account payment for a feature or service purchase.
+     * Creates a new account payment for a feature or service purchase.  **API key scope required:** `PAYMENTS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Create account payment
      */
     createAccountPayment(requestParameters: AccountsApiCreateAccountPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectId>;
     /**
-     * Creates a new manual transaction for account payment with specified open invoice
+     * Creates a new manual transaction for account payment with specified open invoice  **API key scope required:** `PAYMENTS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Create a new manual transaction for account payment invoice
      */
     createAccountPaymentManualTransactionRaw(requestParameters: AccountsApiCreateAccountPaymentManualTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Creates a new manual transaction for account payment with specified open invoice
+     * Creates a new manual transaction for account payment with specified open invoice  **API key scope required:** `PAYMENTS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Create a new manual transaction for account payment invoice
      */
     createAccountPaymentManualTransaction(requestParameters: AccountsApiCreateAccountPaymentManualTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Permanently deletes the current seller account.
+     * Permanently deletes the current seller account.  **API key scope required:** `ACCOUNT_DELETE`. Requests authenticated with a seller session do not need any scope.
      * Delete current account
      */
     deleteMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Permanently deletes the current seller account.
+     * Permanently deletes the current seller account.  **API key scope required:** `ACCOUNT_DELETE`. Requests authenticated with a seller session do not need any scope.
      * Delete current account
      */
     deleteMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Returns details of a specific account payment.
+     * Returns details of a specific account payment.  **API key scope required:** `PAYMENTS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get account payment
      */
     getAccountPaymentRaw(requestParameters: AccountsApiGetAccountPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountPaymentDto>>;
     /**
-     * Returns details of a specific account payment.
+     * Returns details of a specific account payment.  **API key scope required:** `PAYMENTS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get account payment
      */
     getAccountPayment(requestParameters: AccountsApiGetAccountPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountPaymentDto>;
     /**
-     * Returns saved payment methods for the account filtered by payment gateway.
+     * Returns saved payment methods for the account filtered by payment gateway.  **API key scope required:** `PAYMENTS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get account payment methods
      */
     getAccountPaymentMethodsRaw(requestParameters: AccountsApiGetAccountPaymentMethodsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AccountPaymentMethodDto>>>;
     /**
-     * Returns saved payment methods for the account filtered by payment gateway.
+     * Returns saved payment methods for the account filtered by payment gateway.  **API key scope required:** `PAYMENTS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get account payment methods
      */
     getAccountPaymentMethods(requestParameters: AccountsApiGetAccountPaymentMethodsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AccountPaymentMethodDto>>;
     /**
-     * Returns an onboarding session for the account payment provider setup.
+     * Returns an onboarding session for the account payment provider setup.  **API key scope required:** `PAYOUTS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get payment provider onboarding session
      */
     getAccountPaymentProviderSessionRaw(requestParameters: AccountsApiGetAccountPaymentProviderSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountOnboardingSessionDto>>;
     /**
-     * Returns an onboarding session for the account payment provider setup.
+     * Returns an onboarding session for the account payment provider setup.  **API key scope required:** `PAYOUTS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get payment provider onboarding session
      */
     getAccountPaymentProviderSession(requestParameters: AccountsApiGetAccountPaymentProviderSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountOnboardingSessionDto>;
     /**
-     * Returns a summary of pending affiliate commission amounts grouped by currency.
+     * Returns a summary of pending affiliate commission amounts grouped by currency.  **API key scope required:** `COMMISSIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get pending affiliate commissions summary
      */
     getAccountPendingAffiliateCommissionsSummaryRaw(requestParameters: AccountsApiGetAccountPendingAffiliateCommissionsSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<MoneyDto>>>;
     /**
-     * Returns a summary of pending affiliate commission amounts grouped by currency.
+     * Returns a summary of pending affiliate commission amounts grouped by currency.  **API key scope required:** `COMMISSIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get pending affiliate commissions summary
      */
     getAccountPendingAffiliateCommissionsSummary(requestParameters: AccountsApiGetAccountPendingAffiliateCommissionsSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MoneyDto>>;
     /**
-     * Returns the settings for the current seller account.
+     * Returns the settings for the current seller account.  **API key scope required:** `ACCOUNT_READ`. Requests authenticated with a seller session do not need any scope.
      * Get account settings
      */
     getAccountSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountSettingsDto>>;
     /**
-     * Returns the settings for the current seller account.
+     * Returns the settings for the current seller account.  **API key scope required:** `ACCOUNT_READ`. Requests authenticated with a seller session do not need any scope.
      * Get account settings
      */
     getAccountSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountSettingsDto>;
     /**
-     * Lists affiliate commissions for the seller account.
+     * Lists affiliate commissions for the seller account.  **API key scope required:** `COMMISSIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * List affiliate commissions
      */
     getAllAffiliateCommissionsRaw(requestParameters: AccountsApiGetAllAffiliateCommissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllAffiliateCommissions200Response>>;
     /**
-     * Lists affiliate commissions for the seller account.
+     * Lists affiliate commissions for the seller account.  **API key scope required:** `COMMISSIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * List affiliate commissions
      */
     getAllAffiliateCommissions(requestParameters: AccountsApiGetAllAffiliateCommissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllAffiliateCommissions200Response>;
     /**
-     * Lists accounts referred by the seller.
+     * Lists accounts referred by the seller.  **API key scope required:** `COMMISSIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * List account referrals
      */
     getAllReferralsRaw(requestParameters: AccountsApiGetAllReferralsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllReferrals200Response>>;
     /**
-     * Lists accounts referred by the seller.
+     * Lists accounts referred by the seller.  **API key scope required:** `COMMISSIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * List account referrals
      */
     getAllReferrals(requestParameters: AccountsApiGetAllReferralsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllReferrals200Response>;
     /**
-     * Returns Nameshift commission percentages and schedules for the current account.
+     * Returns Nameshift commission percentages and schedules for the current account.  **API key scope required:** `COMMISSIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get Nameshift commissions
      */
     getNameshiftCommissionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAccountNameshiftCommissionsResponseDto>>;
     /**
-     * Returns Nameshift commission percentages and schedules for the current account.
+     * Returns Nameshift commission percentages and schedules for the current account.  **API key scope required:** `COMMISSIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get Nameshift commissions
      */
     getNameshiftCommissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAccountNameshiftCommissionsResponseDto>;
     /**
-     * Returns the current seller account information.
+     * Returns the current seller account information.  **API key scope required:** `ACCOUNT_READ`. Requests authenticated with a seller session do not need any scope.
      * Get current account
      */
     meRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PrivateAccountGetMeResponse>>;
     /**
-     * Returns the current seller account information.
+     * Returns the current seller account information.  **API key scope required:** `ACCOUNT_READ`. Requests authenticated with a seller session do not need any scope.
      * Get current account
      */
     me(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PrivateAccountGetMeResponse>;
     /**
-     * Pays an account payment by confirming the payment intent using the specified payment method
+     * Pays an account payment by confirming the payment intent using the specified payment method  **API key scope required:** `PAYMENTS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Pay an account payment
      */
     payAccountPaymentRaw(requestParameters: AccountsApiPayAccountPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Pays an account payment by confirming the payment intent using the specified payment method
+     * Pays an account payment by confirming the payment intent using the specified payment method  **API key scope required:** `PAYMENTS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Pay an account payment
      */
     payAccountPayment(requestParameters: AccountsApiPayAccountPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Creates or updates billing information for the current seller account.
+     * Creates or updates billing information for the current seller account.  **API key scope required:** `ACCOUNT_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update billing information
      */
     postBillingInformationRaw(requestParameters: AccountsApiPostBillingInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Creates or updates billing information for the current seller account.
+     * Creates or updates billing information for the current seller account.  **API key scope required:** `ACCOUNT_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update billing information
      */
     postBillingInformation(requestParameters: AccountsApiPostBillingInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Marks an account notification as read.
+     * Marks an account notification as read.  **API key scope required:** `NOTIFICATIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Mark notification as read
      */
     postReadAccountNotificationRaw(requestParameters: AccountsApiPostReadAccountNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Marks an account notification as read.
+     * Marks an account notification as read.  **API key scope required:** `NOTIFICATIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Mark notification as read
      */
     postReadAccountNotification(requestParameters: AccountsApiPostReadAccountNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Uploads or replaces the avatar image displayed on the account landing page.
+     * Uploads or replaces the avatar image displayed on the account landing page.  **API key scope required:** `ACCOUNT_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Upload landing page avatar
      */
     putAvatarRaw(requestParameters: AccountsApiPutAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Uploads or replaces the avatar image displayed on the account landing page.
+     * Uploads or replaces the avatar image displayed on the account landing page.  **API key scope required:** `ACCOUNT_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Upload landing page avatar
      */
     putAvatar(requestParameters: AccountsApiPutAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Sets the payout provider for the current seller account.
+     * Sets the payout provider for the current seller account.  **API key scope required:** `PAYOUTS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Set payout provider
      */
     setPayoutProviderRaw(requestParameters: AccountsApiSetPayoutProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Sets the payout provider for the current seller account.
+     * Sets the payout provider for the current seller account.  **API key scope required:** `PAYOUTS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Set payout provider
      */
     setPayoutProvider(requestParameters: AccountsApiSetPayoutProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Updates seller account settings.
+     * Updates seller account settings.  **API key scope required:** `ACCOUNT_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update account settings
      */
     updateSettingsRaw(requestParameters: AccountsApiUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Updates seller account settings.
+     * Updates seller account settings.  **API key scope required:** `ACCOUNT_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update account settings
      */
     updateSettings(requestParameters: AccountsApiUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;