node-ovh-ts/dist/handlers/Store.d.ts

OVH API wrapper library for TypeScript

import { MarketPlaceDocument } from '../models/MarketPlaceDocument.js';
import { MarketPlacePartner } from '../models/MarketPlacePartner.js';
import { MarketPlacePartnerProduct } from '../models/MarketPlacePartnerProduct.js';
import { MarketPlaceContact } from '../models/MarketPlaceContact.js';
import OVHBase from '../ovh.js';
import '../endpoints.js';

declare class StoreHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List current customer contacts */
    listContact: () => Promise<MarketPlaceContact[]>;
    /** Create a 'marketplace' contact for current nic */
    createContact: (body: {
        city?: string;
        country?: string;
        email: string;
        firstname: string;
        lastname: string;
        phone?: string;
        province?: string;
        street?: string;
        title: string;
        zip?: string;
    }) => Promise<MarketPlaceContact>;
    /** Remove an existing contact */
    deleteContactByContactId: (contactId: string) => Promise<string>;
    /** Get contact details */
    getContactByContactId: (contactId: string) => Promise<MarketPlaceContact>;
    /** Edit contact information */
    updateContactByContactId: (contactId: string, body: {
        city?: string;
        country?: string;
        email?: string;
        firstname?: string;
        lastname?: string;
        phone?: string;
        province?: string;
        street?: string;
        title?: string;
        zip?: string;
    }) => Promise<MarketPlaceContact>;
    /** List document associated with contact */
    listContactDocumentByContactId: (contactId: string) => Promise<string[]>;
    /** Add a document to a contact */
    addContactDocumentByContactId: (contactId: string, body: {
        documentId: string;
    }) => Promise<string[]>;
    /** Unlink a document from a contact */
    deleteContactDocumentByContactIdAndDocumentId: (contactId: string, documentId: string) => Promise<string[]>;
    /** List current customer documents */
    listDocument: () => Promise<MarketPlaceDocument[]>;
    /** Create a document */
    createDocument: (body: {
        name: string;
        tags?: string;
    }) => Promise<MarketPlaceDocument>;
    /** Add CORS support on your container */
    addDocumentCors: (body: {
        origin: string;
    }) => Promise<void>;
    /** Delete document */
    deleteDocumentByDocumentId: (documentId: string) => Promise<string>;
    /** Get document info */
    getDocumentByDocumentId: (documentId: string) => Promise<MarketPlaceDocument>;
    /** List current customer partners */
    listPartner: () => Promise<MarketPlacePartner[]>;
    /** Create a 'marketplace' partner for current nic */
    createPartner: (body: {
        category?: string;
        city: string;
        companyNationalIdentificationNumber?: string;
        contact?: string;
        country: string;
        description?: string;
        language?: string;
        legalForm: string;
        organisationDisplayName?: string;
        organisationName: string;
        otherDetails?: string;
        province: string;
        street: string;
        url?: string;
        vat?: string;
        zip: string;
    }) => Promise<MarketPlacePartner>;
    /** Delete partner */
    deletePartnerByPartnerId: (partnerId: string) => Promise<string>;
    /** Get partner info */
    getPartnerByPartnerId: (partnerId: string) => Promise<MarketPlacePartner>;
    /** Edit partner info */
    updatePartnerByPartnerId: (partnerId: string, body: {
        category?: string;
        city?: string;
        companyNationalIdentificationNumber?: string;
        contact?: string;
        country?: string;
        description?: string;
        language?: string;
        legalForm?: string;
        organisationDisplayName?: string;
        organisationName?: string;
        otherDetails?: string;
        province?: string;
        street?: string;
        url?: string;
        vat?: string;
        zip?: string;
    }) => Promise<MarketPlacePartner>;
    /** List document associated with partner */
    listPartnerDocumentByPartnerId: (partnerId: string) => Promise<string[]>;
    /** Add a document to a partner */
    addPartnerDocumentByPartnerId: (partnerId: string, body: {
        documentId: string;
    }) => Promise<string[]>;
    /** Unlink a document from a partner */
    deletePartnerDocumentByPartnerIdAndDocumentId: (documentId: string, partnerId: string) => Promise<string[]>;
    /** List partner's products */
    listPartnerProductByPartnerId: (partnerId: string) => Promise<MarketPlacePartnerProduct[]>;
    /** Create a new product for partner */
    createPartnerProductByPartnerId: (partnerId: string, body: {
        category: string;
        description: string;
        name: string;
        otherDetails?: string;
    }) => Promise<MarketPlacePartnerProduct>;
    /** Delete product */
    deletePartnerProductByPartnerIdAndProductId: (partnerId: string, productId: string) => Promise<string>;
    /** Get partner info */
    getPartnerProductByPartnerIdAndProductId: (partnerId: string, productId: string) => Promise<MarketPlacePartnerProduct>;
    /** Edit product info */
    updatePartnerProductByPartnerIdAndProductId: (partnerId: string, productId: string, body: {
        category?: string;
        description?: string;
        name?: string;
        otherDetails?: string;
    }) => Promise<MarketPlacePartnerProduct>;
    /** List document associated with product */
    listPartnerProductDocumentByPartnerIdAndProductId: (partnerId: string, productId: string) => Promise<string[]>;
    /** Add a document to a product */
    addPartnerProductDocumentByPartnerIdAndProductId: (partnerId: string, productId: string, body: {
        documentId: string;
    }) => Promise<string[]>;
    /** Unlink a document from a product */
    deletePartnerProductDocumentByPartnerIdAndProductIdAndDocumentId: (documentId: string, partnerId: string, productId: string) => Promise<string[]>;
}

export { StoreHandler };