@maxio-com/advanced-billing-sdk
Version:
Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.
131 lines • 8.91 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core.js';
import { ListSaleRepItem } from '../models/listSaleRepItem.js';
import { SaleRep } from '../models/saleRep.js';
import { SaleRepSettings } from '../models/saleRepSettings.js';
import { BaseController } from './baseController.js';
export declare class SalesCommissionsController extends BaseController {
/**
* Endpoint returns subscriptions with associated sales reps
*
* ## Modified Authentication Process
*
* The Sales Commission API differs from other Chargify API endpoints. This resource is associated with
* the seller itself. Up to now all available resources were at the level of the site, therefore
* creating the API Key per site was a sufficient solution. To share resources at the seller level, a
* new authentication method was introduced, which is user authentication. Creating an API Key for a
* user is a required step to correctly use the Sales Commission API, more details [here](https:
* //developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
*
* Access to the Sales Commission API endpoints is available to users with financial access, where the
* seller has the Advanced Analytics component enabled. For further information on getting access to
* Advanced Analytics contact Maxio support.
*
* > Note: The request is at seller level, it means `<<subdomain>>` variable will be replaced by `app`
*
* @param sellerId The Chargify id of your seller account
* @param authorization For authorization use user API key. See details [here](https://developers.
* chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-
* authentication).
* @param liveMode This parameter indicates if records should be fetched from live mode sites.
* Default value is true.
* @param page Result records are organized in pages. By default, the first page of results is
* displayed. The page parameter specifies a page number of results to fetch. You can
* start navigating through the pages to consume the results. You do this by passing
* in a page parameter. Retrieve the next page by adding ?page=2 to the query string.
* If there are no results to return, then an empty result set will be returned. Use
* in query `page=1`.
* @param perPage This parameter indicates how many records to fetch in each request. Default value
* is 100.
* @return Response from the API call
*/
listSalesCommissionSettings({ sellerId, authorization, liveMode, page, perPage, }: {
sellerId: string;
authorization?: string;
liveMode?: boolean;
page?: number;
perPage?: number;
}, requestOptions?: RequestOptions): Promise<ApiResponse<SaleRepSettings[]>>;
/**
* Endpoint returns sales rep list with details
*
* ## Modified Authentication Process
*
* The Sales Commission API differs from other Chargify API endpoints. This resource is associated with
* the seller itself. Up to now all available resources were at the level of the site, therefore
* creating the API Key per site was a sufficient solution. To share resources at the seller level, a
* new authentication method was introduced, which is user authentication. Creating an API Key for a
* user is a required step to correctly use the Sales Commission API, more details [here](https:
* //developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
*
* Access to the Sales Commission API endpoints is available to users with financial access, where the
* seller has the Advanced Analytics component enabled. For further information on getting access to
* Advanced Analytics contact Maxio support.
*
* > Note: The request is at seller level, it means `<<subdomain>>` variable will be replaced by `app`
*
* @param sellerId The Chargify id of your seller account
* @param authorization For authorization use user API key. See details [here](https://developers.
* chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-
* authentication).
* @param liveMode This parameter indicates if records should be fetched from live mode sites.
* Default value is true.
* @param page Result records are organized in pages. By default, the first page of results is
* displayed. The page parameter specifies a page number of results to fetch. You can
* start navigating through the pages to consume the results. You do this by passing
* in a page parameter. Retrieve the next page by adding ?page=2 to the query string.
* If there are no results to return, then an empty result set will be returned. Use
* in query `page=1`.
* @param perPage This parameter indicates how many records to fetch in each request. Default value
* is 100.
* @return Response from the API call
*/
listSalesReps({ sellerId, authorization, liveMode, page, perPage, }: {
sellerId: string;
authorization?: string;
liveMode?: boolean;
page?: number;
perPage?: number;
}, requestOptions?: RequestOptions): Promise<ApiResponse<ListSaleRepItem[]>>;
/**
* Endpoint returns sales rep and attached subscriptions details.
*
* ## Modified Authentication Process
*
* The Sales Commission API differs from other Chargify API endpoints. This resource is associated with
* the seller itself. Up to now all available resources were at the level of the site, therefore
* creating the API Key per site was a sufficient solution. To share resources at the seller level, a
* new authentication method was introduced, which is user authentication. Creating an API Key for a
* user is a required step to correctly use the Sales Commission API, more details [here](https:
* //developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
*
* Access to the Sales Commission API endpoints is available to users with financial access, where the
* seller has the Advanced Analytics component enabled. For further information on getting access to
* Advanced Analytics contact Maxio support.
*
* > Note: The request is at seller level, it means `<<subdomain>>` variable will be replaced by `app`
*
* @param sellerId The Chargify id of your seller account
* @param salesRepId The Advanced Billing id of sales rep.
* @param authorization For authorization use user API key. See details [here](https://developers.
* chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-
* authentication).
* @param liveMode This parameter indicates if records should be fetched from live mode sites.
* Default value is true.
* @param page Result records are organized in pages. By default, the first page of results is
* displayed. The page parameter specifies a page number of results to fetch. You can
* start navigating through the pages to consume the results. You do this by passing
* in a page parameter. Retrieve the next page by adding ?page=2 to the query string.
* If there are no results to return, then an empty result set will be returned. Use
* in query `page=1`.
* @param perPage This parameter indicates how many records to fetch in each request. Default value
* is 100.
* @return Response from the API call
*/
readSalesRep(sellerId: string, salesRepId: string, authorization?: string, liveMode?: boolean, page?: number, perPage?: number, requestOptions?: RequestOptions): Promise<ApiResponse<SaleRep>>;
}
//# sourceMappingURL=salesCommissionsController.d.ts.map