Skip to content

Commit d1439da

Browse files
revenuecat-opsgreenietea
revenuecat-ops
and
greenietea
authored
[create-pull-request] automated change (#1011)
Co-authored-by: greenietea <[email protected]>
1 parent 1d27bc7 commit d1439da

File tree

2 files changed

+316
-3
lines changed

2 files changed

+316
-3
lines changed

‎openapi-spec/api-v2-beta.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4471,7 +4471,7 @@ paths:
44714471
x-revenuecat-rate-limiting-domain: customer_information
44724472
x-scopes:
44734473
- customer_information:purchases:read
4474-
x-release-status: beta
4474+
x-release-status: public
44754475
tags:
44764476
- Customer
44774477
parameters:
@@ -4547,7 +4547,7 @@ paths:
45474547
x-revenuecat-rate-limiting-domain: virtual_currencies_create_transaction
45484548
x-scopes:
45494549
- customer_information:purchases:read_write
4550-
x-release-status: beta
4550+
x-release-status: public
45514551
tags:
45524552
- Customer
45534553
parameters:
@@ -4640,7 +4640,7 @@ paths:
46404640
x-revenuecat-rate-limiting-domain: virtual_currencies_create_transaction
46414641
x-scopes:
46424642
- customer_information:purchases:read_write
4643-
x-release-status: beta
4643+
x-release-status: public
46444644
tags:
46454645
- Customer
46464646
parameters:

‎openapi-spec/api-v2.yaml

Lines changed: 313 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4464,6 +4464,268 @@ paths:
44644464
'503':
44654465
$ref: '#/components/responses/InternalError'
44664466
description: 'This endpoint requires the following permission(s): <code>customer_information:customers:read</code>.'
4467+
/projects/{project_id}/customers/{customer_id}/virtual_currencies:
4468+
get:
4469+
summary: Get a list of customer's virtual currencies balances
4470+
operationId: list-virtual-currencies-balances
4471+
x-revenuecat-rate-limiting-domain: customer_information
4472+
x-scopes:
4473+
- customer_information:purchases:read
4474+
x-release-status: public
4475+
tags:
4476+
- Customer
4477+
parameters:
4478+
- name: project_id
4479+
description: ID of the project
4480+
required: true
4481+
in: path
4482+
schema:
4483+
type: string
4484+
maxLength: 255
4485+
example: proj1ab2c3d4
4486+
- name: customer_id
4487+
in: path
4488+
description: ID of the customer
4489+
required: true
4490+
schema:
4491+
type: string
4492+
minLength: 1
4493+
maxLength: 1500
4494+
example: 19b8de26-77c1-49f1-aa18-019a391603e2
4495+
- name: include_empty_balances
4496+
in: query
4497+
required: false
4498+
schema:
4499+
type: boolean
4500+
example: true
4501+
- name: starting_after
4502+
in: query
4503+
required: false
4504+
schema:
4505+
type: string
4506+
example: ent12354
4507+
- name: limit
4508+
in: query
4509+
required: false
4510+
schema:
4511+
type: integer
4512+
example: 10
4513+
default: 20
4514+
responses:
4515+
'200':
4516+
description: Success
4517+
content:
4518+
application/json:
4519+
schema:
4520+
$ref: '#/components/schemas/ListVirtualCurrenciesBalances'
4521+
headers:
4522+
RevenueCat-Rate-Limit-Current-Usage:
4523+
$ref: '#/components/headers/RateLimitCurrentUsage'
4524+
RevenueCat-Rate-Limit-Current-Limit:
4525+
$ref: '#/components/headers/RateLimitCurrentLimit'
4526+
'400':
4527+
$ref: '#/components/responses/BadRequest'
4528+
'401':
4529+
$ref: '#/components/responses/Unauthorized'
4530+
'403':
4531+
$ref: '#/components/responses/Forbidden'
4532+
'404':
4533+
$ref: '#/components/responses/NotFound'
4534+
'423':
4535+
$ref: '#/components/responses/Locked'
4536+
'429':
4537+
$ref: '#/components/responses/RateLimited'
4538+
'500':
4539+
$ref: '#/components/responses/InternalError'
4540+
'503':
4541+
$ref: '#/components/responses/InternalError'
4542+
description: 'This endpoint requires the following permission(s): <code>customer_information:purchases:read</code>.'
4543+
/projects/{project_id}/customers/{customer_id}/virtual_currencies/transactions:
4544+
post:
4545+
summary: Create a virtual currencies transaction
4546+
operationId: create-virtual-currencies-transaction
4547+
x-revenuecat-rate-limiting-domain: virtual_currencies_create_transaction
4548+
x-scopes:
4549+
- customer_information:purchases:read_write
4550+
x-release-status: public
4551+
tags:
4552+
- Customer
4553+
parameters:
4554+
- name: project_id
4555+
description: ID of the project
4556+
required: true
4557+
in: path
4558+
schema:
4559+
type: string
4560+
maxLength: 255
4561+
example: proj1ab2c3d4
4562+
- name: customer_id
4563+
in: path
4564+
description: ID of the customer
4565+
required: true
4566+
schema:
4567+
type: string
4568+
minLength: 1
4569+
maxLength: 1500
4570+
example: 19b8de26-77c1-49f1-aa18-019a391603e2
4571+
- name: Idempotency-Key
4572+
in: header
4573+
schema:
4574+
type: string
4575+
example: 1234-5678-9101-1121
4576+
description: This is an optional idempotency key to ensure exactly once execution
4577+
of the request.
4578+
- name: include_empty_balances
4579+
in: query
4580+
required: false
4581+
schema:
4582+
type: boolean
4583+
example: true
4584+
requestBody:
4585+
required: true
4586+
content:
4587+
application/json:
4588+
schema:
4589+
type: object
4590+
required:
4591+
- adjustments
4592+
properties:
4593+
adjustments:
4594+
description: The adjustments to the virtual currencies
4595+
type: object
4596+
additionalProperties:
4597+
type: integer
4598+
reference:
4599+
description: The reference of the transaction
4600+
type: string
4601+
nullable: true
4602+
additionalProperties: false
4603+
responses:
4604+
'200':
4605+
description: Success
4606+
content:
4607+
application/json:
4608+
schema:
4609+
$ref: '#/components/schemas/ListVirtualCurrenciesBalances'
4610+
headers:
4611+
RevenueCat-Rate-Limit-Current-Usage:
4612+
$ref: '#/components/headers/RateLimitCurrentUsage'
4613+
RevenueCat-Rate-Limit-Current-Limit:
4614+
$ref: '#/components/headers/RateLimitCurrentLimit'
4615+
'400':
4616+
$ref: '#/components/responses/BadRequest'
4617+
'401':
4618+
$ref: '#/components/responses/Unauthorized'
4619+
'403':
4620+
$ref: '#/components/responses/Forbidden'
4621+
'404':
4622+
$ref: '#/components/responses/NotFound'
4623+
'409':
4624+
$ref: '#/components/responses/Conflict'
4625+
'422':
4626+
$ref: '#/components/responses/UnprocessableEntity'
4627+
'423':
4628+
$ref: '#/components/responses/Locked'
4629+
'429':
4630+
$ref: '#/components/responses/RateLimited'
4631+
'500':
4632+
$ref: '#/components/responses/InternalError'
4633+
'503':
4634+
$ref: '#/components/responses/InternalError'
4635+
description: 'This endpoint requires the following permission(s): <code>customer_information:purchases:read_write</code>.'
4636+
/projects/{project_id}/customers/{customer_id}/virtual_currencies/update_balance:
4637+
post:
4638+
summary: Update a virtual currencies balance without creating a transaction
4639+
operationId: update-virtual-currencies-balance
4640+
x-revenuecat-rate-limiting-domain: virtual_currencies_create_transaction
4641+
x-scopes:
4642+
- customer_information:purchases:read_write
4643+
x-release-status: public
4644+
tags:
4645+
- Customer
4646+
parameters:
4647+
- name: project_id
4648+
description: ID of the project
4649+
required: true
4650+
in: path
4651+
schema:
4652+
type: string
4653+
maxLength: 255
4654+
example: proj1ab2c3d4
4655+
- name: customer_id
4656+
in: path
4657+
description: ID of the customer
4658+
required: true
4659+
schema:
4660+
type: string
4661+
minLength: 1
4662+
maxLength: 1500
4663+
example: 19b8de26-77c1-49f1-aa18-019a391603e2
4664+
- name: Idempotency-Key
4665+
in: header
4666+
schema:
4667+
type: string
4668+
example: 1234-5678-9101-1121
4669+
description: This is an optional idempotency key to ensure exactly once execution
4670+
of the request.
4671+
- name: include_empty_balances
4672+
in: query
4673+
required: false
4674+
schema:
4675+
type: boolean
4676+
example: true
4677+
requestBody:
4678+
required: true
4679+
content:
4680+
application/json:
4681+
schema:
4682+
type: object
4683+
required:
4684+
- adjustments
4685+
properties:
4686+
adjustments:
4687+
description: The adjustments to the virtual currencies
4688+
type: object
4689+
additionalProperties:
4690+
type: integer
4691+
reference:
4692+
description: The reference of the transaction
4693+
type: string
4694+
nullable: true
4695+
additionalProperties: false
4696+
responses:
4697+
'200':
4698+
description: Success
4699+
content:
4700+
application/json:
4701+
schema:
4702+
$ref: '#/components/schemas/ListVirtualCurrenciesBalances'
4703+
headers:
4704+
RevenueCat-Rate-Limit-Current-Usage:
4705+
$ref: '#/components/headers/RateLimitCurrentUsage'
4706+
RevenueCat-Rate-Limit-Current-Limit:
4707+
$ref: '#/components/headers/RateLimitCurrentLimit'
4708+
'400':
4709+
$ref: '#/components/responses/BadRequest'
4710+
'401':
4711+
$ref: '#/components/responses/Unauthorized'
4712+
'403':
4713+
$ref: '#/components/responses/Forbidden'
4714+
'404':
4715+
$ref: '#/components/responses/NotFound'
4716+
'409':
4717+
$ref: '#/components/responses/Conflict'
4718+
'422':
4719+
$ref: '#/components/responses/UnprocessableEntity'
4720+
'423':
4721+
$ref: '#/components/responses/Locked'
4722+
'429':
4723+
$ref: '#/components/responses/RateLimited'
4724+
'500':
4725+
$ref: '#/components/responses/InternalError'
4726+
'503':
4727+
$ref: '#/components/responses/InternalError'
4728+
description: 'This endpoint requires the following permission(s): <code>customer_information:purchases:read_write</code>.'
44674729
/projects/{project_id}/customers/{customer_id}/attributes:
44684730
get:
44694731
summary: Get a list of the customer's attributes
@@ -6687,6 +6949,37 @@ components:
66876949
maxLength: 5000
66886950
type: string
66896951
example: /v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/subscriptions
6952+
ListVirtualCurrenciesBalances:
6953+
type: object
6954+
title: VirtualCurrenciesBalancesList
6955+
required:
6956+
- items
6957+
- next_page
6958+
- object
6959+
- url
6960+
properties:
6961+
object:
6962+
description: String representing the object's type. Objects of the same
6963+
type share the same value.
6964+
enum:
6965+
- list
6966+
type: string
6967+
items:
6968+
description: Details about each object.
6969+
items:
6970+
$ref: '#/components/schemas/VirtualCurrencyBalance'
6971+
type: array
6972+
next_page:
6973+
description: URL to access the next page of the customer's balances. If
6974+
not present / null, there is no next page
6975+
type: string
6976+
nullable: true
6977+
example: /v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies?starting_after=9fjeja8fjed
6978+
url:
6979+
description: The URL where this list can be accessed.
6980+
maxLength: 5000
6981+
type: string
6982+
example: /v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies
66906983
MacAppStoreApp:
66916984
type: object
66926985
properties:
@@ -8089,6 +8382,26 @@ components:
80898382
target_customer:
80908383
description: The target customer after the transfer
80918384
$ref: '#/components/schemas/Customer'
8385+
VirtualCurrencyBalance:
8386+
type: object
8387+
title: VirtualCurrencyBalance
8388+
required:
8389+
- object
8390+
- currency_code
8391+
- balance
8392+
properties:
8393+
object:
8394+
description: String representing the object's type. Objects of the same
8395+
type share the same value.
8396+
enum:
8397+
- virtual_currency_balance
8398+
type: string
8399+
currency_code:
8400+
description: The code of the virtual currency.
8401+
type: string
8402+
balance:
8403+
description: The balance of the virtual currency.
8404+
type: integer
80928405
headers:
80938406
RateLimitCurrentLimit:
80948407
required: true

0 commit comments

Comments
 (0)