Skip to content

Commit

Permalink
feat(analytics): refactor and introduce analytics APIs to accommodate…
Browse files Browse the repository at this point in the history 
… OrgLevel, MerchantLevel and ProfileLevel authentication (#5729)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
Co-authored-by: Sampras Lopes <[email protected]>
  • Loading branch information
@tsdk02 @hyperswitch-bot @lsampras
3 people authored Sep 3, 2024
1 parent 98cfc13 commit 8ed942c
Show file tree
Hide file tree
Showing 63 changed files with 2,908 additions and 1,555 deletions.
1,975 changes: 1,027 additions & 948 deletions Cargo.lock
View file

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions api-reference-v2/openapi_spec.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"Organization"
],
"summary": "Organization - Create",
"description": "Organization - Create\n\nCreate a new organization",
"description": "Create a new organization",
"operationId": "Create an Organization",
"requestBody": {
"content": {
Expand Down Expand Up @@ -73,7 +73,7 @@
"Organization"
],
"summary": "Organization - Retrieve",
"description": "Organization - Retrieve\n\nRetrieve an existing organization",
"description": "Retrieve an existing organization",
"operationId": "Retrieve an Organization",
"parameters": [
{
Expand Down Expand Up @@ -112,7 +112,7 @@
"Organization"
],
"summary": "Organization - Update",
"description": "Organization - Update\n\nCreate a new organization for .",
"description": "Create a new organization for .",
"operationId": "Update an Organization",
"parameters": [
{
Expand Down Expand Up @@ -170,7 +170,7 @@
"Merchant Connector Account"
],
"summary": "Merchant Connector - Create",
"description": "Merchant Connector - Create\n\nCreates a new Merchant Connector for the merchant account. The connector could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting etc.",
"description": "Creates a new Merchant Connector for the merchant account. The connector could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting etc.",
"operationId": "Create a Merchant Connector",
"requestBody": {
"content": {
Expand Down Expand Up @@ -247,7 +247,7 @@
"Merchant Connector Account"
],
"summary": "Merchant Connector - Retrieve",
"description": "Merchant Connector - Retrieve\n\nRetrieves details of a Connector account",
"description": "Retrieves details of a Connector account",
"operationId": "Retrieve a Merchant Connector",
"parameters": [
{
Expand Down Expand Up @@ -290,7 +290,7 @@
"Merchant Connector Account"
],
"summary": "Merchant Connector - Update",
"description": "Merchant Connector - Update\n\nTo update an existing Merchant Connector account. Helpful in enabling/disabling different payment methods and other settings for the connector",
"description": "To update an existing Merchant Connector account. Helpful in enabling/disabling different payment methods and other settings for the connector",
"operationId": "Update a Merchant Connector",
"parameters": [
{
Expand Down Expand Up @@ -362,7 +362,7 @@
"Merchant Connector Account"
],
"summary": "Merchant Connector - Delete",
"description": "Merchant Connector - Delete\n\nDelete or Detach a Merchant Connector from Merchant Account",
"description": "Delete or Detach a Merchant Connector from Merchant Account",
"operationId": "Delete a Merchant Connector",
"parameters": [
{
Expand Down Expand Up @@ -407,7 +407,7 @@
"Merchant Account"
],
"summary": "Merchant Account - Create",
"description": "Merchant Account - Create\n\nCreate a new account for a *merchant* and the *merchant* could be a seller or retailer or client who likes to receive and send payments.\n\nBefore creating the merchant account, it is mandatory to create an organization.",
"description": "Create a new account for a *merchant* and the *merchant* could be a seller or retailer or client who likes to receive and send payments.\n\nBefore creating the merchant account, it is mandatory to create an organization.",
"operationId": "Create a Merchant Account",
"requestBody": {
"content": {
Expand Down Expand Up @@ -475,7 +475,7 @@
"Merchant Account"
],
"summary": "Merchant Account - Retrieve",
"description": "Merchant Account - Retrieve\n\nRetrieve a *merchant* account details.",
"description": "Retrieve a *merchant* account details.",
"operationId": "Retrieve a Merchant Account",
"parameters": [
{
Expand Down Expand Up @@ -514,7 +514,7 @@
"Merchant Account"
],
"summary": "Merchant Account - Update",
"description": "Merchant Account - Update\n\nUpdates details of an existing merchant account. Helpful in updating merchant details such as email, contact details, or other configuration details like webhook, routing algorithm etc",
"description": "Updates details of an existing merchant account. Helpful in updating merchant details such as email, contact details, or other configuration details like webhook, routing algorithm etc",
"operationId": "Update a Merchant Account",
"parameters": [
{
Expand Down Expand Up @@ -581,7 +581,7 @@
"Business Profile"
],
"summary": "Business Profile - Create",
"description": "Business Profile - Create\n\nCreates a new *business profile* for a merchant",
"description": "Creates a new *business profile* for a merchant",
"operationId": "Create A Business Profile",
"requestBody": {
"content": {
Expand Down Expand Up @@ -628,7 +628,7 @@
"Business Profile"
],
"summary": "Business Profile - Retrieve",
"description": "Business Profile - Retrieve\n\nRetrieve existing *business profile*",
"description": "Retrieve existing *business profile*",
"operationId": "Retrieve a Business Profile",
"parameters": [
{
Expand Down Expand Up @@ -667,7 +667,7 @@
"Business Profile"
],
"summary": "Business Profile - Update",
"description": "Business Profile - Update\n\nUpdate the *business profile*",
"description": "Update the *business profile*",
"operationId": "Update a Business Profile",
"parameters": [
{
Expand Down Expand Up @@ -725,7 +725,7 @@
"Business Profile"
],
"summary": "Business Profile - Activate routing algorithm",
"description": "Business Profile - Activate routing algorithm\n\nActivates a routing algorithm under a business profile",
"description": "Activates a routing algorithm under a business profile",
"operationId": "Activates a routing algorithm under a business profile",
"parameters": [
{
Expand Down Expand Up @@ -792,7 +792,7 @@
"Business Profile"
],
"summary": "Business Profile - Deactivate routing algorithm",
"description": "Business Profile - Deactivate routing algorithm\n\nDeactivates a routing algorithm under a business profile",
"description": "Deactivates a routing algorithm under a business profile",
"operationId": " Deactivates a routing algorithm under a business profile",
"parameters": [
{
Expand Down Expand Up @@ -845,7 +845,7 @@
"Business Profile"
],
"summary": "Business Profile - Update Default Fallback Routing Algorithm",
"description": "Business Profile - Update Default Fallback Routing Algorithm\n\nUpdate the default fallback routing algorithm for the business profile",
"description": "Update the default fallback routing algorithm for the business profile",
"operationId": "Update the default fallback routing algorithm for the business profile",
"parameters": [
{
Expand Down Expand Up @@ -909,7 +909,7 @@
"Business Profile"
],
"summary": "Business Profile - Retrieve Default Fallback Routing Algorithm",
"description": "Business Profile - Retrieve Default Fallback Routing Algorithm\n\nRetrieve the default fallback routing algorithm for the business profile",
"description": "Retrieve the default fallback routing algorithm for the business profile",
"operationId": "Retrieve the default fallback routing algorithm for the business profile",
"parameters": [
{
Expand Down Expand Up @@ -956,7 +956,7 @@
"Business Profile"
],
"summary": "Business Profile - Retrieve Active Routing Algorithm",
"description": "Business Profile - Retrieve Active Routing Algorithm\n\nRetrieve active routing algorithm under the business profile",
"description": "Retrieve active routing algorithm under the business profile",
"operationId": "Retrieve the active routing algorithm under the business profile",
"parameters": [
{
Expand Down Expand Up @@ -1030,7 +1030,7 @@
"Routing"
],
"summary": "Routing - Create",
"description": "Routing - Create\n\nCreate a routing algorithm",
"description": "Create a routing algorithm",
"operationId": "Create a routing algprithm",
"requestBody": {
"content": {
Expand Down Expand Up @@ -1085,7 +1085,7 @@
"Routing"
],
"summary": "Routing - Retrieve",
"description": "Routing - Retrieve\n\nRetrieve a routing algorithm with its algorithm id",
"description": "Retrieve a routing algorithm with its algorithm id",
"operationId": "Retrieve a routing algorithm with its algorithm id",
"parameters": [
{
Expand Down Expand Up @@ -1135,7 +1135,7 @@
"API Key"
],
"summary": "API Key - Create",
"description": "API Key - Create\n\nCreate a new API Key for accessing our APIs from your servers. The plaintext API Key will be\ndisplayed only once on creation, so ensure you store it securely.",
"description": "Create a new API Key for accessing our APIs from your servers. The plaintext API Key will be\ndisplayed only once on creation, so ensure you store it securely.",
"operationId": "Create an API Key",
"requestBody": {
"content": {
Expand Down Expand Up @@ -1175,7 +1175,7 @@
"API Key"
],
"summary": "API Key - Retrieve",
"description": "API Key - Retrieve\n\nRetrieve information about the specified API Key.",
"description": "Retrieve information about the specified API Key.",
"operationId": "Retrieve an API Key",
"parameters": [
{
Expand Down Expand Up @@ -1214,7 +1214,7 @@
"API Key"
],
"summary": "API Key - Update",
"description": "API Key - Update\n\nUpdate information for the specified API Key.",
"description": "Update information for the specified API Key.",
"operationId": "Update an API Key",
"parameters": [
{
Expand Down Expand Up @@ -1263,7 +1263,7 @@
"API Key"
],
"summary": "API Key - Revoke",
"description": "API Key - Revoke\n\nRevoke the specified API Key. Once revoked, the API Key can no longer be used for\nauthenticating with our APIs.",
"description": "Revoke the specified API Key. Once revoked, the API Key can no longer be used for\nauthenticating with our APIs.",
"operationId": "Revoke an API Key",
"parameters": [
{
Expand Down
Loading

0 comments on commit 8ed942c

Please sign in to comment.