Cloud

class matterapi.endpoints.async_api.CloudApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)

async confirm_customer_payment(*, multipart_data: Union[matterapi.models.ConfirmCustomerPaymentMultipartData, Dict]) → None

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

Warning

This is intended for internal use and is subject to change.

Api Reference:: ConfirmCustomerPayment

async create_customer_payment() → matterapi.models.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

Warning

This is intended for internal use and is subject to change.

Api Reference:: CreateCustomerPayment

async get_cloud_customer() → matterapi.models.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

Warning

This is intended for internal use and is subject to change.

Api Reference:: GetCloudCustomer

async get_cloud_products() → List[matterapi.models.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

Warning

This is intended for internal use and is subject to change.

Api Reference:: GetCloudProducts

async get_invoice_for_subscription_as_pdf(invoice_id: str) → None

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

Warning

This is intended for internal use and is subject to change.

Api Reference:: GetInvoiceForSubscriptionAsPdf

async get_invoices_for_subscription() → List[matterapi.models.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

Warning

This is intended for internal use and is subject to change.

Api Reference:: GetInvoicesForSubscription

async get_subscription() → matterapi.models.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

Warning

This is intended for internal use and is subject to change.

Api Reference:: GetSubscription

async get_subscription_stats() → matterapi.models.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

Warning

This is intended for internal use and is subject to change.

Api Reference:: GetSubscriptionStats

async post_endpoint_for_cws_webhooks() → None

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

Warning

This is intended for internal use and is subject to change.

Api Reference:: PostEndpointForCwsWebhooks

async send_admin_upgrade_request_email() → None

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

Warning

This is intended for internal use and is subject to change.

Api Reference:: SendAdminUpgradeRequestEmail

async send_admin_upgrade_request_email_on_join() → None

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

Warning

This is intended for internal use and is subject to change.

Api Reference:: SendAdminUpgradeRequestEmailOnJoin

async update_cloud_customer(*, json_body: Union[matterapi.models.UpdateCloudCustomerJsonBody, Dict]) → matterapi.models.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

Warning

This is intended for internal use and is subject to change.

Api Reference:: UpdateCloudCustomer

async update_cloud_customer_address(*, json_body: Union[matterapi.models.Address, Dict]) → matterapi.models.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

Warning

This is intended for internal use and is subject to change.

Api Reference:: UpdateCloudCustomerAddress