import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import { DeleteV1ContractorPaymentGroupsContractorPaymentGroupIdRequest, DeleteV1ContractorPaymentGroupsContractorPaymentGroupIdResponse } from "../models/operations/deletev1contractorpaymentgroupscontractorpaymentgroupid.js"; import { GetV1CompaniesCompanyIdContractorPaymentGroupsRequest, GetV1CompaniesCompanyIdContractorPaymentGroupsResponse } from "../models/operations/getv1companiescompanyidcontractorpaymentgroups.js"; import { GetV1ContractorPaymentGroupsContractorPaymentGroupIdRequest, GetV1ContractorPaymentGroupsContractorPaymentGroupIdResponse } from "../models/operations/getv1contractorpaymentgroupscontractorpaymentgroupid.js"; import { GetV1ContractorPaymentGroupsIdPartnerDisbursementsRequest, GetV1ContractorPaymentGroupsIdPartnerDisbursementsResponse } from "../models/operations/getv1contractorpaymentgroupsidpartnerdisbursements.js"; import { PatchV1ContractorPaymentGroupsIdPartnerDisbursementsRequest, PatchV1ContractorPaymentGroupsIdPartnerDisbursementsResponse } from "../models/operations/patchv1contractorpaymentgroupsidpartnerdisbursements.js"; import { PostV1CompaniesCompanyIdContractorPaymentGroupsRequest, PostV1CompaniesCompanyIdContractorPaymentGroupsResponse } from "../models/operations/postv1companiescompanyidcontractorpaymentgroups.js"; import { PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewRequest, PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewResponse } from "../models/operations/postv1companiescompanyidcontractorpaymentgroupspreview.js"; import { PutV1ContractorPaymentGroupsContractorPaymentGroupIdFundRequest, PutV1ContractorPaymentGroupsContractorPaymentGroupIdFundResponse } from "../models/operations/putv1contractorpaymentgroupscontractorpaymentgroupidfund.js"; export declare class ContractorPaymentGroups extends ClientSDK { /** * Get contractor payment groups for a company * * @remarks * Returns a list of minimal contractor payment groups within a given time period, including totals but not associated contractor payments. * * scope: `payrolls:read` */ getList(request: GetV1CompaniesCompanyIdContractorPaymentGroupsRequest, options?: RequestOptions): Promise; /** * Create a contractor payment group * * @remarks * Pay a group of contractors. Information needed depends on the contractor's wage type (hourly vs fixed) * * scope: `payrolls:run` */ create(request: PostV1CompaniesCompanyIdContractorPaymentGroupsRequest, options?: RequestOptions): Promise; /** * Preview a contractor payment group * * @remarks * Preview a group of contractor payments. Request will validate inputs and return preview of the contractor payment group including the expected `debit_date`. The `uuid` field will be null in the response. * * The returned `creation_token` is a required parameter in order to create the contractor payment group. * * scope: `payrolls:read` */ preview(request: PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewRequest, options?: RequestOptions): Promise; /** * Get a contractor payment group * * @remarks * Returns a contractor payment group with all associated contractor payments. * * scope: `payrolls:read` */ get(request: GetV1ContractorPaymentGroupsContractorPaymentGroupIdRequest, options?: RequestOptions): Promise; /** * Cancel a contractor payment group * * @remarks * Cancels a contractor payment group and all associated contractor payments. All contractor payments must be cancellable, unfunded. * * scope: `payrolls:run` */ delete(request: DeleteV1ContractorPaymentGroupsContractorPaymentGroupIdRequest, options?: RequestOptions): Promise; /** * Fund a contractor payment group [DEMO] * * @remarks * > 🚧 Demo action * > This action is only available in the Demo environment * * Simulate funding a contractor payment group. Funding only occurs automatically in the production environment when bank transactions are generated. Use this action in the demo environment to transition a contractor payment group's `status` from `Unfunded` to `Funded`. A `Funded` status is required for generating a contractor payment receipt. * * scope: `payrolls:run` */ fund(request: PutV1ContractorPaymentGroupsContractorPaymentGroupIdFundRequest, options?: RequestOptions): Promise; /** * Get partner disbursements for a contractor payment group * * @remarks * Get partner disbursements for a specific contractor payment group. * * scope: `partner_disbursements:read` */ getV1ContractorPaymentGroupsIdPartnerDisbursements(request: GetV1ContractorPaymentGroupsIdPartnerDisbursementsRequest, options?: RequestOptions): Promise; /** * Update partner disbursements for a contractor payment group * * @remarks * Update partner disbursements for a specific contractor payment group. * * scope: `partner_disbursements:write` */ patchV1ContractorPaymentGroupsIdPartnerDisbursements(request: PatchV1ContractorPaymentGroupsIdPartnerDisbursementsRequest, options?: RequestOptions): Promise; } //# sourceMappingURL=contractorpaymentgroups.d.ts.map