File size: 9,623 Bytes
fcaa164 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
import json
import logging
import os
from typing import List
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
from camel.utils import api_keys_required
class StripeToolkit(BaseToolkit):
r"""A class representing a toolkit for Stripe operations.
This toolkit provides methods to interact with the Stripe API,
allowing users to operate stripe core resources, including Customer,
Balance, BalanceTransaction, Payment, Refund
Use the Developers Dashboard https://dashboard.stripe.com/test/apikeys to
create an API keys as STRIPE_API_KEY.
Attributes:
logger (Logger): a logger to write logs.
"""
@api_keys_required(
[
(None, "STRIPE_API_KEY"),
]
)
def __init__(self, retries: int = 3):
r"""Initializes the StripeToolkit with the specified number of
retries.
Args:
retries (int,optional): Number of times to retry the request in
case of failure. (default: :obj:`3`)
"""
import stripe
stripe.max_network_retries = retries
stripe.log = 'info'
self.logger = logging.getLogger(__name__)
self.logger.setLevel(logging.INFO)
handler = logging.StreamHandler()
formatter = logging.Formatter(
'%(asctime)s - %(name)s - %(levelname)s - %(message)s'
)
handler.setFormatter(formatter)
if not self.logger.handlers:
self.logger.addHandler(handler)
stripe.api_key = os.environ.get("STRIPE_API_KEY")
def customer_get(self, customer_id: str) -> str:
r"""Retrieve a customer by ID.
Args:
customer_id (str): The ID of the customer to retrieve.
Returns:
str: The customer data as a str.
"""
import stripe
try:
self.logger.info(f"Retrieving customer with ID: {customer_id}")
customer = stripe.Customer.retrieve(customer_id)
self.logger.info(f"Retrieved customer: {customer.id}")
json_string = json.dumps(customer)
return json_string
except Exception as e:
return self.handle_exception("customer_get", e)
def customer_list(self, limit: int = 100) -> str:
r"""List customers.
Args:
limit (int, optional): Number of customers to retrieve. (default:
:obj:`100`)
Returns:
str: An output str if successful, or an error message string if
failed.
"""
import stripe
try:
self.logger.info(f"Listing customers with limit={limit}")
customers = stripe.Customer.list(limit=limit).data
self.logger.info(
f"Successfully retrieved {len(customers)} customers."
)
return json.dumps([customer for customer in customers])
except Exception as e:
return self.handle_exception("customer_list", e)
def balance_get(self) -> str:
r"""Retrieve your account balance.
Returns:
str: A str containing the account balance if successful, or an
error message string if failed.
"""
import stripe
try:
self.logger.info("Retrieving account balance.")
balance = stripe.Balance.retrieve()
self.logger.info(
f"Successfully retrieved account balance: {balance}."
)
return json.dumps(balance)
except Exception as e:
return self.handle_exception("balance_get", e)
def balance_transaction_list(self, limit: int = 100) -> str:
r"""List your balance transactions.
Args:
limit (int, optional): Number of balance transactions to retrieve.
(default::obj:`100`)
Returns:
str: A list of balance transaction data if successful, or an error
message string if failed.
"""
import stripe
try:
self.logger.info(
f"Listing balance transactions with limit={limit}"
)
transactions = stripe.BalanceTransaction.list(limit=limit).data
self.logger.info(
f"Successfully retrieved {len(transactions)} "
"balance transactions."
)
return json.dumps([transaction for transaction in transactions])
except Exception as e:
return self.handle_exception("balance_transaction_list", e)
def payment_get(self, payment_id: str) -> str:
r"""Retrieve a payment by ID.
Args:
payment_id (str): The ID of the payment to retrieve.
Returns:
str:The payment data as a str if successful, or an error message
string if failed.
"""
import stripe
try:
self.logger.info(f"Retrieving payment with ID: {payment_id}")
payment = stripe.PaymentIntent.retrieve(payment_id)
self.logger.info(f"Retrieved payment: {payment.id}")
return json.dumps(payment)
except Exception as e:
return self.handle_exception("payment_get", e)
def payment_list(self, limit: int = 100) -> str:
r"""List payments.
Args:
limit (int, optional): Number of payments to retrieve.
(default::obj:`100`)
Returns:
str: A list of payment data if successful, or an error message
string if failed.
"""
import stripe
try:
self.logger.info(f"Listing payments with limit={limit}")
payments = stripe.PaymentIntent.list(limit=limit).data
self.logger.info(
f"Successfully retrieved {len(payments)} payments."
)
return json.dumps([payment for payment in payments])
except Exception as e:
return self.handle_exception("payment_list", e)
def refund_get(self, refund_id: str) -> str:
r"""Retrieve a refund by ID.
Args:
refund_id (str): The ID of the refund to retrieve.
Returns:
str: The refund data as a str if successful, or an error message
string if failed.
"""
import stripe
try:
self.logger.info(f"Retrieving refund with ID: {refund_id}")
refund = stripe.Refund.retrieve(refund_id)
self.logger.info(f"Retrieved refund: {refund.id}")
return json.dumps(refund)
except Exception as e:
return self.handle_exception("refund_get", e)
def refund_list(self, limit: int = 100) -> str:
r"""List refunds.
Args:
limit (int, optional): Number of refunds to retrieve.
(default::obj:`100`)
Returns:
str: A list of refund data as a str if successful, or an error
message string if failed.
"""
import stripe
try:
self.logger.info(f"Listing refunds with limit={limit}")
refunds = stripe.Refund.list(limit=limit).data
self.logger.info(f"Successfully retrieved {len(refunds)} refunds.")
return json.dumps([refund for refund in refunds])
except Exception as e:
return self.handle_exception("refund_list", e)
def handle_exception(self, func_name: str, error: Exception) -> str:
r"""Handle exceptions by logging and returning an error message.
Args:
func_name (str): The name of the function where the exception
occurred.
error (Exception): The exception instance.
Returns:
str: An error message string.
"""
from stripe import StripeError
if isinstance(error, StripeError):
message = error.user_message or str(error)
self.logger.error(f"Stripe error in {func_name}: {message}")
return f"Stripe error in {func_name}: {message}"
else:
self.logger.error(f"Unexpected error in {func_name}: {error!s}")
return f"Unexpected error in {func_name}: {error!s}"
def get_tools(self) -> List[FunctionTool]:
r"""Returns a list of FunctionTool objects representing the
functions in the toolkit.
Returns:
List[FunctionTool]: A list of FunctionTool objects for the
toolkit methods.
"""
return [
FunctionTool(self.customer_get),
FunctionTool(self.customer_list),
FunctionTool(self.balance_get),
FunctionTool(self.balance_transaction_list),
FunctionTool(self.payment_get),
FunctionTool(self.payment_list),
FunctionTool(self.refund_get),
FunctionTool(self.refund_list),
]
|