@opusdns/api 1.138.0 → 1.140.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.5.0"
   },
   "name": "@opusdns/api",
-  "version": "1.138.0",
+  "version": "1.140.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -56,6 +56,7 @@ import type {
   HostStatus,
   HttpProtocol,
   IPAddressType,
+  InvoiceDocumentType,
   InvoiceResponsePaymentStatus,
   InvoiceResponseStatus,
   InvoiceResponseType,
@@ -1095,6 +1096,16 @@ export const IP_ADDRESS_TYPE_VALUES = [
   'v6',
 ] as const satisfies ReadonlyArray<IPAddressType>;
 
+export const INVOICE_DOCUMENT_TYPE = {
+  INVOICE: "invoice",
+  RECEIPT: "receipt",
+} as const satisfies Record<string, InvoiceDocumentType>;
+
+export const INVOICE_DOCUMENT_TYPE_VALUES = [
+  'invoice',
+  'receipt',
+] as const satisfies ReadonlyArray<InvoiceDocumentType>;
+
 export const INVOICE_RESPONSE_PAYMENT_STATUS = {
   PENDING: "pending",
   FAILED: "failed",

package/src/helpers/endpoints.ts

@@ -110,6 +110,7 @@ export const ORGANIZATIONS_USERS_ENDPOINT = '/v1/organizations/users';
 export const ORGANIZATIONS_BY_ORGANIZATION_ID_ENDPOINT = '/v1/organizations/{organization_id}';
 export const ORGANIZATIONS_BY_ORGANIZATION_ID_ATTRIBUTES_ENDPOINT = '/v1/organizations/{organization_id}/attributes';
 export const ORGANIZATIONS_BY_ORGANIZATION_ID_BILLING_INVOICES_ENDPOINT = '/v1/organizations/{organization_id}/billing/invoices';
+export const ORGANIZATIONS_BY_ORGANIZATION_ID_BILLING_RECEIPTS_ENDPOINT = '/v1/organizations/{organization_id}/billing/receipts';
 export const ORGANIZATIONS_BY_ORGANIZATION_ID_PRICING_PRODUCT_TYPE_BY_PRODUCT_TYPE_ENDPOINT = '/v1/organizations/{organization_id}/pricing/product-type/{product_type}';
 export const ORGANIZATIONS_BY_ORGANIZATION_ID_TRANSACTIONS_ENDPOINT = '/v1/organizations/{organization_id}/transactions';
 export const ORGANIZATIONS_BY_ORGANIZATION_ID_TRANSACTIONS_BY_TRANSACTION_ID_ENDPOINT = '/v1/organizations/{organization_id}/transactions/{transaction_id}';
@@ -263,6 +264,7 @@ export type Endpoint =
   | typeof ORGANIZATIONS_BY_ORGANIZATION_ID_ENDPOINT
   | typeof ORGANIZATIONS_BY_ORGANIZATION_ID_ATTRIBUTES_ENDPOINT
   | typeof ORGANIZATIONS_BY_ORGANIZATION_ID_BILLING_INVOICES_ENDPOINT
+  | typeof ORGANIZATIONS_BY_ORGANIZATION_ID_BILLING_RECEIPTS_ENDPOINT
   | typeof ORGANIZATIONS_BY_ORGANIZATION_ID_PRICING_PRODUCT_TYPE_BY_PRODUCT_TYPE_ENDPOINT
   | typeof ORGANIZATIONS_BY_ORGANIZATION_ID_TRANSACTIONS_ENDPOINT
   | typeof ORGANIZATIONS_BY_ORGANIZATION_ID_TRANSACTIONS_BY_TRANSACTION_ID_ENDPOINT

package/src/helpers/keys.ts

@@ -3651,6 +3651,7 @@ export const KEYS_IDN_BASE = [
 
 export const KEY_INVOICE_AMOUNT = 'amount' satisfies keyof Invoice;
 export const KEY_INVOICE_CURRENCY = 'currency' satisfies keyof Invoice;
+export const KEY_INVOICE_DOCUMENT_TYPE = 'document_type' satisfies keyof Invoice;
 export const KEY_INVOICE_EXTERNAL_ID = 'external_id' satisfies keyof Invoice;
 export const KEY_INVOICE_FEES_AMOUNT = 'fees_amount' satisfies keyof Invoice;
 export const KEY_INVOICE_FILE_URL = 'file_url' satisfies keyof Invoice;
@@ -3666,6 +3667,7 @@ export const KEY_INVOICE_TAXES_AMOUNT = 'taxes_amount' satisfies keyof Invoice;
 export const KEYS_INVOICE = [
   KEY_INVOICE_AMOUNT,
   KEY_INVOICE_CURRENCY,
+  KEY_INVOICE_DOCUMENT_TYPE,
   KEY_INVOICE_EXTERNAL_ID,
   KEY_INVOICE_FEES_AMOUNT,
   KEY_INVOICE_FILE_URL,

package/src/helpers/permissions.ts

@@ -106,6 +106,7 @@ import {
   ORGANIZATIONS_ATTRIBUTES_ENDPOINT,
   ORGANIZATIONS_BY_ORGANIZATION_ID_ATTRIBUTES_ENDPOINT,
   ORGANIZATIONS_BY_ORGANIZATION_ID_BILLING_INVOICES_ENDPOINT,
+  ORGANIZATIONS_BY_ORGANIZATION_ID_BILLING_RECEIPTS_ENDPOINT,
   ORGANIZATIONS_BY_ORGANIZATION_ID_ENDPOINT,
   ORGANIZATIONS_BY_ORGANIZATION_ID_PRICING_PRODUCT_TYPE_BY_PRODUCT_TYPE_ENDPOINT,
   ORGANIZATIONS_BY_ORGANIZATION_ID_TRANSACTIONS_BY_TRANSACTION_ID_ENDPOINT,
@@ -949,6 +950,13 @@ export const REQUIRED_PERMISSIONS = {
     patch: [],
     delete: [],
   },
+  [ORGANIZATIONS_BY_ORGANIZATION_ID_BILLING_RECEIPTS_ENDPOINT]: {
+    get: [PUBLIC_PERMISSION.BILLING_MANAGE],
+    post: [],
+    put: [],
+    patch: [],
+    delete: [],
+  },
   [ORGANIZATIONS_BY_ORGANIZATION_ID_ENDPOINT]: {
     get: [PUBLIC_PERMISSION.ORGANIZATION_READ],
     post: [],

package/src/helpers/requests.d.ts

@@ -880,6 +880,12 @@ export type GET_OrganizationsByOrganizationIdBillingInvoices_Request = {
 export type GET_OrganizationsByOrganizationIdBillingInvoices_Request_Query = GET_OrganizationsByOrganizationIdBillingInvoices_Request['parameters']['query'];
 export type GET_OrganizationsByOrganizationIdBillingInvoices_Request_Path = GET_OrganizationsByOrganizationIdBillingInvoices_Request['parameters']['path'];
 
+export type GET_OrganizationsByOrganizationIdBillingReceipts_Request = {
+  parameters: operations['list_receipts_v1_organizations__organization_id__billing_receipts_get']['parameters'];
+};
+export type GET_OrganizationsByOrganizationIdBillingReceipts_Request_Query = GET_OrganizationsByOrganizationIdBillingReceipts_Request['parameters']['query'];
+export type GET_OrganizationsByOrganizationIdBillingReceipts_Request_Path = GET_OrganizationsByOrganizationIdBillingReceipts_Request['parameters']['path'];
+
 export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Request = {
   parameters: operations['get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get']['parameters'];
 };

package/src/helpers/responses.d.ts

@@ -679,6 +679,11 @@ export type GET_OrganizationsByOrganizationIdBillingInvoices_Response = GET_Orga
 export type GET_OrganizationsByOrganizationIdBillingInvoices_Response_200 = Pagination_Invoice;
 export type GET_OrganizationsByOrganizationIdBillingInvoices_Response_422 = HTTPValidationError;
 
+export type GET_OrganizationsByOrganizationIdBillingReceipts_Response = GET_OrganizationsByOrganizationIdBillingReceipts_Response_200 | GET_OrganizationsByOrganizationIdBillingReceipts_Response_422;
+
+export type GET_OrganizationsByOrganizationIdBillingReceipts_Response_200 = Pagination_Invoice;
+export type GET_OrganizationsByOrganizationIdBillingReceipts_Response_422 = HTTPValidationError;
+
 export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response = GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_200 | GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_401 | GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_403 | GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_422;
 
 export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_200 = GetPrices;

package/src/helpers/schemas.d.ts

@@ -327,6 +327,7 @@ export type HttpRedirectRequest = components['schemas']['HttpRedirectRequest'];
 export type HttpRedirectUpsert = components['schemas']['HttpRedirectUpsert'];
 export type IPAddressType = components['schemas']['IPAddressType'];
 export type IdnBase = components['schemas']['IdnBase'];
+export type InvoiceDocumentType = components['schemas']['InvoiceDocumentType'];
 export type Invoice = components['schemas']['InvoiceResponse'];
 export type InvoiceResponsePaymentStatus = components['schemas']['InvoiceResponsePaymentStatus'];
 export type InvoiceResponseStatus = components['schemas']['InvoiceResponseStatus'];

package/src/openapi.yaml

@@ -8302,6 +8302,17 @@ components:
       - idn_capable
       title: IdnBase
       type: object
+    InvoiceDocumentType:
+      description: 'Customer-facing document class. Orthogonal to `InvoiceResponseType`:
+        prepaid-credit invoices are receipts,
+
+        everything else billable is an invoice. Documents billing classifies as neither
+        are never returned.'
+      enum:
+      - invoice
+      - receipt
+      title: InvoiceDocumentType
+      type: string
     InvoiceResponse:
       properties:
         amount:
@@ -8312,6 +8323,9 @@ components:
         currency:
           $ref: '#/components/schemas/Currency'
           description: Invoice currency
+        document_type:
+          $ref: '#/components/schemas/InvoiceDocumentType'
+          description: Customer-facing document class
         external_id:
           description: Lago ID (external) for this invoice
           title: External Id
@@ -8365,6 +8379,7 @@ components:
       - issuing_date
       - payment_due_date
       - invoice_type
+      - document_type
       - status
       - payment_status
       - payment_overdue
@@ -15765,7 +15780,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-08-26-165903
+  version: 2026-08-27-143617
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -18051,6 +18066,14 @@ paths:
           - type: string
           - type: 'null'
           title: Country
+      - in: query
+        name: in_use
+        required: false
+        schema:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          title: In Use
       - in: query
         name: created_after
         required: false
@@ -30475,6 +30498,61 @@ paths:
       - organization
       x-required-permissions:
       - billing:manage
+  /v1/organizations/{organization_id}/billing/receipts:
+    get:
+      description: Retrieves a paginated list of all payment receipts for the organization
+      operationId: list_receipts_v1_organizations__organization_id__billing_receipts_get
+      parameters:
+      - in: path
+        name: organization_id
+        required: true
+        schema:
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 1000
+          minimum: 1
+          title: Page Size
+          type: integer
+      - $ref: '#/components/parameters/DatetimeFormatHeader'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pagination_InvoiceResponse_'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: List all payment receipts for the organization
+      tags:
+      - organization
+      x-required-permissions:
+      - billing:manage
   /v1/organizations/{organization_id}/pricing/product-type/{product_type}:
     get:
       description: Retrieves pricing data for a specific product type. If a product

package/src/schema.d.ts

@@ -2304,6 +2304,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/organizations/{organization_id}/billing/receipts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all payment receipts for the organization
+         * @description Retrieves a paginated list of all payment receipts for the organization
+         */
+        get: operations["list_receipts_v1_organizations__organization_id__billing_receipts_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/organizations/{organization_id}/pricing/product-type/{product_type}": {
         parameters: {
             query?: never;
@@ -8471,6 +8491,13 @@ export interface components {
              */
             idn_tables?: string[] | null;
         };
+        /**
+         * InvoiceDocumentType
+         * @description Customer-facing document class. Orthogonal to `InvoiceResponseType`: prepaid-credit invoices are receipts,
+         *     everything else billable is an invoice. Documents billing classifies as neither are never returned.
+         * @enum {string}
+         */
+        InvoiceDocumentType: "invoice" | "receipt";
         /** InvoiceResponse */
         InvoiceResponse: {
             /**
@@ -8480,6 +8507,8 @@ export interface components {
             amount: string;
             /** @description Invoice currency */
             currency: components["schemas"]["Currency"];
+            /** @description Customer-facing document class */
+            document_type: components["schemas"]["InvoiceDocumentType"];
             /**
              * External Id
              * @description Lago ID (external) for this invoice
@@ -15202,6 +15231,7 @@ export interface operations {
                 email?: string | null;
                 search?: string | null;
                 country?: string | null;
+                in_use?: boolean | null;
                 created_after?: Date | null;
                 created_before?: Date | null;
                 /** @description Include additional data in the response. Can be specified multiple times. */
@@ -25192,6 +25222,46 @@ export interface operations {
             };
         };
     };
+    list_receipts_v1_organizations__organization_id__billing_receipts_get: {
+        parameters: {
+            query?: {
+                page?: number;
+                page_size?: number;
+            };
+            header?: {
+                /**
+                 * @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
+                 * @example rfc3339
+                 */
+                "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
+            };
+            path: {
+                organization_id: TypeId<"organization">;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Pagination_InvoiceResponse_"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get: {
         parameters: {
             query?: {