feat: API Sync by GitHub Action (2024-03-13) (#90)

This API Sync PR was automated through [GitHub Actions
workflow_displatch](https://github.com/equinix-labs/metal-python/actions?query=event%3Aworkflow_dispatch)
on 2024-03-13.

* latest Equinix Metal API spec have been fetched
* patches have been applied
* generated client has been updated

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

equinix_metal/.openapi-generator/FILES

@@ -1,7 +1,6 @@
 .github/workflows/python.yml
 .gitignore
 .gitlab-ci.yml
-.openapi-generator-ignore
 .travis.yml
 README.md
 docs/AWSFabricProvider.md
@@ -277,11 +276,15 @@ docs/VlanVirtualCircuit.md
 docs/VlanVirtualCircuitCreateInput.md
 docs/VlanVirtualCircuitUpdateInput.md
 docs/Vrf.md
+docs/VrfBGPNeighbors.md
+docs/VrfBGPNeighborsBgpNeighborsInner.md
 docs/VrfCreateInput.md
 docs/VrfFabricVcCreateInput.md
 docs/VrfIpReservation.md
 docs/VrfIpReservationCreateInput.md
 docs/VrfIpReservationList.md
+docs/VrfLearnedRoutes.md
+docs/VrfLearnedRoutesLearnedRoutesInner.md
 docs/VrfList.md
 docs/VrfMetalGateway.md
 docs/VrfMetalGatewayCreateInput.md
@@ -573,11 +576,15 @@ equinix_metal/models/vlan_virtual_circuit.py
 equinix_metal/models/vlan_virtual_circuit_create_input.py
 equinix_metal/models/vlan_virtual_circuit_update_input.py
 equinix_metal/models/vrf.py
+equinix_metal/models/vrf_bgp_neighbors.py
+equinix_metal/models/vrf_bgp_neighbors_bgp_neighbors_inner.py
 equinix_metal/models/vrf_create_input.py
 equinix_metal/models/vrf_fabric_vc_create_input.py
 equinix_metal/models/vrf_ip_reservation.py
 equinix_metal/models/vrf_ip_reservation_create_input.py
 equinix_metal/models/vrf_ip_reservation_list.py
+equinix_metal/models/vrf_learned_routes.py
+equinix_metal/models/vrf_learned_routes_learned_routes_inner.py
 equinix_metal/models/vrf_list.py
 equinix_metal/models/vrf_metal_gateway.py
 equinix_metal/models/vrf_metal_gateway_create_input.py
@@ -598,293 +605,8 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
-test/test_activate_hardware_reservation_request.py
-test/test_address.py
-test/test_attribute.py
-test/test_attribute_data.py
-test/test_auth_token.py
-test/test_auth_token_input.py
-test/test_auth_token_list.py
-test/test_auth_token_project.py
-test/test_auth_token_user.py
-test/test_authentication_api.py
-test/test_aws_fabric_provider.py
-test/test_batch.py
-test/test_batches_api.py
-test/test_batches_list.py
-test/test_bgp_api.py
-test/test_bgp_config.py
-test/test_bgp_config_request_input.py
-test/test_bgp_dynamic_neighbor.py
-test/test_bgp_dynamic_neighbor_create_input.py
-test/test_bgp_dynamic_neighbor_list.py
-test/test_bgp_neighbor_data.py
-test/test_bgp_route.py
-test/test_bgp_session.py
-test/test_bgp_session_input.py
-test/test_bgp_session_list.py
-test/test_bgp_session_neighbors.py
-test/test_bond_port_data.py
-test/test_capacity_api.py
-test/test_capacity_check_per_facility_info.py
-test/test_capacity_check_per_facility_list.py
-test/test_capacity_check_per_metro_info.py
-test/test_capacity_check_per_metro_list.py
-test/test_capacity_input.py
-test/test_capacity_level_per_baremetal.py
-test/test_capacity_list.py
-test/test_component.py
-test/test_console_log_details_api.py
-test/test_coordinates.py
-test/test_create_device_request.py
-test/test_create_email_input.py
-test/test_create_metal_gateway_request.py
-test/test_create_organization_interconnection_request.py
-test/test_create_self_service_reservation_request.py
-test/test_create_self_service_reservation_request_period.py
-test/test_dedicated_port_create_input.py
-test/test_device.py
-test/test_device_action_input.py
-test/test_device_actions_inner.py
-test/test_device_create_in_facility_input.py
-test/test_device_create_in_metro_input.py
-test/test_device_create_input.py
-test/test_device_created_by.py
-test/test_device_health_rollup.py
-test/test_device_list.py
-test/test_device_metro.py
-test/test_device_project_lite.py
-test/test_device_update_input.py
-test/test_device_usage.py
-test/test_device_usage_list.py
-test/test_devices_api.py
-test/test_disk.py
-test/test_email.py
-test/test_email_input.py
-test/test_emails_api.py
-test/test_entitlement.py
-test/test_error.py
-test/test_event.py
-test/test_event_list.py
-test/test_events_api.py
-test/test_fabric_service_token.py
-test/test_facilities_api.py
-test/test_facility.py
-test/test_facility_input.py
-test/test_facility_input_facility.py
-test/test_facility_list.py
-test/test_filesystem.py
-test/test_find_ip_address_by_id200_response.py
-test/test_find_metal_gateway_by_id200_response.py
-test/test_find_traffic_timeframe_parameter.py
-test/test_firmware_set.py
-test/test_firmware_set_list_response.py
-test/test_firmware_set_response.py
-test/test_firmware_sets_api.py
-test/test_global_bgp_range.py
-test/test_global_bgp_range_list.py
-test/test_hardware_reservation.py
-test/test_hardware_reservation_list.py
-test/test_hardware_reservations_api.py
-test/test_href.py
-test/test_incidents_api.py
-test/test_instances_batch_create_input.py
-test/test_instances_batch_create_input_batches_inner.py
-test/test_interconnection.py
-test/test_interconnection_list.py
-test/test_interconnection_metro_list.py
-test/test_interconnection_metro_list_metros_inner.py
-test/test_interconnection_metro_list_metros_inner_all_of_providers_inner.py
-test/test_interconnection_port.py
-test/test_interconnection_port_list.py
-test/test_interconnection_pricing_list.py
-test/test_interconnection_pricing_list_provider_pricing_inner.py
-test/test_interconnection_pricing_list_provider_pricing_inner_tiers_inner.py
-test/test_interconnection_update_input.py
-test/test_interconnections_api.py
-test/test_invitation.py
-test/test_invitation_input.py
-test/test_invitation_list.py
-test/test_invitations_api.py
-test/test_invoice.py
-test/test_invoice_list.py
-test/test_invoices_api.py
-test/test_ip_address.py
-test/test_ip_addresses_api.py
-test/test_ip_assignment.py
-test/test_ip_assignment_input.py
-test/test_ip_assignment_list.py
-test/test_ip_assignment_metro.py
-test/test_ip_assignment_update_input.py
-test/test_ip_availabilities_list.py
-test/test_ip_reservation.py
-test/test_ip_reservation_facility.py
-test/test_ip_reservation_list.py
-test/test_ip_reservation_list_ip_addresses_inner.py
-test/test_ip_reservation_metro.py
-test/test_ip_reservation_request_input.py
-test/test_license.py
-test/test_license_create_input.py
-test/test_license_list.py
-test/test_license_update_input.py
-test/test_licenses_api.py
-test/test_line_item.py
-test/test_membership.py
-test/test_membership_input.py
-test/test_membership_list.py
-test/test_memberships_api.py
-test/test_meta.py
-test/test_metadata.py
-test/test_metadata_network.py
-test/test_metadata_network_network.py
-test/test_metadata_network_network_bonding.py
-test/test_metal_gateway.py
-test/test_metal_gateway_create_input.py
-test/test_metal_gateway_elastic_ip_create_input.py
-test/test_metal_gateway_list.py
-test/test_metal_gateway_list_metal_gateways_inner.py
-test/test_metal_gateway_lite.py
-test/test_metal_gateways_api.py
-test/test_metro.py
-test/test_metro_input.py
-test/test_metro_list.py
-test/test_metros_api.py
-test/test_mount.py
-test/test_move_hardware_reservation_request.py
-test/test_new_password.py
-test/test_operating_system.py
-test/test_operating_system_list.py
-test/test_operating_systems_api.py
-test/test_organization.py
-test/test_organization_input.py
-test/test_organization_list.py
-test/test_organizations_api.py
-test/test_otps_api.py
-test/test_parent_block.py
-test/test_partition.py
-test/test_password_reset_tokens_api.py
-test/test_payment_method.py
-test/test_payment_method_billing_address.py
-test/test_payment_method_create_input.py
-test/test_payment_method_list.py
-test/test_payment_method_update_input.py
-test/test_payment_methods_api.py
-test/test_plan.py
-test/test_plan_available_in_inner.py
-test/test_plan_available_in_inner_price.py
-test/test_plan_available_in_metros_inner.py
-test/test_plan_list.py
-test/test_plan_specs.py
-test/test_plan_specs_cpus_inner.py
-test/test_plan_specs_drives_inner.py
-test/test_plan_specs_features.py
-test/test_plan_specs_memory.py
-test/test_plan_specs_nics_inner.py
-test/test_plans_api.py
-test/test_port.py
-test/test_port_assign_input.py
-test/test_port_convert_layer3_input.py
-test/test_port_convert_layer3_input_request_ips_inner.py
-test/test_port_data.py
-test/test_port_vlan_assignment.py
-test/test_port_vlan_assignment_batch.py
-test/test_port_vlan_assignment_batch_create_input.py
-test/test_port_vlan_assignment_batch_create_input_vlan_assignments_inner.py
-test/test_port_vlan_assignment_batch_list.py
-test/test_port_vlan_assignment_batch_vlan_assignments_inner.py
-test/test_port_vlan_assignment_list.py
-test/test_ports_api.py
-test/test_project.py
-test/test_project_create_from_root_input.py
-test/test_project_create_input.py
-test/test_project_id_name.py
-test/test_project_list.py
-test/test_project_update_input.py
-test/test_project_usage.py
-test/test_project_usage_list.py
-test/test_projects_api.py
-test/test_raid.py
-test/test_recovery_code_list.py
-test/test_request_ip_reservation201_response.py
-test/test_request_ip_reservation_request.py
-test/test_self_service_reservation_item_request.py
-test/test_self_service_reservation_item_response.py
-test/test_self_service_reservation_list.py
-test/test_self_service_reservation_response.py
-test/test_self_service_reservations_api.py
-test/test_server_info.py
-test/test_shared_port_vc_vlan_create_input.py
-test/test_spot_market_api.py
-test/test_spot_market_prices_list.py
-test/test_spot_market_prices_per_metro_list.py
-test/test_spot_market_prices_per_metro_report.py
-test/test_spot_market_request.py
-test/test_spot_market_request_create_input.py
-test/test_spot_market_request_create_input_instance_parameters.py
-test/test_spot_market_request_list.py
-test/test_spot_market_request_metro.py
-test/test_spot_prices_datapoints.py
-test/test_spot_prices_history_report.py
-test/test_spot_prices_per_baremetal.py
-test/test_spot_prices_per_facility.py
-test/test_spot_prices_per_new_facility.py
-test/test_spot_prices_report.py
-test/test_ssh_key.py
-test/test_ssh_key_create_input.py
-test/test_ssh_key_input.py
-test/test_ssh_key_list.py
-test/test_ssh_keys_api.py
-test/test_storage.py
-test/test_support_request_api.py
-test/test_support_request_input.py
-test/test_transfer_request.py
-test/test_transfer_request_input.py
-test/test_transfer_request_list.py
-test/test_transfer_requests_api.py
-test/test_two_factor_auth_api.py
-test/test_update_email_input.py
-test/test_usages_api.py
-test/test_user.py
-test/test_user_create_input.py
-test/test_user_limited.py
-test/test_user_list.py
-test/test_user_lite.py
-test/test_user_update_input.py
-test/test_user_verification_tokens_api.py
-test/test_userdata.py
-test/test_userdata_api.py
-test/test_users_api.py
-test/test_verify_email.py
-test/test_virtual_circuit.py
-test/test_virtual_circuit_create_input.py
-test/test_virtual_circuit_list.py
-test/test_virtual_circuit_update_input.py
-test/test_virtual_network.py
-test/test_virtual_network_create_input.py
-test/test_virtual_network_list.py
-test/test_vlan_csp_connection_create_input.py
-test/test_vlan_csp_connection_create_input_fabric_provider.py
-test/test_vlan_fabric_vc_create_input.py
-test/test_vlan_virtual_circuit.py
-test/test_vlan_virtual_circuit_create_input.py
-test/test_vlan_virtual_circuit_update_input.py
-test/test_vlans_api.py
-test/test_vrf.py
-test/test_vrf_create_input.py
-test/test_vrf_fabric_vc_create_input.py
-test/test_vrf_ip_reservation.py
-test/test_vrf_ip_reservation_create_input.py
-test/test_vrf_ip_reservation_list.py
-test/test_vrf_list.py
-test/test_vrf_metal_gateway.py
-test/test_vrf_metal_gateway_create_input.py
-test/test_vrf_route.py
-test/test_vrf_route_create_input.py
-test/test_vrf_route_list.py
-test/test_vrf_route_update_input.py
-test/test_vrf_update_input.py
-test/test_vrf_virtual_circuit.py
-test/test_vrf_virtual_circuit_create_input.py
-test/test_vrf_virtual_circuit_update_input.py
-test/test_vrfs_api.py
+test/test_vrf_bgp_neighbors.py
+test/test_vrf_bgp_neighbors_bgp_neighbors_inner.py
+test/test_vrf_learned_routes.py
+test/test_vrf_learned_routes_learned_routes_inner.py
 tox.ini

equinix_metal/README.md

@@ -397,6 +397,8 @@ Class | Method | HTTP request | Description
 *VRFsApi* | [**find_vrf_route_by_id**](docs/VRFsApi.md#find_vrf_route_by_id) | **GET** /routes/{id} | Retrieve a VRF Route
 *VRFsApi* | [**find_vrfs**](docs/VRFsApi.md#find_vrfs) | **GET** /projects/{id}/vrfs | Retrieve all VRFs in the project
 *VRFsApi* | [**get_bgp_dynamic_neighbors**](docs/VRFsApi.md#get_bgp_dynamic_neighbors) | **GET** /metal-gateways/{id}/bgp-dynamic-neighbors | List BGP Dynamic Neighbors
+*VRFsApi* | [**get_vrf_bgp_neighbors**](docs/VRFsApi.md#get_vrf_bgp_neighbors) | **GET** /vrfs/{id}/bgp-neighbors | Retreive BGP neighbor states for the VRF
+*VRFsApi* | [**get_vrf_learned_routes**](docs/VRFsApi.md#get_vrf_learned_routes) | **GET** /vrfs/{id}/learned-routes | Retreive learned L3 routes within the VRF
 *VRFsApi* | [**get_vrf_routes**](docs/VRFsApi.md#get_vrf_routes) | **GET** /vrfs/{id}/routes | Retrieve all routes in the VRF
 *VRFsApi* | [**update_vrf**](docs/VRFsApi.md#update_vrf) | **PUT** /vrfs/{id} | Update the VRF
 *VRFsApi* | [**update_vrf_route_by_id**](docs/VRFsApi.md#update_vrf_route_by_id) | **PUT** /routes/{id} | Update a VRF Route
@@ -637,11 +639,15 @@ Class | Method | HTTP request | Description
  - [VlanVirtualCircuitCreateInput](docs/VlanVirtualCircuitCreateInput.md)
  - [VlanVirtualCircuitUpdateInput](docs/VlanVirtualCircuitUpdateInput.md)
  - [Vrf](docs/Vrf.md)
+ - [VrfBGPNeighbors](docs/VrfBGPNeighbors.md)
+ - [VrfBGPNeighborsBgpNeighborsInner](docs/VrfBGPNeighborsBgpNeighborsInner.md)
  - [VrfCreateInput](docs/VrfCreateInput.md)
  - [VrfFabricVcCreateInput](docs/VrfFabricVcCreateInput.md)
  - [VrfIpReservation](docs/VrfIpReservation.md)
  - [VrfIpReservationCreateInput](docs/VrfIpReservationCreateInput.md)
  - [VrfIpReservationList](docs/VrfIpReservationList.md)
+ - [VrfLearnedRoutes](docs/VrfLearnedRoutes.md)
+ - [VrfLearnedRoutesLearnedRoutesInner](docs/VrfLearnedRoutesLearnedRoutesInner.md)
  - [VrfList](docs/VrfList.md)
  - [VrfMetalGateway](docs/VrfMetalGateway.md)
  - [VrfMetalGatewayCreateInput](docs/VrfMetalGatewayCreateInput.md)

equinix_metal/docs/AuthTokenProject.md

@@ -24,6 +24,7 @@ Name | Type | Description | Notes
 **tags** | **List[str]** |  | [optional] 
 **type** | **str** | The type of the project. Projects of type `vmce` are part of an in development feature and not available to all customers. | [optional] 
 **updated_at** | **datetime** |  | [optional] 
+**url** | **str** |  | [optional] 
 **volumes** | [**List[Href]**](Href.md) |  | [optional] 
 
 ## Example

equinix_metal/docs/CreateDeviceRequest.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **href** | **str** |  | [optional] 
-**metro** | **str** | Metro code or ID of where the instance should be provisioned in. Either metro or facility must be provided. | 
+**metro** | **str** | Metro code or ID of where the device should be provisioned in, or it can be instructed to create the device in the best available metro with `{ \"metro\": \"any\" }`. The special metro value of any means anywhere, any metro. When any is chosen in the request, the metro location is picked per our scheduling algorithms that favor the following factors: hardware reservation location (if requesting reserved hardware), ip reservations, spot instances, etc. The any keyword *does not* optimize for cost, this means that usage costs (instance, transfer, other features dependent on location) will vary. Please check metro value in response to see where the device was created. Either metro or facility must be provided. | 
 **always_pxe** | **bool** | When true, devices with a `custom_ipxe` OS will always boot to iPXE. The default setting of false ensures that iPXE will be used on only the first boot. | [optional] 
 **billing_cycle** | **str** | The billing cycle of the device. | [optional] 
 **customdata** | **Dict[str, object]** | Customdata is an arbitrary JSON value that can be accessed via the metadata service. | [optional] 

equinix_metal/docs/CreateOrganizationInterconnectionRequest.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **billing_account_name** | **str** | The billing account name of the Equinix Fabric account. | [optional] 
 **contact_email** | **str** | The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key. | [optional] 
 **description** | **str** |  | [optional] 
+**facility_id** | **str** |  | [optional] 
 **href** | **str** |  | [optional] 
 **metro** | **str** | A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. | 
 **mode** | **str** | The mode of the interconnection (only relevant to Dedicated Ports). Fabric VCs won't have this field. Can be either 'standard' or 'tunnel'.   The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection.   In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. | [optional] 

equinix_metal/docs/DedicatedPortCreateInput.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **billing_account_name** | **str** | The billing account name of the Equinix Fabric account. | [optional] 
 **contact_email** | **str** | The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key. | [optional] 
 **description** | **str** |  | [optional] 
+**facility_id** | **str** |  | [optional] 
 **href** | **str** |  | [optional] 
 **metro** | **str** | A Metro ID or code. For interconnections with Dedicated Ports, this will be the location of the issued Dedicated Ports. | 
 **mode** | **str** | The mode of the interconnection (only relevant to Dedicated Ports). Fabric VCs won't have this field. Can be either 'standard' or 'tunnel'.   The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection.   In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. | [optional]