From 76c22f315bed2c24fa636c22a89c40eec4116590 Mon Sep 17 00:00:00 2001 From: Jacob Cox Date: Wed, 25 Mar 2026 08:43:48 -0400 Subject: [PATCH 1/4] initial --- swagger.json | 145 ++++++++++++++++++++++++++++++--------------------- 1 file changed, 86 insertions(+), 59 deletions(-) diff --git a/swagger.json b/swagger.json index b648e63..94863a4 100644 --- a/swagger.json +++ b/swagger.json @@ -151,7 +151,7 @@ "security": [{ "api_key": [] }] } }, - "/api/v3.1/site/addUpdate": { + "/api/v2/site/addUpdate": { "post": { "operationId": "SiteController_addUpdateSite", "parameters": [], @@ -485,6 +485,61 @@ "tags": ["site"], "security": [{ "api_key": [] }] } + }, + "api/v3.1/site/{site_id}/invoices": { + "get": { + "operationId": "SiteController_getInvoices", + "parameters": [ + { + "name": "site_id", + "required": true, + "in": "path", + "schema": { "type": "string" } + }, + { + "name": "updated_after", + "required": true, + "in": "query", + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GetInvoicesResponse" } + } + } + }, + "400": { + "description": "Returned on invalid requests", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ErrorResponse" } + } + } + }, + "429": { + "description": "Returned when requests are throttled", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ErrorResponse" } + } + } + }, + "500": { + "description": "Returned when an error occurs on the Hyfin side", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ErrorResponse" } + } + } + } + }, + "tags": ["site"], + "security": [{ "api_key": [] }] + } } }, "info": { @@ -665,61 +720,6 @@ }, "required": ["first_name", "last_name", "email"] }, - "PaymentTypeCard": { - "type": "object", - "properties": { - "active": { - "type": "boolean", - "description": "This flag represents whether the payment method is active and available to be used or not.", - "default": true - }, - "gateway": { - "type": "object", - "description": "The gateway used to process credit/debit card payments.", - "oneOf": [ - { "$ref": "#/components/schemas/Gateway" } - ] - } - }, - "required": ["gateway"] - }, - "PaymentTypeACH": { - "type": "object", - "properties": { - "active": { - "type": "boolean", - "description": "This flag represents whether the payment method is active and available to be used or not.", - "default": true - }, - "gateway": { - "type": "object", - "description": "The gateway used to process ACH payments.", - "oneOf": [ - { "$ref": "#/components/schemas/Gateway" } - ] - } - }, - "required": ["gateway"] - }, - "PaymentTypes": { - "type": "object", - "properties": { - "payment_card": { - "type": "object", - "description": "Required if you would like to enable credit/debit card transactions.", - "oneOf": [ - { "$ref": "#/components/schemas/PaymentTypeCard" } - ] - }, - "ach": { - "type": "object", - "description": "Required if you would like to enable ACH transactions.", - "oneOf": [ - { "$ref": "#/components/schemas/PaymentTypeACH" } - ] - } - } - }, "Gateway": { "type": "object", "properties": { @@ -863,9 +863,9 @@ "description": "The main person responsible for the business.", "allOf": [{ "$ref": "#/components/schemas/Contact" }] }, - "payment_types": { - "description": "The payment methods available to accept payments from customers. At least one payment method is required.", - "allOf": [{ "$ref": "#/components/schemas/PaymentTypes" }] + "gateway": { + "description": "The gateway used to access the processing account.", + "allOf": [{ "$ref": "#/components/schemas/Gateway" }] }, "site_enterprise": { "description": "A reference to the site enterprise record.", @@ -1363,6 +1363,33 @@ } } }, + "GetInvoicesResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Whether the query action ran successfully." + }, + "records_matched": { + "type": "integer", + "description": "The total number of records that matched the query." + }, + "records_returned": { + "type": "integer", + "description": "The number of records that are being returned in the response." + }, + "next_updated_after": { + "type": "string", + "format": "date-time", + "description": "The updated_at timestamp to be used in the next request." + }, + "records": { + "type": "array", + "items": { "$ref": "#/components/schemas/Invoice"}, + "description": "Invoices returned by the query up to 1,000 records." + } + } + }, "ErrorResponse": { "type": "object", "properties": { From 26f81e7ac02c65cdc8589edc86012b59d5f96c23 Mon Sep 17 00:00:00 2001 From: Jacob Cox Date: Wed, 25 Mar 2026 13:49:11 -0400 Subject: [PATCH 2/4] update yardarm version --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5393274..684272a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,7 +21,7 @@ jobs: with: dotnet-version: 6.0.x - name: Install Yardarm - run: dotnet tool install --global --version 0.3.3 Yardarm.CommandLine + run: dotnet tool install --global --version 0.6.3 Yardarm.CommandLine - name: Install GitVersion uses: gittools/actions/gitversion/setup@v0.9.15 with: From e0530c20ff9b493f4f977c992f3e0cd9965d464f Mon Sep 17 00:00:00 2001 From: Jacob Cox Date: Wed, 25 Mar 2026 14:29:02 -0400 Subject: [PATCH 3/4] fix typo --- swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger.json b/swagger.json index 94863a4..7a7452b 100644 --- a/swagger.json +++ b/swagger.json @@ -486,7 +486,7 @@ "security": [{ "api_key": [] }] } }, - "api/v3.1/site/{site_id}/invoices": { + "/api/v3.1/site/{site_id}/invoices": { "get": { "operationId": "SiteController_getInvoices", "parameters": [ From ca1dc3b39c517d7328f2e727ade2674faf561e7a Mon Sep 17 00:00:00 2001 From: Jacob Cox Date: Wed, 25 Mar 2026 14:43:37 -0400 Subject: [PATCH 4/4] add date-time format --- swagger.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/swagger.json b/swagger.json index 7a7452b..253d309 100644 --- a/swagger.json +++ b/swagger.json @@ -500,7 +500,10 @@ "name": "updated_after", "required": true, "in": "query", - "schema": { "type": "string" } + "schema": { + "type": "string", + "format": "date-time" + } } ], "responses": {