/** * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { ApiResponse, RequestOptions } from '../core.js'; import { BasicDateField } from '../models/basicDateField.js'; import { CreateCustomerRequest } from '../models/createCustomerRequest.js'; import { CustomerResponse } from '../models/customerResponse.js'; import { SortingDirection } from '../models/sortingDirection.js'; import { SubscriptionResponse } from '../models/subscriptionResponse.js'; import { UpdateCustomerRequest } from '../models/updateCustomerRequest.js'; import { BaseController } from './baseController.js'; export declare class CustomersController extends BaseController { /** * Creates a new customer; can also be created alongside a new subscription. The only validation * restriction is that you may only create one customer for a given reference value. * * If provided, the `reference` value must be unique. It represents a unique identifier for the * customer from your own app, i.e. the customer’s ID. This allows you to retrieve a given customer via * a piece of shared information. Alternatively, you may choose to leave `reference` blank, and store * Advanced Billing’s unique ID for the customer, which is in the `id` attribute. * * Full documentation on how to locate, create and edit Customers in the Advanced Billing UI can be * located [here](https://maxio.zendesk.com/hc/en-us/articles/24252190590093-Customer-Details). * * ## Required Country Format * * Advanced Billing requires that you use the ISO Standard Country codes when formatting country * attribute of the customer. * * Countries should be formatted as 2 characters. For more information, see the following wikipedia * article on [ISO_3166-1.](http://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) * * ## Required State Format * * Advanced Billing requires that you use the ISO Standard State codes when formatting state attribute * of the customer. * * + US States (2 characters): [ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) * * + States Outside the US (2-3 characters): To find the correct state codes outside of the US, go to * [ISO_3166-1](http://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) and click on the link in the * “ISO 3166-2 codes” column next to country you wish to populate. * * ## Locale * * Advanced Billing allows you to attribute a language/region to your customer to deliver invoices in * any required language. * For more: [Customer Locale](https://maxio.zendesk.com/hc/en-us/articles/24286672013709-Customer- * Locale) * * @param body * @return Response from the API call */ createCustomer(body?: CreateCustomerRequest, requestOptions?: RequestOptions): Promise>; /** * Lists all customers associated with your site, or filters results using the search parameter. * * ## Find Customer * * Use the search feature with the `q` query parameter to retrieve an array of customers that matches * the search query. * * Common use cases are: * * + Search by an email * + Search by an Advanced Billing ID * + Search by an organization * + Search by a reference value from your application * + Search by a first or last name * * To retrieve a single, exact match by reference, use the [lookup endpoint](https://developers. * chargify.com/docs/api-docs/b710d8fbef104-read-customer-by-reference). * * @param direction Direction to sort customers by time of creation * @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 50. The maximum allowed values is 200; any per_page * value over 200 will be changed to 200. Use in query `per_page=200`. * @param dateField The type of filter you would like to apply to your search. Use in query: * `date_field=created_at`. * @param startDate The start date (format YYYY-MM-DD) with which to filter the date_field. * Returns subscriptions with a timestamp at or after midnight (12:00:00 * AM) in your site’s time zone on the date specified. * @param endDate The end date (format YYYY-MM-DD) with which to filter the date_field. * Returns subscriptions with a timestamp up to and including 11:59:59PM in * your site’s time zone on the date specified. * @param startDatetime The start date and time (format YYYY-MM-DD HH:MM:SS) with which to * filter the date_field. Returns subscriptions with a timestamp at or * after exact time provided in query. You can specify timezone in query - * otherwise your site's time zone will be used. If provided, this * parameter will be used instead of start_date. * @param endDatetime The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter * the date_field. Returns subscriptions with a timestamp at or before * exact time provided in query. You can specify timezone in query - * otherwise your site's time zone will be used. If provided, this * parameter will be used instead of end_date. * @param q A search query by which to filter customers (can be an email, an ID, a * reference, organization) * @return Response from the API call */ listCustomers({ direction, page, perPage, dateField, startDate, endDate, startDatetime, endDatetime, q, }: { direction?: SortingDirection; page?: number; perPage?: number; dateField?: BasicDateField; startDate?: string; endDate?: string; startDatetime?: string; endDatetime?: string; q?: string; }, requestOptions?: RequestOptions): Promise>; /** * Retrieves the Customer properties by Advanced Billing-generated Customer ID. * * @param id The Advanced Billing id of the customer * @return Response from the API call */ readCustomer(id: number, requestOptions?: RequestOptions): Promise>; /** * Updates the customer. * * @param id The Advanced Billing id of the customer * @param body * @return Response from the API call */ updateCustomer(id: number, body?: UpdateCustomerRequest, requestOptions?: RequestOptions): Promise>; /** * Deletes the customer. * * @param id The Advanced Billing id of the customer * @return Response from the API call */ deleteCustomer(id: number, requestOptions?: RequestOptions): Promise>; /** * Returns a customer by their unique reference ID. It will return a single match. * * @param reference Customer reference * @return Response from the API call */ readCustomerByReference(reference: string, requestOptions?: RequestOptions): Promise>; /** * Lists all subscriptions that belong to a customer. * * @param customerId The Chargify id of the customer * @return Response from the API call */ listCustomerSubscriptions(customerId: number, requestOptions?: RequestOptions): Promise>; } //# sourceMappingURL=customersController.d.ts.map