Plugins class abstract

Annotations

• @ChopperApi.new()

Constructors

Plugins()

Properties

client ↔ ChopperClient

getter/setter pair, inherited

definitionType → Type

Used internally to retrieve the service from ChopperClient.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

azureadpluginImportgroupcontactsPost({required WebApiModulesPluginsAzureADContactsImportGroupRequest? body}) → Future<Response<WebApiModulesPluginsAzureADContactsImportGroupResponse>>

azureadpluginImportgroupusersPost({required WebApiModulesPluginsAzureADUsersImportGroupRequest? body}) → Future<Response<WebApiModulesPluginsAzureADUsersImportGroupResponse>>

azureadpluginLoadadcontactgroupsPost({required WebApiModulesPluginsAzureADGetAzureADGroupsRequest? body}) → Future<Response<WebApiModulesPluginsAzureADGetAzureADGroupsResponse>>

azureadpluginLoadadusergroupsPost({required WebApiModulesPluginsAzureADGetAzureADGroupsRequest? body}) → Future<Response<WebApiModulesPluginsAzureADGetAzureADGroupsResponse>>

boxeduppluginQaUser3pSignUpPost({required WebApiModulesPluginsBoxedUpBoxedUpSignUpResponse? body}) → Future<Response<WebApiModulesPluginsBoxedUpBoxedUpSignUpResponse>>

Mock service for testing BoxedUp's /user/3p/sign_up endpoint

boxeduppluginQaUser3pUpdateAccessTokenPost({required WebApiModulesPluginsBoxedUpBoxedUpUpdateTokenRequest? body}) → Future<Response<WebApiModulesPluginsBoxedUpBoxedUpUpdateTokenResponse>>

Mock service for testing BoxedUp's /user/3p/update_access_token endpoint

boxeduppluginSignUpPost({required WebApiModulesPluginsBoxedUpRwBoxedUpRequestWebApiModulesPluginsBoxedUpBoxedUpSignUpRequest? body}) → Future<Response<WebApiModulesPluginsBoxedUpStatusResponseWebApiModulesPluginsBoxedUpRwBoxedUpTokenResponseWebApiModulesPluginsBoxedUpBoxedUpSignUpResponse>>

Call BoxedUp to signup for an account and provide a RentalWorks access token.

boxeduppluginUpdateAccessTokenPost({required WebApiModulesPluginsBoxedUpRwBoxedUpRequestWebApiModulesPluginsBoxedUpBoxedUpUpdateTokenRequest? body}) → Future<Response<WebApiModulesPluginsBoxedUpStatusResponseWebApiModulesPluginsBoxedUpBoxedUpUpdateTokenResponse>>

Call BoxedUp to update their RentalWorks access token.

creditcardpluginCardpointeGatewayapiCarddetailsAccountAccountidLocationLocationidGet({required String? accountid, required String? locationid}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginBinResponse>>

Calls the Cardpointe Gateway API BIN endpoint to get info about the card such as whether it's credit or debit. @param accountid @param locationid

creditcardpluginCardpointeGatewayapiSurchargefeeLocationLocationidAccountAccountidPostalcodePostalcodeAmountAmountGet({required String? locationid, required String? accountid, required String? postalcode, required num? amount}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginGetDefaultSurchargeAmountResponse>>

Calls the Cardpointe Gateway API Surcharge endpoint to determine if there is a surcharge for an account (tokenized card #). @param locationid @param accountid @param postalcode @param amount

creditcardpluginCardpointeGatewayapiSurchargefeeLocationLocationidCustomerCustomeridAccountidAccountidPostalcodePostalcodeAmountAmountGet({required String? locationid, required String? customerid, required String? accountid, required String? postalcode, required num? amount}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginGetDefaultSurchargeAmountResponse>>

Calls the Cardpointe Gateway API Surcharge endpoint to determine if there is a surcharge for this postal code. Accountid should be the saved card number from the proifle. If so, then calls CardPointe Gateway API InquireMerchant to determine the surcharge percent and returns the percentages and totals. @param locationid @param customerid @param accountid @param postalcode @param amount

creditcardpluginCardpointeGatewayapiSurchargefeeLocationLocationidDealDealidAccountidAccountidPostalcodePostalcodeAmountAmountGet({required String? locationid, required String? dealid, required String? accountid, required String? postalcode, required num? amount}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginGetDefaultSurchargeAmountResponse>>

Calls the Cardpointe Gateway API Surcharge endpoint to determine if there is a surcharge for this postal code. If so, then calls CardPointe Gateway API InquireMerchant to determine the surcharge percent and returns the percentages and totals. @param locationid @param dealid @param accountid @param postalcode @param amount

creditcardpluginCardpointeGatewayapiSurchargefeeLocationLocationidGet({required String? locationid}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginGetDefaultSurchargeAmountResponse>>

Calls InquireMerchant on the CardPointe GatewayApi to get the surcharge fee percentage. @param locationid

creditcardpluginCardpointeIscreditcardfeeenabledLocationLocationidGet({required String? locationid}) → Future<Response<bool>>

This determines if MerchId (Surcharge) is configured in CardPointe plugin settings. @param locationid

creditcardpluginDepositBrowsePost({required FwStandardModelsBrowseRequest? body}) → Future<Response<FwStandardSqlServerFwJsonDataTable>>

Browse credit card deposit records.

creditcardpluginDepositEmptyobjectGet() → Future<Response>

Get an empty credit card deposit record.

creditcardpluginDepositExportexcelxlsxPost({required FwStandardModelsBrowseRequest? body}) → Future<Response<FwCoreControllersFwDataControllerDoExportExcelXlsxExportFileAsyncResult>>

Export credit card deposit records to excel.

creditcardpluginDepositGet({int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesPluginsCreditCardOrderDepositLogic>>

Get credit card deposit records. @param pageno @param pagesize @param sort @param filter

creditcardpluginDepositLocationLocationidPost({required String? locationid, required WebApiModulesPluginsCreditCardCreditCardOrderDepositRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardOrderDepositResponse>>

Do a credit card authorize and capture transaction and create a depleting deposit receipt. @param locationid

creditcardpluginDepositOrderOrderidHasdepositrecordsGet({required String? orderId}) → Future<Response<bool>>

Returns a boolean used to toggle the View Deposits button on an Order. The value is true when there is data to see. @param OrderId Unique Identifier

creditcardpluginDepositReceiptidLocationLocationidRefundPost({required String? locationid, required String? receiptid, required WebApiModulesPluginsCreditCardCreditCardRefundRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardRefundResponse>>

Do a credit card refund against a depleting deposit. @param locationid @param receiptid

creditcardpluginLocationsGet() → Future<Response<List<WebApiModulesPluginsCreditCardCreditCardPluginLocation>>>

creditcardpluginLogBrowsePost({required FwStandardModelsBrowseRequest? body}) → Future<Response<FwStandardSqlServerFwJsonDataTable>>

Browse the credit card transaction log.

creditcardpluginLogEmptyobjectGet() → Future<Response>

Get an empty credit card transaction log object.

creditcardpluginLogExportexcelxlsxPost({required FwStandardModelsBrowseRequest? body}) → Future<Response<FwCoreControllersFwDataControllerDoExportExcelXlsxExportFileAsyncResult>>

Return credit card transaction log as an excel spreadsheet.

creditcardpluginLogGet({int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesPluginsCreditCardCreditCardLogLogic>>

Gets credit card transaction log records. @param pageno @param pagesize @param sort @param filter

creditcardpluginLogLegendGet() → Future<Response<Object>>

creditcardpluginLogOrderOrderidHasrecordsGet({required String? orderId}) → Future<Response<bool>>

Returns a boolean if an order has credit card transaction log records. @param OrderId

creditcardpluginPreauthorizationBrowsePost({required String? orderId, required FwStandardModelsBrowseRequest? body}) → Future<Response<FwStandardSqlServerFwJsonDataTable>>

Browse credit card pre-authorization records. @param OrderId

creditcardpluginPreauthorizationEmptyobjectGet() → Future<Response>

Get an empty credit card pre-authorization record.

creditcardpluginPreauthorizationExportexcelxlsxPost({required FwStandardModelsBrowseRequest? body}) → Future<Response<FwCoreControllersFwDataControllerDoExportExcelXlsxExportFileAsyncResult>>

Export credit card pre-authorization records to excel.

creditcardpluginPreauthorizationGet({int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesPluginsCreditCardCreditCardPreAuthorizationLogic>>

Get credit card pre-authorizations. @param pageno @param pagesize @param sort @param filter

creditcardpluginPreauthorizationLocationLocationidOrderOrderidCapturepreauthorizationsPost({required String? locationid, required String? orderid, required WebApiModulesPluginsCreditCardCreditCardCapturePreAuthorizationForOrderRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardCapturePreAuthorizationForOrderResponse>>

Capture pre-authorizations for an order and create depleting deposits. @param locationid @param orderid

creditcardpluginPreauthorizationLocationLocationidPost({required String? locationid, required WebApiModulesPluginsCreditCardCreditCardPreAuthorizationRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPreAuthorizationResponse>>

Create a credit card pre-authorization record and do a credit card authorize transaction (unless there's an approval step). @param locationid

creditcardpluginPreauthorizationOrderOrderidHaspreauthorizationrecordsGet({required String? orderId}) → Future<Response<bool>>

Returns a boolean if an order has any pre-authorization records (no status filter). @param OrderId

creditcardpluginPreauthorizationOrderOrderidTotalpreauthorizationamountGet({required String? orderId}) → Future<Response<num>>

Get total of all credit card pre-authorization records for an order where status is APPROVED. @param OrderId

creditcardpluginPreauthorizationPreauthorizationidLocationLocationidCapturePost({required String? preauthorizationid, required String? locationid, required WebApiModulesPluginsCreditCardCreditCardCapturePreAuthorizationRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardCapturePreAuthorizationResponse>>

Capture a pre-authorization and create a depleting deposit. @param preauthorizationid @param locationid

creditcardpluginPreauthorizationPreauthorizationidLocationLocationidUpdatestatusPost({required String? preauthorizationid, required String? locationid, required WebApiModulesPluginsCreditCardCreditCardUpdatePreAuthorizationStatusRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardUpdatePreAuthorizationStatusResponse>>

Approve a credit card pre-authorization. @param preauthorizationid @param locationid

creditcardpluginPreauthorizationPreauthorizationidLocationLocationidVoidPost({required String? preauthorizationid, required String? locationid, required WebApiModulesPluginsCreditCardCreditCardVoidPreAuthorizationRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardVoidPreAuthorizationResponse>>

Void a credit card pre-authorization. @param preauthorizationid @param locationid

creditcardpluginProcesscreditcardinfoLookuppaymenttypeGet({int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesPluginsCreditCardProcessCreditCardPaymentType>>

Lookup payment type field on process credit card form (on Order). @param pageno @param pagesize @param sort @param filter

creditcardpluginProcesscreditcardinfoOrderidGet({required String? orderId}) → Future<Response<WebApiModulesPluginsCreditCardProcessCreditCardInfo>>

Load order info for processing credit card payments. @param OrderId

creditcardpluginProcesscreditcardinfoPaymenttypebytokenTokenLocationLocationidGet({required String? token, required String? locationid}) → Future<Response<WebApiModulesPluginsCreditCardProcessCreditCardPaymentType>>

Returns a PaymentType record with fees given a tokenized card number. @param token @param locationid

creditcardpluginProcesscreditcardinfoPaymenttypePaymenttypeidGet({required String? paymenttypeid}) → Future<Response<WebApiModulesPluginsCreditCardProcessCreditCardPaymentType>>

Returns a PaymentType record with fees given a PaymentTypeId @param paymenttypeid

creditcardpluginProfileCustomerCustomeridLocationLocationidAccountAccountidDelete({required String? locationid, required String? customerid, required String? accountid}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginDeleteAccountResponse>>

Delete a customer credit card. @param locationid @param customerid @param accountid

creditcardpluginProfileCustomerCustomeridLocationLocationidAccountAccountidGet({required String? locationid, required String? customerid, required String? accountid}) → Future<Response<WebApiModulesPluginsCreditCardAccount>>

Get customer credit card account. @param locationid @param customerid @param accountid

creditcardpluginProfileCustomerCustomeridLocationLocationidAccountGet({required String? locationid, required String? customerid, int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesPluginsCreditCardAccount>>

Get customer credit card accounts. @param locationid @param customerid @param pageno @param pagesize @param sort @param filter

creditcardpluginProfileCustomerCustomeridLocationLocationidAccountPost({required String? locationid, required String? customerid, required WebApiModulesPluginsCreditCardCreditCardPluginCreateOrUpdateAccountRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginCreateOrUpdateAccountResponse>>

Create/update a customer credit card account. @param locationid @param customerid

creditcardpluginProfileCustomerCustomeridLocationLocationidAuthorizedaccountGet({required String? locationid, required String? customerid, int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesPluginsCreditCardAccount>>

Get customer credit card accounts that have card on file permission from the customer. @param locationid @param customerid @param pageno @param pagesize @param sort @param filter

creditcardpluginProfileCustomerCustomeridLocationLocationidDefaultaccountGet({required String? locationid, required String? customerid}) → Future<Response>

Get customer default credit card account. Returns null if not found. @param locationid @param customerid

creditcardpluginProfileDealDealidLocationLocationidAccountAccountidDelete({required String? locationid, required String? dealid, required String? accountid}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginDeleteAccountResponse>>

Delete a deal credit card account. @param locationid @param dealid @param accountid

creditcardpluginProfileDealDealidLocationLocationidAccountAccountidGet({required String? locationid, required String? dealid, required String? accountid}) → Future<Response<WebApiModulesPluginsCreditCardAccount>>

Get deal credit card account. @param locationid @param dealid @param accountid

creditcardpluginProfileDealDealidLocationLocationidAccountGet({required String? locationid, required String? dealid, int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesPluginsCreditCardAccount>>

Get deal credit card accounts. @param locationid @param dealid @param pageno @param pagesize @param sort @param filter

creditcardpluginProfileDealDealidLocationLocationidAccountPost({required String? locationid, required String? dealid, required WebApiModulesPluginsCreditCardCreditCardPluginCreateOrUpdateAccountRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginCreateOrUpdateAccountResponse>>

Create/update a deal credit card account. @param locationid @param dealid

creditcardpluginProfileDealDealidLocationLocationidAuthorizedaccountGet({required String? locationid, required String? dealid, int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesPluginsCreditCardAccount>>

Get deal credit card accounts that have card on file permission from the customer. @param locationid @param dealid @param pageno @param pagesize @param sort @param filter

creditcardpluginProfileDealDealidLocationLocationidDefaultaccountGet({required String? locationid, required String? dealid}) → Future<Response>

Get deal default credit card account. @param locationid @param dealid

creditcardpluginSettingsLocationLocationidGet({required String? locationid, required String? receiptid}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginGetSettingsResponse>>

Get settings for interacting with the credit card api @param locationid @param receiptid

creditcardpluginVoidReceiptReceiptidLocationLocationidPost({required String? locationid, required String? receiptid, required WebApiModulesPluginsCreditCardCreditCardPluginVoidReceiptRequest? body}) → Future<Response<WebApiModulesPluginsCreditCardCreditCardPluginVoidResponse>>

Voids a credit card payment receipt if the transaction has not been settled and the receipt has not been exported @param locationid @param receiptid

freightpoppluginGettrackingnumberPost({required WebApiModulesPluginsFreightPopFreightPopShipmentRequest? body}) → Future<Response<FwStandardSqlServerTSpStatusResponse>>

kissflowpluginOrderGet({String? quoteOrderProjectNo}) → Future<Response<WebApiModulesPluginsKissFlowOrderResponse>>

@param QuoteOrderProjectNo

kissflowpluginProjectGet({String? quoteOrderProjectNo}) → Future<Response<WebApiModulesPluginsKissFlowProjectResponse>>

@param QuoteOrderProjectNo

kissflowpluginQuoteGet({String? quoteOrderProjectNo}) → Future<Response<WebApiModulesPluginsKissFlowQuoteResponse>>

@param QuoteOrderProjectNo

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openaipluginTestsettingsPost({required WebApiModulesPluginsOpenAIOpenAISettingsTestRequest? body}) → Future<Response<WebApiModulesPluginsOpenAIOpenAISettingsTestResponse>>

quickbooksonlinepluginAuthorizePost({required WebApiModulesPluginsQuickbooksOnlineQuickBooksOnlinePluginLogicQBOAuth? body}) → Future<Response<bool>>

quickbooksonlinepluginDisconnectPost({String? locationid}) → Future<Response<bool>>

@param locationid

quickbooksonlinepluginGetauthorizationrequestGet({String? locationid}) → Future<Response<String>>

@param locationid

quickbooksonlinepluginLocationsGet() → Future<Response<WebApiModulesPluginsQuickbooksOnlineQuickBooksOnlinePluginLogicRwToQBOLocations>>

shopifypluginCreateQuoteFromShopifyOrderLocationLocationidOrderNumberOrderNumberPost({required String? locationid, required String? orderNumber}) → Future<Response<String>>

@param locationid @param order_number

shopifypluginDisableCreateOrderWebhookLocationLocationidPost({required String? locationid}) → Future<Response<WebApiModulesPluginsShopifyDisableCreateOrderWebhookResponse>>

@param locationid

shopifypluginEnableCreateOrderWebhookLocationLocationidPost({required String? locationid}) → Future<Response<WebApiModulesPluginsShopifyEnableCreateOrderWebhookResponse>>

@param locationid

shopifypluginInstallThemeLocationLocationidPost({required String? locationid}) → Future<Response<WebApiModulesIntegrationsShopifyShopifyInstallThemeResponse>>

@param locationid

shopifypluginIntegrationStatusLocationLocationidGet({required String? locationid}) → Future<Response<WebApiModulesPluginsShopifyShopifyIntegrationStatus>>

@param locationid

shopifypluginLocationsGet() → Future<Response<WebApiModulesPluginsShopifyShopifyLocations>>

shopifypluginSavelocationsPost({required WebApiModulesPluginsShopifyShopifyLocations? body}) → Future<Response<bool>>

shopifypluginUninstallThemeLocationLocationidPost({required String? locationid}) → Future<Response<WebApiModulesIntegrationsShopifyShopifyUninstallThemeResponse>>

@param locationid

shopifypluginValidateshopifyurlPost({required WebApiModulesPluginsShopifyValidateShopURLRequest? body}) → Future<Response<WebApiModulesPluginsShopifyValidateShopURLResponse>>

taskschedulerTaskstepsBrowsePost({required FwStandardModelsBrowseRequest? body}) → Future<Response<FwStandardSqlServerFwJsonDataTable>>

taskschedulerTaskstepsExportexcelxlsxPost({required FwStandardModelsBrowseRequest? body}) → Future<Response<FwCoreControllersFwDataControllerDoExportExcelXlsxExportFileAsyncResult>>

taskschedulerTaskstepsGet({int? pageno, int? pagesize, String? sort, List<FwStandardModelsFwQueryFilter>? filter}) → Future<Response<FwStandardModelsFwQueryResponseWebApiModulesAdministratorTaskSchedulerTaskStepsLogic>>

@param pageno @param pagesize @param sort @param filter

taskschedulerTaskstepsIdDelete({required String? id}) → Future<Response<bool>>

@param id

taskschedulerTaskstepsIdGet({required String? id}) → Future<Response<WebApiModulesAdministratorTaskSchedulerTaskSteps>>

@param id

taskschedulerTaskstepsIdPut({required String? id, required WebApiModulesAdministratorTaskSchedulerTaskSteps? body}) → Future<Response<WebApiModulesAdministratorTaskSchedulerTaskSteps>>

@param id

taskschedulerTaskstepsPost({required WebApiModulesAdministratorTaskSchedulerTaskSteps? body}) → Future<Response<WebApiModulesAdministratorTaskSchedulerTaskSteps>>

teamuppluginLoadteamuppluginGet() → Future<Response<WebApiModulesPluginsTeamupTeamupPlugin>>

teamuppluginLocationsGet() → Future<Response<List<WebApiModulesPluginsTeamupTeamupPluginLocation>>>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create({ChopperClient? client, Client? httpClient, Authenticator? authenticator, ErrorConverter? errorConverter, Converter? converter, Uri? baseUrl, List<Interceptor>? interceptors}) → Plugins