Module cloud_api

Enums

ConfirmCustomerPaymentError

struct for typed errors of method confirm_customer_payment

CreateCustomerPaymentError

struct for typed errors of method create_customer_payment

GetCloudCustomerError

struct for typed errors of method get_cloud_customer

GetCloudLimitsError

struct for typed errors of method get_cloud_limits

GetCloudProductsError

struct for typed errors of method get_cloud_products

GetInvoiceForSubscriptionAsPdfError

struct for typed errors of method get_invoice_for_subscription_as_pdf

GetInvoicesForSubscriptionError

struct for typed errors of method get_invoices_for_subscription

GetSubscriptionError

struct for typed errors of method get_subscription

PostEndpointForCwsWebhooksError

struct for typed errors of method post_endpoint_for_cws_webhooks

UpdateCloudCustomerAddressError

struct for typed errors of method update_cloud_customer_address

UpdateCloudCustomerError

struct for typed errors of method update_cloud_customer

Functions

confirm_customer_payment

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.

create_customer_payment

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.

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.

get_cloud_limits

Retrieve any cloud workspace limits applicable to this instance. ##### Permissions Must be authenticated and be licensed for Cloud. Minimum server version: 7.0 Note: This is intended for internal use and is subject to change.

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.

get_invoice_for_subscription_as_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.

get_invoices_for_subscription

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.

get_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.

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.

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.

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.