@billkit-eu/sdk 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -1025,6 +1025,18 @@ declare class WebhookEndpoints extends BaseResource {
         pageSize?: number;
     }): AsyncIterableIterator<T>;
     /** Fetch one delivery row for inspection before deciding to redeliver. */
+    retrieveDelivery<T = unknown>(endpointId: string, deliveryId: string): Promise<T>;
+    /**
+     * @deprecated Renamed to {@link WebhookEndpoints.retrieveDelivery}.
+     *
+     * Every other single-row fetch in every BillKit SDK is `retrieve`; this
+     * one method was `get`, which meant reaching for the obvious name and
+     * getting a type error. The python and php clients already spell it
+     * `retrieve_delivery` / `retrieveDelivery`, so node was the outlier.
+     *
+     * Kept as an alias because removing it would break callers for a naming
+     * preference. It will go in the next major.
+     */
     getDelivery<T = unknown>(endpointId: string, deliveryId: string): Promise<T>;
     /**
      * Re-enqueue a delivery row for the dispatcher.
@@ -1318,7 +1330,7 @@ declare class RateLimitError extends BillKitError {
     });
 }
 
-declare const VERSION = "0.4.0";
+declare const VERSION = "0.5.0";
 
 /**
  * Verify `BillKit-Signature: t=<unix>,v1=<hex>` headers.
@@ -1350,4 +1362,4 @@ interface VerifyWebhookOptions {
 }
 declare function verifyWebhookSignature<T = unknown>(options: VerifyWebhookOptions): Promise<T>;
 
-export { APIConnectionError, APIError, type AuditLogsListParams, AuthenticationError, type BaseListParams, BillKit, BillKitError, type BillKitLogger, type BillKitOptions, ConflictError, type CreateBillingPortalSessionParams, type CreateCheckoutSessionParams, type CreateCouponParams, type CreateCustomerParams, type CreateOneShotPaymentParams, type CreatePriceParams, type CreateProductParams, type CreateRefundParams, type CreateTaxRateParams, type CreateUsageRecordParams, type CreateWebhookEndpointParams, type CreditNotesListParams, DEFAULT_RETRY_POLICY, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type EventsListParams, type IdempotencyOptions, InvalidRequestError, type ListParams, type ListResponseEnvelope, type LogContext, NOOP_LOGGER, type PaginateOptions, PermissionError, type PriceTier, type PricesListParams, RateLimitError, ResourceMissingError, type RetryPolicy, type RotateProviderCredentialParams, ServerError, type SetPortalBrandingParams, type SubscriptionsListParams, type UpdateCouponParams, type UpdateCustomerParams, type UpdateProductParams, type UpdateTaxRateParams, type UpdateWebhookEndpointParams, type UsageRecordsListParams, VERSION, type ValidateCouponParams, type VerifyWebhookOptions, type VoidInvoiceParams, WebhookVerificationError, paginate, verifyWebhookSignature };
+export { APIConnectionError, APIError, type AuditLogsListParams, AuthenticationError, type BaseListParams, BillKit, BillKitError, type BillKitLogger, type BillKitOptions, ConflictError, type CreateBillingPortalSessionParams, type CreateCheckoutSessionParams, type CreateCouponParams, type CreateCustomerParams, type CreateOneShotPaymentParams, type CreatePriceParams, type CreateProductParams, type CreateRefundParams, type CreateTaxRateParams, type CreateUsageRecordParams, type CreateWebhookEndpointParams, type CreditNotesListParams, type CustomerListParams, DEFAULT_RETRY_POLICY, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type EventsListParams, type IdempotencyOptions, InvalidRequestError, type ListParams, type ListResponseEnvelope, type LogContext, NOOP_LOGGER, type PaginateOptions, PermissionError, type PriceTier, type PricesListParams, RateLimitError, ResourceMissingError, type RetryPolicy, type RotateProviderCredentialParams, ServerError, type SetPortalBrandingParams, type SubscriptionsListParams, type UpdateCouponParams, type UpdateCustomerParams, type UpdateProductParams, type UpdateTaxRateParams, type UpdateWebhookEndpointParams, type UsageRecordsListParams, VERSION, type ValidateCouponParams, type VerifyWebhookOptions, type VoidInvoiceParams, WebhookVerificationError, paginate, verifyWebhookSignature };

package/dist/index.d.ts

@@ -1025,6 +1025,18 @@ declare class WebhookEndpoints extends BaseResource {
         pageSize?: number;
     }): AsyncIterableIterator<T>;
     /** Fetch one delivery row for inspection before deciding to redeliver. */
+    retrieveDelivery<T = unknown>(endpointId: string, deliveryId: string): Promise<T>;
+    /**
+     * @deprecated Renamed to {@link WebhookEndpoints.retrieveDelivery}.
+     *
+     * Every other single-row fetch in every BillKit SDK is `retrieve`; this
+     * one method was `get`, which meant reaching for the obvious name and
+     * getting a type error. The python and php clients already spell it
+     * `retrieve_delivery` / `retrieveDelivery`, so node was the outlier.
+     *
+     * Kept as an alias because removing it would break callers for a naming
+     * preference. It will go in the next major.
+     */
     getDelivery<T = unknown>(endpointId: string, deliveryId: string): Promise<T>;
     /**
      * Re-enqueue a delivery row for the dispatcher.
@@ -1318,7 +1330,7 @@ declare class RateLimitError extends BillKitError {
     });
 }
 
-declare const VERSION = "0.4.0";
+declare const VERSION = "0.5.0";
 
 /**
  * Verify `BillKit-Signature: t=<unix>,v1=<hex>` headers.
@@ -1350,4 +1362,4 @@ interface VerifyWebhookOptions {
 }
 declare function verifyWebhookSignature<T = unknown>(options: VerifyWebhookOptions): Promise<T>;
 
-export { APIConnectionError, APIError, type AuditLogsListParams, AuthenticationError, type BaseListParams, BillKit, BillKitError, type BillKitLogger, type BillKitOptions, ConflictError, type CreateBillingPortalSessionParams, type CreateCheckoutSessionParams, type CreateCouponParams, type CreateCustomerParams, type CreateOneShotPaymentParams, type CreatePriceParams, type CreateProductParams, type CreateRefundParams, type CreateTaxRateParams, type CreateUsageRecordParams, type CreateWebhookEndpointParams, type CreditNotesListParams, DEFAULT_RETRY_POLICY, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type EventsListParams, type IdempotencyOptions, InvalidRequestError, type ListParams, type ListResponseEnvelope, type LogContext, NOOP_LOGGER, type PaginateOptions, PermissionError, type PriceTier, type PricesListParams, RateLimitError, ResourceMissingError, type RetryPolicy, type RotateProviderCredentialParams, ServerError, type SetPortalBrandingParams, type SubscriptionsListParams, type UpdateCouponParams, type UpdateCustomerParams, type UpdateProductParams, type UpdateTaxRateParams, type UpdateWebhookEndpointParams, type UsageRecordsListParams, VERSION, type ValidateCouponParams, type VerifyWebhookOptions, type VoidInvoiceParams, WebhookVerificationError, paginate, verifyWebhookSignature };
+export { APIConnectionError, APIError, type AuditLogsListParams, AuthenticationError, type BaseListParams, BillKit, BillKitError, type BillKitLogger, type BillKitOptions, ConflictError, type CreateBillingPortalSessionParams, type CreateCheckoutSessionParams, type CreateCouponParams, type CreateCustomerParams, type CreateOneShotPaymentParams, type CreatePriceParams, type CreateProductParams, type CreateRefundParams, type CreateTaxRateParams, type CreateUsageRecordParams, type CreateWebhookEndpointParams, type CreditNotesListParams, type CustomerListParams, DEFAULT_RETRY_POLICY, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type EventsListParams, type IdempotencyOptions, InvalidRequestError, type ListParams, type ListResponseEnvelope, type LogContext, NOOP_LOGGER, type PaginateOptions, PermissionError, type PriceTier, type PricesListParams, RateLimitError, ResourceMissingError, type RetryPolicy, type RotateProviderCredentialParams, ServerError, type SetPortalBrandingParams, type SubscriptionsListParams, type UpdateCouponParams, type UpdateCustomerParams, type UpdateProductParams, type UpdateTaxRateParams, type UpdateWebhookEndpointParams, type UsageRecordsListParams, VERSION, type ValidateCouponParams, type VerifyWebhookOptions, type VoidInvoiceParams, WebhookVerificationError, paginate, verifyWebhookSignature };

package/dist/index.js

@@ -460,9 +460,23 @@ var WebhookEndpoints = class extends BaseResource {
     );
   }
   /** Fetch one delivery row for inspection before deciding to redeliver. */
-  getDelivery(endpointId, deliveryId) {
+  retrieveDelivery(endpointId, deliveryId) {
     return this.get(`/v1/webhook_endpoints/${endpointId}/deliveries/${deliveryId}`);
   }
+  /**
+   * @deprecated Renamed to {@link WebhookEndpoints.retrieveDelivery}.
+   *
+   * Every other single-row fetch in every BillKit SDK is `retrieve`; this
+   * one method was `get`, which meant reaching for the obvious name and
+   * getting a type error. The python and php clients already spell it
+   * `retrieve_delivery` / `retrieveDelivery`, so node was the outlier.
+   *
+   * Kept as an alias because removing it would break callers for a naming
+   * preference. It will go in the next major.
+   */
+  getDelivery(endpointId, deliveryId) {
+    return this.retrieveDelivery(endpointId, deliveryId);
+  }
   /**
    * Re-enqueue a delivery row for the dispatcher.
    *
@@ -835,7 +849,7 @@ function sleep(ms) {
 }
 
 // src/version.ts
-var VERSION = "0.4.0";
+var VERSION = "0.5.0";
 
 // src/transport.ts
 var DEFAULT_BASE_URL = "https://api.billkit.eu";