cardConfiguration.ts

/*
 * The version of the OpenAPI document: v2
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit this class manually.
 */

import { BulkAddress } from "./bulkAddress";


export class CardConfiguration {
    /**
    * The activation label attached to the card that contains the activation instructions.  This field overrides the activation label design ID defined in the card configuration profile.
    */
    "activation"?: string;
    /**
    * Your app\'s URL, if you want to activate cards through your app. For example, **my-app://ref1236a7d**. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process.   Maximum length: 255 characters.
    */
    "activationUrl"?: string;
    "bulkAddress"?: BulkAddress | null;
    /**
    * The unique identifier of the card image. This image is printed on the full front of the card.
    */
    "cardImageId"?: string;
    /**
    * The letter or packaging to which the card is attached.  This field overrides the carrier design ID defined in the card configuration profile. 
    */
    "carrier"?: string;
    /**
    * The unique identifier of the carrier image. This image is printed on the letter to which the card is attached.
    */
    "carrierImageId"?: string;
    /**
    * The unique identifier of the card configuration profile that contains the settings that are applied to the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment.  You can override some of the existing settings in the configuration profile by providing the corresponding fields in the `configuration` object. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.
    */
    "configurationProfileId": string;
    /**
    * The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.  This field overrides the existing currency setting on the card configuration profile.
    */
    "currency"?: string;
    /**
    * Overrides the envelope design ID defined in the card configuration profile. 
    */
    "envelope"?: string;
    /**
    * Any additional material, such as marketing material, that is shipped together with the card.  This field overrides the insert design ID defined in the card configuration profile.
    */
    "insert"?: string;
    /**
    * The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**.
    */
    "language"?: string;
    /**
    * The unique identifier of the logo image. This image is printed on the partial front of the card, for example, a logo on the upper right corner.
    */
    "logoImageId"?: string;
    /**
    * The letter on which the PIN of the card is printed.  This field overrides the PIN mailer design ID defined in the card configuration profile.
    */
    "pinMailer"?: string;
    /**
    * The logistics company that ships the card.  This field overrides the logistics company defined in the card configuration profile.
    */
    "shipmentMethod"?: string;

    static readonly discriminator: string | undefined = undefined;

    static readonly mapping: {[index: string]: string} | undefined = undefined;

    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
        {
            "name": "activation",
            "baseName": "activation",
            "type": "string",
            "format": ""
        },
        {
            "name": "activationUrl",
            "baseName": "activationUrl",
            "type": "string",
            "format": ""
        },
        {
            "name": "bulkAddress",
            "baseName": "bulkAddress",
            "type": "BulkAddress | null",
            "format": ""
        },
        {
            "name": "cardImageId",
            "baseName": "cardImageId",
            "type": "string",
            "format": ""
        },
        {
            "name": "carrier",
            "baseName": "carrier",
            "type": "string",
            "format": ""
        },
        {
            "name": "carrierImageId",
            "baseName": "carrierImageId",
            "type": "string",
            "format": ""
        },
        {
            "name": "configurationProfileId",
            "baseName": "configurationProfileId",
            "type": "string",
            "format": ""
        },
        {
            "name": "currency",
            "baseName": "currency",
            "type": "string",
            "format": ""
        },
        {
            "name": "envelope",
            "baseName": "envelope",
            "type": "string",
            "format": ""
        },
        {
            "name": "insert",
            "baseName": "insert",
            "type": "string",
            "format": ""
        },
        {
            "name": "language",
            "baseName": "language",
            "type": "string",
            "format": ""
        },
        {
            "name": "logoImageId",
            "baseName": "logoImageId",
            "type": "string",
            "format": ""
        },
        {
            "name": "pinMailer",
            "baseName": "pinMailer",
            "type": "string",
            "format": ""
        },
        {
            "name": "shipmentMethod",
            "baseName": "shipmentMethod",
            "type": "string",
            "format": ""
        }    ];

    static getAttributeTypeMap() {
        return CardConfiguration.attributeTypeMap;
    }

    public constructor() {
    }
}