settings library

The v4 settings family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/settings.dart' as settings;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

CustomObject: The custom object body.
CustomObjectList: A page of CustomObject records.
Settings: The settings body.
SettingsCurrency: The settings currency body.
SettingsCurrencyCountry: A SettingsCurrency's country.
SettingsCurrencyList: A page of SettingsCurrency records.
SettingsCurrencyRead: The settings currency read body.
SettingsCurrencyReadCountry: A SettingsCurrencyRead's country.
SettingsCustomLogicScript: The settings custom logic script body.
SettingsCustomLogicScripts: The settings custom logic scripts body.
SettingsCustomLogicScriptSaved: What the custom logic script writes answer, under custom_logic_script: the read's fields and code, which the server does not store.
SettingsCustomObjectCustomize: The settings custom object customize body.
SettingsCustomObjectCustomizeConfiguration: A SettingsCustomObjectCustomize's configuration.
SettingsCustomObjectCustomizeConfigurationAttribute: One entry of a SettingsCustomObjectCustomizeConfiguration's attributes.
SettingsCustomObjectDefinition: One custom object definition, as /settings/custom_objects serves it.
SettingsCustomObjectDefinitionList: One page of SettingsCustomObjectDefinition records, under data; paged by cursor.
SettingsCustomObjectDefinitionRead: One custom object definition, under custom_object: the record the listing serves.
SettingsCustomObjects: The settings custom objects body.
SettingsDiscountProfile: The settings discount profile body.
SettingsDiscountProfileAccountingCode: A SettingsDiscountProfile's accounting_code.
SettingsDiscountProfileList: A page of SettingsDiscountProfile records.
SettingsDiscountProfileRead: One discount profile, under discount_profile: the record the listing serves.
SettingsDiscountProfileTaxCode: A SettingsDiscountProfile's tax_code.
SettingsFieldSettingList: One page of SettingsFieldSettingsItemData records, under data; paged by cursor.
SettingsFieldSettingRead: One field setting, under field_setting: the record the listing serves.
SettingsFieldSettingsAccountUpdated: One page of what updateSettingsFieldSettingsAccount lists, under data.
SettingsFieldSettingsAccountUpdatedData: One entry of a SettingsFieldSettingsAccountUpdated's data.
SettingsFieldSettingsItem: The settings field settings item body.
SettingsFieldSettingsItemData: One entry of a SettingsFieldSettingsItem's data.
SettingsFieldSettingsItemGeneralSettingsAccount: A SettingsFieldSettingsItemGeneralSettings's account.
SettingsFieldSettingsItemGeneralSettingsAccountAccountGrouping: A SettingsFieldSettingsItemGeneralSettingsAccount's account_grouping.
SettingsFieldSettingsItemGeneralSettingsAccountAccountManagement: A SettingsFieldSettingsItemGeneralSettingsAccount's account_management.
SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact1: A SettingsFieldSettingsItemGeneralSettingsAccount's additional_contact_1.
SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact2: A SettingsFieldSettingsItemGeneralSettingsAccount's additional_contact_2.
SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact3: A SettingsFieldSettingsItemGeneralSettingsAccount's additional_contact_3.
SettingsFieldSettingsItemGeneralSettingsAccountBillingContact: A SettingsFieldSettingsItemGeneralSettingsAccount's billing_contact.
SettingsFieldSettingsItemGeneralSettingsAccountCreationOfSubsidiaryAccount: A SettingsFieldSettingsItemGeneralSettingsAccount's creation_of_subsidiary_account.
SettingsFieldSettingsItemGeneralSettingsAccountReferralTrackingAtAccountLevel: A SettingsFieldSettingsItemGeneralSettingsAccount's referral_tracking_at_account_level.
SettingsFieldSettingsItemGeneralSettingsAccountSalesRepTrackingAtAccountLevel: A SettingsFieldSettingsItemGeneralSettingsAccount's sales_rep_tracking_at_account_level.
SettingsFieldSettingsItemGeneralSettingsAccountShippingContact: A SettingsFieldSettingsItemGeneralSettingsAccount's shipping_contact.
SettingsFieldSettingsItemUpdated: One page of what updateSettingsFieldSettingsItem lists, under data.
SettingsFieldSettingsItemUpdatedData: One entry of a SettingsFieldSettingsItemUpdated's data.
SettingsGeneralSettings: One group of general settings, under general_settings, keyed by the group; item and order also carry product.
SettingsGeneralSettingsAccountUpdated: What updateSettingsGeneralSettingsAccount answers, under general_settings.
SettingsGeneralSettingsAccountUpdatedAccount: A SettingsGeneralSettingsAccountUpdated's account.
SettingsGeneralSettingsAccountUpdatedAccountAccountGrouping: A SettingsGeneralSettingsAccountUpdatedAccount's account_grouping.
SettingsGeneralSettingsAccountUpdatedAccountAccountManagement: A SettingsGeneralSettingsAccountUpdatedAccount's account_management.
SettingsGeneralSettingsAccountUpdatedAccountAdditionalContact1: A SettingsGeneralSettingsAccountUpdatedAccount's additional_contact_1.
SettingsGeneralSettingsAccountUpdatedAccountAdditionalContact2: A SettingsGeneralSettingsAccountUpdatedAccount's additional_contact_2.
SettingsGeneralSettingsAccountUpdatedAccountAdditionalContact3: A SettingsGeneralSettingsAccountUpdatedAccount's additional_contact_3.
SettingsGeneralSettingsAccountUpdatedAccountBillingContact: A SettingsGeneralSettingsAccountUpdatedAccount's billing_contact.
SettingsGeneralSettingsAccountUpdatedAccountCreationOfSubsidiaryAccount: A SettingsGeneralSettingsAccountUpdatedAccount's creation_of_subsidiary_account.
SettingsGeneralSettingsAccountUpdatedAccountReferralTrackingAtAccountLevel: A SettingsGeneralSettingsAccountUpdatedAccount's referral_tracking_at_account_level.
SettingsGeneralSettingsAccountUpdatedAccountSalesRepTrackingAtAccountLevel: A SettingsGeneralSettingsAccountUpdatedAccount's sales_rep_tracking_at_account_level.
SettingsGeneralSettingsAccountUpdatedAccountShippingContact: A SettingsGeneralSettingsAccountUpdatedAccount's shipping_contact.
SettingsGeneralSettingsDashboard: A SettingsGeneralSettings's dashboard.
SettingsGeneralSettingsDateAndTime: A SettingsGeneralSettings's date_and_time.
SettingsGeneralSettingsItemUpdated: What updateSettingsGeneralSettingsItem answers, under general_settings.
SettingsGeneralSettingsItemUpdatedDetail: A SettingsGeneralSettingsItemUpdated's item.
SettingsGeneralSettingsItemUpdatedDetailAvailableChargeTypes: A SettingsGeneralSettingsItemUpdatedDetail's available_charge_types.
SettingsGeneralSettingsItemUpdatedDetailAvailablePricingMethods: A SettingsGeneralSettingsItemUpdatedDetail's available_pricing_methods.
SettingsGeneralSettingsItemUpdatedDetailInventoryAdjustmentRules: A SettingsGeneralSettingsItemUpdatedDetail's inventory_adjustment_rules.
SettingsGeneralSettingsItemUpdatedDetailItemGrouping: A SettingsGeneralSettingsItemUpdatedDetail's item_grouping.
SettingsGeneralSettingsItemUpdatedDetailItemManagement: A SettingsGeneralSettingsItemUpdatedDetail's item_management.
SettingsGeneralSettingsItemUpdatedDetailPreOrder: A SettingsGeneralSettingsItemUpdatedDetail's pre_order.
SettingsGeneralSettingsItemUpdatedDetailPricingPeriodCanVaryFromChargingPeriod: A SettingsGeneralSettingsItemUpdatedDetail's pricing_period_can_vary_from_charging_period.
SettingsGeneralSettingsItemUpdatedDetailPurchasePriceEnteredIsInclusiveOfTax: A SettingsGeneralSettingsItemUpdatedDetail's purchase_price_entered_is_inclusive_of_tax.
SettingsGeneralSettingsItemUpdatedDetailPurchasePriceEnteredIsInclusiveOfTaxDetail: A SettingsGeneralSettingsItemUpdatedDetailPurchasePriceEnteredIsInclusiveOfTax's tax.
SettingsGeneralSettingsItemUpdatedDetailSalePriceEnteredIsInclusiveOfTax: A SettingsGeneralSettingsItemUpdatedDetail's sale_price_entered_is_inclusive_of_tax.
SettingsGeneralSettingsItemUpdatedDetailUseVolumePricing: A SettingsGeneralSettingsItemUpdatedDetail's use_volume_pricing.
SettingsGeneralSettingsItemUpdatedItem: A SettingsGeneralSettingsItemUpdated's item.
SettingsGeneralSettingsItemUpdatedItemAvailableChargeTypes: A SettingsGeneralSettingsItemUpdatedItem's available_charge_types.
SettingsGeneralSettingsItemUpdatedItemAvailablePricingMethods: A SettingsGeneralSettingsItemUpdatedItem's available_pricing_methods.
SettingsGeneralSettingsItemUpdatedItemInventoryAdjustmentRules: A SettingsGeneralSettingsItemUpdatedItem's inventory_adjustment_rules.
SettingsGeneralSettingsItemUpdatedItemItemGrouping: A SettingsGeneralSettingsItemUpdatedItem's item_grouping.
SettingsGeneralSettingsItemUpdatedItemItemManagement: A SettingsGeneralSettingsItemUpdatedItem's item_management.
SettingsGeneralSettingsItemUpdatedItemPreOrder: A SettingsGeneralSettingsItemUpdatedItem's pre_order.
SettingsGeneralSettingsItemUpdatedItemPricingPeriodCanVaryFromChargingPeriod: A SettingsGeneralSettingsItemUpdatedItem's pricing_period_can_vary_from_charging_period.
SettingsGeneralSettingsItemUpdatedItemPurchasePriceEnteredIsInclusiveOfTax: A SettingsGeneralSettingsItemUpdatedItem's purchase_price_entered_is_inclusive_of_tax.
SettingsGeneralSettingsItemUpdatedItemPurchasePriceEnteredIsInclusiveOfTaxTax: A SettingsGeneralSettingsItemUpdatedItemPurchasePriceEnteredIsInclusiveOfTax's tax.
SettingsGeneralSettingsItemUpdatedItemSalePriceEnteredIsInclusiveOfTax: A SettingsGeneralSettingsItemUpdatedItem's sale_price_entered_is_inclusive_of_tax.
SettingsGeneralSettingsItemUpdatedItemUseVolumePricing: A SettingsGeneralSettingsItemUpdatedItem's use_volume_pricing.
SettingsGeneralSettingsItemUpdatedProduct: A SettingsGeneralSettingsItemUpdated's product.
SettingsGeneralSettingsLabour: A SettingsGeneralSettings's labour.
SettingsGeneralSettingsOrder: A SettingsGeneralSettings's order.
SettingsGeneralSettingsOrderOrderManagement: A SettingsGeneralSettingsOrder's order_management.
SettingsGeneralSettingsOrderReferralTrackingAtOrderLevel: A SettingsGeneralSettingsOrder's referral_tracking_at_order_level.
SettingsGeneralSettingsOrderSalesRepTrackingAtOrderLevel: A SettingsGeneralSettingsOrder's sales_rep_tracking_at_order_level.
SettingsGeneralSettingsPortal: A SettingsGeneralSettings's portal.
SettingsGeneralSettingsPurchase: A SettingsGeneralSettings's purchase.
SettingsGeneralSettingsPurchaseAllowModificationOfFollowingPurchaseCreditNoteFields: A SettingsGeneralSettingsPurchase's allow_modification_of_following_purchase_credit_note_fields.
SettingsGeneralSettingsPurchaseAllowModificationOfFollowingPurchaseInvoiceFields: A SettingsGeneralSettingsPurchase's allow_modification_of_following_purchase_invoice_fields.
SettingsGeneralSettingsPurchaseAllowModificationOfFollowingPurchasePaymentFields: A SettingsGeneralSettingsPurchase's allow_modification_of_following_purchase_payment_fields.
SettingsGeneralSettingsPurchaseAllowModificationOfFollowingPurchaseRefundFields: A SettingsGeneralSettingsPurchase's allow_modification_of_following_purchase_refund_fields.
SettingsGeneralSettingsSecurity: A SettingsGeneralSettings's security.
SettingsGeneralSettingsTransaction: A SettingsGeneralSettings's transaction.
SettingsGeneralSettingsTransactionAllowModificationOfFollowingCreditNoteFields: A SettingsGeneralSettingsTransaction's allow_modification_of_following_credit_note_fields.
SettingsGeneralSettingsTransactionAllowModificationOfFollowingInvoiceFields: A SettingsGeneralSettingsTransaction's allow_modification_of_following_invoice_fields.
SettingsGeneralSettingsTransactionAllowModificationOfFollowingPaymentFields: A SettingsGeneralSettingsTransaction's allow_modification_of_following_payment_fields.
SettingsGeneralSettingsTransactionAllowModificationOfFollowingRefundFields: A SettingsGeneralSettingsTransaction's allow_modification_of_following_refund_fields.
SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreference: A SettingsGeneralSettingsTransaction's available_mediums_for_communication_preference.
SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreferenceEmail: A SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreference's email.
SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreferencePostalMail: A SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreference's postal_mail.
SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreferenceTextMessage: A SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreference's text_message.
SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreferenceVoiceMail: A SettingsGeneralSettingsTransactionAvailableMediumsForCommunicationPreference's voice_mail.
SettingsGeneralSettingsTransactionDefaultAccountingCodes: A SettingsGeneralSettingsTransaction's default_accounting_codes.
SettingsItemGroup: The settings item group body.
SettingsItemGroupAccountingCode: A SettingsItemGroup's accounting_code.
SettingsItemGroupList: A page of SettingsItemGroup records.
SettingsItemGroups: The settings item groups body.
SettingsItemGroupsAccountingCode: A SettingsItemGroups's accounting_code.
SettingsPaymentProcessor: The settings payment processor body.
SettingsPaymentProcessorAccountingCode: A SettingsPaymentProcessor's accounting_code.
SettingsPaymentProcessorCurrency: A SettingsPaymentProcessor's currency.
SettingsPaymentProcessorList: A page of SettingsPaymentProcessor records.
SettingsPaymentProcessorRead: One payment processor, under payment_processor: the record the listing serves.
SettingsPaymentProcessorSaved: What createSettingsPaymentProcessor answers, under payment_processor: gateway_name and credentials where the read has provider.
SettingsPaymentProcessorSavedCurrency: A SettingsPaymentProcessorSaved's currency.
SettingsPaymentTerm: The settings payment term body.
SettingsPaymentTermCreated: What createSettingsPaymentTerm answers, under payment_term: a flat period and duration where the read nests them.
SettingsPaymentTermDuration: A SettingsPaymentTerm's duration.
SettingsPaymentTermList: A page of SettingsPaymentTerm records.
SettingsPaymentTermRead: One payment term, under payment_term: the record the listing serves.
SettingsPaymentTermUpdated: What updateSettingsPaymentTerm answers, under payment_term: the read's fields and display_order.
SettingsPricingLevel: The settings pricing level body.
SettingsPricingLevelCreated: What createSettingsPricingLevel answers, under pricing_level: price_tax_inclusive where the read has three tax fields.
SettingsPricingLevelList: A page of SettingsPricingLevel records.
SettingsPricingLevelRead: One pricing level, under pricing_level: the record the listing serves.
SettingsPricingLevelTaxCode: A SettingsPricingLevel's tax_code.
SettingsResource: The settings endpoints with client already applied.
SettingsResourceEntry: One entry of a Settings's resources.
SettingsShippingProfile: The settings shipping profile body.
SettingsShippingProfileAccountingCode: A SettingsShippingProfile's accounting_code.
SettingsShippingProfileList: A page of SettingsShippingProfile records.
SettingsShippingProfileRead: One shipping profile, under shipping_profile: the record the listing serves.
SettingsShippingProfileTaxRule: A SettingsShippingProfile's tax_rule.
SettingsTax: The settings tax body.
SettingsTaxCountry: A SettingsTax's country.
SettingsTaxCountryTaxByState: One entry of a SettingsTax's country_tax_by_states.
SettingsTaxList: A page of SettingsTax records.
SettingsTaxRead: One tax, under tax: the record the listing serves.
SettingsTimeZone: The settings time zone body.
SettingsTimeZoneList: A page of SettingsTimeZone records.
SettingsTimeZoneRead: The settings time zone read body.
SettingsUrls
SettingsVariation: The settings variation body.
SettingsVariationList: A page of SettingsVariation records.
SettingsVariations: The settings variations body.
SettingsWarehouse: The settings warehouse body.
SettingsWarehouseCountry: A SettingsWarehouse's country.
SettingsWarehouseList: A page of SettingsWarehouse records.
SettingsWarehouseRead: One warehouse, under warehouse: the record the listing serves.

Functions

createCustomObject(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>: POST /api/{api_version}/custom_objects
createSettingsCurrency(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/settings/currencies
createSettingsCustomLogicScript(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomLogicScriptSaved>>: POST /api/{api_version}/settings/custom_logic_scripts
createSettingsCustomObject(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>: POST /api/{api_version}/settings/custom_objects
createSettingsCustomObjectCustomize(ExsitedClient client, Object customObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjectCustomize>>: POST /api/{api_version}/settings/custom_objects/{custom_object_id}/customize
createSettingsDiscountProfile(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsDiscountProfileRead>>: POST /api/{api_version}/settings/discount_profiles
createSettingsItemGroup(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroups>>: POST /api/{api_version}/settings/item_groups
createSettingsItemGroupBillingPreference(ExsitedClient client, Object itemGroupId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroups>>: POST /api/{api_version}/settings/item_groups/{item_group_id}/billing_preferences
createSettingsPaymentProcessor(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentProcessorSaved>>: POST /api/{api_version}/settings/payment_processors
createSettingsPaymentTerm(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentTermCreated>>: POST /api/{api_version}/settings/payment_terms
createSettingsPricingLevel(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPricingLevelCreated>>: POST /api/{api_version}/settings/pricing_levels
createSettingsShippingProfile(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingProfileRead>>: POST /api/{api_version}/settings/shipping_profiles
createSettingsTax(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/settings/taxes
createSettingsVariation(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsVariations>>: POST /api/{api_version}/settings/variations
createSettingsWarehouse(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsWarehouseRead>>: POST /api/{api_version}/settings/warehouses
deleteCustomObject(ExsitedClient client, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/custom_objects/{custom_object_id}
deleteSettingsCustomLogicScript(ExsitedClient client, Object customLogicScriptId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/custom_logic_scripts/{custom_logic_script_id}
deleteSettingsCustomObject(ExsitedClient client, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/custom_objects/{custom_object_id}
deleteSettingsDiscountProfile(ExsitedClient client, Object discountProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/discount_profiles/{discount_profile_id}
deleteSettingsItemGroup(ExsitedClient client, Object itemGroupId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/item_groups/{item_group_id}
deleteSettingsPaymentProcessor(ExsitedClient client, Object paymentProcessorId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/payment_processors/{payment_processor_id}
deleteSettingsPaymentTerm(ExsitedClient client, Object paymentTermId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/payment_terms/{payment_term_id}
deleteSettingsPricingLevel(ExsitedClient client, Object pricingLevelId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/pricing_levels/{pricing_level_id}
deleteSettingsShippingProfile(ExsitedClient client, Object shippingProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/shipping_profiles/{shipping_profile_id}
deleteSettingsVariation(ExsitedClient client, Object variationId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/variations/{variation_id}
deleteSettingsWarehouse(ExsitedClient client, Object warehouseId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/settings/warehouses/{warehouse_id}
getCustomObject(ExsitedClient client, Object customObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>: GET /api/{api_version}/custom_objects/{custom_object_id}
getCustomObjects(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CustomObjectList>>: GET /api/{api_version}/custom_objects
getSettings(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Settings>>: GET /api/{api_version}/settings
getSettingsCurrencies(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCurrencyList>>: GET /api/{api_version}/settings/currencies
getSettingsCurrency(ExsitedClient client, Object currencyId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCurrencyRead>>: GET /api/{api_version}/settings/currencies/{currency_id}
getSettingsCustomLogicScript(ExsitedClient client, Object customLogicScriptId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomLogicScript>>: GET /api/{api_version}/settings/custom_logic_scripts/{custom_logic_script_id}
getSettingsCustomLogicScripts(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomLogicScripts>>: GET /api/{api_version}/settings/custom_logic_scripts
getSettingsCustomObject(ExsitedClient client, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjectDefinitionRead>>: GET /api/{api_version}/settings/custom_objects/{custom_object_id}
getSettingsCustomObjects(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjectDefinitionList>>: GET /api/{api_version}/settings/custom_objects
getSettingsDiscountProfile(ExsitedClient client, Object discountProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsDiscountProfileRead>>: GET /api/{api_version}/settings/discount_profiles/{discount_profile_id}
getSettingsDiscountProfiles(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsDiscountProfileList>>: GET /api/{api_version}/settings/discount_profiles
getSettingsFieldSetting(ExsitedClient client, Object fieldSettingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsFieldSettingRead>>: GET /api/{api_version}/settings/field_settings/{field_setting_id}
getSettingsFieldSettings(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsFieldSettingList>>: GET /api/{api_version}/settings/field_settings
getSettingsGeneralSetting(ExsitedClient client, Object group, Object generalSettingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/settings/general_settings/{group}/{general_setting_id}
getSettingsGeneralSettings(ExsitedClient client, Object group, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: GET /api/{api_version}/settings/general_settings/{group}
getSettingsItemGroup(ExsitedClient client, Object itemGroupId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroups>>: GET /api/{api_version}/settings/item_groups/{item_group_id}
getSettingsItemGroups(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroupList>>: GET /api/{api_version}/settings/item_groups
getSettingsPaymentProcessor(ExsitedClient client, Object paymentProcessorId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentProcessorRead>>: GET /api/{api_version}/settings/payment_processors/{payment_processor_id}
getSettingsPaymentProcessors(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentProcessorList>>: GET /api/{api_version}/settings/payment_processors
getSettingsPaymentTerm(ExsitedClient client, Object paymentTermId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentTermRead>>: GET /api/{api_version}/settings/payment_terms/{payment_term_id}
getSettingsPaymentTerms(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentTermList>>: GET /api/{api_version}/settings/payment_terms
getSettingsPricingLevel(ExsitedClient client, Object pricingLevelId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPricingLevelRead>>: GET /api/{api_version}/settings/pricing_levels/{pricing_level_id}
getSettingsPricingLevels(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPricingLevelList>>: GET /api/{api_version}/settings/pricing_levels
getSettingsShippingProfile(ExsitedClient client, Object shippingProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingProfileRead>>: GET /api/{api_version}/settings/shipping_profiles/{shipping_profile_id}
getSettingsShippingProfiles(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingProfileList>>: GET /api/{api_version}/settings/shipping_profiles
getSettingsTax(ExsitedClient client, Object taxId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTaxRead>>: GET /api/{api_version}/settings/taxes/{tax_id}
getSettingsTaxes(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTaxList>>: GET /api/{api_version}/settings/taxes
getSettingsTimeZone(ExsitedClient client, Object timeZoneId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTimeZoneRead>>: GET /api/{api_version}/settings/time_zones/{time_zone_id}
getSettingsTimeZones(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTimeZoneList>>: GET /api/{api_version}/settings/time_zones
getSettingsVariation(ExsitedClient client, Object variationId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsVariations>>: GET /api/{api_version}/settings/variations/{variation_id}
getSettingsVariations(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsVariationList>>: GET /api/{api_version}/settings/variations
getSettingsWarehouse(ExsitedClient client, Object warehouseId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsWarehouseRead>>: GET /api/{api_version}/settings/warehouses/{warehouse_id}
getSettingsWarehouses(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsWarehouseList>>: GET /api/{api_version}/settings/warehouses
updateCustomObject(ExsitedClient client, Object customObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>: PATCH /api/{api_version}/custom_objects/{custom_object_id}
updateSettingsCurrency(ExsitedClient client, Object currencyId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: PATCH /api/{api_version}/settings/currencies/{currency_id}
updateSettingsCustomLogicScript(ExsitedClient client, Object customLogicScriptId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomLogicScriptSaved>>: PATCH /api/{api_version}/settings/custom_logic_scripts/{custom_logic_script_id}
updateSettingsCustomObject(ExsitedClient client, Object customObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>: PATCH /api/{api_version}/settings/custom_objects/{custom_object_id}
updateSettingsDiscountProfile(ExsitedClient client, Object discountProfileId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsDiscountProfileRead>>: PATCH /api/{api_version}/settings/discount_profiles/{discount_profile_id}
updateSettingsFieldSettingsAccount(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsFieldSettingsAccountUpdated>>: PATCH /api/{api_version}/settings/field_settings/account
updateSettingsFieldSettingsItem(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsFieldSettingsItemUpdated>>: PATCH /api/{api_version}/settings/field_settings/item
updateSettingsGeneralSettingsAccount(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettingsAccountUpdated>>: PATCH /api/{api_version}/settings/general_settings/account
updateSettingsGeneralSettingsDashboard(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/dashboard
updateSettingsGeneralSettingsDateAndTime(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/date_and_time
updateSettingsGeneralSettingsDisplay(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/display
updateSettingsGeneralSettingsGeneral(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/general
updateSettingsGeneralSettingsItem(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettingsItemUpdated>>: PATCH /api/{api_version}/settings/general_settings/item
updateSettingsGeneralSettingsLabour(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/labour
updateSettingsGeneralSettingsOrder(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/order
updateSettingsGeneralSettingsPortal(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/portal
updateSettingsGeneralSettingsPurchase(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/purchase
updateSettingsGeneralSettingsSecurity(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/security
updateSettingsGeneralSettingsTransaction(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>: PATCH /api/{api_version}/settings/general_settings/transaction
updateSettingsItemGroup(ExsitedClient client, Object itemGroupId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroups>>: PATCH /api/{api_version}/settings/item_groups/{item_group_id}
updateSettingsPaymentProcessor(ExsitedClient client, Object paymentProcessorId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentProcessorSaved>>: PATCH /api/{api_version}/settings/payment_processors/{payment_processor_id}
updateSettingsPaymentTerm(ExsitedClient client, Object paymentTermId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentTermUpdated>>: PATCH /api/{api_version}/settings/payment_terms/{payment_term_id}
updateSettingsPricingLevel(ExsitedClient client, Object pricingLevelId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPricingLevelRead>>: PATCH /api/{api_version}/settings/pricing_levels/{pricing_level_id}
updateSettingsShippingProfile(ExsitedClient client, Object shippingProfileId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: PATCH /api/{api_version}/settings/shipping_profiles/{shipping_profile_id}
updateSettingsTax(ExsitedClient client, Object taxId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: PATCH /api/{api_version}/settings/taxes/{tax_id}
updateSettingsVariation(ExsitedClient client, Object variationId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsVariations>>: PATCH /api/{api_version}/settings/variations/{variation_id}
updateSettingsWarehouse(ExsitedClient client, Object warehouseId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsWarehouseRead>>: PATCH /api/{api_version}/settings/warehouses/{warehouse_id}

settings library

Classes

Functions

exsited package

settings library