@rebilly/api 0.19.0 → 0.19.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1 -1
- package/dist/core-client.d.ts +1 -1
- package/dist/core-client.schemas.d.ts +22 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/dist/core-client.d.ts
CHANGED
|
@@ -9797,7 +9797,7 @@ export type GetCustomDomainCollectionVariables = {
|
|
|
9797
9797
|
query?: GetCustomDomainCollectionQuery;
|
|
9798
9798
|
};
|
|
9799
9799
|
export type PostCustomDomainResult = CustomDomain;
|
|
9800
|
-
export type PostCustomDomainBody = Omit<CustomDomain, "id" | "isVerified">;
|
|
9800
|
+
export type PostCustomDomainBody = Omit<CustomDomain, "id" | "isVerified" | "verificationFailure">;
|
|
9801
9801
|
export type PostCustomDomainResponseHeaders = {
|
|
9802
9802
|
location?: string;
|
|
9803
9803
|
rateLimitLimit?: number;
|
|
@@ -2699,6 +2699,8 @@ export type File = {
|
|
|
2699
2699
|
* Specifies if the file is available publicly without authentication.
|
|
2700
2700
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
2701
2701
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
2702
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
2703
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
2702
2704
|
*/
|
|
2703
2705
|
isPublic?: boolean;
|
|
2704
2706
|
/**
|
|
@@ -2724,6 +2726,8 @@ export type FileCreateFromInline = {
|
|
|
2724
2726
|
* Specifies if the file is available publicly without authentication.
|
|
2725
2727
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
2726
2728
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
2729
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
2730
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
2727
2731
|
*/
|
|
2728
2732
|
isPublic?: boolean;
|
|
2729
2733
|
/**
|
|
@@ -2754,6 +2758,8 @@ export type FileCreateFromUrl = {
|
|
|
2754
2758
|
* Specifies if the file is available publicly without authentication.
|
|
2755
2759
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
2756
2760
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
2761
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
2762
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
2757
2763
|
*/
|
|
2758
2764
|
isPublic?: boolean;
|
|
2759
2765
|
/**
|
|
@@ -15002,6 +15008,7 @@ export type CheckoutForm = {
|
|
|
15002
15008
|
websiteId: WebsiteId;
|
|
15003
15009
|
/**
|
|
15004
15010
|
* Custom domain for the checkout form.
|
|
15011
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
15005
15012
|
* @maxLength 255
|
|
15006
15013
|
*/
|
|
15007
15014
|
customDomain?: string | null;
|
|
@@ -15861,6 +15868,7 @@ export type BillingPortal = {
|
|
|
15861
15868
|
/**
|
|
15862
15869
|
* Custom domain for the billing portal.
|
|
15863
15870
|
* The default domain is: `portal.secure-payments.app`.
|
|
15871
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
15864
15872
|
* @maxLength 255
|
|
15865
15873
|
*/
|
|
15866
15874
|
customDomain?: string | null;
|
|
@@ -16918,10 +16926,24 @@ export type CustomDomain = {
|
|
|
16918
16926
|
* @maxLength 255
|
|
16919
16927
|
*/
|
|
16920
16928
|
domain: string;
|
|
16929
|
+
/**
|
|
16930
|
+
* Purpose of the custom domain.
|
|
16931
|
+
* Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
|
|
16932
|
+
* and `media` for the public files of the organization.
|
|
16933
|
+
* Each organization has at most one custom domain with the `purpose` field set to `media`.
|
|
16934
|
+
*/
|
|
16935
|
+
purpose?: "hosted-pages" | "media";
|
|
16921
16936
|
/**
|
|
16922
16937
|
* True if the domain is verified by Rebilly.
|
|
16923
16938
|
*/
|
|
16924
16939
|
readonly isVerified?: boolean;
|
|
16940
|
+
/**
|
|
16941
|
+
* Reason why the media domain cannot be verified,
|
|
16942
|
+
* or why a verified media domain fails its hourly check.
|
|
16943
|
+
* A verified media domain keeps `isVerified` set to `true` while it fails the check.
|
|
16944
|
+
* This value is `null` if verification is pending, or if the custom domain has no failure.
|
|
16945
|
+
*/
|
|
16946
|
+
readonly verificationFailure?: ("certificate-failed" | "hostname-taken" | "cname-missing") | null;
|
|
16925
16947
|
createdTime?: CreatedTime;
|
|
16926
16948
|
updatedTime?: UpdatedTime;
|
|
16927
16949
|
_links?: SelfLink;
|