rebilly-js-sdk 62.247.0 → 62.247.2
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/rebilly-js-sdk.d.cts +105 -19
- package/dist/rebilly-js-sdk.d.mts +105 -19
- package/dist/rebilly-js-sdk.d.ts +105 -19
- package/dist/rebilly-js-sdk.es.mjs +1 -1
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5649,6 +5649,7 @@ export interface corePaths {
|
|
|
5649
5649
|
* For `block` and `unblock`, if the request includes `payoutRequestIds`
|
|
5650
5650
|
* and a specified payout request is not associated with this batch,
|
|
5651
5651
|
* the operation returns a `409` response and changes no payout request.
|
|
5652
|
+
*
|
|
5652
5653
|
* For the other types, each payout request is checked independently.
|
|
5653
5654
|
* Payout requests that do not qualify for the action are skipped.
|
|
5654
5655
|
*
|
|
@@ -8246,6 +8247,8 @@ export interface coreComponents {
|
|
|
8246
8247
|
* Specifies if the file is available publicly without authentication.
|
|
8247
8248
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
8248
8249
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
8250
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
8251
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
8249
8252
|
*/
|
|
8250
8253
|
isPublic?: boolean;
|
|
8251
8254
|
/** Related links. */
|
|
@@ -8263,6 +8266,8 @@ export interface coreComponents {
|
|
|
8263
8266
|
* Specifies if the file is available publicly without authentication.
|
|
8264
8267
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
8265
8268
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
8269
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
8270
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
8266
8271
|
*/
|
|
8267
8272
|
isPublic?: boolean;
|
|
8268
8273
|
/** File name used for downloading. */
|
|
@@ -8288,6 +8293,8 @@ export interface coreComponents {
|
|
|
8288
8293
|
* Specifies if the file is available publicly without authentication.
|
|
8289
8294
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
8290
8295
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
8296
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
8297
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
8291
8298
|
*/
|
|
8292
8299
|
isPublic?: boolean;
|
|
8293
8300
|
/** File name used for downloading. */
|
|
@@ -14258,6 +14265,11 @@ export interface coreComponents {
|
|
|
14258
14265
|
*/
|
|
14259
14266
|
searched?: string[];
|
|
14260
14267
|
};
|
|
14268
|
+
BadRequest: { [key: string]: any } & {
|
|
14269
|
+
/** HTTP status code. */
|
|
14270
|
+
status?: number;
|
|
14271
|
+
invalidFields?: coreComponents["schemas"]["InvalidFields"];
|
|
14272
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
14261
14273
|
ShippingOption: {
|
|
14262
14274
|
/** ID of the shipping rate. */
|
|
14263
14275
|
id?: string;
|
|
@@ -16557,6 +16569,7 @@ export interface coreComponents {
|
|
|
16557
16569
|
/**
|
|
16558
16570
|
* Custom domain for the billing portal.
|
|
16559
16571
|
* The default domain is: `portal.secure-payments.app`.
|
|
16572
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
16560
16573
|
*/
|
|
16561
16574
|
customDomain?: string | null;
|
|
16562
16575
|
/** Features that can be enabled for the billing portal. */
|
|
@@ -17255,7 +17268,10 @@ export interface coreComponents {
|
|
|
17255
17268
|
/** ID of the checkout form. */
|
|
17256
17269
|
id?: string;
|
|
17257
17270
|
websiteId: coreComponents["schemas"]["WebsiteId"];
|
|
17258
|
-
/**
|
|
17271
|
+
/**
|
|
17272
|
+
* Custom domain for the checkout form.
|
|
17273
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
17274
|
+
*/
|
|
17259
17275
|
customDomain?: string | null;
|
|
17260
17276
|
/**
|
|
17261
17277
|
* List of plans that are applied to a customer order by default.
|
|
@@ -17881,8 +17897,24 @@ export interface coreComponents {
|
|
|
17881
17897
|
id?: string;
|
|
17882
17898
|
/** Fully qualified domain name. */
|
|
17883
17899
|
domain: string;
|
|
17900
|
+
/**
|
|
17901
|
+
* Purpose of the custom domain.
|
|
17902
|
+
* Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
|
|
17903
|
+
* and `media` for the public files of the organization.
|
|
17904
|
+
* Each organization has at most one custom domain with the `purpose` field set to `media`.
|
|
17905
|
+
*/
|
|
17906
|
+
purpose?: "hosted-pages" | "media";
|
|
17884
17907
|
/** True if the domain is verified by Rebilly. */
|
|
17885
17908
|
isVerified?: boolean;
|
|
17909
|
+
/**
|
|
17910
|
+
* Reason why the media domain cannot be verified,
|
|
17911
|
+
* or why a verified media domain fails its hourly check.
|
|
17912
|
+
* A verified media domain keeps `isVerified` set to `true` while it fails the check.
|
|
17913
|
+
* This value is `null` if verification is pending, or if the custom domain has no failure.
|
|
17914
|
+
*/
|
|
17915
|
+
verificationFailure?:
|
|
17916
|
+
| ("certificate-failed" | "hostname-taken" | "cname-missing")
|
|
17917
|
+
| null;
|
|
17886
17918
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
17887
17919
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
17888
17920
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
@@ -23526,11 +23558,6 @@ export interface coreComponents {
|
|
|
23526
23558
|
message: string;
|
|
23527
23559
|
extraData: coreComponents["schemas"]["TimelineExtraData"];
|
|
23528
23560
|
};
|
|
23529
|
-
BadRequest: { [key: string]: any } & {
|
|
23530
|
-
/** HTTP status code. */
|
|
23531
|
-
status?: number;
|
|
23532
|
-
invalidFields?: coreComponents["schemas"]["InvalidFields"];
|
|
23533
|
-
} & coreComponents["schemas"]["BaseProblem"];
|
|
23534
23561
|
ProcessPayoutRequestAllocationOperation: {
|
|
23535
23562
|
/** Type of operation that queues the given allocations for processing. */
|
|
23536
23563
|
type: "process";
|
|
@@ -37063,7 +37090,13 @@ export interface operations {
|
|
|
37063
37090
|
200: {
|
|
37064
37091
|
headers: {};
|
|
37065
37092
|
content: {
|
|
37066
|
-
"application/json": coreComponents["schemas"]["Search"]
|
|
37093
|
+
"application/json": coreComponents["schemas"]["Search"];
|
|
37094
|
+
};
|
|
37095
|
+
};
|
|
37096
|
+
/** Invalid search query provided. */
|
|
37097
|
+
400: {
|
|
37098
|
+
content: {
|
|
37099
|
+
"application/json": coreComponents["schemas"]["BadRequest"];
|
|
37067
37100
|
};
|
|
37068
37101
|
};
|
|
37069
37102
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -44358,6 +44391,7 @@ export interface operations {
|
|
|
44358
44391
|
* For `block` and `unblock`, if the request includes `payoutRequestIds`
|
|
44359
44392
|
* and a specified payout request is not associated with this batch,
|
|
44360
44393
|
* the operation returns a `409` response and changes no payout request.
|
|
44394
|
+
*
|
|
44361
44395
|
* For the other types, each payout request is checked independently.
|
|
44362
44396
|
* Payout requests that do not qualify for the action are skipped.
|
|
44363
44397
|
*
|
|
@@ -48972,6 +49006,8 @@ export interface storefrontComponents {
|
|
|
48972
49006
|
* Specifies if the file is available publicly without authentication.
|
|
48973
49007
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
48974
49008
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
49009
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
49010
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
48975
49011
|
*/
|
|
48976
49012
|
isPublic?: boolean;
|
|
48977
49013
|
/** Related links. */
|
|
@@ -48989,6 +49025,8 @@ export interface storefrontComponents {
|
|
|
48989
49025
|
* Specifies if the file is available publicly without authentication.
|
|
48990
49026
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
48991
49027
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
49028
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
49029
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
48992
49030
|
*/
|
|
48993
49031
|
isPublic?: boolean;
|
|
48994
49032
|
/** File name used for downloading. */
|
|
@@ -49014,6 +49052,8 @@ export interface storefrontComponents {
|
|
|
49014
49052
|
* Specifies if the file is available publicly without authentication.
|
|
49015
49053
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
49016
49054
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
49055
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
49056
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
49017
49057
|
*/
|
|
49018
49058
|
isPublic?: boolean;
|
|
49019
49059
|
/** File name used for downloading. */
|
|
@@ -54984,6 +55024,11 @@ export interface storefrontComponents {
|
|
|
54984
55024
|
*/
|
|
54985
55025
|
searched?: string[];
|
|
54986
55026
|
};
|
|
55027
|
+
BadRequest: { [key: string]: any } & {
|
|
55028
|
+
/** HTTP status code. */
|
|
55029
|
+
status?: number;
|
|
55030
|
+
invalidFields?: storefrontComponents["schemas"]["InvalidFields"];
|
|
55031
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
54987
55032
|
ShippingOption: {
|
|
54988
55033
|
/** ID of the shipping rate. */
|
|
54989
55034
|
id?: string;
|
|
@@ -57283,6 +57328,7 @@ export interface storefrontComponents {
|
|
|
57283
57328
|
/**
|
|
57284
57329
|
* Custom domain for the billing portal.
|
|
57285
57330
|
* The default domain is: `portal.secure-payments.app`.
|
|
57331
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
57286
57332
|
*/
|
|
57287
57333
|
customDomain?: string | null;
|
|
57288
57334
|
/** Features that can be enabled for the billing portal. */
|
|
@@ -57981,7 +58027,10 @@ export interface storefrontComponents {
|
|
|
57981
58027
|
/** ID of the checkout form. */
|
|
57982
58028
|
id?: string;
|
|
57983
58029
|
websiteId: storefrontComponents["schemas"]["WebsiteId"];
|
|
57984
|
-
/**
|
|
58030
|
+
/**
|
|
58031
|
+
* Custom domain for the checkout form.
|
|
58032
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
58033
|
+
*/
|
|
57985
58034
|
customDomain?: string | null;
|
|
57986
58035
|
/**
|
|
57987
58036
|
* List of plans that are applied to a customer order by default.
|
|
@@ -58607,8 +58656,24 @@ export interface storefrontComponents {
|
|
|
58607
58656
|
id?: string;
|
|
58608
58657
|
/** Fully qualified domain name. */
|
|
58609
58658
|
domain: string;
|
|
58659
|
+
/**
|
|
58660
|
+
* Purpose of the custom domain.
|
|
58661
|
+
* Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
|
|
58662
|
+
* and `media` for the public files of the organization.
|
|
58663
|
+
* Each organization has at most one custom domain with the `purpose` field set to `media`.
|
|
58664
|
+
*/
|
|
58665
|
+
purpose?: "hosted-pages" | "media";
|
|
58610
58666
|
/** True if the domain is verified by Rebilly. */
|
|
58611
58667
|
isVerified?: boolean;
|
|
58668
|
+
/**
|
|
58669
|
+
* Reason why the media domain cannot be verified,
|
|
58670
|
+
* or why a verified media domain fails its hourly check.
|
|
58671
|
+
* A verified media domain keeps `isVerified` set to `true` while it fails the check.
|
|
58672
|
+
* This value is `null` if verification is pending, or if the custom domain has no failure.
|
|
58673
|
+
*/
|
|
58674
|
+
verificationFailure?:
|
|
58675
|
+
| ("certificate-failed" | "hostname-taken" | "cname-missing")
|
|
58676
|
+
| null;
|
|
58612
58677
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
58613
58678
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
58614
58679
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
@@ -64252,11 +64317,6 @@ export interface storefrontComponents {
|
|
|
64252
64317
|
message: string;
|
|
64253
64318
|
extraData: storefrontComponents["schemas"]["TimelineExtraData"];
|
|
64254
64319
|
};
|
|
64255
|
-
BadRequest: { [key: string]: any } & {
|
|
64256
|
-
/** HTTP status code. */
|
|
64257
|
-
status?: number;
|
|
64258
|
-
invalidFields?: storefrontComponents["schemas"]["InvalidFields"];
|
|
64259
|
-
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
64260
64320
|
ProcessPayoutRequestAllocationOperation: {
|
|
64261
64321
|
/** Type of operation that queues the given allocations for processing. */
|
|
64262
64322
|
type: "process";
|
|
@@ -76855,6 +76915,8 @@ export interface reportsComponents {
|
|
|
76855
76915
|
* Specifies if the file is available publicly without authentication.
|
|
76856
76916
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
76857
76917
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
76918
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
76919
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
76858
76920
|
*/
|
|
76859
76921
|
isPublic?: boolean;
|
|
76860
76922
|
/** Related links. */
|
|
@@ -76872,6 +76934,8 @@ export interface reportsComponents {
|
|
|
76872
76934
|
* Specifies if the file is available publicly without authentication.
|
|
76873
76935
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
76874
76936
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
76937
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
76938
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
76875
76939
|
*/
|
|
76876
76940
|
isPublic?: boolean;
|
|
76877
76941
|
/** File name used for downloading. */
|
|
@@ -76897,6 +76961,8 @@ export interface reportsComponents {
|
|
|
76897
76961
|
* Specifies if the file is available publicly without authentication.
|
|
76898
76962
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
76899
76963
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
76964
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
76965
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
76900
76966
|
*/
|
|
76901
76967
|
isPublic?: boolean;
|
|
76902
76968
|
/** File name used for downloading. */
|
|
@@ -82867,6 +82933,11 @@ export interface reportsComponents {
|
|
|
82867
82933
|
*/
|
|
82868
82934
|
searched?: string[];
|
|
82869
82935
|
};
|
|
82936
|
+
BadRequest: { [key: string]: any } & {
|
|
82937
|
+
/** HTTP status code. */
|
|
82938
|
+
status?: number;
|
|
82939
|
+
invalidFields?: reportsComponents["schemas"]["InvalidFields"];
|
|
82940
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
82870
82941
|
ShippingOption: {
|
|
82871
82942
|
/** ID of the shipping rate. */
|
|
82872
82943
|
id?: string;
|
|
@@ -85166,6 +85237,7 @@ export interface reportsComponents {
|
|
|
85166
85237
|
/**
|
|
85167
85238
|
* Custom domain for the billing portal.
|
|
85168
85239
|
* The default domain is: `portal.secure-payments.app`.
|
|
85240
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
85169
85241
|
*/
|
|
85170
85242
|
customDomain?: string | null;
|
|
85171
85243
|
/** Features that can be enabled for the billing portal. */
|
|
@@ -85864,7 +85936,10 @@ export interface reportsComponents {
|
|
|
85864
85936
|
/** ID of the checkout form. */
|
|
85865
85937
|
id?: string;
|
|
85866
85938
|
websiteId: reportsComponents["schemas"]["WebsiteId"];
|
|
85867
|
-
/**
|
|
85939
|
+
/**
|
|
85940
|
+
* Custom domain for the checkout form.
|
|
85941
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
85942
|
+
*/
|
|
85868
85943
|
customDomain?: string | null;
|
|
85869
85944
|
/**
|
|
85870
85945
|
* List of plans that are applied to a customer order by default.
|
|
@@ -86490,8 +86565,24 @@ export interface reportsComponents {
|
|
|
86490
86565
|
id?: string;
|
|
86491
86566
|
/** Fully qualified domain name. */
|
|
86492
86567
|
domain: string;
|
|
86568
|
+
/**
|
|
86569
|
+
* Purpose of the custom domain.
|
|
86570
|
+
* Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
|
|
86571
|
+
* and `media` for the public files of the organization.
|
|
86572
|
+
* Each organization has at most one custom domain with the `purpose` field set to `media`.
|
|
86573
|
+
*/
|
|
86574
|
+
purpose?: "hosted-pages" | "media";
|
|
86493
86575
|
/** True if the domain is verified by Rebilly. */
|
|
86494
86576
|
isVerified?: boolean;
|
|
86577
|
+
/**
|
|
86578
|
+
* Reason why the media domain cannot be verified,
|
|
86579
|
+
* or why a verified media domain fails its hourly check.
|
|
86580
|
+
* A verified media domain keeps `isVerified` set to `true` while it fails the check.
|
|
86581
|
+
* This value is `null` if verification is pending, or if the custom domain has no failure.
|
|
86582
|
+
*/
|
|
86583
|
+
verificationFailure?:
|
|
86584
|
+
| ("certificate-failed" | "hostname-taken" | "cname-missing")
|
|
86585
|
+
| null;
|
|
86495
86586
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
86496
86587
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
86497
86588
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
@@ -92135,11 +92226,6 @@ export interface reportsComponents {
|
|
|
92135
92226
|
message: string;
|
|
92136
92227
|
extraData: reportsComponents["schemas"]["TimelineExtraData"];
|
|
92137
92228
|
};
|
|
92138
|
-
BadRequest: { [key: string]: any } & {
|
|
92139
|
-
/** HTTP status code. */
|
|
92140
|
-
status?: number;
|
|
92141
|
-
invalidFields?: reportsComponents["schemas"]["InvalidFields"];
|
|
92142
|
-
} & reportsComponents["schemas"]["BaseProblem"];
|
|
92143
92229
|
ProcessPayoutRequestAllocationOperation: {
|
|
92144
92230
|
/** Type of operation that queues the given allocations for processing. */
|
|
92145
92231
|
type: "process";
|
|
@@ -5649,6 +5649,7 @@ export interface corePaths {
|
|
|
5649
5649
|
* For `block` and `unblock`, if the request includes `payoutRequestIds`
|
|
5650
5650
|
* and a specified payout request is not associated with this batch,
|
|
5651
5651
|
* the operation returns a `409` response and changes no payout request.
|
|
5652
|
+
*
|
|
5652
5653
|
* For the other types, each payout request is checked independently.
|
|
5653
5654
|
* Payout requests that do not qualify for the action are skipped.
|
|
5654
5655
|
*
|
|
@@ -8246,6 +8247,8 @@ export interface coreComponents {
|
|
|
8246
8247
|
* Specifies if the file is available publicly without authentication.
|
|
8247
8248
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
8248
8249
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
8250
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
8251
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
8249
8252
|
*/
|
|
8250
8253
|
isPublic?: boolean;
|
|
8251
8254
|
/** Related links. */
|
|
@@ -8263,6 +8266,8 @@ export interface coreComponents {
|
|
|
8263
8266
|
* Specifies if the file is available publicly without authentication.
|
|
8264
8267
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
8265
8268
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
8269
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
8270
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
8266
8271
|
*/
|
|
8267
8272
|
isPublic?: boolean;
|
|
8268
8273
|
/** File name used for downloading. */
|
|
@@ -8288,6 +8293,8 @@ export interface coreComponents {
|
|
|
8288
8293
|
* Specifies if the file is available publicly without authentication.
|
|
8289
8294
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
8290
8295
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
8296
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
8297
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
8291
8298
|
*/
|
|
8292
8299
|
isPublic?: boolean;
|
|
8293
8300
|
/** File name used for downloading. */
|
|
@@ -14258,6 +14265,11 @@ export interface coreComponents {
|
|
|
14258
14265
|
*/
|
|
14259
14266
|
searched?: string[];
|
|
14260
14267
|
};
|
|
14268
|
+
BadRequest: { [key: string]: any } & {
|
|
14269
|
+
/** HTTP status code. */
|
|
14270
|
+
status?: number;
|
|
14271
|
+
invalidFields?: coreComponents["schemas"]["InvalidFields"];
|
|
14272
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
14261
14273
|
ShippingOption: {
|
|
14262
14274
|
/** ID of the shipping rate. */
|
|
14263
14275
|
id?: string;
|
|
@@ -16557,6 +16569,7 @@ export interface coreComponents {
|
|
|
16557
16569
|
/**
|
|
16558
16570
|
* Custom domain for the billing portal.
|
|
16559
16571
|
* The default domain is: `portal.secure-payments.app`.
|
|
16572
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
16560
16573
|
*/
|
|
16561
16574
|
customDomain?: string | null;
|
|
16562
16575
|
/** Features that can be enabled for the billing portal. */
|
|
@@ -17255,7 +17268,10 @@ export interface coreComponents {
|
|
|
17255
17268
|
/** ID of the checkout form. */
|
|
17256
17269
|
id?: string;
|
|
17257
17270
|
websiteId: coreComponents["schemas"]["WebsiteId"];
|
|
17258
|
-
/**
|
|
17271
|
+
/**
|
|
17272
|
+
* Custom domain for the checkout form.
|
|
17273
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
17274
|
+
*/
|
|
17259
17275
|
customDomain?: string | null;
|
|
17260
17276
|
/**
|
|
17261
17277
|
* List of plans that are applied to a customer order by default.
|
|
@@ -17881,8 +17897,24 @@ export interface coreComponents {
|
|
|
17881
17897
|
id?: string;
|
|
17882
17898
|
/** Fully qualified domain name. */
|
|
17883
17899
|
domain: string;
|
|
17900
|
+
/**
|
|
17901
|
+
* Purpose of the custom domain.
|
|
17902
|
+
* Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
|
|
17903
|
+
* and `media` for the public files of the organization.
|
|
17904
|
+
* Each organization has at most one custom domain with the `purpose` field set to `media`.
|
|
17905
|
+
*/
|
|
17906
|
+
purpose?: "hosted-pages" | "media";
|
|
17884
17907
|
/** True if the domain is verified by Rebilly. */
|
|
17885
17908
|
isVerified?: boolean;
|
|
17909
|
+
/**
|
|
17910
|
+
* Reason why the media domain cannot be verified,
|
|
17911
|
+
* or why a verified media domain fails its hourly check.
|
|
17912
|
+
* A verified media domain keeps `isVerified` set to `true` while it fails the check.
|
|
17913
|
+
* This value is `null` if verification is pending, or if the custom domain has no failure.
|
|
17914
|
+
*/
|
|
17915
|
+
verificationFailure?:
|
|
17916
|
+
| ("certificate-failed" | "hostname-taken" | "cname-missing")
|
|
17917
|
+
| null;
|
|
17886
17918
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
17887
17919
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
17888
17920
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
@@ -23526,11 +23558,6 @@ export interface coreComponents {
|
|
|
23526
23558
|
message: string;
|
|
23527
23559
|
extraData: coreComponents["schemas"]["TimelineExtraData"];
|
|
23528
23560
|
};
|
|
23529
|
-
BadRequest: { [key: string]: any } & {
|
|
23530
|
-
/** HTTP status code. */
|
|
23531
|
-
status?: number;
|
|
23532
|
-
invalidFields?: coreComponents["schemas"]["InvalidFields"];
|
|
23533
|
-
} & coreComponents["schemas"]["BaseProblem"];
|
|
23534
23561
|
ProcessPayoutRequestAllocationOperation: {
|
|
23535
23562
|
/** Type of operation that queues the given allocations for processing. */
|
|
23536
23563
|
type: "process";
|
|
@@ -37063,7 +37090,13 @@ export interface operations {
|
|
|
37063
37090
|
200: {
|
|
37064
37091
|
headers: {};
|
|
37065
37092
|
content: {
|
|
37066
|
-
"application/json": coreComponents["schemas"]["Search"]
|
|
37093
|
+
"application/json": coreComponents["schemas"]["Search"];
|
|
37094
|
+
};
|
|
37095
|
+
};
|
|
37096
|
+
/** Invalid search query provided. */
|
|
37097
|
+
400: {
|
|
37098
|
+
content: {
|
|
37099
|
+
"application/json": coreComponents["schemas"]["BadRequest"];
|
|
37067
37100
|
};
|
|
37068
37101
|
};
|
|
37069
37102
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -44358,6 +44391,7 @@ export interface operations {
|
|
|
44358
44391
|
* For `block` and `unblock`, if the request includes `payoutRequestIds`
|
|
44359
44392
|
* and a specified payout request is not associated with this batch,
|
|
44360
44393
|
* the operation returns a `409` response and changes no payout request.
|
|
44394
|
+
*
|
|
44361
44395
|
* For the other types, each payout request is checked independently.
|
|
44362
44396
|
* Payout requests that do not qualify for the action are skipped.
|
|
44363
44397
|
*
|
|
@@ -48972,6 +49006,8 @@ export interface storefrontComponents {
|
|
|
48972
49006
|
* Specifies if the file is available publicly without authentication.
|
|
48973
49007
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
48974
49008
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
49009
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
49010
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
48975
49011
|
*/
|
|
48976
49012
|
isPublic?: boolean;
|
|
48977
49013
|
/** Related links. */
|
|
@@ -48989,6 +49025,8 @@ export interface storefrontComponents {
|
|
|
48989
49025
|
* Specifies if the file is available publicly without authentication.
|
|
48990
49026
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
48991
49027
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
49028
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
49029
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
48992
49030
|
*/
|
|
48993
49031
|
isPublic?: boolean;
|
|
48994
49032
|
/** File name used for downloading. */
|
|
@@ -49014,6 +49052,8 @@ export interface storefrontComponents {
|
|
|
49014
49052
|
* Specifies if the file is available publicly without authentication.
|
|
49015
49053
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
49016
49054
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
49055
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
49056
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
49017
49057
|
*/
|
|
49018
49058
|
isPublic?: boolean;
|
|
49019
49059
|
/** File name used for downloading. */
|
|
@@ -54984,6 +55024,11 @@ export interface storefrontComponents {
|
|
|
54984
55024
|
*/
|
|
54985
55025
|
searched?: string[];
|
|
54986
55026
|
};
|
|
55027
|
+
BadRequest: { [key: string]: any } & {
|
|
55028
|
+
/** HTTP status code. */
|
|
55029
|
+
status?: number;
|
|
55030
|
+
invalidFields?: storefrontComponents["schemas"]["InvalidFields"];
|
|
55031
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
54987
55032
|
ShippingOption: {
|
|
54988
55033
|
/** ID of the shipping rate. */
|
|
54989
55034
|
id?: string;
|
|
@@ -57283,6 +57328,7 @@ export interface storefrontComponents {
|
|
|
57283
57328
|
/**
|
|
57284
57329
|
* Custom domain for the billing portal.
|
|
57285
57330
|
* The default domain is: `portal.secure-payments.app`.
|
|
57331
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
57286
57332
|
*/
|
|
57287
57333
|
customDomain?: string | null;
|
|
57288
57334
|
/** Features that can be enabled for the billing portal. */
|
|
@@ -57981,7 +58027,10 @@ export interface storefrontComponents {
|
|
|
57981
58027
|
/** ID of the checkout form. */
|
|
57982
58028
|
id?: string;
|
|
57983
58029
|
websiteId: storefrontComponents["schemas"]["WebsiteId"];
|
|
57984
|
-
/**
|
|
58030
|
+
/**
|
|
58031
|
+
* Custom domain for the checkout form.
|
|
58032
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
58033
|
+
*/
|
|
57985
58034
|
customDomain?: string | null;
|
|
57986
58035
|
/**
|
|
57987
58036
|
* List of plans that are applied to a customer order by default.
|
|
@@ -58607,8 +58656,24 @@ export interface storefrontComponents {
|
|
|
58607
58656
|
id?: string;
|
|
58608
58657
|
/** Fully qualified domain name. */
|
|
58609
58658
|
domain: string;
|
|
58659
|
+
/**
|
|
58660
|
+
* Purpose of the custom domain.
|
|
58661
|
+
* Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
|
|
58662
|
+
* and `media` for the public files of the organization.
|
|
58663
|
+
* Each organization has at most one custom domain with the `purpose` field set to `media`.
|
|
58664
|
+
*/
|
|
58665
|
+
purpose?: "hosted-pages" | "media";
|
|
58610
58666
|
/** True if the domain is verified by Rebilly. */
|
|
58611
58667
|
isVerified?: boolean;
|
|
58668
|
+
/**
|
|
58669
|
+
* Reason why the media domain cannot be verified,
|
|
58670
|
+
* or why a verified media domain fails its hourly check.
|
|
58671
|
+
* A verified media domain keeps `isVerified` set to `true` while it fails the check.
|
|
58672
|
+
* This value is `null` if verification is pending, or if the custom domain has no failure.
|
|
58673
|
+
*/
|
|
58674
|
+
verificationFailure?:
|
|
58675
|
+
| ("certificate-failed" | "hostname-taken" | "cname-missing")
|
|
58676
|
+
| null;
|
|
58612
58677
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
58613
58678
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
58614
58679
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
@@ -64252,11 +64317,6 @@ export interface storefrontComponents {
|
|
|
64252
64317
|
message: string;
|
|
64253
64318
|
extraData: storefrontComponents["schemas"]["TimelineExtraData"];
|
|
64254
64319
|
};
|
|
64255
|
-
BadRequest: { [key: string]: any } & {
|
|
64256
|
-
/** HTTP status code. */
|
|
64257
|
-
status?: number;
|
|
64258
|
-
invalidFields?: storefrontComponents["schemas"]["InvalidFields"];
|
|
64259
|
-
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
64260
64320
|
ProcessPayoutRequestAllocationOperation: {
|
|
64261
64321
|
/** Type of operation that queues the given allocations for processing. */
|
|
64262
64322
|
type: "process";
|
|
@@ -76855,6 +76915,8 @@ export interface reportsComponents {
|
|
|
76855
76915
|
* Specifies if the file is available publicly without authentication.
|
|
76856
76916
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
76857
76917
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
76918
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
76919
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
76858
76920
|
*/
|
|
76859
76921
|
isPublic?: boolean;
|
|
76860
76922
|
/** Related links. */
|
|
@@ -76872,6 +76934,8 @@ export interface reportsComponents {
|
|
|
76872
76934
|
* Specifies if the file is available publicly without authentication.
|
|
76873
76935
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
76874
76936
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
76937
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
76938
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
76875
76939
|
*/
|
|
76876
76940
|
isPublic?: boolean;
|
|
76877
76941
|
/** File name used for downloading. */
|
|
@@ -76897,6 +76961,8 @@ export interface reportsComponents {
|
|
|
76897
76961
|
* Specifies if the file is available publicly without authentication.
|
|
76898
76962
|
* If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
|
|
76899
76963
|
* The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
|
|
76964
|
+
* If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
|
|
76965
|
+
* For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
|
|
76900
76966
|
*/
|
|
76901
76967
|
isPublic?: boolean;
|
|
76902
76968
|
/** File name used for downloading. */
|
|
@@ -82867,6 +82933,11 @@ export interface reportsComponents {
|
|
|
82867
82933
|
*/
|
|
82868
82934
|
searched?: string[];
|
|
82869
82935
|
};
|
|
82936
|
+
BadRequest: { [key: string]: any } & {
|
|
82937
|
+
/** HTTP status code. */
|
|
82938
|
+
status?: number;
|
|
82939
|
+
invalidFields?: reportsComponents["schemas"]["InvalidFields"];
|
|
82940
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
82870
82941
|
ShippingOption: {
|
|
82871
82942
|
/** ID of the shipping rate. */
|
|
82872
82943
|
id?: string;
|
|
@@ -85166,6 +85237,7 @@ export interface reportsComponents {
|
|
|
85166
85237
|
/**
|
|
85167
85238
|
* Custom domain for the billing portal.
|
|
85168
85239
|
* The default domain is: `portal.secure-payments.app`.
|
|
85240
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
85169
85241
|
*/
|
|
85170
85242
|
customDomain?: string | null;
|
|
85171
85243
|
/** Features that can be enabled for the billing portal. */
|
|
@@ -85864,7 +85936,10 @@ export interface reportsComponents {
|
|
|
85864
85936
|
/** ID of the checkout form. */
|
|
85865
85937
|
id?: string;
|
|
85866
85938
|
websiteId: reportsComponents["schemas"]["WebsiteId"];
|
|
85867
|
-
/**
|
|
85939
|
+
/**
|
|
85940
|
+
* Custom domain for the checkout form.
|
|
85941
|
+
* Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
|
|
85942
|
+
*/
|
|
85868
85943
|
customDomain?: string | null;
|
|
85869
85944
|
/**
|
|
85870
85945
|
* List of plans that are applied to a customer order by default.
|
|
@@ -86490,8 +86565,24 @@ export interface reportsComponents {
|
|
|
86490
86565
|
id?: string;
|
|
86491
86566
|
/** Fully qualified domain name. */
|
|
86492
86567
|
domain: string;
|
|
86568
|
+
/**
|
|
86569
|
+
* Purpose of the custom domain.
|
|
86570
|
+
* Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
|
|
86571
|
+
* and `media` for the public files of the organization.
|
|
86572
|
+
* Each organization has at most one custom domain with the `purpose` field set to `media`.
|
|
86573
|
+
*/
|
|
86574
|
+
purpose?: "hosted-pages" | "media";
|
|
86493
86575
|
/** True if the domain is verified by Rebilly. */
|
|
86494
86576
|
isVerified?: boolean;
|
|
86577
|
+
/**
|
|
86578
|
+
* Reason why the media domain cannot be verified,
|
|
86579
|
+
* or why a verified media domain fails its hourly check.
|
|
86580
|
+
* A verified media domain keeps `isVerified` set to `true` while it fails the check.
|
|
86581
|
+
* This value is `null` if verification is pending, or if the custom domain has no failure.
|
|
86582
|
+
*/
|
|
86583
|
+
verificationFailure?:
|
|
86584
|
+
| ("certificate-failed" | "hostname-taken" | "cname-missing")
|
|
86585
|
+
| null;
|
|
86495
86586
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
86496
86587
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
86497
86588
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
@@ -92135,11 +92226,6 @@ export interface reportsComponents {
|
|
|
92135
92226
|
message: string;
|
|
92136
92227
|
extraData: reportsComponents["schemas"]["TimelineExtraData"];
|
|
92137
92228
|
};
|
|
92138
|
-
BadRequest: { [key: string]: any } & {
|
|
92139
|
-
/** HTTP status code. */
|
|
92140
|
-
status?: number;
|
|
92141
|
-
invalidFields?: reportsComponents["schemas"]["InvalidFields"];
|
|
92142
|
-
} & reportsComponents["schemas"]["BaseProblem"];
|
|
92143
92229
|
ProcessPayoutRequestAllocationOperation: {
|
|
92144
92230
|
/** Type of operation that queues the given allocations for processing. */
|
|
92145
92231
|
type: "process";
|