Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Unreleased
-
v0.15.2
Fixed
- Mark
portId,enabled, andtypeas required on the switch port response shared byget_device_switch_ports,get_device_switch_port, andupdate_device_switch_port. The spec marks every field nullable, but these fields are always returned. - Mark
idandnameas required on the wireless RF profile response shared byget_network_wireless_rf_profiles,get_network_wireless_rf_profile,create_network_wireless_rf_profile, andupdate_network_wireless_rf_profile. The spec marks every field nullable, but an RF profile always has an ID and name. - Mark
idandnameas required on the content filtering category items returned byget_network_appliance_content_filtering,update_network_appliance_content_filtering, andget_network_appliance_content_filtering_categories. Every category Meraki returns has both fields. - Mark
policy,protocol,srcCidr,srcPort,destCidr,destPort, andsyslogEnabledas required on the appliance firewall rule items returned by the cellular, inbound cellular, inbound, L3, and VPN firewall rule endpoints (get/updatevariants). The spec marks every field nullable, but every rule has these fields populated.
v0.15.1
Fixed
- Mark
number,enabled, andtypeas required on the appliance port response shared byget_network_appliance_ports,get_network_appliance_port, andupdate_network_appliance_port. The spec marks every field nullable, but these fields are always returned.
v0.15.0
Changed
Update to Meraki API v1.70.0
- Added organization-wide cellular data management endpoints
get_organization_devices_cellular_data_profiles,create_organization_devices_cellular_data_profile,update_organization_devices_cellular_data_profile,delete_organization_devices_cellular_data_profile,get_organization_devices_cellular_data_profiles_assignments,batch_organization_devices_cellular_data_profiles_assignments_create,bulk_organization_devices_cellular_data_profiles_assignments_delete,get_organization_devices_cellular_data_devices,get_organization_devices_cellular_data_usage_by_device, andget_organization_devices_cellular_data_usage_history_by_device_by_interval. - Added cellular geolocation, band, and tower endpoints
get_organization_devices_cellular_geolocations,update_device_cellular_geolocations,get_organization_devices_cellular_uplinks_bands_by_device,create_device_cellular_uplinks_bands_masks_update, andget_organization_devices_cellular_uplinks_towers_by_device. - Added appliance redundancy and VRF settings endpoints
get_organization_appliance_devices_redundancy_by_network,update_network_appliance_devices_redundancy,create_network_appliance_devices_redundancy_swap,get_organization_appliance_routing_vrfs_settings, andupdate_organization_appliance_routing_vrfs_settings. - Added port cycle live tools endpoints
create_device_live_tools_ports_cycleandget_device_live_tools_ports_cycle. - Added SASE integration endpoints
get_organization_sase_integration,create_organization_sase_integration, anddelete_organization_sase_integration. - Removed
batch_organization_sase_connectors_createand the cloud monitoring onboarding endpointscreate_organization_inventory_onboarding_cloud_monitoring_export_event,create_organization_inventory_onboarding_cloud_monitoring_import,create_organization_inventory_onboarding_cloud_monitoring_prepare,get_organization_inventory_onboarding_cloud_monitoring_imports, andget_organization_inventory_onboarding_cloud_monitoring_networks.
Fixed
- Duplicate generated Python parameters for endpoints where an optional top-level request body ID also appears in the URL, such as
update_organization_devices_cellular_data_profile.
v0.14.1
Fixed
- Add spec overrides to fix updateDevice return type.
v0.14.0
Added
- Allow
requiredspec overrides to apply to responseextra_fields.
Fixed
- Make timezone mandatory again in network responses.
- Respect nested response overrides when deduplicating reused nested schemas.
- Fixes to appliance vlan responses with spec overrides.
v0.13.4
Fixed
- Timezone not always present in network response.
v0.13.3
Fixed
- Add spec overrides to fix getOrganizationInventoryOnboardingCloudMonitoringNetworks and createOrganizationNetwork return types.
v0.13.2
Fixed
- Add spec overrides to fix OrganizationPolicyObjectsGroupResponse return type.
v0.13.1
Fixed
- Add spec overrides to fix OrganizationPolicyObjectResponse return type.
v0.13.0
Changed
Update to Meraki API v1.69.0
- Added organization-wide firewall ruleset endpoints
get_organization_policies_global_firewall_rulesets,create_organization_policies_global_firewall_ruleset,get_organization_policies_global_firewall_rulesets_rules,create_organization_policies_global_firewall_rulesets_rule,update_organization_policies_global_firewall_rulesets_rule,delete_organization_policies_global_firewall_rulesets_rule,update_organization_policies_global_firewall_ruleset, anddelete_organization_policies_global_firewall_ruleset. - Added organization-wide group policy and policy object endpoints including
get_organization_policies_global_group_policies,create_organization_policies_global_group_policy,update_organization_policies_global_group_policy,delete_organization_policies_global_group_policy,get_organization_policy_objects,create_organization_policy_object,get_organization_policy_objects_groups,create_organization_policy_objects_group,get_organization_policy_object, andupdate_organization_policy_object. - Added organization-wide assignment endpoints
assign_organization_policies_global_group_policies_adaptive_policy_groups,remove_organization_policies_global_group_policies_adaptive_policy_groups,create_organization_policies_global_group_policies_firewall_rulesets_assignment,update_organization_policies_global_group_policies_firewall_rulesets_assignment,delete_organization_policies_global_group_policies_firewall_rulesets_assignment,assign_organization_policies_global_group_policies_appliance_vlans, andremove_organization_policies_global_group_policies_appliance_vlans. - Added SAML endpoints
get_organization_saml,update_organization_saml,get_organization_saml_idps,create_organization_saml_idp,get_organization_saml_idp,update_organization_saml_idp,delete_organization_saml_idp,get_organization_saml_roles,create_organization_saml_role,get_organization_saml_role,update_organization_saml_role, anddelete_organization_saml_role, plus SASE endpointsget_organization_sase_connectors,batch_organization_sase_connectors_create,batch_organization_sase_connectors_delete,get_organization_sase_networks_eligible,get_organization_sase_regions,get_organization_sase_sites,attach_organization_sase_sites,detach_organization_sase_sites,update_organization_sase_site,get_organization_sase_sites_connectivity_history_by_site, andget_organization_sase_sites_connectivity_overview. - Added
update_network_appliance_uplinks_nat,get_organization_appliance_uplinks_nat_by_network,clip_device_camera,get_organization_api_rest_provisioning_pipelines_jobs, andget_organization_api_rest_provisioning_pipelines_jobs_overviews_by_pipeline;get_organization_appliance_security_intrusionandget_network_wireless_ssid_vpnnow return typed response models instead ofDictResponse.
Fixed
- Fixed duplicate generated Python parameters for endpoints where a required top-level request body ID also appears in the URL, such as
update_organization_sase_site.
v0.12.0
Changed
- Codegen now deduplicates identical top-level response schemas and reuses a shared resource-style name when duplicate operations differ only by action, such as
NetworkWebhooksHttpServerResponse.
Fixed
- Fix spec overrides so response-only overrides no longer leak into request body parameter schemas, and correct response typing/required fields for network client, VLAN, organization, network, device, and webhook server responses.
v0.11.1
Added
- Added
inject_response_schemacodegen override for endpoints with bare{type: object}response schemas in the spec. Used to typeget_network_appliance_firewall_l3_firewall_rules, which now returnsGetNetworkApplianceFirewallL3FirewallRulesResponseinstead ofDictResponse.
Fixed
- Fix automatic publishing.
v0.11.0
Changed
Update to Meraki API v1.68.0
- Added
connect_network_appliance_umbrella_accountanddisconnect_network_appliance_umbrella_accountendpoints to connect/disconnect a Cisco Umbrella account from a network. - Added
get_organization_integrations_deployableandget_organization_integrations_deployedendpoints to list available and active integrations for an organization. - Added
get_organization_wireless_devices_provisioning_deployments,create_organization_wireless_devices_provisioning_deployment,update_organization_wireless_devices_provisioning_deployments, anddelete_organization_wireless_devices_provisioning_deploymentendpoints for zero touch wireless AP provisioning deployments. - Camera endpoints
get_device_camera_quality_and_retention,update_device_camera_quality_and_retention,get_device_camera_sense,update_device_camera_sense,get_device_camera_video_link,get_device_camera_wireless_profiles,update_device_camera_wireless_profiles, andupdate_organization_camera_onboarding_statusesnow return typed response schemas instead ofDictResponse. - Added
ecmpUplinkConfigsfield to appliance VPN peer responses (get_network_appliance_vpn_bgp,update_network_appliance_vpn_bgp). - Added
vrf,vrfType, andipVersionfields to device multicast routing response. - Added
modelfield to network clients response; addedopen-enhanced-with-radiusas a valid SSIDauth_modevalue.
v0.10.3
Fixed
- Required fields fixes for
get_organization,get_organizations,get_organization_networks,get_network,get_organization_admins,get_organization_appliance_uplink_statuses,get_device,get_organization_devicesresponses.
v0.10.2
Changed
- Coerce numbers to strings automatically in response schemas.
v0.10.1
Fixed
- Fix required device fields for getOrganizationDevices, getOrganizationInventoryDevices and getOrganizationDevicesStatuses operations.
v0.10.0
Added
- Codegen: Add
force_paginated_items_schemainspec_overrides.tomlfor endpoints where paginated responses are incorrectly modeled asarray[{items, meta}]in OpenAPI. - Add
response,status_code, andstatus_reasonfields toInvalidResponseError. - Codegen: Generate enum request params as
Literal[...]type hints so type checkers can validate allowed values at development time.
Changed
- Codegen: Skip generating top-level paginated wrapper schemas with only
items/metafields; generate only item schemas used byPaginatedResponse[T]. - Codegen: Treat GET endpoints with top-level
items/metaresponses as paginated and returnPaginatedResponse[T]. - Codegen:
force_paginatedno longer injectstotal_pages/directionargs when the endpoint does not already declare pagination params in the spec. - Session: Track page metadata on paginated results via
PaginatedResponse.metaandPaginatedResponse.meta_pages(and async equivalent).
Fixed
- Fix invalid cause in MerakiHTTPError.
- Fixed array item object parameter types for array of objects query parameters.
v0.9.0
Added
- Allow specifying operations where response can be
Nonein spec overrides.
v0.8.0
Changed
- Return
Noneonly for endpoints that have no schema.
v0.7.0
Changed
- Change default type for lists to empty list instead of
None. - Format Meraki API error messages as a single line when logged or displayed in exceptions.
v0.6.0
Added
- Codegen: Support for adding missing fields via
[operationId.extra_fields]inspec_overrides.toml. - Add
dot11wanddot11rfields togetNetworkWirelessSsidsresponse (missing from OpenAPI spec). - Documentation for accessing extra fields via
model_extra. - Add batch endpoints to API reference documentation.
Changed
Update to Meraki API v1.67.0
- New endpoints:
get_organization_inventory_devices_eox_overview,get_network_moves,create_network_move,update_network_wireless_radio_rrm,get_organization_wireless_radio_rrm_by_network. - New parameter
eox_statusesfilter forget_organization_inventory_devices. - New parameter
multicast_to_unicast_conversionforupdate_network_wireless_settings. - New response field
eoxin inventory device responses with EOX status information. - New response field
useOobMgmtin switch alternate management interface responses. - New response field
alwaysAllowedServersin switch DHCP server policy responses. - Change Policy Object Group
object_idstype fromlist[int]tolist[str]. - Remove
nacAPI module (NAC certificates authorities CRL endpoints).
v0.5.0
Added
- Codegen: Support for marking response fields as required via
[operationId.required]inspec_overrides.toml. - Mark
idas required for organization and network responses (getOrganization,getOrganizations,getNetwork,getOrganizationNetworks). - Mark
organizationIdas required for network responses (getNetwork,getOrganizationNetworks). - Mark
serialas required forgetOrganizationDevicesresponse.
v0.4.0
Changed
- All list-returning GET endpoints now return
PaginatedResponse[T]instead ofSchema | None. - Raise exception if pagination endpoint dict doesn't contain required keys.
v0.3.0
Changed
- Return empty list instead of None in list endpoints.
v0.2.0
Fixed
- Fix invalid URL when paginating.
- Fix recognizing schema params with type checkers.
- Fix handling of abbreviations when converting to snake-case.
v0.1.0
Added
- Initial release of meraki-client.