@rebilly/api 0.19.8 → 0.19.9

package/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 0.19.8 (2026-11-05)
+## 0.19.9 (2026-11-05)
 
 This was a version bump only for rebilly-api to align it with other projects, there were no code changes.

package/dist/core-client.d.ts

@@ -285,7 +285,7 @@ export type DeleteAuthenticationTokenResponseHeaders = {
 export type DeleteAuthenticationTokenVariables = {
     path: DeleteAuthenticationTokenPath;
 };
-export type PostAuthenticationTokenExchangeResult = CustomerJWT;
+export type PostAuthenticationTokenExchangeResult = Omit<CustomerJWT, "invalidate" | "oneTimePassword">;
 export type PostAuthenticationTokenExchangePath = {
     /**
      * ID of the authentication token.
@@ -578,7 +578,7 @@ export type PostCouponExpirationVariables = {
     path: PostCouponExpirationPath;
     body?: PostCouponExpirationBody;
 };
-export type GetCredentialCollectionResult = CustomerCredential[];
+export type GetCredentialCollectionResult = Omit<CustomerCredential, "password">[];
 export type GetCredentialCollectionQuery = {
     /**
      * Limit the number of collection items to be returned.
@@ -602,7 +602,7 @@ export type GetCredentialCollectionResponseHeaders = {
 export type GetCredentialCollectionVariables = {
     query?: GetCredentialCollectionQuery;
 };
-export type PostCredentialResult = CustomerCredential;
+export type PostCredentialResult = Omit<CustomerCredential, "password">;
 export type PostCredentialBody = Omit<CustomerCredential, "id" | "_links">;
 export type PostCredentialResponseHeaders = {
     location?: string;
@@ -612,7 +612,7 @@ export type PostCredentialResponseHeaders = {
 export type PostCredentialVariables = {
     body: PostCredentialBody;
 };
-export type GetCredentialResult = CustomerCredential;
+export type GetCredentialResult = Omit<CustomerCredential, "password">;
 export type GetCredentialPath = {
     /**
      * ID of the resource.
@@ -624,7 +624,7 @@ export type GetCredentialPath = {
 export type GetCredentialVariables = {
     path: GetCredentialPath;
 };
-export type PutCredentialResult = CustomerCredential;
+export type PutCredentialResult = Omit<CustomerCredential, "password">;
 export type PutCredentialPath = {
     /**
      * ID of the resource.
@@ -722,7 +722,7 @@ export type PutCustomFieldVariables = {
     path: PutCustomFieldPath;
     body: PutCustomFieldBody;
 };
-export type GetCustomerCollectionResult = Customer[];
+export type GetCustomerCollectionResult = Omit<Customer, "paymentToken" | "defaultPaymentInstrumentId" | "leadSource">[];
 export type GetCustomerCollectionQuery = {
     /**
      * Limit the number of collection items to be returned.
@@ -777,7 +777,7 @@ export type GetCustomerCollectionResponseHeaders = {
 export type GetCustomerCollectionVariables = {
     query?: GetCustomerCollectionQuery;
 };
-export type PostCustomerResult = Customer;
+export type PostCustomerResult = Omit<Customer, "paymentToken" | "defaultPaymentInstrumentId" | "leadSource">;
 export type PostCustomerBody = Omit<Customer, "id" | "email" | "firstName" | "lastName" | "defaultPaymentInstrument" | "paymentCount" | "lastPaymentTime" | "invoiceCount" | "tags" | "revision" | "hasFulfilledKyc" | "organizationId" | "_links" | "_embedded">;
 export type PostCustomerResponseHeaders = {
     location?: string;
@@ -787,7 +787,7 @@ export type PostCustomerResponseHeaders = {
 export type PostCustomerVariables = {
     body: PostCustomerBody;
 };
-export type GetCustomerResult = Customer;
+export type GetCustomerResult = Omit<Customer, "paymentToken" | "defaultPaymentInstrumentId" | "leadSource">;
 export type GetCustomerPath = {
     /**
      * ID of the resource.
@@ -815,7 +815,7 @@ export type GetCustomerVariables = {
     path: GetCustomerPath;
     query?: GetCustomerQuery;
 };
-export type PutCustomerResult = Customer;
+export type PutCustomerResult = Omit<Customer, "paymentToken" | "defaultPaymentInstrumentId" | "leadSource">;
 export type PutCustomerPath = {
     /**
      * ID of the resource.
@@ -960,7 +960,7 @@ export type DeleteCustomerLeadSourceResponseHeaders = {
 export type DeleteCustomerLeadSourceVariables = {
     path: DeleteCustomerLeadSourcePath;
 };
-export type GetCustomerTimelineCollectionResult = CustomerTimeline[];
+export type GetCustomerTimelineCollectionResult = Omit<CustomerTimeline, "customData">[];
 export type GetCustomerTimelineCollectionPath = {
     /**
      * ID of the resource.
@@ -1011,7 +1011,7 @@ export type GetCustomerTimelineCollectionVariables = {
     path: GetCustomerTimelineCollectionPath;
     query?: GetCustomerTimelineCollectionQuery;
 };
-export type PostCustomerTimelineResult = CustomerTimeline;
+export type PostCustomerTimelineResult = Omit<CustomerTimeline, "customData">;
 export type PostCustomerTimelinePath = {
     /**
      * ID of the resource.
@@ -1030,7 +1030,7 @@ export type PostCustomerTimelineVariables = {
     path: PostCustomerTimelinePath;
     body: PostCustomerTimelineBody;
 };
-export type GetCustomerTimelineResult = CustomerTimeline;
+export type GetCustomerTimelineResult = Omit<CustomerTimeline, "customData">;
 export type GetCustomerTimelinePath = {
     /**
      * ID of the resource.
@@ -4304,7 +4304,7 @@ export type PatchOrderCancellationVariables = {
     path: PatchOrderCancellationPath;
     body: PatchOrderCancellationBody;
 };
-export type GetOrderReactivationCollectionResult = OrderReactivation[];
+export type GetOrderReactivationCollectionResult = Omit<OrderReactivation, "effectiveTime" | "paymentInstrumentId">[];
 export type GetOrderReactivationCollectionQuery = {
     /**
      * Limit the number of collection items to be returned.
@@ -4342,7 +4342,7 @@ export type GetOrderReactivationCollectionResponseHeaders = {
 export type GetOrderReactivationCollectionVariables = {
     query?: GetOrderReactivationCollectionQuery;
 };
-export type PostOrderReactivationResult = OrderReactivation;
+export type PostOrderReactivationResult = Omit<OrderReactivation, "effectiveTime" | "paymentInstrumentId">;
 export type PostOrderReactivationBody = Omit<OrderReactivation, "id" | "cancellationId">;
 export type PostOrderReactivationResponseHeaders = {
     location?: string;
@@ -4352,7 +4352,7 @@ export type PostOrderReactivationResponseHeaders = {
 export type PostOrderReactivationVariables = {
     body: PostOrderReactivationBody;
 };
-export type GetOrderReactivationResult = OrderReactivation;
+export type GetOrderReactivationResult = Omit<OrderReactivation, "effectiveTime" | "paymentInstrumentId">;
 export type GetOrderReactivationPath = {
     /**
      * ID of the resource.
@@ -4959,7 +4959,7 @@ export type PatchSubscriptionCancellationVariables = {
     path: PatchSubscriptionCancellationPath;
     body: PatchSubscriptionCancellationBody;
 };
-export type GetSubscriptionReactivationCollectionResult = SubscriptionReactivation[];
+export type GetSubscriptionReactivationCollectionResult = Omit<SubscriptionReactivation, "effectiveTime" | "paymentInstrumentId">[];
 export type GetSubscriptionReactivationCollectionQuery = {
     /**
      * Limit the number of collection items to be returned.
@@ -4997,7 +4997,7 @@ export type GetSubscriptionReactivationCollectionResponseHeaders = {
 export type GetSubscriptionReactivationCollectionVariables = {
     query?: GetSubscriptionReactivationCollectionQuery;
 };
-export type PostSubscriptionReactivationResult = SubscriptionReactivation;
+export type PostSubscriptionReactivationResult = Omit<SubscriptionReactivation, "effectiveTime" | "paymentInstrumentId">;
 export type PostSubscriptionReactivationBody = Omit<SubscriptionReactivation, "id" | "cancellationId">;
 export type PostSubscriptionReactivationResponseHeaders = {
     location?: string;
@@ -5007,7 +5007,7 @@ export type PostSubscriptionReactivationResponseHeaders = {
 export type PostSubscriptionReactivationVariables = {
     body: PostSubscriptionReactivationBody;
 };
-export type GetSubscriptionReactivationResult = SubscriptionReactivation;
+export type GetSubscriptionReactivationResult = Omit<SubscriptionReactivation, "effectiveTime" | "paymentInstrumentId">;
 export type GetSubscriptionReactivationPath = {
     /**
      * ID of the resource.
@@ -5232,7 +5232,7 @@ export type DeleteSubscriptionTimelineResponseHeaders = {
 export type DeleteSubscriptionTimelineVariables = {
     path: DeleteSubscriptionTimelinePath;
 };
-export type GetUsageCollectionResult = Usage[];
+export type GetUsageCollectionResult = Omit<Usage, "acceptPartialQuantity">[];
 export type GetUsageCollectionQuery = {
     /**
      * Criteria for filtering collection items.
@@ -5274,7 +5274,7 @@ export type GetUsageCollectionResponseHeaders = {
 export type GetUsageCollectionVariables = {
     query?: GetUsageCollectionQuery;
 };
-export type PostUsageResult = Usage;
+export type PostUsageResult = Omit<Usage, "acceptPartialQuantity">;
 export type PostUsageBody = Omit<Usage, "id" | "invoiceId" | "invoiceItemId">;
 export type PostUsageResponseHeaders = {
     location?: string;
@@ -5284,7 +5284,7 @@ export type PostUsageResponseHeaders = {
 export type PostUsageVariables = {
     body: PostUsageBody;
 };
-export type GetUsageResult = Usage;
+export type GetUsageResult = Omit<Usage, "acceptPartialQuantity">;
 export type GetUsagePath = {
     /**
      * ID of the resource.
@@ -5894,7 +5894,7 @@ export type PostTransactionBody = {
      */
     redirectUrl?: string | null;
     customFields?: ResourceCustomFields;
-    riskMetadata?: RiskMetadata;
+    riskMetadata?: Omit<RiskMetadata, "isProxy" | "isVpn" | "isTor" | "isHosting" | "hostingName" | "isp" | "country" | "region" | "city" | "latitude" | "longitude" | "postalCode" | "timeZone" | "accuracyRadius" | "distance" | "hasMismatchedBillingAddressCountry" | "hasMismatchedBankCountry" | "hasMismatchedTimeZone" | "hasMismatchedHolderName" | "hasFakeName" | "isHighRiskCountry" | "paymentInstrumentVelocity" | "declinedPaymentInstrumentVelocity" | "deviceVelocity" | "ipVelocity" | "emailVelocity" | "billingAddressVelocity" | "paymentInstrumentApprovedTransactionCount" | "score">;
     /**
      * Specifies when the transaction is processed outside Rebilly.
      */
@@ -6047,7 +6047,7 @@ export type PostPayoutBody = {
      */
     redirectUrl?: string | null;
     customFields?: ResourceCustomFields;
-    riskMetadata?: RiskMetadata;
+    riskMetadata?: Omit<RiskMetadata, "isProxy" | "isVpn" | "isTor" | "isHosting" | "hostingName" | "isp" | "country" | "region" | "city" | "latitude" | "longitude" | "postalCode" | "timeZone" | "accuracyRadius" | "distance" | "hasMismatchedBillingAddressCountry" | "hasMismatchedBankCountry" | "hasMismatchedTimeZone" | "hasMismatchedHolderName" | "hasFakeName" | "isHighRiskCountry" | "paymentInstrumentVelocity" | "declinedPaymentInstrumentVelocity" | "deviceVelocity" | "ipVelocity" | "emailVelocity" | "billingAddressVelocity" | "paymentInstrumentApprovedTransactionCount" | "score">;
     /**
      * Specifies when the transaction is processed outside Rebilly.
      */
@@ -7889,7 +7889,7 @@ export type DeleteDigitalWalletOnboardingApplePayDomainResponseHeaders = {
 export type DeleteDigitalWalletOnboardingApplePayDomainVariables = {
     path: DeleteDigitalWalletOnboardingApplePayDomainPath;
 };
-export type GetGridSegmentResult = GridSegment;
+export type GetGridSegmentResult = Omit<GridSegment, "userIds" | "systemId">;
 export type GetGridSegmentPath = {
     /**
      * ID of the resource.
@@ -7906,7 +7906,7 @@ export type GetGridSegmentResponseHeaders = {
 export type GetGridSegmentVariables = {
     path: GetGridSegmentPath;
 };
-export type PutGridSegmentResult = GridSegment;
+export type PutGridSegmentResult = Omit<GridSegment, "userIds" | "systemId">;
 export type PutGridSegmentPath = {
     /**
      * ID of the resource.
@@ -8033,7 +8033,7 @@ export type DeleteUserMembershipResponseHeaders = {
 export type DeleteUserMembershipVariables = {
     path: DeleteUserMembershipPath;
 };
-export type GetOrganizationResult = Organization;
+export type GetOrganizationResult = Omit<Organization, "website">;
 export type GetOrganizationPath = {
     /**
      * ID of the resource.
@@ -8045,7 +8045,7 @@ export type GetOrganizationPath = {
 export type GetOrganizationVariables = {
     path: GetOrganizationPath;
 };
-export type PatchOrganizationResult = Organization;
+export type PatchOrganizationResult = Omit<Organization, "website">;
 export type PatchOrganizationPath = {
     /**
      * ID of the resource.
@@ -8794,7 +8794,7 @@ export type PatchPayoutRequestBatchVariables = {
     path: PatchPayoutRequestBatchPath;
     body?: PatchPayoutRequestBatchBody;
 };
-export type PostPreviewOrderResult = OrderPreview;
+export type PostPreviewOrderResult = Omit<OrderPreview, "websiteId" | "items" | "couponIds" | "shipping">;
 export type PostPreviewOrderBody = Omit<OrderPreview, "currency" | "lineItems" | "shippingRates" | "taxes" | "discounts" | "subtotalAmount" | "taxAmount" | "shippingAmount" | "discountsAmount" | "total" | "initialAmounts" | "recurringAmounts">;
 export type PostPreviewOrderResponseHeaders = {
     rateLimitLimit?: number;
@@ -10041,7 +10041,7 @@ export type PostDigitalWalletOnboardingApplePayResponseHeaders = {
 export type PostDigitalWalletOnboardingApplePayVariables = {
     body: PostDigitalWalletOnboardingApplePayBody;
 };
-export type GetGridSegmentCollectionResult = GridSegment[];
+export type GetGridSegmentCollectionResult = Omit<GridSegment, "userIds" | "systemId">[];
 export type GetGridSegmentCollectionQuery = {
     /**
      * Limit the number of collection items to be returned.
@@ -10083,7 +10083,7 @@ export type GetGridSegmentCollectionResponseHeaders = {
 export type GetGridSegmentCollectionVariables = {
     query?: GetGridSegmentCollectionQuery;
 };
-export type PostGridSegmentResult = GridSegment;
+export type PostGridSegmentResult = Omit<GridSegment, "userIds" | "systemId">;
 export type PostGridSegmentBody = Omit<GridSegment, "id" | "owner" | "users">;
 export type PostGridSegmentResponseHeaders = {
     location?: string;
@@ -10174,7 +10174,7 @@ export type PostListResponseHeaders = {
 export type PostListVariables = {
     body?: PostListBody;
 };
-export type GetOrganizationCollectionResult = Organization[];
+export type GetOrganizationCollectionResult = Omit<Organization, "website">[];
 export type GetOrganizationCollectionQuery = {
     /**
      * Limit the number of collection items to be returned.
@@ -10216,7 +10216,7 @@ export type GetOrganizationCollectionResponseHeaders = {
 export type GetOrganizationCollectionVariables = {
     query?: GetOrganizationCollectionQuery;
 };
-export type PostOrganizationResult = Organization;
+export type PostOrganizationResult = Omit<Organization, "website">;
 export type PostOrganizationBody = Organization & unknown;
 export type PostOrganizationResponseHeaders = {
     location?: string;
@@ -34353,7 +34353,7 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostAuthenticationTokenExchange: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: PostAuthenticationTokenExchangePath;
     body: PostAuthenticationTokenExchangeBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<CustomerJWT, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostAuthenticationTokenExchangeResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
@@ -34434,16 +34434,16 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     paginationOffset?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostCredential: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     body: PostCredentialBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<CustomerCredential, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostCredentialResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetCredential: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetCredentialPath;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<CustomerCredential, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, PutCredential: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetCredentialResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, PutCredential: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: PutCredentialPath;
     body: PutCredentialBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<CustomerCredential, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PutCredentialResult, {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, DeleteCredential: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
@@ -34470,17 +34470,17 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     paginationOffset?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostCustomer: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     body: PostCustomerBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<Customer, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostCustomerResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetCustomer: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetCustomerPath;
     query?: GetCustomerQuery;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<Customer, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, PutCustomer: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetCustomerResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, PutCustomer: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: PutCustomerPath;
     body: PutCustomerBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<Customer, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, DeleteCustomer: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PutCustomerResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, DeleteCustomer: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: DeleteCustomerPath;
     query: DeleteCustomerQuery;
 }, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<void, {
@@ -34528,13 +34528,13 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostCustomerTimeline: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: PostCustomerTimelinePath;
     body: PostCustomerTimelineBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<CustomerTimeline, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostCustomerTimelineResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetCustomerTimeline: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetCustomerTimelinePath;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<CustomerTimeline, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, DeleteCustomerTimeline: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetCustomerTimelineResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, DeleteCustomerTimeline: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: DeleteCustomerTimelinePath;
 }, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<void, {
     rateLimitLimit?: number;
@@ -35320,13 +35320,13 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     paginationOffset?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostOrderReactivation: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     body: PostOrderReactivationBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<OrderReactivation, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostOrderReactivationResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetOrderReactivation: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetOrderReactivationPath;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<OrderReactivation, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetSubscriptionCollection: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetOrderReactivationResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetSubscriptionCollection: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     query?: GetSubscriptionCollectionQuery;
 } | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetSubscriptionCollectionResult, {
     paginationTotal?: number;
@@ -35472,13 +35472,13 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     paginationOffset?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostSubscriptionReactivation: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     body: PostSubscriptionReactivationBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<SubscriptionReactivation, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostSubscriptionReactivationResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetSubscriptionReactivation: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetSubscriptionReactivationPath;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<SubscriptionReactivation, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetSubscriptionUpcomingInvoiceCollection: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetSubscriptionReactivationResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetSubscriptionUpcomingInvoiceCollection: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetSubscriptionUpcomingInvoiceCollectionPath;
     query?: GetSubscriptionUpcomingInvoiceCollectionQuery;
 }, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetSubscriptionUpcomingInvoiceCollectionResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetSubscriptionUpcomingInvoice: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
@@ -35534,13 +35534,13 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     paginationOffset?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostUsage: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     body: PostUsageBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<Usage, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostUsageResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetUsage: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetUsagePath;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<Usage, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, DeleteUsage: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetUsageResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, DeleteUsage: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: DeleteUsagePath;
 }, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<void, {
     rateLimitLimit?: number;
@@ -36099,14 +36099,14 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetGridSegment: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetGridSegmentPath;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GridSegment, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetGridSegmentResult, {
     paginationTotal?: number;
     paginationLimit?: number;
     paginationOffset?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PutGridSegment: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: PutGridSegmentPath;
     body?: PutGridSegmentBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GridSegment, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PutGridSegmentResult, {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, DeleteGridSegment: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
@@ -36138,10 +36138,10 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetOrganization: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: GetOrganizationPath;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<Organization, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, PatchOrganization: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GetOrganizationResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, PatchOrganization: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: PatchOrganizationPath;
     body?: PatchOrganizationBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<Organization, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PatchOrganizationResult, {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetPaymentMethodCollection: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
@@ -36270,7 +36270,7 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostPreviewOrder: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     body?: PostPreviewOrderBody;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<OrderPreview, {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostPreviewOrderResult, {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, GetRole: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
@@ -36564,7 +36564,7 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     paginationOffset?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostGridSegment: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     body: PostGridSegmentBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<GridSegment, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostGridSegmentResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
@@ -36594,7 +36594,7 @@ export declare const GetAmlCheckCollection: (<Init extends import('./core-client
     paginationOffset?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, PostOrganization: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     body?: PostOrganizationBody;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<Organization, {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<PostOrganizationResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;

package/dist/core-client.js

@@ -16,11 +16,29 @@ import { createClient } from "./runtime/factory.js";
 * Every action in the [Rebilly UI](https://app.rebilly.com) is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes.
 * This API reference documentation contains the most commonly integrated resources.
 *
+* # Base URL
+*
+* Each environment has its own base URL.
+* The organization ID is part of the path.
+*
+* | Environment | Base URL |
+* | --- | --- |
+* | Sandbox | `https://api-sandbox.rebilly.com/organizations/{organizationId}` |
+* | Live | `https://api.rebilly.com/organizations/{organizationId}` |
+*
+* The sandbox and live environments do not share data, API keys, or configuration.
+* For more information, see [Environments](/docs/tutorials/environments/).
+*
+* To obtain your organization ID, see [Obtain your organization ID and website ID](/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+*
 * # Authentication
 *
 * Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
 *
 * - Secret API key: Use to make requests from the server side.
+*   Send the key in the `REB-APIKEY` header.
+*   Sandbox keys start with `sk_sandbox_` and live keys start with `sk_live_`.
+*   To obtain a key, see [Obtain a secret key](/docs/dev-docs/api-keys/#obtain-a-secret-key).
 *   Never share these keys.
 *   Keep them guarded and secure.
 * - Publishable API key: Use in your client-side code to tokenize payment information.
@@ -79,6 +97,32 @@ import { createClient } from "./runtime/factory.js";
 *
 * To create and manage API keys, see [API keys](https://www.rebilly.com/docs/dev-docs/api-keys/).
 *
+* ## Send your first request
+*
+* This cURL request lists the five most recent customers in your sandbox organization.
+*
+* 1. In a terminal, paste the following command:
+*
+*     ```bash
+*     curl 'https://api-sandbox.rebilly.com/organizations/your_organization_id/customers?limit=5&sort=-createdTime' \
+*       -H 'REB-APIKEY: your_secret_API_key'
+*     ```
+*
+* 1. Replace `your_organization_id` with your organization ID.
+*    For more information, see [Obtain your organization ID and website ID](/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+* 1. Replace `your_secret_API_key` with a sandbox secret key.
+*    For more information, see [Obtain a secret key](/docs/dev-docs/api-keys/#obtain-a-secret-key).
+* 1. Run the command.
+*
+* In the response, a `200` status code indicates a successful request.
+* The response body contains a JSON array of customers.
+* An empty array means the request succeeded and the organization has no customers yet.
+*
+* List operations accept `limit`, `offset`, `filter`, and `sort` query parameters.
+* For more information on filters, see [Search filters](/docs/dev-docs/search-filters/).
+*
+* To try operations in the browser, use the interactive examples in [Set up your environment](/docs/dev-docs/set-up-environment/#add-data-to-your-rebilly-environment).
+*
 * # Rate limits
 *
 * Rate limits apply to the organization, not to the API key.

package/dist/core-client.schemas.d.ts

@@ -12,11 +12,29 @@
  * Every action in the [Rebilly UI](https://app.rebilly.com) is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes.
  * This API reference documentation contains the most commonly integrated resources.
  *
+ * # Base URL
+ *
+ * Each environment has its own base URL.
+ * The organization ID is part of the path.
+ *
+ * | Environment | Base URL |
+ * | --- | --- |
+ * | Sandbox | `https://api-sandbox.rebilly.com/organizations/{organizationId}` |
+ * | Live | `https://api.rebilly.com/organizations/{organizationId}` |
+ *
+ * The sandbox and live environments do not share data, API keys, or configuration.
+ * For more information, see [Environments](/docs/tutorials/environments/).
+ *
+ * To obtain your organization ID, see [Obtain your organization ID and website ID](/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+ *
  * # Authentication
  *
  * Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
  *
  * - Secret API key: Use to make requests from the server side.
+ *   Send the key in the `REB-APIKEY` header.
+ *   Sandbox keys start with `sk_sandbox_` and live keys start with `sk_live_`.
+ *   To obtain a key, see [Obtain a secret key](/docs/dev-docs/api-keys/#obtain-a-secret-key).
  *   Never share these keys.
  *   Keep them guarded and secure.
  * - Publishable API key: Use in your client-side code to tokenize payment information.
@@ -75,6 +93,32 @@
  *
  * To create and manage API keys, see [API keys](https://www.rebilly.com/docs/dev-docs/api-keys/).
  *
+ * ## Send your first request
+ *
+ * This cURL request lists the five most recent customers in your sandbox organization.
+ *
+ * 1. In a terminal, paste the following command:
+ *
+ *     ```bash
+ *     curl 'https://api-sandbox.rebilly.com/organizations/your_organization_id/customers?limit=5&sort=-createdTime' \
+ *       -H 'REB-APIKEY: your_secret_API_key'
+ *     ```
+ *
+ * 1. Replace `your_organization_id` with your organization ID.
+ *    For more information, see [Obtain your organization ID and website ID](/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+ * 1. Replace `your_secret_API_key` with a sandbox secret key.
+ *    For more information, see [Obtain a secret key](/docs/dev-docs/api-keys/#obtain-a-secret-key).
+ * 1. Run the command.
+ *
+ * In the response, a `200` status code indicates a successful request.
+ * The response body contains a JSON array of customers.
+ * An empty array means the request succeeded and the organization has no customers yet.
+ *
+ * List operations accept `limit`, `offset`, `filter`, and `sort` query parameters.
+ * For more information on filters, see [Search filters](/docs/dev-docs/search-filters/).
+ *
+ * To try operations in the browser, use the interactive examples in [Set up your environment](/docs/dev-docs/set-up-environment/#add-data-to-your-rebilly-environment).
+ *
  * # Rate limits
  *
  * Rate limits apply to the organization, not to the API key.

package/dist/runtime/create-client.js

@@ -95,7 +95,7 @@ function queryStyles(op) {
 		styles[param.name] = {
 			style: param.style ?? "form",
 			explode: param.explode ?? true,
-			allowReserved: param.allowReserved
+			...param.allowReserved === void 0 ? {} : { allowReserved: param.allowReserved }
 		};
 	}
 	return styles;

package/dist/runtime/send.js

@@ -23,9 +23,9 @@ function toHeaderRecord(headers) {
 */
 function middlewareChain(config) {
 	return [...config.onRequest || config.onResponse || config.onError ? [{
-		onRequest: config.onRequest,
-		onResponse: config.onResponse,
-		onError: config.onError
+		...config.onRequest ? { onRequest: config.onRequest } : {},
+		...config.onResponse ? { onResponse: config.onResponse } : {},
+		...config.onError ? { onError: config.onError } : {}
 	}] : [], ...config.middleware ?? []];
 }
 /**
@@ -136,10 +136,10 @@ async function send(config, op, url, init, body, bodySpec, caps, accept = "appli
 				response = await doFetch(context.url, {
 					...fetchInit,
 					...isStream ? { duplex: "half" } : {},
-					signal: attemptSignal,
+					signal: attemptSignal ?? null,
 					method: context.method,
 					headers: context.headers,
-					body: payload
+					body: payload ?? null
 				});
 			} catch (error) {
 				const timedOut = timeout !== void 0 && budget?.aborted && !signal?.aborted;
@@ -156,7 +156,7 @@ async function send(config, op, url, init, body, bodySpec, caps, accept = "appli
 			}
 			lastResponse = response;
 			for (let i = middleware.length - 1; i >= 0; i--) {
-				const onResponse = middleware[i].onResponse;
+				const onResponse = middleware[i]?.onResponse;
 				if (onResponse) {
 					const replaced = await onResponse(response, context);
 					if (replaced && replaced !== response) {

package/dist/runtime/types.d.ts

@@ -163,7 +163,7 @@ export type ApiErrorLike = globalThis.Error & {
     body: unknown;
 };
 export type SettledCall = {
-    response?: Response;
+    response?: Response | undefined;
     error?: unknown;
     attempts: number;
     durationMs: number;

package/dist/storefront-client.d.ts

@@ -1,7 +1,7 @@
 import { Cashier, ContactObject, CurrencyCode, CustomField, DepositRequest, DepositStrategy, LeadSourceData, PaymentInstructionsInstrument, PaymentInstructionsToken, PostSubscription, PostSubscriptionItemsChange, PostSubscriptionReactivation, ReadyToPay, ReadyToPayMethods, ReadyToPayout, ReadyToPayoutMethods, ResourceCustomFields, RiskMetadata, StorefrontAccount, StorefrontBillingPortal, StorefrontCashier, StorefrontChangeQuote, StorefrontCheckoutForm, StorefrontCustomerJWT, StorefrontInvoice, StorefrontKycDocument, StorefrontKycLivenessSession, StorefrontKycRequest, StorefrontOrder, StorefrontOrderChange, StorefrontOrderPreview, StorefrontPaymentInstrument, StorefrontPayoutRequest, StorefrontPlan, StorefrontProduct, StorefrontPurchase, StorefrontQuote, StorefrontReactivationQuote, StorefrontTransaction, StorefrontTransactionRedirectUrl, StorefrontUpcomingInvoice, Website, WebsiteId } from './storefront-client.schemas.ts';
 export * from './runtime/factory.ts';
 export * from './storefront-client.schemas.ts';
-export type StorefrontGetAccountResult = StorefrontAccount;
+export type StorefrontGetAccountResult = Omit<StorefrontAccount, "paymentToken" | "defaultPaymentInstrumentId">;
 export type StorefrontGetAccountQuery = {
     /**
      * Expands a request to include embedded objects within the `_embedded`
@@ -15,7 +15,7 @@ export type StorefrontGetAccountQuery = {
 export type StorefrontGetAccountVariables = {
     query?: StorefrontGetAccountQuery;
 };
-export type StorefrontPatchAccountResult = StorefrontAccount;
+export type StorefrontPatchAccountResult = Omit<StorefrontAccount, "paymentToken" | "defaultPaymentInstrumentId">;
 export type StorefrontPatchAccountBody = Omit<StorefrontAccount, "id" | "websiteId" | "username" | "defaultPaymentInstrument" | "isVerified" | "_embedded">;
 export type StorefrontPatchAccountResponseHeaders = {
     rateLimitLimit?: number;
@@ -38,7 +38,7 @@ export type StorefrontPostForgotPasswordResponseHeaders = {
 export type StorefrontPostForgotPasswordVariables = {
     body?: StorefrontPostForgotPasswordBody;
 };
-export type StorefrontPatchAccountPasswordResult = StorefrontAccount;
+export type StorefrontPatchAccountPasswordResult = Omit<StorefrontAccount, "paymentToken" | "defaultPaymentInstrumentId">;
 export type StorefrontPatchAccountPasswordBody = {
     /**
      * Current password.
@@ -74,7 +74,7 @@ export type StorefrontPostAccountResendVerificationResponseHeaders = {
 export type StorefrontPostAccountResendVerificationVariables = {
     body?: StorefrontPostAccountResendVerificationBody;
 };
-export type StorefrontPostResetPasswordResult = StorefrontAccount;
+export type StorefrontPostResetPasswordResult = Omit<StorefrontAccount, "paymentToken" | "defaultPaymentInstrumentId">;
 export type StorefrontPostResetPasswordPath = {
     /**
      * Token string.
@@ -191,7 +191,7 @@ export type StorefrontPostDepositBody = {
      * ID of the payment token.
      */
     token?: string | null;
-    riskMetadata?: RiskMetadata;
+    riskMetadata?: Omit<RiskMetadata, "isProxy" | "isVpn" | "isTor" | "isHosting" | "hostingName" | "isp" | "country" | "region" | "city" | "latitude" | "longitude" | "postalCode" | "timeZone" | "accuracyRadius" | "distance" | "hasMismatchedBillingAddressCountry" | "hasMismatchedBankCountry" | "hasMismatchedTimeZone" | "hasMismatchedHolderName" | "hasFakeName" | "isHighRiskCountry" | "paymentInstrumentVelocity" | "declinedPaymentInstrumentVelocity" | "deviceVelocity" | "ipVelocity" | "emailVelocity" | "billingAddressVelocity" | "paymentInstrumentApprovedTransactionCount" | "score">;
     redirectUrl?: StorefrontTransactionRedirectUrl;
     /**
      * ID of the promotion to apply to this deposit.
@@ -769,7 +769,7 @@ export type StorefrontPostOrderPauseVariables = {
     path: StorefrontPostOrderPausePath;
     body: StorefrontPostOrderPauseBody;
 };
-export type StorefrontPostSubscriptionItemsChangeResult = StorefrontChangeQuote;
+export type StorefrontPostSubscriptionItemsChangeResult = Omit<StorefrontChangeQuote, "acceptanceConditions">;
 export type StorefrontPostSubscriptionItemsChangePath = {
     /**
      * ID of the resource.
@@ -837,7 +837,7 @@ export type StorefrontDeleteOrderChangeResponseHeaders = {
 export type StorefrontDeleteOrderChangeVariables = {
     path: StorefrontDeleteOrderChangePath;
 };
-export type StorefrontPostSubscriptionReactivationResult = StorefrontReactivationQuote;
+export type StorefrontPostSubscriptionReactivationResult = Omit<StorefrontReactivationQuote, "acceptanceConditions">;
 export type StorefrontPostSubscriptionReactivationBody = PostSubscriptionReactivation;
 export type StorefrontPostSubscriptionReactivationVariables = {
     body?: StorefrontPostSubscriptionReactivationBody;
@@ -961,7 +961,7 @@ export type StorefrontPatchPaymentInstrumentBody = {
      * If this field is supplied,
      * it overrides the billing address obtained from the token.
      */
-    billingAddress?: ContactObject;
+    billingAddress?: Omit<ContactObject, "hash">;
     customFields?: ResourceCustomFields;
 };
 export type StorefrontPatchPaymentInstrumentResponseHeaders = {
@@ -1035,7 +1035,7 @@ export type StorefrontPostPaymentInstrumentSetupBody = {
      * @format uri
      */
     redirectUrl?: string | null;
-    riskMetadata?: RiskMetadata;
+    riskMetadata?: Omit<RiskMetadata, "isProxy" | "isVpn" | "isTor" | "isHosting" | "hostingName" | "isp" | "country" | "region" | "city" | "latitude" | "longitude" | "postalCode" | "timeZone" | "accuracyRadius" | "distance" | "hasMismatchedBillingAddressCountry" | "hasMismatchedBankCountry" | "hasMismatchedTimeZone" | "hasMismatchedHolderName" | "hasFakeName" | "isHighRiskCountry" | "paymentInstrumentVelocity" | "declinedPaymentInstrumentVelocity" | "deviceVelocity" | "ipVelocity" | "emailVelocity" | "billingAddressVelocity" | "paymentInstrumentApprovedTransactionCount" | "score">;
 };
 export type StorefrontPostPaymentInstrumentSetupResponseHeaders = {
     location?: string;
@@ -1293,7 +1293,7 @@ export type StorefrontGetProductPath = {
 export type StorefrontGetProductVariables = {
     path: StorefrontGetProductPath;
 };
-export type StorefrontPostPurchaseResult = StorefrontPurchase;
+export type StorefrontPostPurchaseResult = Omit<StorefrontPurchase, "websiteId" | "items" | "billingAddress" | "deliveryAddress" | "shippingRateId" | "paymentInstruction" | "couponIds" | "password" | "redirectUrl" | "customFields">;
 export type StorefrontPostPurchaseBody = Omit<StorefrontPurchase, "orderId" | "invoice" | "transaction" | "token">;
 export type StorefrontPostPurchaseResponseHeaders = {
     location?: string;
@@ -1303,7 +1303,7 @@ export type StorefrontPostPurchaseResponseHeaders = {
 export type StorefrontPostPurchaseVariables = {
     body?: StorefrontPostPurchaseBody;
 };
-export type StorefrontPostPreviewPurchaseResult = StorefrontOrderPreview;
+export type StorefrontPostPreviewPurchaseResult = Omit<StorefrontOrderPreview, "websiteId" | "items" | "couponIds" | "shippingRateId">;
 export type StorefrontPostPreviewPurchaseBody = Omit<StorefrontOrderPreview, "currency" | "lineItems" | "shippingRates" | "taxes" | "discounts" | "subtotalAmount" | "taxAmount" | "shippingAmount" | "discountsAmount" | "total" | "initialAmounts" | "recurringAmounts">;
 export type StorefrontPostPreviewPurchaseResponseHeaders = {
     rateLimitLimit?: number;
@@ -1392,7 +1392,7 @@ export type StorefrontPostReadyToPayoutResponseHeaders = {
 export type StorefrontPostReadyToPayoutVariables = {
     body?: StorefrontPostReadyToPayoutBody;
 };
-export type StorefrontPostRegisterResult = StorefrontAccount;
+export type StorefrontPostRegisterResult = Omit<StorefrontAccount, "paymentToken" | "defaultPaymentInstrumentId">;
 export type StorefrontPostRegisterBody = {
     /**
      * Username.
@@ -1403,7 +1403,7 @@ export type StorefrontPostRegisterBody = {
      * @format password
      */
     password: string;
-    primaryAddress?: ContactObject;
+    primaryAddress?: Omit<ContactObject, "hash">;
     /**
      * Write-only payment token;
      * if supplied, it converts into a payment instrument and is set as the `defaultPaymentInstrument`.
@@ -1411,7 +1411,7 @@ export type StorefrontPostRegisterBody = {
      * The token may only be used once before it is expired.
      */
     paymentToken?: string;
-    leadSource?: LeadSourceData;
+    leadSource?: Omit<LeadSourceData, "_links">;
     /**
      * ID of the website where the customer signs up.
      * If this value is not set, the account is associated with the first website of the organization.
@@ -3940,9 +3940,9 @@ export declare const client: import('./core-client.ts').Client<Ops, import('./co
 export declare const configure: (config: import('./core-client.ts').ClientConfig<import('./core-client.ts').OperationContext<"StorefrontGetAccount" | "StorefrontPatchAccount" | "StorefrontPostForgotPassword" | "StorefrontPatchAccountPassword" | "StorefrontPostAccountResendVerification" | "StorefrontPostResetPassword" | "StorefrontPostAccountVerification" | "StorefrontGetBillingPortal" | "StorefrontGetDepositStrategy" | "StorefrontGetDepositRequest" | "StorefrontGetCashier" | "StorefrontPostDeposit" | "StorefrontGetCheckoutForm" | "StorefrontGetCustomFieldCollection" | "StorefrontGetInvoiceCollection" | "StorefrontGetInvoice" | "StorefrontPatchInvoice" | "StorefrontGetOrderUpcomingInvoice" | "StorefrontPostKycDocument" | "StorefrontGetKycDocument" | "StorefrontPatchKycDocument" | "StorefrontGetKycRequest" | "StorefrontPostKycLivenessSession" | "StorefrontGetKycLivenessSession" | "StorefrontPostKycLivenessSessionFinish" | "StorefrontPostLogin" | "StorefrontPostLogout" | "StorefrontGetOrderCollection" | "StorefrontGetOrder" | "StorefrontPatchOrder" | "StorefrontPostOrderCancellation" | "StorefrontPostOrderPause" | "StorefrontPostSubscriptionItemsChange" | "StorefrontGetOrderChangeCollection" | "StorefrontDeleteOrderChange" | "StorefrontPostSubscriptionReactivation" | "StorefrontPostPayment" | "StorefrontGetPaymentInstrumentCollection" | "StorefrontPostPaymentInstrument" | "StorefrontGetPaymentInstrument" | "StorefrontPatchPaymentInstrument" | "StorefrontPostPaymentInstrumentDeactivation" | "StorefrontGetPaymentInstrumentSetup" | "StorefrontPostPaymentInstrumentSetup" | "StorefrontGetPayoutRequestCollection" | "StorefrontPostPayoutRequest" | "StorefrontGetPayoutRequest" | "StorefrontPatchPayoutRequest" | "StorefrontPostPayoutRequestCancellation" | "StorefrontGetPlanCollection" | "StorefrontGetPlan" | "StorefrontGetProductCollection" | "StorefrontGetProduct" | "StorefrontPostPurchase" | "StorefrontPostPreviewPurchase" | "StorefrontGetQuote" | "StorefrontPostQuoteAcceptance" | "StorefrontPostQuoteRejection" | "StorefrontPostReadyToPay" | "StorefrontPostReadyToPayout" | "StorefrontPostRegister" | "StorefrontPostSubscription" | "StorefrontGetTransactionCollection" | "StorefrontGetTransaction" | "StorefrontGetTransactionDccOffer" | "StorefrontPatchTransactionDccOffer" | "StorefrontPostKycRequestContinue" | "StorefrontPostKycRequestBypass" | "StorefrontGetWebsite", "/storefront/account" | "/storefront/account/forgot-password" | "/storefront/account/password" | "/storefront/account/resend-verification" | "/storefront/account/reset-password/{token}" | "/storefront/account/verification/{token}" | "/storefront/billing-portals/{slug}" | "/storefront/deposit-strategies/{id}" | "/storefront/deposit-requests/{id}" | "/storefront/cashiers/{id}" | "/storefront/deposit" | "/storefront/checkout-forms/{id}" | "/storefront/custom-fields/{resource}" | "/storefront/invoices" | "/storefront/invoices/{id}" | "/storefront/orders/{id}/upcoming-invoice" | "/storefront/kyc-documents" | "/storefront/kyc-documents/{id}" | "/storefront/kyc-requests/{id}" | "/storefront/kyc-liveness-sessions" | "/storefront/kyc-liveness-sessions/{id}" | "/storefront/kyc-liveness-sessions/{id}/finish" | "/storefront/login" | "/storefront/logout" | "/storefront/orders" | "/storefront/orders/{id}" | "/storefront/orders/{id}/cancellation" | "/storefront/orders/{id}/pause" | "/storefront/subscriptions/{id}/change-items" | "/storefront/order-changes" | "/storefront/order-changes/{id}" | "/storefront/subscription-reactivations" | "/storefront/payment" | "/storefront/payment-instruments" | "/storefront/payment-instruments/{id}" | "/storefront/payment-instruments/{id}/deactivation" | "/storefront/payment-instruments/{id}/setup" | "/storefront/payout-requests" | "/storefront/payout-requests/{id}" | "/storefront/payout-request-cancellations" | "/storefront/plans" | "/storefront/plans/{id}" | "/storefront/products" | "/storefront/products/{id}" | "/storefront/purchase" | "/storefront/preview-purchase" | "/storefront/quotes/{id}" | "/storefront/quotes/{id}/accept" | "/storefront/quotes/{id}/reject" | "/storefront/ready-to-pay" | "/storefront/ready-to-payout" | "/storefront/register" | "/storefront/subscriptions" | "/storefront/transactions" | "/storefront/transactions/{id}" | "/storefront/transactions/{id}/dcc" | "/storefront/transactions/{id}/{token}/continue" | "/storefront/transactions/{id}/{token}/bypass" | "/storefront/websites/{id}", "Storefront account" | "Storefront billing portals" | "Storefront deposits" | "Storefront cashiers" | "Storefront checkout forms" | "Storefront custom fields" | "Storefront invoices" | "Storefront orders" | "Storefront KYC documents" | "Storefront purchases" | "Storefront payment instruments" | "Storefront transactions" | "Storefront plans" | "Storefront products" | "Storefront quotes" | "Storefront websites">>) => void, use: (...middleware: import('./core-client.ts').Middleware<import('./core-client.ts').OperationContext<"StorefrontGetAccount" | "StorefrontPatchAccount" | "StorefrontPostForgotPassword" | "StorefrontPatchAccountPassword" | "StorefrontPostAccountResendVerification" | "StorefrontPostResetPassword" | "StorefrontPostAccountVerification" | "StorefrontGetBillingPortal" | "StorefrontGetDepositStrategy" | "StorefrontGetDepositRequest" | "StorefrontGetCashier" | "StorefrontPostDeposit" | "StorefrontGetCheckoutForm" | "StorefrontGetCustomFieldCollection" | "StorefrontGetInvoiceCollection" | "StorefrontGetInvoice" | "StorefrontPatchInvoice" | "StorefrontGetOrderUpcomingInvoice" | "StorefrontPostKycDocument" | "StorefrontGetKycDocument" | "StorefrontPatchKycDocument" | "StorefrontGetKycRequest" | "StorefrontPostKycLivenessSession" | "StorefrontGetKycLivenessSession" | "StorefrontPostKycLivenessSessionFinish" | "StorefrontPostLogin" | "StorefrontPostLogout" | "StorefrontGetOrderCollection" | "StorefrontGetOrder" | "StorefrontPatchOrder" | "StorefrontPostOrderCancellation" | "StorefrontPostOrderPause" | "StorefrontPostSubscriptionItemsChange" | "StorefrontGetOrderChangeCollection" | "StorefrontDeleteOrderChange" | "StorefrontPostSubscriptionReactivation" | "StorefrontPostPayment" | "StorefrontGetPaymentInstrumentCollection" | "StorefrontPostPaymentInstrument" | "StorefrontGetPaymentInstrument" | "StorefrontPatchPaymentInstrument" | "StorefrontPostPaymentInstrumentDeactivation" | "StorefrontGetPaymentInstrumentSetup" | "StorefrontPostPaymentInstrumentSetup" | "StorefrontGetPayoutRequestCollection" | "StorefrontPostPayoutRequest" | "StorefrontGetPayoutRequest" | "StorefrontPatchPayoutRequest" | "StorefrontPostPayoutRequestCancellation" | "StorefrontGetPlanCollection" | "StorefrontGetPlan" | "StorefrontGetProductCollection" | "StorefrontGetProduct" | "StorefrontPostPurchase" | "StorefrontPostPreviewPurchase" | "StorefrontGetQuote" | "StorefrontPostQuoteAcceptance" | "StorefrontPostQuoteRejection" | "StorefrontPostReadyToPay" | "StorefrontPostReadyToPayout" | "StorefrontPostRegister" | "StorefrontPostSubscription" | "StorefrontGetTransactionCollection" | "StorefrontGetTransaction" | "StorefrontGetTransactionDccOffer" | "StorefrontPatchTransactionDccOffer" | "StorefrontPostKycRequestContinue" | "StorefrontPostKycRequestBypass" | "StorefrontGetWebsite", "/storefront/account" | "/storefront/account/forgot-password" | "/storefront/account/password" | "/storefront/account/resend-verification" | "/storefront/account/reset-password/{token}" | "/storefront/account/verification/{token}" | "/storefront/billing-portals/{slug}" | "/storefront/deposit-strategies/{id}" | "/storefront/deposit-requests/{id}" | "/storefront/cashiers/{id}" | "/storefront/deposit" | "/storefront/checkout-forms/{id}" | "/storefront/custom-fields/{resource}" | "/storefront/invoices" | "/storefront/invoices/{id}" | "/storefront/orders/{id}/upcoming-invoice" | "/storefront/kyc-documents" | "/storefront/kyc-documents/{id}" | "/storefront/kyc-requests/{id}" | "/storefront/kyc-liveness-sessions" | "/storefront/kyc-liveness-sessions/{id}" | "/storefront/kyc-liveness-sessions/{id}/finish" | "/storefront/login" | "/storefront/logout" | "/storefront/orders" | "/storefront/orders/{id}" | "/storefront/orders/{id}/cancellation" | "/storefront/orders/{id}/pause" | "/storefront/subscriptions/{id}/change-items" | "/storefront/order-changes" | "/storefront/order-changes/{id}" | "/storefront/subscription-reactivations" | "/storefront/payment" | "/storefront/payment-instruments" | "/storefront/payment-instruments/{id}" | "/storefront/payment-instruments/{id}/deactivation" | "/storefront/payment-instruments/{id}/setup" | "/storefront/payout-requests" | "/storefront/payout-requests/{id}" | "/storefront/payout-request-cancellations" | "/storefront/plans" | "/storefront/plans/{id}" | "/storefront/products" | "/storefront/products/{id}" | "/storefront/purchase" | "/storefront/preview-purchase" | "/storefront/quotes/{id}" | "/storefront/quotes/{id}/accept" | "/storefront/quotes/{id}/reject" | "/storefront/ready-to-pay" | "/storefront/ready-to-payout" | "/storefront/register" | "/storefront/subscriptions" | "/storefront/transactions" | "/storefront/transactions/{id}" | "/storefront/transactions/{id}/dcc" | "/storefront/transactions/{id}/{token}/continue" | "/storefront/transactions/{id}/{token}/bypass" | "/storefront/websites/{id}", "Storefront account" | "Storefront billing portals" | "Storefront deposits" | "Storefront cashiers" | "Storefront checkout forms" | "Storefront custom fields" | "Storefront invoices" | "Storefront orders" | "Storefront KYC documents" | "Storefront purchases" | "Storefront payment instruments" | "Storefront transactions" | "Storefront plans" | "Storefront products" | "Storefront quotes" | "Storefront websites">>[]) => void;
 export declare const StorefrontGetAccount: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     query?: StorefrontGetAccountQuery;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontAccount, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPatchAccount: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontGetAccountResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPatchAccount: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     body?: StorefrontPatchAccountBody;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontAccount, {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPatchAccountResult, {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostForgotPassword: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
@@ -3952,7 +3952,7 @@ export declare const StorefrontGetAccount: (<Init extends import('./core-client.
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPatchAccountPassword: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     body?: StorefrontPatchAccountPasswordBody;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontAccount, {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPatchAccountPasswordResult, {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostAccountResendVerification: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
@@ -3963,7 +3963,7 @@ export declare const StorefrontGetAccount: (<Init extends import('./core-client.
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostResetPassword: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: StorefrontPostResetPasswordPath;
     body?: StorefrontPostResetPasswordBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontAccount, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPostResetPasswordResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
@@ -4082,7 +4082,7 @@ export declare const StorefrontGetAccount: (<Init extends import('./core-client.
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostSubscriptionItemsChange: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     path: StorefrontPostSubscriptionItemsChangePath;
     body: StorefrontPostSubscriptionItemsChangeBody;
-}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontChangeQuote, {
+}, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPostSubscriptionItemsChangeResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
@@ -4099,7 +4099,7 @@ export declare const StorefrontGetAccount: (<Init extends import('./core-client.
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostSubscriptionReactivation: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     body?: StorefrontPostSubscriptionReactivationBody;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontReactivationQuote, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostPayment: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPostSubscriptionReactivationResult, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostPayment: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
     body: StorefrontPostPaymentBody;
 }, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontTransaction, {
     rateLimitLimit?: number;
@@ -4183,13 +4183,13 @@ export declare const StorefrontGetAccount: (<Init extends import('./core-client.
     path: StorefrontGetProductPath;
 }, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontProduct, Record<string, never>, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostPurchase: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     body?: StorefrontPostPurchaseBody;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPurchase, {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPostPurchaseResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostPreviewPurchase: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     body?: StorefrontPostPreviewPurchaseBody;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontOrderPreview, {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPostPreviewPurchaseResult, {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontGetQuote: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args: {
@@ -4218,7 +4218,7 @@ export declare const StorefrontGetAccount: (<Init extends import('./core-client.
     rateLimitRemaining?: number;
 }, Init>>) & import('./core-client.ts').OperationMethodIdentity, StorefrontPostRegister: (<Init extends import('./core-client.ts').RequestOptions | undefined = undefined>(args?: {
     body?: StorefrontPostRegisterBody;
-} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontAccount, {
+} | undefined, init?: Init | undefined) => Promise<import('./core-client.ts').EnvelopeResult<StorefrontPostRegisterResult, {
     location?: string;
     rateLimitLimit?: number;
     rateLimitRemaining?: number;

package/dist/storefront-client.js

@@ -16,11 +16,29 @@ import { createClient } from "./runtime/factory.js";
 * Every action in the [Rebilly UI](https://app.rebilly.com) is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes.
 * This API reference documentation contains the most commonly integrated resources.
 *
+* # Base URL
+*
+* Each environment has its own base URL.
+* The organization ID is part of the path.
+*
+* | Environment | Base URL |
+* | --- | --- |
+* | Sandbox | `https://api-sandbox.rebilly.com/organizations/{organizationId}` |
+* | Live | `https://api.rebilly.com/organizations/{organizationId}` |
+*
+* The sandbox and live environments do not share data, API keys, or configuration.
+* For more information, see [Environments](/docs/tutorials/environments/).
+*
+* To obtain your organization ID, see [Obtain your organization ID and website ID](/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+*
 * # Authentication
 *
 * Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
 *
 * - Secret API key: Use to make requests from the server side.
+*   Send the key in the `REB-APIKEY` header.
+*   Sandbox keys start with `sk_sandbox_` and live keys start with `sk_live_`.
+*   To obtain a key, see [Obtain a secret key](/docs/dev-docs/api-keys/#obtain-a-secret-key).
 *   Never share these keys.
 *   Keep them guarded and secure.
 * - Publishable API key: Use in your client-side code to tokenize payment information.
@@ -79,6 +97,32 @@ import { createClient } from "./runtime/factory.js";
 *
 * To create and manage API keys, see [API keys](https://www.rebilly.com/docs/dev-docs/api-keys/).
 *
+* ## Send your first request
+*
+* This cURL request lists the five most recent customers in your sandbox organization.
+*
+* 1. In a terminal, paste the following command:
+*
+*     ```bash
+*     curl 'https://api-sandbox.rebilly.com/organizations/your_organization_id/customers?limit=5&sort=-createdTime' \
+*       -H 'REB-APIKEY: your_secret_API_key'
+*     ```
+*
+* 1. Replace `your_organization_id` with your organization ID.
+*    For more information, see [Obtain your organization ID and website ID](/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+* 1. Replace `your_secret_API_key` with a sandbox secret key.
+*    For more information, see [Obtain a secret key](/docs/dev-docs/api-keys/#obtain-a-secret-key).
+* 1. Run the command.
+*
+* In the response, a `200` status code indicates a successful request.
+* The response body contains a JSON array of customers.
+* An empty array means the request succeeded and the organization has no customers yet.
+*
+* List operations accept `limit`, `offset`, `filter`, and `sort` query parameters.
+* For more information on filters, see [Search filters](/docs/dev-docs/search-filters/).
+*
+* To try operations in the browser, use the interactive examples in [Set up your environment](/docs/dev-docs/set-up-environment/#add-data-to-your-rebilly-environment).
+*
 * # Rate limits
 *
 * Rate limits apply to the organization, not to the API key.

package/dist/storefront-client.schemas.d.ts

@@ -12,11 +12,29 @@
  * Every action in the [Rebilly UI](https://app.rebilly.com) is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes.
  * This API reference documentation contains the most commonly integrated resources.
  *
+ * # Base URL
+ *
+ * Each environment has its own base URL.
+ * The organization ID is part of the path.
+ *
+ * | Environment | Base URL |
+ * | --- | --- |
+ * | Sandbox | `https://api-sandbox.rebilly.com/organizations/{organizationId}` |
+ * | Live | `https://api.rebilly.com/organizations/{organizationId}` |
+ *
+ * The sandbox and live environments do not share data, API keys, or configuration.
+ * For more information, see [Environments](/docs/tutorials/environments/).
+ *
+ * To obtain your organization ID, see [Obtain your organization ID and website ID](/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+ *
  * # Authentication
  *
  * Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
  *
  * - Secret API key: Use to make requests from the server side.
+ *   Send the key in the `REB-APIKEY` header.
+ *   Sandbox keys start with `sk_sandbox_` and live keys start with `sk_live_`.
+ *   To obtain a key, see [Obtain a secret key](/docs/dev-docs/api-keys/#obtain-a-secret-key).
  *   Never share these keys.
  *   Keep them guarded and secure.
  * - Publishable API key: Use in your client-side code to tokenize payment information.
@@ -75,6 +93,32 @@
  *
  * To create and manage API keys, see [API keys](https://www.rebilly.com/docs/dev-docs/api-keys/).
  *
+ * ## Send your first request
+ *
+ * This cURL request lists the five most recent customers in your sandbox organization.
+ *
+ * 1. In a terminal, paste the following command:
+ *
+ *     ```bash
+ *     curl 'https://api-sandbox.rebilly.com/organizations/your_organization_id/customers?limit=5&sort=-createdTime' \
+ *       -H 'REB-APIKEY: your_secret_API_key'
+ *     ```
+ *
+ * 1. Replace `your_organization_id` with your organization ID.
+ *    For more information, see [Obtain your organization ID and website ID](/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+ * 1. Replace `your_secret_API_key` with a sandbox secret key.
+ *    For more information, see [Obtain a secret key](/docs/dev-docs/api-keys/#obtain-a-secret-key).
+ * 1. Run the command.
+ *
+ * In the response, a `200` status code indicates a successful request.
+ * The response body contains a JSON array of customers.
+ * An empty array means the request succeeded and the organization has no customers yet.
+ *
+ * List operations accept `limit`, `offset`, `filter`, and `sort` query parameters.
+ * For more information on filters, see [Search filters](/docs/dev-docs/search-filters/).
+ *
+ * To try operations in the browser, use the interactive examples in [Set up your environment](/docs/dev-docs/set-up-environment/#add-data-to-your-rebilly-environment).
+ *
  * # Rate limits
  *
  * Rate limits apply to the organization, not to the API key.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebilly/api",
-  "version": "0.19.8",
+  "version": "0.19.9",
   "description": "Rebilly Core and Storefront API clients generated from the OpenAPI definitions",
   "type": "module",
   "sideEffects": false,