Skip to content
Open
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
76 changes: 66 additions & 10 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions src/resources/customer_wallet_alerts.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ get:
summary: List wallet alerts
description: This endpoint enables the retrieval of all alerts for a wallet.
operationId: getCustomerWalletAlerts
parameters:
- $ref: "../parameters/page.yaml"
- $ref: "../parameters/per_page.yaml"
responses:
"200":
description: Wallet alerts
Expand Down
1 change: 1 addition & 0 deletions src/resources/customer_wallets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ get:
parameters:
- $ref: "../parameters/page.yaml"
- $ref: "../parameters/per_page.yaml"
- $ref: "../parameters/currency.yaml"
- name: billing_entity_codes[]
in: query
description: Filter wallets by billing entity codes.
Expand Down
2 changes: 2 additions & 0 deletions src/resources/subscription_alerts.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ get:
operationId: getSubscriptionAlerts
parameters:
- $ref: "../parameters/subscription_status.yaml"
- $ref: "../parameters/page.yaml"
- $ref: "../parameters/per_page.yaml"
responses:
"200":
description: Subscription alerts
Expand Down
8 changes: 8 additions & 0 deletions src/resources/wallet_transactions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ get:
schema:
type: string
example: "inbound"
- name: metadata[key]
in: query
description: Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. For example, `metadata[color]=blue`.
required: false
explode: true
schema:
type: string
example: "someValue"
responses:
"200":
description: Wallet transactions
Expand Down
6 changes: 6 additions & 0 deletions src/schemas/AppliedCouponObject.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ properties:
type: string
description: The name of the coupon.
example: Startup Deal
coupon_description:
type:
- string
- "null"
description: The description of the parent coupon.
example: "I am a coupon description"
coupon_status:
type: string
enum:
Expand Down
8 changes: 8 additions & 0 deletions src/schemas/WalletCreateInput.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
type: object
required:
- wallet
properties:
wallet:
type: object
Expand Down Expand Up @@ -92,6 +94,12 @@ properties:
- "null"
description: The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.
example: "Tokens for models 'high-fidelity-boost'"
transaction_priority:
type: integer
minimum: 1
maximum: 50
description: "The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50."
example: 50
purchase_order_number:
type:
- string
Expand Down
1 change: 0 additions & 1 deletion src/schemas/WalletObject.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ required:
- currency
- rate_amount
- credits_balance
- balance
- balance_cents
- consumed_credits
- created_at
Expand Down
13 changes: 13 additions & 0 deletions src/schemas/WalletTransactionCreateInput.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,19 @@ properties:
pattern: "^[0-9]+.?[0-9]*$"
description: The number of voided credits.
example: "5.0"
voided_transaction_id:
type:
- string
- "null"
format: "uuid"
description: Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount.
example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
priority:
type: integer
minimum: 1
maximum: 50
description: "The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50."
example: 50
invoice_requires_successful_payment:
type: boolean
description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
Expand Down
4 changes: 4 additions & 0 deletions src/schemas/WalletTransactionObject.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ properties:
format: "uuid"
description: Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.
example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
billing_entity_code:
type: string
example: "default"
description: The code of the billing entity associated with the wallet transaction. Falls back to the wallet's billing entity when the transaction does not carry one.
lago_invoice_id:
type:
- string
Expand Down
12 changes: 12 additions & 0 deletions src/schemas/WalletUpdateInput.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,18 @@ properties:
type: boolean
description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
example: false
paid_top_up_min_amount_cents:
type:
- integer
- "null"
description: Minimum amount of cents that can be top-up with a single paid transaction.
example: 100
paid_top_up_max_amount_cents:
type:
- integer
- "null"
description: Maximum amount of cents that can be top-up with a single paid transaction.
example: 1000
billing_entity_code:
type: string
example: "default"
Expand Down
Loading