import { GetPayments200Response } from '../../models/base/get-payments200-response/index'; import { Api, ApiClient, RequestMetadata } from '@ama-sdk/core'; /** Parameters object to PaymentsApi's getPayments function */ export interface PaymentsApiGetPaymentsRequestData { /** Short-lived token returned from \"getPluginPaymentTokenAsync\" in the plugin payments API and used to authenticate to this endpoint. Read more about generating this token through \"Calling the Payments REST API from a plugin or widget\" below. */ 'plugin_payment_token'?: string; /** The ID of the user to query payment information about. You can get the user ID by having the user OAuth2 to the Figma REST API. */ 'user_id'?: string; /** The ID of the Community file to query a user's payment information on. You can get the Community file ID from the file's Community page (look for the number after \"file/\" in the URL). Provide exactly one of \"community_file_id\", \"plugin_id\", or \"widget_id\". */ 'community_file_id'?: string; /** The ID of the plugin to query a user's payment information on. You can get the plugin ID from the plugin's manifest, or from the plugin's Community page (look for the number after \"plugin/\" in the URL). Provide exactly one of \"community_file_id\", \"plugin_id\", or \"widget_id\". */ 'plugin_id'?: string; /** The ID of the widget to query a user's payment information on. You can get the widget ID from the widget's manifest, or from the widget's Community page (look for the number after \"widget/\" in the URL). Provide exactly one of \"community_file_id\", \"plugin_id\", or \"widget_id\". */ 'widget_id'?: string; } export declare class PaymentsApi implements Api { /** API name */ static readonly apiName = "PaymentsApi"; /** @inheritDoc */ readonly apiName = "PaymentsApi"; /** Tokens of the parameters containing PII */ readonly piiParamTokens: { [key: string]: string; }; /** @inheritDoc */ client: ApiClient; /** * Initialize your interface * * @param apiClient Client used to process call to the API */ constructor(apiClient: ApiClient); /** * Get payments * There are two methods to query for a user's payment information on a plugin, widget, or Community file. The first method, using plugin payment tokens, is typically used when making queries from a plugin's or widget's code. The second method, providing a user ID and resource ID, is typically used when making queries from anywhere else. Note that you can only query for resources that you own. In most cases, this means that you can only query resources that you originally created. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getPayments(data: PaymentsApiGetPaymentsRequestData, metadata?: RequestMetadata): Promise; } //# sourceMappingURL=payments-api.d.ts.map