SettingsResource class

The settings endpoints with client already applied.

Constructors

SettingsResource(ExsitedClient client)

Bind the resource to a client; normally reached via client.settings.

const

Properties

client → ExsitedClient

The client every call below is made through.

final

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

createCustomObject(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>

POST /api/{api_version}/custom_objects

createSettingsCurrency(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/settings/currencies

createSettingsCustomLogicScript(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomLogicScriptSaved>>

POST /api/{api_version}/settings/custom_logic_scripts

createSettingsCustomObject(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>

POST /api/{api_version}/settings/custom_objects

createSettingsCustomObjectCustomize(Object customObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjectCustomize>>

POST /api/{api_version}/settings/custom_objects/{custom_object_id}/customize

createSettingsDiscountProfile(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsDiscountProfileRead>>

POST /api/{api_version}/settings/discount_profiles

createSettingsItemGroup(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroups>>

POST /api/{api_version}/settings/item_groups

createSettingsItemGroupBillingPreference(Object itemGroupId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroups>>

POST /api/{api_version}/settings/item_groups/{item_group_id}/billing_preferences

createSettingsPaymentProcessor(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentProcessorSaved>>

POST /api/{api_version}/settings/payment_processors

createSettingsPaymentTerm(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentTermCreated>>

POST /api/{api_version}/settings/payment_terms

createSettingsPricingLevel(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPricingLevelCreated>>

POST /api/{api_version}/settings/pricing_levels

createSettingsShippingProfile(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingProfileRead>>

POST /api/{api_version}/settings/shipping_profiles

createSettingsTax(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/settings/taxes

createSettingsVariation(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsVariations>>

POST /api/{api_version}/settings/variations

createSettingsWarehouse(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsWarehouseRead>>

POST /api/{api_version}/settings/warehouses

deleteCustomObject(Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/custom_objects/{custom_object_id}

deleteSettingsCustomLogicScript(Object customLogicScriptId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/custom_logic_scripts/{custom_logic_script_id}

deleteSettingsCustomObject(Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/custom_objects/{custom_object_id}

deleteSettingsDiscountProfile(Object discountProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/discount_profiles/{discount_profile_id}

deleteSettingsItemGroup(Object itemGroupId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/item_groups/{item_group_id}

deleteSettingsPaymentProcessor(Object paymentProcessorId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/payment_processors/{payment_processor_id}

deleteSettingsPaymentTerm(Object paymentTermId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/payment_terms/{payment_term_id}

deleteSettingsPricingLevel(Object pricingLevelId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/pricing_levels/{pricing_level_id}

deleteSettingsShippingProfile(Object shippingProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/shipping_profiles/{shipping_profile_id}

deleteSettingsVariation(Object variationId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/variations/{variation_id}

deleteSettingsWarehouse(Object warehouseId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/warehouses/{warehouse_id}

getCustomObject(Object customObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>

GET /api/{api_version}/custom_objects/{custom_object_id}

getCustomObjects({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CustomObjectList>>

GET /api/{api_version}/custom_objects

getSettings({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Settings>>

GET /api/{api_version}/settings

getSettingsCurrencies({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCurrencyList>>

GET /api/{api_version}/settings/currencies

getSettingsCurrency(Object currencyId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCurrencyRead>>

GET /api/{api_version}/settings/currencies/{currency_id}

getSettingsCustomLogicScript(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({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomLogicScripts>>

GET /api/{api_version}/settings/custom_logic_scripts

getSettingsCustomObject(Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjectDefinitionRead>>

GET /api/{api_version}/settings/custom_objects/{custom_object_id}

getSettingsCustomObjects({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjectDefinitionList>>

GET /api/{api_version}/settings/custom_objects

getSettingsDiscountProfile(Object discountProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsDiscountProfileRead>>

GET /api/{api_version}/settings/discount_profiles/{discount_profile_id}

getSettingsDiscountProfiles({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsDiscountProfileList>>

GET /api/{api_version}/settings/discount_profiles

getSettingsFieldSetting(Object fieldSettingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsFieldSettingRead>>

GET /api/{api_version}/settings/field_settings/{field_setting_id}

getSettingsFieldSettings({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsFieldSettingList>>

GET /api/{api_version}/settings/field_settings

getSettingsGeneralSetting(Object group, Object generalSettingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/settings/general_settings/{group}/{general_setting_id}

getSettingsGeneralSettings(Object group, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

GET /api/{api_version}/settings/general_settings/{group}

getSettingsItemGroup(Object itemGroupId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroups>>

GET /api/{api_version}/settings/item_groups/{item_group_id}

getSettingsItemGroups({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroupList>>

GET /api/{api_version}/settings/item_groups

getSettingsPaymentProcessor(Object paymentProcessorId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentProcessorRead>>

GET /api/{api_version}/settings/payment_processors/{payment_processor_id}

getSettingsPaymentProcessors({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentProcessorList>>

GET /api/{api_version}/settings/payment_processors

getSettingsPaymentTerm(Object paymentTermId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentTermRead>>

GET /api/{api_version}/settings/payment_terms/{payment_term_id}

getSettingsPaymentTerms({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentTermList>>

GET /api/{api_version}/settings/payment_terms

getSettingsPricingLevel(Object pricingLevelId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPricingLevelRead>>

GET /api/{api_version}/settings/pricing_levels/{pricing_level_id}

getSettingsPricingLevels({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPricingLevelList>>

GET /api/{api_version}/settings/pricing_levels

getSettingsShippingProfile(Object shippingProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingProfileRead>>

GET /api/{api_version}/settings/shipping_profiles/{shipping_profile_id}

getSettingsShippingProfiles({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingProfileList>>

GET /api/{api_version}/settings/shipping_profiles

getSettingsTax(Object taxId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTaxRead>>

GET /api/{api_version}/settings/taxes/{tax_id}

getSettingsTaxes({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTaxList>>

GET /api/{api_version}/settings/taxes

getSettingsTimeZone(Object timeZoneId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTimeZoneRead>>

GET /api/{api_version}/settings/time_zones/{time_zone_id}

getSettingsTimeZones({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTimeZoneList>>

GET /api/{api_version}/settings/time_zones

getSettingsVariation(Object variationId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsVariations>>

GET /api/{api_version}/settings/variations/{variation_id}

getSettingsVariations({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsVariationList>>

GET /api/{api_version}/settings/variations

getSettingsWarehouse(Object warehouseId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsWarehouseRead>>

GET /api/{api_version}/settings/warehouses/{warehouse_id}

getSettingsWarehouses({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsWarehouseList>>

GET /api/{api_version}/settings/warehouses

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateCustomObject(Object customObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>

PATCH /api/{api_version}/custom_objects/{custom_object_id}

updateSettingsCurrency(Object currencyId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

PATCH /api/{api_version}/settings/currencies/{currency_id}

updateSettingsCustomLogicScript(Object customLogicScriptId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomLogicScriptSaved>>

PATCH /api/{api_version}/settings/custom_logic_scripts/{custom_logic_script_id}

updateSettingsCustomObject(Object customObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsCustomObjects>>

PATCH /api/{api_version}/settings/custom_objects/{custom_object_id}

updateSettingsDiscountProfile(Object discountProfileId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsDiscountProfileRead>>

PATCH /api/{api_version}/settings/discount_profiles/{discount_profile_id}

updateSettingsFieldSettingsAccount(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsFieldSettingsAccountUpdated>>

PATCH /api/{api_version}/settings/field_settings/account

updateSettingsFieldSettingsItem(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsFieldSettingsItemUpdated>>

PATCH /api/{api_version}/settings/field_settings/item

updateSettingsGeneralSettingsAccount(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettingsAccountUpdated>>

PATCH /api/{api_version}/settings/general_settings/account

updateSettingsGeneralSettingsDashboard(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/dashboard

updateSettingsGeneralSettingsDateAndTime(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/date_and_time

updateSettingsGeneralSettingsDisplay(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/display

updateSettingsGeneralSettingsGeneral(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/general

updateSettingsGeneralSettingsItem(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettingsItemUpdated>>

PATCH /api/{api_version}/settings/general_settings/item

updateSettingsGeneralSettingsLabour(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/labour

updateSettingsGeneralSettingsOrder(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/order

updateSettingsGeneralSettingsPortal(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/portal

updateSettingsGeneralSettingsPurchase(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/purchase

updateSettingsGeneralSettingsSecurity(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/security

updateSettingsGeneralSettingsTransaction(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsGeneralSettings>>

PATCH /api/{api_version}/settings/general_settings/transaction

updateSettingsItemGroup(Object itemGroupId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsItemGroups>>

PATCH /api/{api_version}/settings/item_groups/{item_group_id}

updateSettingsPaymentProcessor(Object paymentProcessorId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentProcessorSaved>>

PATCH /api/{api_version}/settings/payment_processors/{payment_processor_id}

updateSettingsPaymentTerm(Object paymentTermId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPaymentTermUpdated>>

PATCH /api/{api_version}/settings/payment_terms/{payment_term_id}

updateSettingsPricingLevel(Object pricingLevelId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsPricingLevelRead>>

PATCH /api/{api_version}/settings/pricing_levels/{pricing_level_id}

updateSettingsShippingProfile(Object shippingProfileId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

PATCH /api/{api_version}/settings/shipping_profiles/{shipping_profile_id}

updateSettingsTax(Object taxId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

PATCH /api/{api_version}/settings/taxes/{tax_id}

updateSettingsVariation(Object variationId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsVariations>>

PATCH /api/{api_version}/settings/variations/{variation_id}

updateSettingsWarehouse(Object warehouseId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsWarehouseRead>>

PATCH /api/{api_version}/settings/warehouses/{warehouse_id}

Operators

operator ==(Object other) → bool

The equality operator.

inherited