@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts

@@ -1,11 +1,6 @@
 export = FileStoragePlatformModel;
 /**
- * @typedef ProxyResponse
- * @property {Object} [data]
- * @property {Object} [support]
- */
-/**
- * @typedef FailedResponse
+ * @typedef FailedBrowseFilesResult
  * @property {string} message
  */
 /**
@@ -20,7 +15,7 @@ export = FileStoragePlatformModel;
  * @property {string} url
  */
 /**
- * @typedef StartResponse
+ * @typedef FileUpload
  * @property {string} file_name
  * @property {string} file_path
  * @property {string} content_type
@@ -29,15 +24,10 @@ export = FileStoragePlatformModel;
  * @property {string} operation
  * @property {number} size
  * @property {Upload} upload
- * @property {CDN} cdn
  * @property {string[]} [tags]
  */
 /**
- * @typedef Params
- * @property {string} [subpath] - The subpath for the file.
- */
-/**
- * @typedef StartRequest
+ * @typedef FileUploadStart
  * @property {string} file_name
  * @property {string} content_type
  * @property {number} size
@@ -49,7 +39,7 @@ export = FileStoragePlatformModel;
  * @property {string} [username]
  */
 /**
- * @typedef CompleteResponse
+ * @typedef FileUploadComplete
  * @property {string} _id
  * @property {string} file_name
  * @property {string} file_path
@@ -66,6 +56,12 @@ export = FileStoragePlatformModel;
  * @property {string} modified_on
  * @property {CreatedBy} [created_by]
  */
+/**
+ * @typedef ProxyFileAccess
+ * @property {boolean} [success] - A boolean value indicating whether the proxy
+ *   request was successful. Returns true when the external URL was successfully
+ *   fetched and processed.
+ */
 /**
  * @typedef DestinationNamespace
  * @property {string} [namespace]
@@ -82,386 +78,37 @@ export = FileStoragePlatformModel;
  * @property {number} expiry
  */
 /**
- * @typedef SignUrlResponse
+ * @typedef SignUrlResult
  * @property {Urls[]} urls
  */
 /**
- * @typedef SignUrlRequest
+ * @typedef SignUrl
  * @property {number} expiry
  * @property {string[]} urls
  */
-/**
- * @typedef InvoiceTypesDataResponse
- * @property {boolean} [status]
- * @property {string} _id
- * @property {number} pdf_type_id
- * @property {string} name
- * @property {string[]} format
- * @property {number} __v
- * @property {boolean} visibility
- * @property {string} country_code
- */
-/**
- * @typedef InvoiceTypesResponse
- * @property {InvoiceTypesDataResponse[]} data
- * @property {boolean} success
- */
-/**
- * @typedef ConversionRate
- * @property {string} [base]
- * @property {Object} [rates]
- * @property {number} [timestamp]
- */
-/**
- * @typedef DeliveryPartnerDetail
- * @property {string} [name]
- * @property {string} [awb_number_barcode]
- * @property {string} [awb_number]
- * @property {string} [origin]
- * @property {string} [destination]
- * @property {string} [eway_bill_number]
- */
-/**
- * @typedef Image
- * @property {string} [sales_channel_logo]
- */
-/**
- * @typedef PaymentData
- * @property {string} [payment_type]
- * @property {number} [amount]
- * @property {string} [date]
- * @property {string} [transaction_id]
- * @property {string} [time]
- * @property {string} [mode]
- * @property {string} [name]
- * @property {Object} [meta]
- */
-/**
- * @typedef InvoiceDetail
- * @property {string} [invoice_id]
- * @property {string} [invoice_date]
- * @property {string} [irn]
- * @property {string} [external_order_id]
- * @property {string} [shipment_id]
- * @property {string} [signed_qrcode]
- * @property {string} [upi_qrcode]
- * @property {string} [device_id]
- * @property {string} [marketplace_invoice_id]
- * @property {string} [marketplace_shipment_id]
- * @property {string} [channel_order_id]
- */
-/**
- * @typedef CompanyDetail
- * @property {string} [name] - The official name of the company.
- * @property {string} [address] - The physical street address of the company.
- * @property {string} [city] - The city where the company is located.
- * @property {string} [state] - The state or province where the company is located.
- * @property {string} [country] - The country where the company is based.
- * @property {number} [zip_code] - The postal code for the company's location.
- * @property {string} [state_code] - A code representing the state, often used
- *   in official documents and forms.
- * @property {string} [country_code] - The code of the country.
- * @property {string} [gstin] - The Goods and Services Tax Identification
- *   Number, unique to each business in India.
- * @property {string} [pan] - The Permanent Account Number, unique to each
- *   taxpayer in India.
- * @property {string} [phone_no] - The primary contact phone number for the company.
- * @property {string} [cin] - The Corporate Identification Number, unique to
- *   each company registered in India.
- * @property {string} [website_url] - The URL to the company's official website.
- * @property {string} [email] - The company's official email address.
- * @property {string} [display_address] - The display address of the company.
- * @property {string} [sector] - The sector in which company is located.
- * @property {Object} [phone] - The provided phone no of country.
- * @property {string} [trn] - The trn no of the company.
- * @property {string} [vat] - The vat no of the company.
- * @property {string} [business_country_timezone] - The bussiness country timezone.
- * @property {Object} [business_country_currency] - This object represents the
- *   bussiness country currency.
- * @property {Object} [meta] - This object represents the meta fields for company.
- */
-/**
- * @typedef StoreDetail
- * @property {string} [store_name]
- * @property {string} [address]
- * @property {string} [city]
- * @property {string} [state]
- * @property {string} [country]
- * @property {string} [country_code]
- * @property {string} [zip_code]
- * @property {string} [state_code]
- * @property {string} [gstin]
- * @property {string} [display_address]
- * @property {string} [sector]
- * @property {string} [store_id]
- */
-/**
- * @typedef CustomerBillingDetail
- * @property {string} [name]
- * @property {string} [phone_no]
- * @property {string} [address]
- * @property {string} [city]
- * @property {string} [state]
- * @property {string} [country]
- * @property {string} [country_code]
- * @property {string} [zip_code]
- * @property {string} [state_code]
- * @property {string} [gstin]
- * @property {string} [display_address]
- * @property {string} [sector]
- * @property {string} [email]
- */
-/**
- * @typedef CustomerShippingDetail
- * @property {string} [name]
- * @property {string} [phone_no]
- * @property {string} [address]
- * @property {string} [city]
- * @property {string} [state]
- * @property {string} [country]
- * @property {string} [country_code]
- * @property {string} [zip_code]
- * @property {string} [state_code]
- * @property {string} [gstin]
- * @property {string} [display_address]
- * @property {string} [sector]
- */
-/**
- * @typedef ReturnDetail
- * @property {string} [address]
- * @property {string} [city]
- * @property {string} [state]
- * @property {string} [country]
- * @property {string} [country_code]
- * @property {string} [zip_code]
- * @property {string} [state_code]
- * @property {string} [gstin]
- * @property {string} [display_address]
- * @property {string} [sector]
- */
-/**
- * @typedef Brand
- * @property {string} [logo]
- * @property {string} [name]
- */
-/**
- * @typedef Cgst
- * @property {number} [value]
- * @property {number} [percent]
- */
-/**
- * @typedef Sgst
- * @property {number} [value]
- * @property {number} [percent]
- */
-/**
- * @typedef Igst
- * @property {number} [value]
- * @property {number} [percent]
- */
-/**
- * @typedef Tax
- * @property {Cgst} [cgst]
- * @property {Sgst} [sgst]
- * @property {Igst} [igst]
- */
-/**
- * @typedef ItemsProductTable
- * @property {string} [name]
- * @property {string} [seller_identifier]
- * @property {number} [total]
- * @property {Brand} [brand]
- * @property {string} [hsn_code]
- * @property {string} [item_code]
- * @property {number} [total_units]
- * @property {string} [size]
- * @property {number} [mrp]
- * @property {number} [discount]
- * @property {number} [taxable_amount]
- * @property {number} [total_taxable_amount]
- * @property {Tax} [tax]
- * @property {Object} [meta]
- * @property {string} [country_of_origin]
- */
-/**
- * @typedef ProductTable
- * @property {number} [total_items]
- * @property {ItemsProductTable[]} [products]
- * @property {number} [grand_total]
- * @property {number} [delivery_charges]
- * @property {string} [delivery_charge_text]
- * @property {number} [cod_charges]
- * @property {number} [fynd_discounts]
- * @property {string} [total_in_words]
- * @property {number} [gift_price]
- * @property {number} [total_quantity]
- * @property {number} [sub_total]
- * @property {number} [discount]
- * @property {number} [promotion]
- * @property {number} [coupon]
- * @property {number} [reward]
- * @property {number} [round_off]
- * @property {number} [total_value_of_goods]
- */
-/**
- * @typedef Taxes
- * @property {string} [hsn_code]
- * @property {Tax} [tax]
- * @property {number} [total_tax_value]
- */
-/**
- * @typedef TaxTable
- * @property {Taxes[]} [taxes]
- * @property {number} [total_tax]
- * @property {string} [tax_in_words]
- */
-/**
- * @typedef RegisteredCompanyDetail
- * @property {string} [address]
- * @property {string} [city]
- * @property {string} [state]
- * @property {string} [country]
- * @property {string} [country_code]
- * @property {number} [zip_code]
- * @property {string} [state_code]
- * @property {string} [display_address]
- * @property {string} [sector]
- */
-/**
- * @typedef Kwargs
- * @property {string} [value]
- */
-/**
- * @typedef ShipmentIdBarcodeGenerator
- * @property {string} [method]
- * @property {Kwargs} [kwargs]
- */
-/**
- * @typedef SignedQrcodeGenerator
- * @property {string} [method]
- * @property {Kwargs} [kwargs]
- */
-/**
- * @typedef KwargsUpiQrcode
- * @property {string} [qr_data]
- * @property {string} [qr_url]
- */
-/**
- * @typedef UpiQrcodeGenerator
- * @property {string} [method]
- * @property {KwargsUpiQrcode} [kwargs]
- */
-/**
- * @typedef DigitalsignatureGenerator
- * @property {string} [method]
- * @property {Kwargs} [kwargs]
- */
-/**
- * @typedef KwargsAwbNumber
- * @property {Object[]} [value]
- */
-/**
- * @typedef AwbNumberLabelBarcodeGenerator
- * @property {string} [method]
- * @property {KwargsAwbNumber} [kwargs]
- */
-/**
- * @typedef AwbNumberBarcodeGenerator
- * @property {string} [method]
- * @property {Kwargs} [kwargs]
- */
-/**
- * @typedef MetaProperty
- * @property {ShipmentIdBarcodeGenerator} [shipment_id_barcode_generator]
- * @property {SignedQrcodeGenerator} [signed_qrcode_generator]
- * @property {UpiQrcodeGenerator} [upi_qrcode_generator]
- * @property {DigitalsignatureGenerator} [digitalsignature_generator]
- * @property {AwbNumberLabelBarcodeGenerator} [awb_number_label_barcode_generator]
- * @property {AwbNumberBarcodeGenerator} [awb_number_barcode_generator]
- */
-/**
- * @typedef Meta
- * @property {MetaProperty} [generator]
- */
-/**
- * @typedef DummyTemplateDataPayload
- * @property {boolean} [is_export]
- * @property {boolean} [is_export_shipment]
- * @property {string} [app_domain_name]
- * @property {string} [txn_id]
- * @property {string} [utr]
- * @property {string} [po_number]
- * @property {string} [credit_note_id]
- * @property {string} [current_date]
- * @property {number} [total_value_of_goods]
- * @property {Object} [b2b_buyer_details]
- * @property {Object} [is_qwik]
- * @property {string} [order_type]
- * @property {ConversionRate} [conversion_rate]
- * @property {string} [currency_code]
- * @property {string} [shipment_id]
- * @property {DeliveryPartnerDetail} [delivery_partner_detail]
- * @property {Image} [image]
- * @property {PaymentData[]} [payments]
- * @property {InvoiceDetail} [invoice_detail]
- * @property {CompanyDetail} [company_detail]
- * @property {StoreDetail} [store_detail]
- * @property {CustomerBillingDetail} [customer_billing_detail]
- * @property {CustomerShippingDetail} [customer_shipping_detail]
- * @property {ReturnDetail} [return_detail]
- * @property {ProductTable} [product_table]
- * @property {TaxTable} [tax_table]
- * @property {string[]} [declaration_texts]
- * @property {RegisteredCompanyDetail} [registered_company_detail]
- * @property {string} [disclaimer]
- * @property {Meta} [meta]
- * @property {boolean} [is_self_ship]
- * @property {string} [mode]
- * @property {boolean} [is_self_pickup]
- * @property {Object} [shipment_meta] - This field represents the shipment meta details
- * @property {Object} [order_meta] - This field represents the order meta details
- * @property {string} [platform_name]
- * @property {number} [amount_to_be_collected]
- * @property {number} [amount_paid]
- * @property {Object[]} [waybills]
- * @property {number} [total_items]
- * @property {string} [brand_logo]
- * @property {string} [shipment_id_barcode]
- * @property {string} [signed_qrcode]
- * @property {string} [upi_qrcode]
- * @property {string} [digitalsignature]
- * @property {string} [awb_number_barcode]
- * @property {string} [uid]
- */
-/**
- * @typedef DummyTemplateData
- * @property {string} [_id] - This field contains the unique identifier for the
- *   PDF payload.
- * @property {number} [pdf_type_id] - This is invoice unique id
- * @property {DummyTemplateDataPayload} payload
- * @property {string} [country_code] - This field represents the country code.
- * @property {number} [__v] - This field holds the version number.
- */
-/**
- * @typedef DummyTemplateDataItems
- * @property {DummyTemplateData[]} data
- * @property {boolean} success
- */
 /**
  * @typedef PdfConfig
  * @property {string} [format] - This is invoice document format such as A4, A6, POS
- * @property {string} [template] - This is html template string
- * @property {number} [pdf_type_id]
+ * @property {string} [template] - This is html template string.
+ * @property {number} [pdf_type_id] - This field holds an identifier for the type of PDF.
+ * @property {string} [country_code] - This field contains the country code.
+ * @property {boolean} [default_template] - This field indicates whether the
+ *   fetched HTML template is the default template.
  */
 /**
  * @typedef PdfConfigSuccessData
- * @property {string} [_id]
- * @property {number} [company_id]
- * @property {string} [application_id]
- * @property {number} [pdf_type_id]
- * @property {string} [format]
- * @property {string} [template]
- * @property {number} [__v]
+ * @property {string} [_id] - This field contains the unique identifier for the
+ *   PDF configuration.
+ * @property {number} [company_id] - This field holds the identifier for the
+ *   company associated with the PDF configuration.
+ * @property {string} [application_id] - This field contains the identifier for
+ *   the application that uses this PDF configuration.
+ * @property {number} [pdf_type_id] - This field holds an identifier for the type of PDF.
+ * @property {string} [format] - This field specifies the format of the invoice document.
+ * @property {string} [template] - This field contains the HTML template string
+ *   for the PDF document.
+ * @property {number} [__v] - This field holds the version number of the PDF
+ *   configuration document.
  * @property {string} [country_code]
  */
 /**
@@ -484,20 +131,6 @@ export = FileStoragePlatformModel;
  * @property {PdfConfigSaveSuccessData} [data]
  * @property {boolean} [success]
  */
-/**
- * @typedef PdfDefaultTemplateSuccess
- * @property {Document[]} [data]
- * @property {boolean} [success] - Indicates if the request was successful.
- */
-/**
- * @typedef Document
- * @property {string} [_id]
- * @property {number} [pdf_type_id]
- * @property {string} [format]
- * @property {string} [template]
- * @property {string} [country_code]
- * @property {number} [__v]
- */
 /**
  * @typedef PaymentReceiptRequestBody
  * @property {PaymentReceiptPayload} [payload]
@@ -570,17 +203,11 @@ export = FileStoragePlatformModel;
 declare class FileStoragePlatformModel {
 }
 declare namespace FileStoragePlatformModel {
-    export { ProxyResponse, FailedResponse, CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
+    export { FailedBrowseFilesResult, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, ProxyFileAccess, DestinationNamespace, CopyFiles, Urls, SignUrlResult, SignUrl, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
 }
-/** @returns {ProxyResponse} */
-declare function ProxyResponse(): ProxyResponse;
-type ProxyResponse = {
-    data?: any;
-    support?: any;
-};
-/** @returns {FailedResponse} */
-declare function FailedResponse(): FailedResponse;
-type FailedResponse = {
+/** @returns {FailedBrowseFilesResult} */
+declare function FailedBrowseFilesResult(): FailedBrowseFilesResult;
+type FailedBrowseFilesResult = {
     message: string;
 };
 /** @returns {CDN} */
@@ -596,9 +223,9 @@ type Upload = {
     expiry: number;
     url: string;
 };
-/** @returns {StartResponse} */
-declare function StartResponse(): StartResponse;
-type StartResponse = {
+/** @returns {FileUpload} */
+declare function FileUpload(): FileUpload;
+type FileUpload = {
     file_name: string;
     file_path: string;
     content_type: string;
@@ -607,20 +234,11 @@ type StartResponse = {
     operation: string;
     size: number;
     upload: Upload;
-    cdn: CDN;
     tags?: string[];
 };
-/** @returns {Params} */
-declare function Params(): Params;
-type Params = {
-    /**
-     * - The subpath for the file.
-     */
-    subpath?: string;
-};
-/** @returns {StartRequest} */
-declare function StartRequest(): StartRequest;
-type StartRequest = {
+/** @returns {FileUploadStart} */
+declare function FileUploadStart(): FileUploadStart;
+type FileUploadStart = {
     file_name: string;
     content_type: string;
     size: number;
@@ -632,9 +250,9 @@ declare function CreatedBy(): CreatedBy;
 type CreatedBy = {
     username?: string;
 };
-/** @returns {CompleteResponse} */
-declare function CompleteResponse(): CompleteResponse;
-type CompleteResponse = {
+/** @returns {FileUploadComplete} */
+declare function FileUploadComplete(): FileUploadComplete;
+type FileUploadComplete = {
     _id: string;
     file_name: string;
     file_path: string;
@@ -651,6 +269,16 @@ type CompleteResponse = {
     modified_on: string;
     created_by?: CreatedBy;
 };
+/** @returns {ProxyFileAccess} */
+declare function ProxyFileAccess(): ProxyFileAccess;
+type ProxyFileAccess = {
+    /**
+     * - A boolean value indicating whether the proxy
+     * request was successful. Returns true when the external URL was successfully
+     * fetched and processed.
+     */
+    success?: boolean;
+};
 /** @returns {DestinationNamespace} */
 declare function DestinationNamespace(): DestinationNamespace;
 type DestinationNamespace = {
@@ -669,516 +297,77 @@ type Urls = {
     signed_url: string;
     expiry: number;
 };
-/** @returns {SignUrlResponse} */
-declare function SignUrlResponse(): SignUrlResponse;
-type SignUrlResponse = {
+/** @returns {SignUrlResult} */
+declare function SignUrlResult(): SignUrlResult;
+type SignUrlResult = {
     urls: Urls[];
 };
-/** @returns {SignUrlRequest} */
-declare function SignUrlRequest(): SignUrlRequest;
-type SignUrlRequest = {
+/** @returns {SignUrl} */
+declare function SignUrl(): SignUrl;
+type SignUrl = {
     expiry: number;
     urls: string[];
 };
-/** @returns {InvoiceTypesDataResponse} */
-declare function InvoiceTypesDataResponse(): InvoiceTypesDataResponse;
-type InvoiceTypesDataResponse = {
-    status?: boolean;
-    _id: string;
-    pdf_type_id: number;
-    name: string;
-    format: string[];
-    __v: number;
-    visibility: boolean;
-    country_code: string;
-};
-/** @returns {InvoiceTypesResponse} */
-declare function InvoiceTypesResponse(): InvoiceTypesResponse;
-type InvoiceTypesResponse = {
-    data: InvoiceTypesDataResponse[];
-    success: boolean;
-};
-/** @returns {ConversionRate} */
-declare function ConversionRate(): ConversionRate;
-type ConversionRate = {
-    base?: string;
-    rates?: any;
-    timestamp?: number;
-};
-/** @returns {DeliveryPartnerDetail} */
-declare function DeliveryPartnerDetail(): DeliveryPartnerDetail;
-type DeliveryPartnerDetail = {
-    name?: string;
-    awb_number_barcode?: string;
-    awb_number?: string;
-    origin?: string;
-    destination?: string;
-    eway_bill_number?: string;
-};
-/** @returns {Image} */
-declare function Image(): Image;
-type Image = {
-    sales_channel_logo?: string;
-};
-/** @returns {PaymentData} */
-declare function PaymentData(): PaymentData;
-type PaymentData = {
-    payment_type?: string;
-    amount?: number;
-    date?: string;
-    transaction_id?: string;
-    time?: string;
-    mode?: string;
-    name?: string;
-    meta?: any;
-};
-/** @returns {InvoiceDetail} */
-declare function InvoiceDetail(): InvoiceDetail;
-type InvoiceDetail = {
-    invoice_id?: string;
-    invoice_date?: string;
-    irn?: string;
-    external_order_id?: string;
-    shipment_id?: string;
-    signed_qrcode?: string;
-    upi_qrcode?: string;
-    device_id?: string;
-    marketplace_invoice_id?: string;
-    marketplace_shipment_id?: string;
-    channel_order_id?: string;
-};
-/** @returns {CompanyDetail} */
-declare function CompanyDetail(): CompanyDetail;
-type CompanyDetail = {
-    /**
-     * - The official name of the company.
-     */
-    name?: string;
-    /**
-     * - The physical street address of the company.
-     */
-    address?: string;
-    /**
-     * - The city where the company is located.
-     */
-    city?: string;
-    /**
-     * - The state or province where the company is located.
-     */
-    state?: string;
-    /**
-     * - The country where the company is based.
-     */
-    country?: string;
-    /**
-     * - The postal code for the company's location.
-     */
-    zip_code?: number;
-    /**
-     * - A code representing the state, often used
-     * in official documents and forms.
-     */
-    state_code?: string;
-    /**
-     * - The code of the country.
-     */
-    country_code?: string;
-    /**
-     * - The Goods and Services Tax Identification
-     * Number, unique to each business in India.
-     */
-    gstin?: string;
-    /**
-     * - The Permanent Account Number, unique to each
-     * taxpayer in India.
-     */
-    pan?: string;
-    /**
-     * - The primary contact phone number for the company.
-     */
-    phone_no?: string;
-    /**
-     * - The Corporate Identification Number, unique to
-     * each company registered in India.
-     */
-    cin?: string;
-    /**
-     * - The URL to the company's official website.
-     */
-    website_url?: string;
-    /**
-     * - The company's official email address.
-     */
-    email?: string;
-    /**
-     * - The display address of the company.
-     */
-    display_address?: string;
-    /**
-     * - The sector in which company is located.
-     */
-    sector?: string;
-    /**
-     * - The provided phone no of country.
-     */
-    phone?: any;
-    /**
-     * - The trn no of the company.
-     */
-    trn?: string;
+/** @returns {PdfConfig} */
+declare function PdfConfig(): PdfConfig;
+type PdfConfig = {
     /**
-     * - The vat no of the company.
+     * - This is invoice document format such as A4, A6, POS
      */
-    vat?: string;
+    format?: string;
     /**
-     * - The bussiness country timezone.
+     * - This is html template string.
      */
-    business_country_timezone?: string;
+    template?: string;
     /**
-     * - This object represents the
-     * bussiness country currency.
+     * - This field holds an identifier for the type of PDF.
      */
-    business_country_currency?: any;
+    pdf_type_id?: number;
     /**
-     * - This object represents the meta fields for company.
+     * - This field contains the country code.
      */
-    meta?: any;
-};
-/** @returns {StoreDetail} */
-declare function StoreDetail(): StoreDetail;
-type StoreDetail = {
-    store_name?: string;
-    address?: string;
-    city?: string;
-    state?: string;
-    country?: string;
-    country_code?: string;
-    zip_code?: string;
-    state_code?: string;
-    gstin?: string;
-    display_address?: string;
-    sector?: string;
-    store_id?: string;
-};
-/** @returns {CustomerBillingDetail} */
-declare function CustomerBillingDetail(): CustomerBillingDetail;
-type CustomerBillingDetail = {
-    name?: string;
-    phone_no?: string;
-    address?: string;
-    city?: string;
-    state?: string;
-    country?: string;
-    country_code?: string;
-    zip_code?: string;
-    state_code?: string;
-    gstin?: string;
-    display_address?: string;
-    sector?: string;
-    email?: string;
-};
-/** @returns {CustomerShippingDetail} */
-declare function CustomerShippingDetail(): CustomerShippingDetail;
-type CustomerShippingDetail = {
-    name?: string;
-    phone_no?: string;
-    address?: string;
-    city?: string;
-    state?: string;
-    country?: string;
-    country_code?: string;
-    zip_code?: string;
-    state_code?: string;
-    gstin?: string;
-    display_address?: string;
-    sector?: string;
-};
-/** @returns {ReturnDetail} */
-declare function ReturnDetail(): ReturnDetail;
-type ReturnDetail = {
-    address?: string;
-    city?: string;
-    state?: string;
-    country?: string;
-    country_code?: string;
-    zip_code?: string;
-    state_code?: string;
-    gstin?: string;
-    display_address?: string;
-    sector?: string;
-};
-/** @returns {Brand} */
-declare function Brand(): Brand;
-type Brand = {
-    logo?: string;
-    name?: string;
-};
-/** @returns {Cgst} */
-declare function Cgst(): Cgst;
-type Cgst = {
-    value?: number;
-    percent?: number;
-};
-/** @returns {Sgst} */
-declare function Sgst(): Sgst;
-type Sgst = {
-    value?: number;
-    percent?: number;
-};
-/** @returns {Igst} */
-declare function Igst(): Igst;
-type Igst = {
-    value?: number;
-    percent?: number;
-};
-/** @returns {Tax} */
-declare function Tax(): Tax;
-type Tax = {
-    cgst?: Cgst;
-    sgst?: Sgst;
-    igst?: Igst;
-};
-/** @returns {ItemsProductTable} */
-declare function ItemsProductTable(): ItemsProductTable;
-type ItemsProductTable = {
-    name?: string;
-    seller_identifier?: string;
-    total?: number;
-    brand?: Brand;
-    hsn_code?: string;
-    item_code?: string;
-    total_units?: number;
-    size?: string;
-    mrp?: number;
-    discount?: number;
-    taxable_amount?: number;
-    total_taxable_amount?: number;
-    tax?: Tax;
-    meta?: any;
-    country_of_origin?: string;
-};
-/** @returns {ProductTable} */
-declare function ProductTable(): ProductTable;
-type ProductTable = {
-    total_items?: number;
-    products?: ItemsProductTable[];
-    grand_total?: number;
-    delivery_charges?: number;
-    delivery_charge_text?: string;
-    cod_charges?: number;
-    fynd_discounts?: number;
-    total_in_words?: string;
-    gift_price?: number;
-    total_quantity?: number;
-    sub_total?: number;
-    discount?: number;
-    promotion?: number;
-    coupon?: number;
-    reward?: number;
-    round_off?: number;
-    total_value_of_goods?: number;
-};
-/** @returns {Taxes} */
-declare function Taxes(): Taxes;
-type Taxes = {
-    hsn_code?: string;
-    tax?: Tax;
-    total_tax_value?: number;
-};
-/** @returns {TaxTable} */
-declare function TaxTable(): TaxTable;
-type TaxTable = {
-    taxes?: Taxes[];
-    total_tax?: number;
-    tax_in_words?: string;
-};
-/** @returns {RegisteredCompanyDetail} */
-declare function RegisteredCompanyDetail(): RegisteredCompanyDetail;
-type RegisteredCompanyDetail = {
-    address?: string;
-    city?: string;
-    state?: string;
-    country?: string;
     country_code?: string;
-    zip_code?: number;
-    state_code?: string;
-    display_address?: string;
-    sector?: string;
-};
-/** @returns {Kwargs} */
-declare function Kwargs(): Kwargs;
-type Kwargs = {
-    value?: string;
-};
-/** @returns {ShipmentIdBarcodeGenerator} */
-declare function ShipmentIdBarcodeGenerator(): ShipmentIdBarcodeGenerator;
-type ShipmentIdBarcodeGenerator = {
-    method?: string;
-    kwargs?: Kwargs;
-};
-/** @returns {SignedQrcodeGenerator} */
-declare function SignedQrcodeGenerator(): SignedQrcodeGenerator;
-type SignedQrcodeGenerator = {
-    method?: string;
-    kwargs?: Kwargs;
-};
-/** @returns {KwargsUpiQrcode} */
-declare function KwargsUpiQrcode(): KwargsUpiQrcode;
-type KwargsUpiQrcode = {
-    qr_data?: string;
-    qr_url?: string;
-};
-/** @returns {UpiQrcodeGenerator} */
-declare function UpiQrcodeGenerator(): UpiQrcodeGenerator;
-type UpiQrcodeGenerator = {
-    method?: string;
-    kwargs?: KwargsUpiQrcode;
-};
-/** @returns {DigitalsignatureGenerator} */
-declare function DigitalsignatureGenerator(): DigitalsignatureGenerator;
-type DigitalsignatureGenerator = {
-    method?: string;
-    kwargs?: Kwargs;
-};
-/** @returns {KwargsAwbNumber} */
-declare function KwargsAwbNumber(): KwargsAwbNumber;
-type KwargsAwbNumber = {
-    value?: any[];
-};
-/** @returns {AwbNumberLabelBarcodeGenerator} */
-declare function AwbNumberLabelBarcodeGenerator(): AwbNumberLabelBarcodeGenerator;
-type AwbNumberLabelBarcodeGenerator = {
-    method?: string;
-    kwargs?: KwargsAwbNumber;
-};
-/** @returns {AwbNumberBarcodeGenerator} */
-declare function AwbNumberBarcodeGenerator(): AwbNumberBarcodeGenerator;
-type AwbNumberBarcodeGenerator = {
-    method?: string;
-    kwargs?: Kwargs;
-};
-/** @returns {MetaProperty} */
-declare function MetaProperty(): MetaProperty;
-type MetaProperty = {
-    shipment_id_barcode_generator?: ShipmentIdBarcodeGenerator;
-    signed_qrcode_generator?: SignedQrcodeGenerator;
-    upi_qrcode_generator?: UpiQrcodeGenerator;
-    digitalsignature_generator?: DigitalsignatureGenerator;
-    awb_number_label_barcode_generator?: AwbNumberLabelBarcodeGenerator;
-    awb_number_barcode_generator?: AwbNumberBarcodeGenerator;
-};
-/** @returns {Meta} */
-declare function Meta(): Meta;
-type Meta = {
-    generator?: MetaProperty;
-};
-/** @returns {DummyTemplateDataPayload} */
-declare function DummyTemplateDataPayload(): DummyTemplateDataPayload;
-type DummyTemplateDataPayload = {
-    is_export?: boolean;
-    is_export_shipment?: boolean;
-    app_domain_name?: string;
-    txn_id?: string;
-    utr?: string;
-    po_number?: string;
-    credit_note_id?: string;
-    current_date?: string;
-    total_value_of_goods?: number;
-    b2b_buyer_details?: any;
-    is_qwik?: any;
-    order_type?: string;
-    conversion_rate?: ConversionRate;
-    currency_code?: string;
-    shipment_id?: string;
-    delivery_partner_detail?: DeliveryPartnerDetail;
-    image?: Image;
-    payments?: PaymentData[];
-    invoice_detail?: InvoiceDetail;
-    company_detail?: CompanyDetail;
-    store_detail?: StoreDetail;
-    customer_billing_detail?: CustomerBillingDetail;
-    customer_shipping_detail?: CustomerShippingDetail;
-    return_detail?: ReturnDetail;
-    product_table?: ProductTable;
-    tax_table?: TaxTable;
-    declaration_texts?: string[];
-    registered_company_detail?: RegisteredCompanyDetail;
-    disclaimer?: string;
-    meta?: Meta;
-    is_self_ship?: boolean;
-    mode?: string;
-    is_self_pickup?: boolean;
     /**
-     * - This field represents the shipment meta details
+     * - This field indicates whether the
+     * fetched HTML template is the default template.
      */
-    shipment_meta?: any;
-    /**
-     * - This field represents the order meta details
-     */
-    order_meta?: any;
-    platform_name?: string;
-    amount_to_be_collected?: number;
-    amount_paid?: number;
-    waybills?: any[];
-    total_items?: number;
-    brand_logo?: string;
-    shipment_id_barcode?: string;
-    signed_qrcode?: string;
-    upi_qrcode?: string;
-    digitalsignature?: string;
-    awb_number_barcode?: string;
-    uid?: string;
+    default_template?: boolean;
 };
-/** @returns {DummyTemplateData} */
-declare function DummyTemplateData(): DummyTemplateData;
-type DummyTemplateData = {
+/** @returns {PdfConfigSuccessData} */
+declare function PdfConfigSuccessData(): PdfConfigSuccessData;
+type PdfConfigSuccessData = {
     /**
      * - This field contains the unique identifier for the
-     * PDF payload.
+     * PDF configuration.
      */
     _id?: string;
     /**
-     * - This is invoice unique id
+     * - This field holds the identifier for the
+     * company associated with the PDF configuration.
      */
-    pdf_type_id?: number;
-    payload: DummyTemplateDataPayload;
+    company_id?: number;
     /**
-     * - This field represents the country code.
+     * - This field contains the identifier for
+     * the application that uses this PDF configuration.
      */
-    country_code?: string;
+    application_id?: string;
     /**
-     * - This field holds the version number.
+     * - This field holds an identifier for the type of PDF.
      */
-    __v?: number;
-};
-/** @returns {DummyTemplateDataItems} */
-declare function DummyTemplateDataItems(): DummyTemplateDataItems;
-type DummyTemplateDataItems = {
-    data: DummyTemplateData[];
-    success: boolean;
-};
-/** @returns {PdfConfig} */
-declare function PdfConfig(): PdfConfig;
-type PdfConfig = {
+    pdf_type_id?: number;
     /**
-     * - This is invoice document format such as A4, A6, POS
+     * - This field specifies the format of the invoice document.
      */
     format?: string;
     /**
-     * - This is html template string
+     * - This field contains the HTML template string
+     * for the PDF document.
      */
     template?: string;
-    pdf_type_id?: number;
-};
-/** @returns {PdfConfigSuccessData} */
-declare function PdfConfigSuccessData(): PdfConfigSuccessData;
-type PdfConfigSuccessData = {
-    _id?: string;
-    company_id?: number;
-    application_id?: string;
-    pdf_type_id?: number;
-    format?: string;
-    template?: string;
+    /**
+     * - This field holds the version number of the PDF
+     * configuration document.
+     */
     __v?: number;
     country_code?: string;
 };
@@ -1205,25 +394,6 @@ type PdfConfigSaveSuccess = {
     data?: PdfConfigSaveSuccessData;
     success?: boolean;
 };
-/** @returns {PdfDefaultTemplateSuccess} */
-declare function PdfDefaultTemplateSuccess(): PdfDefaultTemplateSuccess;
-type PdfDefaultTemplateSuccess = {
-    data?: Document[];
-    /**
-     * - Indicates if the request was successful.
-     */
-    success?: boolean;
-};
-/** @returns {Document} */
-declare function Document(): Document;
-type Document = {
-    _id?: string;
-    pdf_type_id?: number;
-    format?: string;
-    template?: string;
-    country_code?: string;
-    __v?: number;
-};
 /** @returns {PaymentReceiptRequestBody} */
 declare function PaymentReceiptRequestBody(): PaymentReceiptRequestBody;
 type PaymentReceiptRequestBody = {