@niur/google-admanager-api 0.0.5

package/dist/client/services/creativeTemplate/creativeTemplate.type.d.ts

@@ -0,0 +1,150 @@
+import { PageResult } from '../../../common/types';
+import { AssetCreativeTemplateVariableMimeType, CreativeTemplateStatus, CreativeTemplateType } from './creativeTemplate.enum';
+/**
+ * Represents a file asset variable defined in a creative template.
+ *
+ * Use AssetCreativeTemplateVariableValue to specify the value for this variable when creating TemplateCreative from the TemplateCreative.
+ */
+export declare type AssetCreativeTemplateVariable = {
+    /**
+     * A set of supported mime types. This set can be empty or null if there's no constraint, meaning files of any mime types are allowed.
+     */
+    mimeTypes: AssetCreativeTemplateVariableMimeType[];
+};
+/**
+ * Represents a long variable defined in a creative template.
+ */
+export declare type LongCreativeTemplateVariable = {
+    /**
+     * Default value to be filled in when creating creatives from the creative template.
+     */
+    defaultValue: number;
+};
+/**
+ * Stores variable choices that users can select from
+ */
+export declare type ListStringCreativeTemplateVariableVariableChoice = {
+    /**
+     * Label that users can select from. This is displayed to users when creating a TemplateCreative. This attribute is intended to be more descriptive than value. This attribute is required and has a maximum length of 255 characters.
+     */
+    label: string;
+    /**
+     * Value that users can select from. When creating a TemplateCreative, the value in StringCreativeTemplateVariableValue should match this value, if you intend to select this value. This attribute is required and has a maximum length of 255 characters.
+     */
+    value: string;
+};
+/**
+ * Represents a list variable defined in a creative template. This is similar to StringCreativeTemplateVariable, except that there are possible choices to choose from.
+ *
+ * Use StringCreativeTemplateVariableValue to specify the value for this variable when creating a TemplateCreative from a CreativeTemplate.
+ */
+export declare type ListStringCreativeTemplateVariable = {
+    /**
+     * The values within the list users need to select from.
+     */
+    choices: ListStringCreativeTemplateVariableVariableChoice[];
+    /**
+     * true if a user can specifiy an 'other' value. For example, if a variable called backgroundColor is defined as a list with values: red, green, blue,
+     * this boolean can be set to allow a user to enter a value not on the list such as purple.
+     */
+    allowOtherChoice: boolean;
+};
+/**
+ * Represents a string variable defined in a creative template.
+ *
+ * Use StringCreativeTemplateVariableValue to specify the value for this variable when creating TemplateCreative from the TemplateCreative.
+ */
+export declare type StringCreativeTemplateVariable = {
+    /**
+     * Default value to be filled in when creating creatives from the creative template.
+     */
+    defaultValue: string;
+} & ListStringCreativeTemplateVariable;
+/**
+ * Represents a url variable defined in a creative template.
+ *
+ * Use UrlCreativeTemplateVariableValue to specify the value for this variable when creating TemplateCreative from the TemplateCreative
+ */
+export declare type UrlCreativeTemplateVariable = {
+    /**
+     * Default value to be filled in when creating creatives from the creative template.
+     */
+    defaultValue: string;
+    /**
+     * When true, if the URL is identified as from a known vendor, cache-busting macros will automatically be inserted upon save.
+     */
+    isTrackingUrl: boolean;
+};
+/**
+ * Represents a variable defined in a creative template.
+ */
+export declare type CreativeTemplateVariable = {
+    /**
+     * Label that is displayed to users when creating TemplateCreative from the CreativeTemplate. This attribute is required and has a maximum length of 127 characters.
+     */
+    label: string;
+    /**
+     * Unique name used to identify the variable. This attribute is read-only and is assigned by Google, by deriving from label, when a creative template variable is created.
+     */
+    uniqueName: string;
+    /**
+     * A descriptive help text that is displayed to users along with the label. This attribute is required and has a maximum length of 255 characters.
+     */
+    description: string;
+    /**
+     * true if this variable is required to be filled in by users when creating TemplateCreative from the CreativeTemplate.
+     */
+    isRequired: boolean;
+} & AssetCreativeTemplateVariable & LongCreativeTemplateVariable & StringCreativeTemplateVariable & UrlCreativeTemplateVariable;
+/**
+ * A template upon which a creative can be created.
+ */
+export declare type CreativeTemplate = {
+    /**
+     * Uniquely identifies the CreativeTemplate. This attribute is read-only and is assigned by Google when a creative template is created.
+     */
+    id: number;
+    /**
+     * The name of the creative template. This attribute is required and has a maximum length of 255 characters.
+     */
+    name: string;
+    /**
+     * The description of the creative template. This attribute is optional.
+     */
+    description: string;
+    /**
+     * The list of creative template variables. This attribute is required.
+     */
+    variables: CreativeTemplateVariable[];
+    /**
+     * The snippet of the creative template, with placeholders for the associated variables. This attribute is required.
+     */
+    snippet: string;
+    /**
+     * The status of the CreativeTemplate. This attribute is read-only and is assigned by Google.
+     */
+    status: CreativeTemplateStatus;
+    /**
+     * The type of the CreativeTemplate. Publisher can only create user-defined template
+     */
+    type: CreativeTemplateType;
+    /**
+     * true if this creative template produces interstitial creatives.
+     */
+    isInterstitial: boolean;
+    /**
+     * true if this creative template produces native-eligible creatives.
+     */
+    isNativeEligible: boolean;
+    /**
+     * Whether the Creative produced is compatible for SafeFrame rendering.
+     *
+     * This attribute is optional and defaults to true.
+     */
+    isSafeFrameCompatible: boolean;
+};
+/**
+ * Captures a page of {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.CreativeTemplate CreativeTemplate} objects.
+ */
+export declare type CreativeTemplatePage = PageResult<CreativeTemplate>;
+//# sourceMappingURL=creativeTemplate.type.d.ts.map

package/dist/client/services/creativeTemplate/creativeTemplate.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeTemplate.type.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/creativeTemplate/creativeTemplate.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EACL,qCAAqC,EACrC,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC;;;;GAIG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,qCAAqC,EAAE,CAAC;CACpD,CAAC;AAEF;;GAEG;AACH,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,gDAAgD,GAAG;IAC7D;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;GAIG;AACH,oBAAY,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,EAAE,gDAAgD,EAAE,CAAC;IAE5D;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,oBAAY,8BAA8B,GAAG;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,kCAAkC,CAAC;AAEvC;;;;GAIG;AACH,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB,GAAG,6BAA6B,GAC/B,4BAA4B,GAC5B,8BAA8B,GAC9B,2BAA2B,CAAC;AAE9B;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,wBAAwB,EAAE,CAAC;IAEtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;IAE3B;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,oBAAY,oBAAoB,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC"}

package/dist/client/services/creativeTemplate/creativeTemplate.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=creativeTemplate.type.js.map

package/dist/client/services/creativeTemplate/creativeTemplate.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeTemplate.type.js","sourceRoot":"","sources":["../../../../lib/client/services/creativeTemplate/creativeTemplate.type.ts"],"names":[],"mappings":""}

package/dist/client/services/creativeTemplate/creativeTemplateService.interface.d.ts

@@ -0,0 +1,25 @@
+import { CreativeTemplatePage } from './creativeTemplate.type';
+import { Statement } from '../../../common/types';
+/**
+ * Provides methods for retrieving {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.CreativeTemplate CreativeTemplate} objects.
+ */
+export interface CreativeTemplateServiceOperations {
+    /**
+     * Gets a {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.CreativeTemplatePage CreativeTemplatePage}
+     * of {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.CreativeTemplate CreativeTemplate} objects that satisfy the given
+     * {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.Statement#query Statement.query}.
+     * The following fields are supported for filtering:
+     *
+     * | PQL Property         | PQL Property                                                                                                                                    |
+     * | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+     * | id                   | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.CreativeTemplate#id CreativeTemplate.id}                                     |
+     * | name                 | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.CreativeTemplate#name CreativeTemplate.name}                                 |
+     * | type                 | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.CreativeTemplate#type CreativeTemplate.type}                                 |
+     * | status               | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeTemplateService.CreativeTemplate#status CreativeTemplate.status} |
+     *
+     * @param filterStatement a Publisher Query Language statement used to filter a set of creative templates.
+     * @returns the creative templates that match the given filter
+     */
+    getCreativeTemplatesByStatement(filterStatement: Statement): Promise<CreativeTemplatePage>;
+}
+//# sourceMappingURL=creativeTemplateService.interface.d.ts.map

package/dist/client/services/creativeTemplate/creativeTemplateService.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeTemplateService.interface.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/creativeTemplate/creativeTemplateService.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;;;;;;;;;;;;;OAeG;IACH,+BAA+B,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC5F"}

package/dist/client/services/creativeTemplate/creativeTemplateService.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=creativeTemplateService.interface.js.map

package/dist/client/services/creativeTemplate/creativeTemplateService.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeTemplateService.interface.js","sourceRoot":"","sources":["../../../../lib/client/services/creativeTemplate/creativeTemplateService.interface.ts"],"names":[],"mappings":""}

package/dist/client/services/creativeTemplate/index.d.ts

@@ -0,0 +1,2 @@
+export { CreativeTemplateService } from './creativeTemplate.service';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/services/creativeTemplate/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/creativeTemplate/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/client/services/creativeTemplate/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreativeTemplateService = void 0;
+var creativeTemplate_service_1 = require("./creativeTemplate.service");
+Object.defineProperty(exports, "CreativeTemplateService", { enumerable: true, get: function () { return creativeTemplate_service_1.CreativeTemplateService; } });
+//# sourceMappingURL=index.js.map

package/dist/client/services/creativeTemplate/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/client/services/creativeTemplate/index.ts"],"names":[],"mappings":";;;AAAA,uEAAqE;AAA5D,mIAAA,uBAAuB,OAAA"}

package/dist/client/services/creativeWrapper/creativeWrapper.enum.d.ts

@@ -0,0 +1,157 @@
+/**
+ * The type of a creative wrapper which is specified on the CreativeWrapper.
+ */
+export declare enum CreativeWrapperType {
+    /**
+     * HTML creative wrappers that include header/footer HTML snippets.
+     */
+    HTML = "HTML",
+    /**
+     * Video Tracking URL creative wrappers that include tracking URIs.
+     */
+    VIDEO_TRACKING_URL = "VIDEO_TRACKING_URL",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * All possible tracking event types. Not all events are supported by every kind of creative.
+ */
+export declare enum ConversionEvent {
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN",
+    /**
+     * Corresponds to the creativeView tracking event.
+     */
+    CREATIVE_VIEW = "CREATIVE_VIEW",
+    /**
+     * Corresponds to the start tracking event.
+     */
+    START = "START",
+    /**
+     * An event that is fired when a video skip button is shown, usually after 5 seconds of viewing the video. This event does not correspond to any VAST element and is implemented using an extension.
+     */
+    SKIP_SHOWN = "SKIP_SHOWN",
+    /**
+     * Corresponds to the firstQuartile tracking event.
+     */
+    FIRST_QUARTILE = "FIRST_QUARTILE",
+    /**
+     * Corresponds to the midpoint tracking event.
+     */
+    MIDPOINT = "MIDPOINT",
+    /**
+     * Corresponds to the thirdQuartile tracking event.
+     */
+    THIRD_QUARTILE = "THIRD_QUARTILE",
+    /**
+     * An event that is fired after 30 seconds of viewing the video or when the video finished (if the video duration is less than 30 seconds). This event does not correspond to any VAST element and is implemented using an extension.
+     */
+    ENGAGED_VIEW = "ENGAGED_VIEW",
+    /**
+     * Corresponds to the complete tracking event.
+     */
+    COMPLETE = "COMPLETE",
+    /**
+     * Corresponds to the mute tracking event.
+     */
+    MUTE = "MUTE",
+    /**
+     * Corresponds to the unmute tracking event.
+     */
+    UNMUTE = "UNMUTE",
+    /**
+     * Corresponds to the pause tracking event.
+     */
+    PAUSE = "PAUSE",
+    /**
+     * Corresponds to the rewind tracking event.
+     */
+    REWIND = "REWIND",
+    /**
+     * Corresponds to the resume tracking event.
+     */
+    RESUME = "RESUME",
+    /**
+     * An event that is fired when a video was skipped. This event does not correspond to any VAST element and is implemented using an extension.
+     */
+    SKIPPED = "SKIPPED",
+    /**
+     * Corresponds to the fullscreen tracking event.
+     */
+    FULLSCREEN = "FULLSCREEN",
+    /**
+     * Corresponds to the expand tracking event.
+     */
+    EXPAND = "EXPAND",
+    /**
+     * Corresponds to the collapse tracking event.
+     */
+    COLLAPSE = "COLLAPSE",
+    /**
+     * Corresponds to the acceptInvitation tracking event.
+     */
+    ACCEPT_INVITATION = "ACCEPT_INVITATION",
+    /**
+     * Corresponds to the close tracking event.
+     */
+    CLOSE = "CLOSE",
+    /**
+     * Corresponds to the Linear.VideoClicks.ClickTracking node.
+     */
+    CLICK_TRACKING = "CLICK_TRACKING",
+    /**
+     * Corresponds to the InLine.Survey node.
+     */
+    SURVEY = "SURVEY",
+    /**
+     * Corresponds to the Linear.VideoClicks.CustomClick node.
+     */
+    CUSTOM_CLICK = "CUSTOM_CLICK",
+    /**
+     * Corresponds to the measurableImpression tracking event.
+     */
+    MEASURABLE_IMPRESSION = "MEASURABLE_IMPRESSION",
+    /**
+     * Corresponds to the viewableImpression tracking event.
+     */
+    VIEWABLE_IMPRESSION = "VIEWABLE_IMPRESSION",
+    /**
+     * Corresponds to the abandon tracking event.
+     */
+    VIDEO_ABANDON = "VIDEO_ABANDON",
+    /**
+     * Corresponds to the fullyViewableAudibleHalfDurationImpression tracking event.
+     */
+    FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION = "FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION"
+}
+/**
+ * Defines the order in which the header and footer HTML snippets will be wrapped around the served creative.
+ * INNER snippets will be wrapped first, followed by NO_PREFERENCE and finally OUTER.
+ * If the creative needs to be wrapped with more than one snippet with the same CreativeWrapperOrdering, then the order is unspecified.
+ */
+export declare enum CreativeWrapperOrdering {
+    /**
+     * Wrapping occurs after INNER but before OUTER
+     */
+    NO_PREFERENCE = "NO_PREFERENCE",
+    /**
+     * Wrapping occurs as early as possible.
+     */
+    INNER = "INNER",
+    /**
+     * Wrapping occurs after both NO_PREFERENCE and INNER
+     */
+    OUTER = "OUTER"
+}
+/**
+ * Indicates whether the CreativeWrapper is active. HTML snippets are served to creatives only when the creative wrapper is active.
+ */
+export declare enum CreativeWrapperStatus {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE"
+}
+//# sourceMappingURL=creativeWrapper.enum.d.ts.map

package/dist/client/services/creativeWrapper/creativeWrapper.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeWrapper.enum.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/creativeWrapper.enum.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,mBAAmB;IAC7B;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,kBAAkB,uBAAuB;IACzC;;OAEG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,aAAa,kBAAkB;IAC/B;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,cAAc,mBAAmB;IACjC;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,cAAc,mBAAmB;IACjC;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,iBAAiB,sBAAsB;IACvC;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,cAAc,mBAAmB;IACjC;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,qBAAqB,0BAA0B;IAC/C;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C;;OAEG;IACH,aAAa,kBAAkB;IAC/B;;OAEG;IACH,+CAA+C,oDAAoD;CACpG;AAED;;;;GAIG;AACH,oBAAY,uBAAuB;IACjC;;OAEG;IACH,aAAa,kBAAkB;IAC/B;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB"}

package/dist/client/services/creativeWrapper/creativeWrapper.enum.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreativeWrapperStatus = exports.CreativeWrapperOrdering = exports.ConversionEvent = exports.CreativeWrapperType = void 0;
+/**
+ * The type of a creative wrapper which is specified on the CreativeWrapper.
+ */
+var CreativeWrapperType;
+(function (CreativeWrapperType) {
+    /**
+     * HTML creative wrappers that include header/footer HTML snippets.
+     */
+    CreativeWrapperType["HTML"] = "HTML";
+    /**
+     * Video Tracking URL creative wrappers that include tracking URIs.
+     */
+    CreativeWrapperType["VIDEO_TRACKING_URL"] = "VIDEO_TRACKING_URL";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    CreativeWrapperType["UNKNOWN"] = "UNKNOWN";
+})(CreativeWrapperType = exports.CreativeWrapperType || (exports.CreativeWrapperType = {}));
+/**
+ * All possible tracking event types. Not all events are supported by every kind of creative.
+ */
+var ConversionEvent;
+(function (ConversionEvent) {
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    ConversionEvent["UNKNOWN"] = "UNKNOWN";
+    /**
+     * Corresponds to the creativeView tracking event.
+     */
+    ConversionEvent["CREATIVE_VIEW"] = "CREATIVE_VIEW";
+    /**
+     * Corresponds to the start tracking event.
+     */
+    ConversionEvent["START"] = "START";
+    /**
+     * An event that is fired when a video skip button is shown, usually after 5 seconds of viewing the video. This event does not correspond to any VAST element and is implemented using an extension.
+     */
+    ConversionEvent["SKIP_SHOWN"] = "SKIP_SHOWN";
+    /**
+     * Corresponds to the firstQuartile tracking event.
+     */
+    ConversionEvent["FIRST_QUARTILE"] = "FIRST_QUARTILE";
+    /**
+     * Corresponds to the midpoint tracking event.
+     */
+    ConversionEvent["MIDPOINT"] = "MIDPOINT";
+    /**
+     * Corresponds to the thirdQuartile tracking event.
+     */
+    ConversionEvent["THIRD_QUARTILE"] = "THIRD_QUARTILE";
+    /**
+     * An event that is fired after 30 seconds of viewing the video or when the video finished (if the video duration is less than 30 seconds). This event does not correspond to any VAST element and is implemented using an extension.
+     */
+    ConversionEvent["ENGAGED_VIEW"] = "ENGAGED_VIEW";
+    /**
+     * Corresponds to the complete tracking event.
+     */
+    ConversionEvent["COMPLETE"] = "COMPLETE";
+    /**
+     * Corresponds to the mute tracking event.
+     */
+    ConversionEvent["MUTE"] = "MUTE";
+    /**
+     * Corresponds to the unmute tracking event.
+     */
+    ConversionEvent["UNMUTE"] = "UNMUTE";
+    /**
+     * Corresponds to the pause tracking event.
+     */
+    ConversionEvent["PAUSE"] = "PAUSE";
+    /**
+     * Corresponds to the rewind tracking event.
+     */
+    ConversionEvent["REWIND"] = "REWIND";
+    /**
+     * Corresponds to the resume tracking event.
+     */
+    ConversionEvent["RESUME"] = "RESUME";
+    /**
+     * An event that is fired when a video was skipped. This event does not correspond to any VAST element and is implemented using an extension.
+     */
+    ConversionEvent["SKIPPED"] = "SKIPPED";
+    /**
+     * Corresponds to the fullscreen tracking event.
+     */
+    ConversionEvent["FULLSCREEN"] = "FULLSCREEN";
+    /**
+     * Corresponds to the expand tracking event.
+     */
+    ConversionEvent["EXPAND"] = "EXPAND";
+    /**
+     * Corresponds to the collapse tracking event.
+     */
+    ConversionEvent["COLLAPSE"] = "COLLAPSE";
+    /**
+     * Corresponds to the acceptInvitation tracking event.
+     */
+    ConversionEvent["ACCEPT_INVITATION"] = "ACCEPT_INVITATION";
+    /**
+     * Corresponds to the close tracking event.
+     */
+    ConversionEvent["CLOSE"] = "CLOSE";
+    /**
+     * Corresponds to the Linear.VideoClicks.ClickTracking node.
+     */
+    ConversionEvent["CLICK_TRACKING"] = "CLICK_TRACKING";
+    /**
+     * Corresponds to the InLine.Survey node.
+     */
+    ConversionEvent["SURVEY"] = "SURVEY";
+    /**
+     * Corresponds to the Linear.VideoClicks.CustomClick node.
+     */
+    ConversionEvent["CUSTOM_CLICK"] = "CUSTOM_CLICK";
+    /**
+     * Corresponds to the measurableImpression tracking event.
+     */
+    ConversionEvent["MEASURABLE_IMPRESSION"] = "MEASURABLE_IMPRESSION";
+    /**
+     * Corresponds to the viewableImpression tracking event.
+     */
+    ConversionEvent["VIEWABLE_IMPRESSION"] = "VIEWABLE_IMPRESSION";
+    /**
+     * Corresponds to the abandon tracking event.
+     */
+    ConversionEvent["VIDEO_ABANDON"] = "VIDEO_ABANDON";
+    /**
+     * Corresponds to the fullyViewableAudibleHalfDurationImpression tracking event.
+     */
+    ConversionEvent["FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION"] = "FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION";
+})(ConversionEvent = exports.ConversionEvent || (exports.ConversionEvent = {}));
+/**
+ * Defines the order in which the header and footer HTML snippets will be wrapped around the served creative.
+ * INNER snippets will be wrapped first, followed by NO_PREFERENCE and finally OUTER.
+ * If the creative needs to be wrapped with more than one snippet with the same CreativeWrapperOrdering, then the order is unspecified.
+ */
+var CreativeWrapperOrdering;
+(function (CreativeWrapperOrdering) {
+    /**
+     * Wrapping occurs after INNER but before OUTER
+     */
+    CreativeWrapperOrdering["NO_PREFERENCE"] = "NO_PREFERENCE";
+    /**
+     * Wrapping occurs as early as possible.
+     */
+    CreativeWrapperOrdering["INNER"] = "INNER";
+    /**
+     * Wrapping occurs after both NO_PREFERENCE and INNER
+     */
+    CreativeWrapperOrdering["OUTER"] = "OUTER";
+})(CreativeWrapperOrdering = exports.CreativeWrapperOrdering || (exports.CreativeWrapperOrdering = {}));
+/**
+ * Indicates whether the CreativeWrapper is active. HTML snippets are served to creatives only when the creative wrapper is active.
+ */
+var CreativeWrapperStatus;
+(function (CreativeWrapperStatus) {
+    CreativeWrapperStatus["ACTIVE"] = "ACTIVE";
+    CreativeWrapperStatus["INACTIVE"] = "INACTIVE";
+})(CreativeWrapperStatus = exports.CreativeWrapperStatus || (exports.CreativeWrapperStatus = {}));
+//# sourceMappingURL=creativeWrapper.enum.js.map

package/dist/client/services/creativeWrapper/creativeWrapper.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeWrapper.enum.js","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/creativeWrapper.enum.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC7B;;OAEG;IACH,oCAAa,CAAA;IACb;;OAEG;IACH,gEAAyC,CAAA;IACzC;;OAEG;IACH,0CAAmB,CAAA;AACrB,CAAC,EAbW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAa9B;AAED;;GAEG;AACH,IAAY,eA6GX;AA7GD,WAAY,eAAe;IACzB;;OAEG;IACH,sCAAmB,CAAA;IACnB;;OAEG;IACH,kDAA+B,CAAA;IAC/B;;OAEG;IACH,kCAAe,CAAA;IACf;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,oDAAiC,CAAA;IACjC;;OAEG;IACH,wCAAqB,CAAA;IACrB;;OAEG;IACH,oDAAiC,CAAA;IACjC;;OAEG;IACH,gDAA6B,CAAA;IAC7B;;OAEG;IACH,wCAAqB,CAAA;IACrB;;OAEG;IACH,gCAAa,CAAA;IACb;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,kCAAe,CAAA;IACf;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,sCAAmB,CAAA;IACnB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,wCAAqB,CAAA;IACrB;;OAEG;IACH,0DAAuC,CAAA;IACvC;;OAEG;IACH,kCAAe,CAAA;IACf;;OAEG;IACH,oDAAiC,CAAA;IACjC;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,gDAA6B,CAAA;IAC7B;;OAEG;IACH,kEAA+C,CAAA;IAC/C;;OAEG;IACH,8DAA2C,CAAA;IAC3C;;OAEG;IACH,kDAA+B,CAAA;IAC/B;;OAEG;IACH,sHAAmG,CAAA;AACrG,CAAC,EA7GW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA6G1B;AAED;;;;GAIG;AACH,IAAY,uBAaX;AAbD,WAAY,uBAAuB;IACjC;;OAEG;IACH,0DAA+B,CAAA;IAC/B;;OAEG;IACH,0CAAe,CAAA;IACf;;OAEG;IACH,0CAAe,CAAA;AACjB,CAAC,EAbW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAalC;AAED;;GAEG;AACH,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,0CAAiB,CAAA;IACjB,8CAAqB,CAAA;AACvB,CAAC,EAHW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAGhC"}

package/dist/client/services/creativeWrapper/creativeWrapper.service.d.ts

@@ -0,0 +1,13 @@
+import { Client } from 'soap';
+import { CreativeWrapperServiceOperations } from './creativeWrapperService.interface';
+import { Statement, UpdateResult } from '../../../common/types';
+import { CreativeWrapper, CreativeWrapperAction, CreativeWrapperPage } from './creativeWrapper.type';
+export declare class CreativeWrapperService implements CreativeWrapperServiceOperations {
+    private _client;
+    constructor(client: Client);
+    createCreativeWrappers(creativeWrappers: CreativeWrapper[]): Promise<CreativeWrapper[]>;
+    getCreativeWrappersByStatement(filterStatement: Statement): Promise<CreativeWrapperPage>;
+    performCreativeWrapperAction(creativeWrapperAction: CreativeWrapperAction, filterStatement: Statement): Promise<UpdateResult>;
+    updateCreativeWrappers(creativeWrappers: CreativeWrapper[]): Promise<CreativeWrapper[]>;
+}
+//# sourceMappingURL=creativeWrapper.service.d.ts.map

package/dist/client/services/creativeWrapper/creativeWrapper.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeWrapper.service.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/creativeWrapper.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AACtF,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAErG,qBAAa,sBAAuB,YAAW,gCAAgC;IAC7E,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,MAAM;IAIpB,sBAAsB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIvF,8BAA8B,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAMxF,4BAA4B,CAChC,qBAAqB,EAAE,qBAAqB,EAC5C,eAAe,EAAE,SAAS,GACzB,OAAO,CAAC,YAAY,CAAC;IAWlB,sBAAsB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;CAG9F"}

package/dist/client/services/creativeWrapper/creativeWrapper.service.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreativeWrapperService = void 0;
+class CreativeWrapperService {
+    constructor(client) {
+        this._client = client;
+    }
+    async createCreativeWrappers(creativeWrappers) {
+        return this._client.createCreativeWrappers({ creativeWrappers });
+    }
+    async getCreativeWrappersByStatement(filterStatement) {
+        return this._client.getCreativeWrappersByStatement({
+            filterStatement,
+        });
+    }
+    async performCreativeWrapperAction(creativeWrapperAction, filterStatement) {
+        return this._client.performCreativeWrapperAction({
+            creativeWrapperAction: {
+                attributes: {
+                    'xsi:type': creativeWrapperAction,
+                },
+            },
+            filterStatement,
+        });
+    }
+    async updateCreativeWrappers(creativeWrappers) {
+        return this._client.updateCreativeWrappers({ creativeWrappers });
+    }
+}
+exports.CreativeWrapperService = CreativeWrapperService;
+//# sourceMappingURL=creativeWrapper.service.js.map

package/dist/client/services/creativeWrapper/creativeWrapper.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeWrapper.service.js","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/creativeWrapper.service.ts"],"names":[],"mappings":";;;AAMA,MAAa,sBAAsB;IAGjC,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,gBAAmC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,8BAA8B,CAAC,eAA0B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,8BAA8B,CAAC;YACjD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,4BAA4B,CAChC,qBAA4C,EAC5C,eAA0B;QAE1B,OAAO,IAAI,CAAC,OAAO,CAAC,4BAA4B,CAAC;YAC/C,qBAAqB,EAAE;gBACrB,UAAU,EAAE;oBACV,UAAU,EAAE,qBAAqB;iBAClC;aACF;YACD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,gBAAmC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAlCD,wDAkCC"}