Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.5.0] - 2025-08-19

### Removed

- Removes `Patch::Estimate.create_flight_estimate` method

## [2.4.0] - 2025-05-16

### Removed
Expand Down
21 changes: 0 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,27 +135,6 @@ patch.estimates.create_mass_estimate(mass_g=mass_g)
project_id = 'pro_test_1234' # Pass in the project's ID
patch.estimates.create_mass_estimate(mass_g=mass_g, project_id=project_id)

# Create a flight estimate
distance_m = 1_000_000 # Pass in the distance traveled in meters
patch.estimates.create_flight_estimate(distance_m=distance_m)

# Create an ecommerce estimate
distance_m = 1_000_000 # Pass in the distance traveled in meters
transportation_method = "rail"
package_mass_g = 5000
patch.estimates.create_ecommerce_estimate(
distance_m=distance_m,
transportation_method=transportation_method,
package_mass_g=package_mass_g
)

# Create a vehicle estimate
distance_m = 1_000_000 # Pass in the distance traveled in meters
make = "Toyota"
model = "Corolla"
year = 1995
patch.estimates.create_vehicle_estimate(distance_m=distance_m, make=make, model=model, year=year)

# Create a bitcoin estimate
transaction_value_btc_sats = 1000 # [Optional] Pass in the transaction value in satoshis
patch.estimates.create_bitcoin_estimate(transaction_value_btc_sats=transaction_value_btc_sats)
Expand Down
4 changes: 3 additions & 1 deletion patch_api/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# coding: utf-8

# flake8: noqa

"""
Patch API V2

Expand All @@ -13,7 +15,7 @@

from __future__ import absolute_import

__version__ = "2.4.0"
__version__ = "2.5.0"

# import ApiClient
from patch_api.api_client import ApiClient
Expand Down
2 changes: 2 additions & 0 deletions patch_api/api/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
from __future__ import absolute_import

# flake8: noqa

# import apis into api package
from patch_api.api.estimates_api import EstimatesApi
from patch_api.api.order_line_items_api import OrderLineItemsApi
Expand Down
198 changes: 0 additions & 198 deletions patch_api/api/estimates_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -485,204 +485,6 @@ def create_bitcoin_estimate_with_http_info(
collection_formats=collection_formats,
)

def create_flight_estimate(
self, create_flight_estimate_request={}, **kwargs
): # noqa: E501
"""Create a flight estimate given the distance traveled in meters # noqa: E501

Creates a flight estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters, linked to the estimate. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_flight_estimate(create_flight_estimate_request, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param CreateFlightEstimateRequest create_flight_estimate_request: (required)
:param int patch_version:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EstimateResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs["_return_http_data_only"] = True
return self.create_flight_estimate_with_http_info(
create_flight_estimate_request, **kwargs
) # noqa: E501

def create_flight_estimate_with_http_info(
self, create_flight_estimate_request, **kwargs
): # noqa: E501
"""Create a flight estimate given the distance traveled in meters # noqa: E501

Creates a flight estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters, linked to the estimate. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_flight_estimate_with_http_info(create_flight_estimate_request, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param CreateFlightEstimateRequest create_flight_estimate_request: (required)
:param int patch_version:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EstimateResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""

local_var_params = locals()

all_params = ["create_flight_estimate_request", "patch_version"] # noqa: E501
all_params.append("async_req")
all_params.append("_return_http_data_only")
all_params.append("_preload_content")
all_params.append("_request_timeout")
all_params.append("mass_g")
all_params.append("total_price_cents_usd")
all_params.append("project_id")
all_params.append("metadata")
all_params.append("distance_m")
all_params.append("transportation_method")
all_params.append("package_mass_g")
all_params.append("create_order")
all_params.append("make")
all_params.append("model")
all_params.append("year")
all_params.append("transaction_value_btc_sats")
all_params.append("transaction_value_eth_gwei")
all_params.append("gas_used")
all_params.append("transaction_value_btc_sats")
all_params.append("average_daily_balance_btc_sats")
all_params.append("average_daily_balance_eth_gwei")
all_params.append("timestamp")
all_params.append("origin_airport")
all_params.append("destination_airport")
all_params.append("aircraft_code")
all_params.append("cabin_class")
all_params.append("passenger_count")
all_params.append("state")
all_params.append("country_code")
all_params.append("city")
all_params.append("region")
all_params.append("star_rating")
all_params.append("number_of_nights")
all_params.append("number_of_rooms")
all_params.append("vintage_year")
all_params.append("total_price")
all_params.append("currency")
all_params.append("amount")
all_params.append("unit")
all_params.append("issued_to")
all_params.append("cargo_type")
all_params.append("container_size_code")
all_params.append("destination_country_code")
all_params.append("destination_locode")
all_params.append("destination_postal_code")
all_params.append("emissions_scope")
all_params.append("freight_mass_g")
all_params.append("freight_volume_cubic_m")
all_params.append("fuel_type")
all_params.append("number_of_containers")
all_params.append("origin_country_code")
all_params.append("origin_locode")
all_params.append("origin_postal_code")
all_params.append("truck_weight_t")
all_params.append("vessel_imo")
all_params.append("vintage_start_year")
all_params.append("vintage_end_year")

for key, val in six.iteritems(local_var_params["kwargs"]):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method create_flight_estimate" % key
)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'create_flight_estimate_request' is set
if (
"create_flight_estimate_request" not in local_var_params
or local_var_params["create_flight_estimate_request"] is None
):
raise ApiValueError(
"Missing the required parameter `create_flight_estimate_request` when calling `create_flight_estimate`"
) # noqa: E501

collection_formats = {}

path_params = {}

query_params = []

# do not add duplicate keys to query_params list
existing_keys = []
for param in query_params:
existing_keys.append(param[0])

for key in kwargs:
if key not in existing_keys:
query_params.append([key, kwargs.get(key)])

header_params = {}
if "patch_version" in local_var_params:
header_params["Patch-Version"] = local_var_params[
"patch_version"
] # noqa: E501

form_params = []
local_var_files = {}

body_params = None
if "create_flight_estimate_request" in local_var_params:
body_params = local_var_params["create_flight_estimate_request"]
# HTTP header `Accept`
header_params["Accept"] = self.api_client.select_header_accept(
["application/json"]
) # noqa: E501

# HTTP header `Content-Type`
header_params["Content-Type"] = (
self.api_client.select_header_content_type( # noqa: E501
["application/json"]
)
) # noqa: E501

# Authentication setting
auth_settings = ["bearer_auth"] # noqa: E501

return self.api_client.call_api(
"/v1/estimates/flight",
"POST",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="EstimateResponse", # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get("async_req"),
_return_http_data_only=local_var_params.get(
"_return_http_data_only"
), # noqa: E501
_preload_content=local_var_params.get("_preload_content", True),
_request_timeout=local_var_params.get("_request_timeout"),
collection_formats=collection_formats,
)

def create_mass_estimate(
self, create_mass_estimate_request={}, **kwargs
): # noqa: E501
Expand Down
2 changes: 1 addition & 1 deletion patch_api/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def __init__(
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
self.user_agent = "patch-python/2.4.0"
self.user_agent = "patch-python/2.5.0"
# Set default Patch-Version
self.patch_version = 2

Expand Down
2 changes: 1 addition & 1 deletion patch_api/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ def to_debug_report(self):
"OS: {env}\n"
"Python Version: {pyversion}\n"
"Version of the API: 2\n"
"SDK Package Version: 2.4.0".format(env=sys.platform, pyversion=sys.version)
"SDK Package Version: 2.5.0".format(env=sys.platform, pyversion=sys.version)
)

def get_host_settings(self):
Expand Down
2 changes: 1 addition & 1 deletion patch_api/models/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# coding: utf-8

# flake8: noqa
"""
Patch API V2

Expand All @@ -20,7 +21,6 @@
from patch_api.models.create_bitcoin_estimate_request import (
CreateBitcoinEstimateRequest,
)
from patch_api.models.create_flight_estimate_request import CreateFlightEstimateRequest
from patch_api.models.create_mass_estimate_request import CreateMassEstimateRequest
from patch_api.models.create_order_line_item_request import CreateOrderLineItemRequest
from patch_api.models.create_order_request import CreateOrderRequest
Expand Down
Loading