@contentchef/contentchef-types 2.6.0-alpha.0 → 2.6.1-alpha.0

package/dist/api/Space.d.ts

@@ -1,7 +1,7 @@
 /**
  * Indicates what attribute an api key, visibile to the user, is made up of
  */
-export declare type ExportedApiKey = {
+export type ExportedApiKey = {
     /**
     * The Id of the requested space
     */
@@ -34,7 +34,7 @@ export declare type ExportedApiKey = {
 /**
  * Credentials of the requested space
  */
-export declare type ListSpaceApiCredentials = {
+export type ListSpaceApiCredentials = {
     /**
      * The space id related to the api credentials
      */
@@ -51,11 +51,11 @@ export declare type ListSpaceApiCredentials = {
 /**
  * Response of the getSpaceCredentials method on SpaceFacade
  */
-export declare type ListSpaceApiCredentialsResponse = ListSpaceApiCredentials;
+export type ListSpaceApiCredentialsResponse = ListSpaceApiCredentials;
 /**
  * This type represent the model of a space api credentials
  */
-export declare type SpaceApiCredentials = {
+export type SpaceApiCredentials = {
     /**
      * The space id related to the api credentials
      */
@@ -76,11 +76,11 @@ export declare type SpaceApiCredentials = {
 /**
  * This type represent the model for the space api credentials
  */
-export declare type SpaceApiCredentialsResponse = SpaceApiCredentials;
+export type SpaceApiCredentialsResponse = SpaceApiCredentials;
 /**
  * This type represent the model of the content stats for a space
  */
-export declare type ContentStats = {
+export type ContentStats = {
     /**
      * The total number of unarchived content in the space
      */
@@ -97,7 +97,7 @@ export declare type ContentStats = {
 /**
  * This type represent the model of the content repository stats for a space
  */
-export declare type ContentRepositoryStats = {
+export type ContentRepositoryStats = {
     /**
      * The total number of content repositories in the space
      */
@@ -106,7 +106,7 @@ export declare type ContentRepositoryStats = {
 /**
  * This type represent the model of the media gallery stats for a space
  */
-export declare type MediaGalleryStats = {
+export type MediaGalleryStats = {
     /**
      * The total number of media galleries in the space
      */
@@ -115,7 +115,7 @@ export declare type MediaGalleryStats = {
 /**
  * This type represent the model for the top content definition of the space
  */
-export declare type TopContentDefinition = {
+export type TopContentDefinition = {
     /**
      * The unique id of the content definition
      */
@@ -136,7 +136,7 @@ export declare type TopContentDefinition = {
 /**
  * This type represent the model for content definitions stats
  */
-export declare type ContentDefinitionStats = {
+export type ContentDefinitionStats = {
     /**
      * The count of content definitions in the space
      */
@@ -149,11 +149,11 @@ export declare type ContentDefinitionStats = {
 /**
  * This type represent the model for the space stats
  */
-export declare type SpaceStats = ContentStats & ContentDefinitionStats & ContentRepositoryStats & MediaGalleryStats;
+export type SpaceStats = ContentStats & ContentDefinitionStats & ContentRepositoryStats & MediaGalleryStats;
 /**
  * Space locale structure
  */
-export declare type SpaceLocale = {
+export type SpaceLocale = {
     /**
      * Default space locale
      */
@@ -170,11 +170,11 @@ export declare type SpaceLocale = {
 /**
  * Return type of `getSpaceLocale`
  */
-export declare type GetSpaceLocaleResponse = SpaceLocale;
+export type GetSpaceLocaleResponse = SpaceLocale;
 /**
  * Request type when adding a new locale to space
  */
-export declare type AddSpaceLocaleRequest = {
+export type AddSpaceLocaleRequest = {
     /**
      * Locale to add
      */
@@ -183,11 +183,11 @@ export declare type AddSpaceLocaleRequest = {
 /**
  * Return type of `addSpaceLocale`
  */
-export declare type AddSpaceLocaleResponse = SpaceLocale;
+export type AddSpaceLocaleResponse = SpaceLocale;
 /**
  * Request type when removing a locale
  */
-export declare type RemoveSpaceLocaleRequest = {
+export type RemoveSpaceLocaleRequest = {
     /**
      * Locale to remove
      */
@@ -196,11 +196,11 @@ export declare type RemoveSpaceLocaleRequest = {
 /**
  * Return type of `removeSpaceLocale`
  */
-export declare type RemoveSpaceLocaleResponse = SpaceLocale;
+export type RemoveSpaceLocaleResponse = SpaceLocale;
 /**
  * Request type to update a locale to the space's default
  */
-export declare type UpdateSpaceDefaultLocaleRequest = {
+export type UpdateSpaceDefaultLocaleRequest = {
     /**
      * Locale to update to space's default
      */
@@ -209,11 +209,11 @@ export declare type UpdateSpaceDefaultLocaleRequest = {
 /**
  * Return type of `updateSpaceDefaultLocale`
  */
-export declare type UpdateSpaceDefaultLocaleResponse = SpaceLocale;
+export type UpdateSpaceDefaultLocaleResponse = SpaceLocale;
 /**
  * Request type to update space's fallback locale
  */
-export declare type UpdateSpaceFallbackLocaleRequest = {
+export type UpdateSpaceFallbackLocaleRequest = {
     /**
      * Locale to update to space's fallback locale
      */
@@ -222,4 +222,4 @@ export declare type UpdateSpaceFallbackLocaleRequest = {
 /**
  * Return type of `updateSpacefallbackLocale`
  */
-export declare type UpdateSpaceFallbackLocaleResponse = SpaceLocale;
+export type UpdateSpaceFallbackLocaleResponse = SpaceLocale;

package/dist/api/Subscription.d.ts

@@ -21,7 +21,7 @@ export declare enum SubscriptionType {
 /**
  * This type represent the model for a subscription plan
  */
-export declare type SubscriptionPlan = {
+export type SubscriptionPlan = {
     /**
      * The cost of the subscription plan
      */
@@ -50,7 +50,7 @@ export declare type SubscriptionPlan = {
 /**
  * The type represent the model of a subscription
  */
-export declare type SubscriptionResponse = {
+export type SubscriptionResponse = {
     /**
      * The creation date of the subscription
      */
@@ -99,7 +99,7 @@ export declare type SubscriptionResponse = {
 /**
  * This type represent the data needed to make a create subscription API request
  */
-export declare type CreateSubscriptionRequest = {
+export type CreateSubscriptionRequest = {
     /**
      * The scenario selected for the subscription
      * This will create the first space with predefined data based on the selected scenario
@@ -126,11 +126,11 @@ export declare type CreateSubscriptionRequest = {
 /**
  * This type represent the response of of a create subscription API request
  */
-export declare type CreateSubscriptionResponse = SubscriptionResponse;
+export type CreateSubscriptionResponse = SubscriptionResponse;
 /**
  * This type represent the data needed to make a create subscription space API request
  */
-export declare type CreateSubscriptionSpaceRequest = {
+export type CreateSubscriptionSpaceRequest = {
     /**
      * The subscription id where to create the space
      */
@@ -151,11 +151,11 @@ export declare type CreateSubscriptionSpaceRequest = {
 /**
  * This type of represent the response of a create subscription space API request
  */
-export declare type CreateSubscriptionSpaceResponse = boolean;
+export type CreateSubscriptionSpaceResponse = boolean;
 /**
  * This type represent the data needed to make a get subscription API request
  */
-export declare type GetSubscriptionRequest = {
+export type GetSubscriptionRequest = {
     /**
      * The subscription unique id to retrieve
      */
@@ -164,11 +164,11 @@ export declare type GetSubscriptionRequest = {
 /**
  * This type represent the response of a get subscription API request
  */
-export declare type GetSubscriptionResponse = SubscriptionResponse;
+export type GetSubscriptionResponse = SubscriptionResponse;
 /**
  * This type represent the data needed to make a get subscription summary API request
  */
-export declare type GetSubscriptionSummaryRequest = {
+export type GetSubscriptionSummaryRequest = {
     /**
      * The subscription unique id
      */
@@ -177,7 +177,7 @@ export declare type GetSubscriptionSummaryRequest = {
 /**
  * This type represent the response of a get subscription summary response
  */
-export declare type GetSubscriptionSummaryResponse = {
+export type GetSubscriptionSummaryResponse = {
     /**
      * The data of the subscription
      */
@@ -207,15 +207,15 @@ export declare type GetSubscriptionSummaryResponse = {
 /**
  * This type represent the data needed to make a list subscription API request
  */
-export declare type ListSubscriptionRequest = {};
+export type ListSubscriptionRequest = {};
 /**
  * This type represent the response of a list subscription API request
  */
-export declare type ListSubscriptionResponse = SubscriptionResponse[];
+export type ListSubscriptionResponse = SubscriptionResponse[];
 /**
  * This type represent the data needed to make a change plan API request
  */
-export declare type ChangePlanRequest = {
+export type ChangePlanRequest = {
     /**
      * The subscription unique id where to change the plan
      */
@@ -236,11 +236,11 @@ export declare type ChangePlanRequest = {
 /**
  * This type represent the response of a change plan API request
  */
-export declare type ChangePlanResponse = SubscriptionResponse;
+export type ChangePlanResponse = SubscriptionResponse;
 /**
  * This type represent the data needed to make an attempt payment API request
  */
-export declare type AttemptPaymentRequest = {
+export type AttemptPaymentRequest = {
     /**
      * The subscription unique id to try to pay
      */
@@ -257,11 +257,11 @@ export declare type AttemptPaymentRequest = {
 /**
  * This type represent the response of an attempt payment API request
  */
-export declare type AttemptPaymentResponse = SubscriptionResponse;
+export type AttemptPaymentResponse = SubscriptionResponse;
 /**
  * this type represent the data needed to make an update customer source API request
  */
-export declare type UpdateCustomerSourceRequest = {
+export type UpdateCustomerSourceRequest = {
     /**
      * The subscription unique id
      */
@@ -274,11 +274,11 @@ export declare type UpdateCustomerSourceRequest = {
 /**
  * This type represent the response of an update custom source API request
  */
-export declare type UpdateCustomerSourceResponse = boolean;
+export type UpdateCustomerSourceResponse = boolean;
 /**
  * this type represent the data needed to make a cancel subscription API request
  */
-export declare type CancelSubscriptionRequest = {
+export type CancelSubscriptionRequest = {
     /**
      * The subscription unique id
      */
@@ -287,11 +287,11 @@ export declare type CancelSubscriptionRequest = {
 /**
  * This type represent the response of a cancel subscription source API request
  */
-export declare type CancelSubscriptionResponse = boolean;
+export type CancelSubscriptionResponse = boolean;
 /**
  * This type represent the data needed to make an update billing information API request
  */
-export declare type UpdateBillingRequest = {
+export type UpdateBillingRequest = {
     /**
      * The subscription unique id
      */
@@ -304,11 +304,11 @@ export declare type UpdateBillingRequest = {
 /**
  * This type represent the response of an update billing information API request
  */
-export declare type UpdateBillingResponse = BillingInformation;
+export type UpdateBillingResponse = BillingInformation;
 /**
  * This type represent the data needed to make a get billing information API request
  */
-export declare type GetBillingRequest = {
+export type GetBillingRequest = {
     /**
      * The subscription unique id
      */
@@ -317,11 +317,11 @@ export declare type GetBillingRequest = {
 /**
  * This type represent the response of a get billing API request
  */
-export declare type GetBillingResponse = Partial<BillingInformation>;
+export type GetBillingResponse = Partial<BillingInformation>;
 /**
  * This type represent the data needed to make a get a get tax rate API request
  */
-export declare type GetTaxRateRequest = {
+export type GetTaxRateRequest = {
     /**
      * The subscription api request
      */
@@ -330,7 +330,7 @@ export declare type GetTaxRateRequest = {
 /**
  * This type represent the response of a get tax rage API request
  */
-export declare type GetTaxRateResponse = {
+export type GetTaxRateResponse = {
     /**
      * The tax display name
      */
@@ -358,7 +358,7 @@ export declare enum PaymentIntentStatus {
 /**
  * This type represent the model of billing information
  */
-export declare type BillingInformation = {
+export type BillingInformation = {
     /**
      * The name of the billing owner
      */

package/dist/api/Subscription.js

@@ -11,7 +11,7 @@ var SubscriptionState;
     SubscriptionState[SubscriptionState["PendingActivation"] = 0] = "PendingActivation";
     SubscriptionState[SubscriptionState["Inactive"] = -1] = "Inactive";
     SubscriptionState[SubscriptionState["Ready"] = 2] = "Ready";
-})(SubscriptionState = exports.SubscriptionState || (exports.SubscriptionState = {}));
+})(SubscriptionState || (exports.SubscriptionState = SubscriptionState = {}));
 /**
  * This type represent the type of a subscription
  */
@@ -22,7 +22,7 @@ var SubscriptionType;
     SubscriptionType[SubscriptionType["Professional"] = 2] = "Professional";
     SubscriptionType[SubscriptionType["Starter"] = 1] = "Starter";
     SubscriptionType[SubscriptionType["Trial"] = 0] = "Trial";
-})(SubscriptionType = exports.SubscriptionType || (exports.SubscriptionType = {}));
+})(SubscriptionType || (exports.SubscriptionType = SubscriptionType = {}));
 /**
  * This enum represent the payment intent status
  */
@@ -30,7 +30,7 @@ var PaymentIntentStatus;
 (function (PaymentIntentStatus) {
     PaymentIntentStatus["REQUIRES_PAYMENT_METHOD"] = "requires_payment_method";
     PaymentIntentStatus["REQUIRES_ACTION"] = "requires_action";
-})(PaymentIntentStatus = exports.PaymentIntentStatus || (exports.PaymentIntentStatus = {}));
+})(PaymentIntentStatus || (exports.PaymentIntentStatus = PaymentIntentStatus = {}));
 /**
  * This enum represent the admitted payment interval
  */
@@ -40,4 +40,4 @@ var Interval;
     Interval["week"] = "week";
     Interval["month"] = "month";
     Interval["year"] = "year";
-})(Interval = exports.Interval || (exports.Interval = {}));
+})(Interval || (exports.Interval = Interval = {}));

package/dist/api/User.d.ts

@@ -2,7 +2,7 @@ import { ConsentsInformation } from './UserConsents';
 /**
  * This type represent the data needed to make a get user API request
  */
-export declare type GetUserRequest = {
+export type GetUserRequest = {
     /**
      * The user username
      */
@@ -11,7 +11,7 @@ export declare type GetUserRequest = {
 /**
  * This type represent the model for a user
  */
-export declare type UserDetails = {
+export type UserDetails = {
     /**
      * The user id
      */
@@ -32,7 +32,7 @@ export declare type UserDetails = {
 /**
  * This type represent the response of a get current user API request
  */
-export declare type GetCurrentUserResponse = {
+export type GetCurrentUserResponse = {
     /**
      * The current user details
      */
@@ -45,11 +45,11 @@ export declare type GetCurrentUserResponse = {
 /**
  * This type represent the data needed to make a list user by space API request
  */
-export declare type ListUserBySpaceRequest = {};
+export type ListUserBySpaceRequest = {};
 /**
  * This type represent the model of a user by space
  */
-export declare type UserBySpace = {
+export type UserBySpace = {
     /**
      * The unique user id
      */
@@ -82,11 +82,11 @@ export declare type UserBySpace = {
 /**
  * This type represent the response of a list user by space API response
  */
-export declare type ListUserBySpaceResponse = UserBySpace[];
+export type ListUserBySpaceResponse = UserBySpace[];
 /**
  * This type represent the data needed to make a verify email API request
  */
-export declare type VerifyEmailRequest = {
+export type VerifyEmailRequest = {
     /**
      * The verification token to verify the email
      */
@@ -95,7 +95,7 @@ export declare type VerifyEmailRequest = {
 /**
  * This type represent the response of a verify email API request
  */
-export declare type VerifyEmailResponse = boolean;
+export type VerifyEmailResponse = boolean;
 /**
  * This type represent the data needed to make a remove user API request
  */
@@ -104,12 +104,12 @@ export interface RemoveUserRequest {
 /**
  * This type represent the response of a remove user API request
  */
-export declare type RemoveUserResponse = boolean;
+export type RemoveUserResponse = boolean;
 /**
  * This type represent the data needed to make a request email verification API request
  */
-export declare type RequestEmailVerificationRequest = {};
+export type RequestEmailVerificationRequest = {};
 /**
  * This type represent the response of a request email verification API request
  */
-export declare type RequestEmailVerificationResponse = boolean;
+export type RequestEmailVerificationResponse = boolean;

package/dist/api/UserConsents.d.ts

@@ -9,7 +9,7 @@ export declare enum ConsentTypes {
 /**
  * This type represent the model of consent information
  */
-export declare type ConsentInformation = {
+export type ConsentInformation = {
     /**
      * The consent accepted version
      */
@@ -26,7 +26,7 @@ export declare type ConsentInformation = {
 /**
  * This type represent the consents information
  */
-export declare type ConsentsInformation = {
+export type ConsentsInformation = {
     /**
      * The terms and conditions consent information
      */
@@ -43,7 +43,7 @@ export declare type ConsentsInformation = {
 /**
  * This type represent the data needed to make an accept consents API request
  */
-export declare type AcceptConsentsRequest = {
+export type AcceptConsentsRequest = {
     /**
      * The terms and condition policy accepted version
      */
@@ -60,11 +60,11 @@ export declare type AcceptConsentsRequest = {
 /**
  * This type represent the response of an accept consents API request
  */
-export declare type AcceptConsentsResponse = boolean;
+export type AcceptConsentsResponse = boolean;
 /**
  * This type represent the data needed to make an update consent API request
  */
-export declare type UpdateConsentRequest = {
+export type UpdateConsentRequest = {
     /**
      * The consent type to update
      */
@@ -77,8 +77,8 @@ export declare type UpdateConsentRequest = {
 /**
  * This type represent the response of an update consent API request
  */
-export declare type UpdateConsentResponse = boolean;
+export type UpdateConsentResponse = boolean;
 /**
  * This type represent the response of a remove marketing consent API request
  */
-export declare type RemoveMarketingConsentResponse = boolean;
+export type RemoveMarketingConsentResponse = boolean;

package/dist/api/UserConsents.js

@@ -9,4 +9,4 @@ var ConsentTypes;
     ConsentTypes["TermsAndConditionsPolicy"] = "termsAndConditionsPolicy";
     ConsentTypes["PrivacyPolicy"] = "privacyPolicy";
     ConsentTypes["MarketingPolicy"] = "marketingPolicy";
-})(ConsentTypes = exports.ConsentTypes || (exports.ConsentTypes = {}));
+})(ConsentTypes || (exports.ConsentTypes = ConsentTypes = {}));

package/dist/api/UserPermission.d.ts

@@ -29,7 +29,7 @@ export declare enum UserProfileIds {
 /**
  * This type represent the model of a user permission
  */
-export declare type UserPermission = {
+export type UserPermission = {
     /**
      * The space id of the permissions
      */
@@ -50,7 +50,7 @@ export declare type UserPermission = {
 /**
  * This type represent the data needed to make a change space profile for user API request
  */
-export declare type ChangeSpaceProfileForUserRequest = {
+export type ChangeSpaceProfileForUserRequest = {
     /**
      * The user sub (the unique user id)
      */
@@ -63,4 +63,4 @@ export declare type ChangeSpaceProfileForUserRequest = {
 /**
  * This type represent the response of a change space profile for user API request
  */
-export declare type ChangeSpaceProfileForUserResponse = boolean;
+export type ChangeSpaceProfileForUserResponse = boolean;

package/dist/api/UserPermission.js

@@ -16,7 +16,7 @@ var UserPermissionIds;
     UserPermissionIds["MANAGE_SPACE_PROFILES"] = "manage_space_profiles";
     UserPermissionIds["MANAGE_SPACE_WEBHOOKS"] = "manage_space_webhooks";
     UserPermissionIds["READ_SPACE"] = "read_space";
-})(UserPermissionIds = exports.UserPermissionIds || (exports.UserPermissionIds = {}));
+})(UserPermissionIds || (exports.UserPermissionIds = UserPermissionIds = {}));
 /**
  * This enum represent al possible user profile ids
  */
@@ -30,4 +30,4 @@ var UserProfileIds;
     UserProfileIds["CONTENT_EDITOR"] = "content_editor";
     UserProfileIds["REPOSITORY_MANAGER"] = "repository_manager";
     UserProfileIds["LIVE_PUBLISHING_MANAGER"] = "live_publishing_manager";
-})(UserProfileIds = exports.UserProfileIds || (exports.UserProfileIds = {}));
+})(UserProfileIds || (exports.UserProfileIds = UserProfileIds = {}));

package/dist/api/Webhooks.d.ts

@@ -2,12 +2,13 @@
  * This enum represent all possible webhook lifecycle events
  */
 export declare enum WebhookLifecycleEvents {
-    PublishToLIve = "publish_to_live"
+    PublishToLive = "publish_to_live",
+    PublishToStage = "publish_to_stage"
 }
 /**
  * This type represent the model of a webhook
  */
-export declare type Webhook = {
+export type Webhook = {
     /**
      * The space di where the webhook belong
      */
@@ -56,7 +57,7 @@ export declare type Webhook = {
 /**
  * Thi type represent the data needed to make a list of webhook API request
  */
-export declare type ListWebhookRequest = {
+export type ListWebhookRequest = {
     /**
      * This filter is used to search webhooks only for the inserted event type
      */
@@ -65,11 +66,11 @@ export declare type ListWebhookRequest = {
 /**
  * This type represent the response of the list of webhook API request
  */
-export declare type ListWebhookResponse = Webhook[];
+export type ListWebhookResponse = Webhook[];
 /**
  * This type represent the data needed to make a get webhook API request
  */
-export declare type GetWebhookRequest = {
+export type GetWebhookRequest = {
     /**
      * The webhook unique id
      */
@@ -78,11 +79,11 @@ export declare type GetWebhookRequest = {
 /**
  * This data represent the response of a get webhook API request
  */
-export declare type GetWebhookResponse = Webhook;
+export type GetWebhookResponse = Webhook;
 /**
  * This data represent the data needed to make a save webhook API request
  */
-export declare type SaveWebhookRequest = {
+export type SaveWebhookRequest = {
     /**
      * The webhook url to call
      */
@@ -99,11 +100,11 @@ export declare type SaveWebhookRequest = {
 /**
  * This type represent the response of the save webhook API request
  */
-export declare type SaveWebhookResponse = Webhook;
+export type SaveWebhookResponse = Webhook;
 /**
  * This type represent the data needed to make an update webhook request
  */
-export declare type UpdateWebhookRequest = {
+export type UpdateWebhookRequest = {
     /**
      * The webhook url to call
      */
@@ -120,17 +121,17 @@ export declare type UpdateWebhookRequest = {
 /**
  * This type represent the response of the update webhook API request
  */
-export declare type UpdateWebhookResponse = Webhook;
+export type UpdateWebhookResponse = Webhook;
 /**
  * This type represent the data needed to make a delete webhook API request
  */
-export declare type DeleteWebhookRequest = {
+export type DeleteWebhookRequest = {
     id: string;
 };
 /**
  * This type represent the response of a delete webhook API request
  */
-export declare type DeleteWebhookResponse = boolean;
-export declare type GetWebhookPublicKeyResponse = {
+export type DeleteWebhookResponse = boolean;
+export type GetWebhookPublicKeyResponse = {
     key: string;
 };

package/dist/api/Webhooks.js

@@ -6,5 +6,6 @@ exports.WebhookLifecycleEvents = void 0;
  */
 var WebhookLifecycleEvents;
 (function (WebhookLifecycleEvents) {
-    WebhookLifecycleEvents["PublishToLIve"] = "publish_to_live";
-})(WebhookLifecycleEvents = exports.WebhookLifecycleEvents || (exports.WebhookLifecycleEvents = {}));
+    WebhookLifecycleEvents["PublishToLive"] = "publish_to_live";
+    WebhookLifecycleEvents["PublishToStage"] = "publish_to_stage";
+})(WebhookLifecycleEvents || (exports.WebhookLifecycleEvents = WebhookLifecycleEvents = {}));

package/dist/api/common.d.ts

@@ -2,7 +2,7 @@
  * This type represent the model of a paged list response
  *  @template T The type of item returned inside the items attribute.
  */
-export declare type PagedListResponse<T> = {
+export type PagedListResponse<T> = {
     items: T[];
     total: number;
     skip: number;

package/dist/api/common.js

@@ -8,4 +8,4 @@ var StagingEnvironment;
 (function (StagingEnvironment) {
     StagingEnvironment["STAGE"] = "stage";
     StagingEnvironment["LIVE"] = "live";
-})(StagingEnvironment = exports.StagingEnvironment || (exports.StagingEnvironment = {}));
+})(StagingEnvironment || (exports.StagingEnvironment = StagingEnvironment = {}));