mirror of
https://github.com/mattermost/mattermost.git
synced 2026-02-03 20:40:00 -05:00
41 lines
1.4 KiB
TypeScript
41 lines
1.4 KiB
TypeScript
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
/// <reference types="cypress" />
|
|
|
|
// ***************************************************************
|
|
// Each command should be properly documented using JSDoc.
|
|
// See https://jsdoc.app/index.html for reference.
|
|
// Basic requirements for documentation are the following:
|
|
// - Meaningful description
|
|
// - Specific link to https://api.mattermost.com
|
|
// - Each parameter with `@params`
|
|
// - Return value with `@returns`
|
|
// - Example usage with `@example`
|
|
// Custom command should follow naming convention of having `api` prefix, e.g. `apiLogin`.
|
|
// ***************************************************************
|
|
|
|
declare namespace Cypress {
|
|
interface Chainable {
|
|
|
|
/**
|
|
* Get products.
|
|
* See https://api.mattermost.com/#operation/GetCloudProducts
|
|
* @returns {Product[]} out.Products: `Product[]` object
|
|
*
|
|
* @example
|
|
* cy.apiGetCloudProducts();
|
|
*/
|
|
apiGetCloudProducts(): Chainable<{products: Product[]}>;
|
|
|
|
/**
|
|
* Get subscriptions.
|
|
* See https://api.mattermost.com/#operation/GetSubscription
|
|
* @returns {Subscription} out.subscription: `Subscription` object
|
|
*
|
|
* @example
|
|
* cy.apiGetCloudSubscription();
|
|
*/
|
|
apiGetCloudSubscription(): Chainable<{subscription: Subscription}>;
|
|
}
|
|
}
|