CloudApi class

Constructors

CloudApi(Dio _dio, Serializers _serializers)

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

confirmCustomerPayment({String? stripeSetupIntentId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Completes the payment setup intent Confirms the payment setup intent initiated when posting to `/cloud/payment`. ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.28 Note: This is intended for internal use and is subject to change.

createCustomerPayment({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<PaymentSetupIntent>>

Create a customer setup payment intent Creates a customer setup payment intent for the given Mattermost cloud installation. ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.28 Note:: This is intended for internal use and is subject to change.

getCloudCustomer({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<CloudCustomer>>

Get cloud customer Retrieves the customer information for the Mattermost Cloud customer bound to this installation. ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.28 Note: This is intended for internal use and is subject to change.

getCloudProducts({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Product>>>

Get cloud products Retrieve a list of all products that are offered for Mattermost Cloud. ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.28 Note: This is intended for internal use and is subject to change.

getInvoiceForSubscriptionAsPdf({required String invoiceId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Get cloud invoice PDF Retrieves the PDF for the invoice passed as parameter ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.30 Note: This is intended for internal use and is subject to change.

getInvoicesForSubscription({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Invoice>>>

Get cloud subscription invoices Retrieves the invoices for the subscription bound to this installation. ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.30 Note: This is intended for internal use and is subject to change.

getSubscription({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Subscription>>

Get cloud subscription Retrieves the subscription information for the Mattermost Cloud customer bound to this installation. ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.28 Note: This is intended for internal use and is subject to change.

getSubscriptionStats({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<SubscriptionStats>>

GET endpoint for cloud subscription stats An endpoint that returns stats about a user's subscription. For example remaining seats on a free tier ##### Permissions This endpoint should only be accessed in a Mattermost Cloud instance Minimum server version: 5.34 Note: This is intended for internal use and is subject to change.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

postEndpointForCwsWebhooks({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

POST endpoint for CWS Webhooks An endpoint for processing webhooks from the Customer Portal ##### Permissions This endpoint should only be accessed by CWS, in a Mattermost Cloud instance Minimum server version: 5.30 Note: This is intended for internal use and is subject to change.

sendAdminUpgradeRequestEmail({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

POST endpoint for triggering sending emails to admin with request to upgrade workspace An endpoint that triggers sending emails to all sys admins to request them to upgrade the workspace when a user tries to invite more users ##### Permissions This endpoint should only be accessed in a Mattermost Cloud instance Minimum server version: 5.34 Note: This is intended for internal use and is subject to change.

sendAdminUpgradeRequestEmailOnJoin({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

POST endpoint for triggering sending emails to admin with request to upgrade workspace An endpoint that triggers sending emails to all sys admins to request them to upgrade the workspace when a user tries to join the workspace ##### Permissions This endpoint should only be accessed in a Mattermost Cloud instance Minimum server version: 5.34 Note: This is intended for internal use and is subject to change.

toString() → String

A string representation of this object.

inherited

updateCloudCustomer({required InlineObject109 inlineObject109, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<CloudCustomer>>

Update cloud customer Updates the customer information for the Mattermost Cloud customer bound to this installation. ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.29 Note: This is intended for internal use and is subject to change.

updateCloudCustomerAddress({required Address address, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<CloudCustomer>>

Update cloud customer address Updates the company address for the Mattermost Cloud customer bound to this installation. ##### Permissions Must have `manage_system` permission and be licensed for Cloud. Minimum server version: 5.29 Note: This is intended for internal use and is subject to change.

Operators

operator ==(Object other) → bool

The equality operator.

inherited