/** * Catalog API * This API gets and orders catalog items from different cloud sources. * * The version of the OpenAPI document: 1.3.0 * Contact: support@redhat.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * API Error * @export * @interface ApiError */ export interface ApiError { /** * HTTP status code * @type {string} * @memberof ApiError */ status?: string; /** * Error details * @type {string} * @memberof ApiError */ details?: string; } /** * API Error collection * @export * @interface ApiErrorCollection */ export interface ApiErrorCollection { /** * Error list from the API query * @type {Array} * @memberof ApiErrorCollection */ errors?: Array; } /** * * @export * @interface ApprovalRequest */ export interface ApprovalRequest { /** * The unique identifier for this approval request. * @type {string} * @memberof ApprovalRequest */ id?: string; /** * The id of the approval submitted to approval-api * @type {string} * @memberof ApprovalRequest */ approval_request_ref?: string; /** * The Order Item which the approval request belongs to * @type {string} * @memberof ApprovalRequest */ order_item_id?: string; /** * The reason for the current state. * @type {string} * @memberof ApprovalRequest */ reason?: string; /** * * @type {string} * @memberof ApprovalRequest */ request_completed_at?: string; /** * The state of the approval request (approved, denied, undecided, canceled, error) * @type {string} * @memberof ApprovalRequest */ state?: ApprovalRequestStateEnum; } /** * @export * @enum {string} */ export declare enum ApprovalRequestStateEnum { Undecided = "undecided", Approved = "approved", Denied = "denied", Canceled = "canceled", Error = "error" } /** * * @export * @interface ApprovalRequestsCollection */ export interface ApprovalRequestsCollection { /** * * @type {CollectionMetadata} * @memberof ApprovalRequestsCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof ApprovalRequestsCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof ApprovalRequestsCollection */ data?: Array; } /** * * @export * @interface CollectionLinks */ export interface CollectionLinks { /** * The link to fetch the first group of items in the result set * @type {string} * @memberof CollectionLinks */ first?: string; /** * The link to fetch the last group of items in the result set * @type {string} * @memberof CollectionLinks */ last?: string; /** * The link to fetch the previous group of items in the result set * @type {string} * @memberof CollectionLinks */ prev?: string; /** * The link to fetch the next group of items in the result set * @type {string} * @memberof CollectionLinks */ next?: string; } /** * * @export * @interface CollectionMetadata */ export interface CollectionMetadata { /** * Total number of items in the result set, of which only a subset is returned, defined by the QueryLimit parameter. * @type {number} * @memberof CollectionMetadata */ count?: number; } /** * * @export * @interface CopyPortfolioItem */ export interface CopyPortfolioItem { /** * The portfolio to place the new copy of the Portfolio Item in * @type {string} * @memberof CopyPortfolioItem */ portfolio_id?: string; /** * The name of the copied portfolio item * @type {string} * @memberof CopyPortfolioItem */ portfolio_item_name?: string; } /** * * @export * @interface CreateIcon */ export interface CreateIcon { /** * The binary image contents, maximum size is 250KB * @type {any} * @memberof CreateIcon */ content?: any; /** * The Portfolio this Icon belongs to * @type {string} * @memberof CreateIcon */ portfolio_id?: string; /** * The Portfolio Item this Icon belongs to * @type {string} * @memberof CreateIcon */ portfolio_item_id?: string; } /** * * @export * @interface CreatePortfolioItem */ export interface CreatePortfolioItem { /** * The Portfolio this portfolio item should belong to * @type {string} * @memberof CreatePortfolioItem */ portfolio_id: string; /** * The service offering ref should be retrieved from a call to the catalog inventory Service. * @type {string} * @memberof CreatePortfolioItem */ service_offering_ref?: string; } /** * * @export * @interface GraphQLRequest */ export interface GraphQLRequest { /** * The GraphQL query * @type {string} * @memberof GraphQLRequest */ query: string; /** * If the Query contains several named operations, the operationName controls which one should be executed * @type {string} * @memberof GraphQLRequest */ operationName?: string; /** * Optional Query variables * @type {object} * @memberof GraphQLRequest */ variables?: object | null; } /** * * @export * @interface GraphQLResponse */ export interface GraphQLResponse { /** * Results from the GraphQL query * @type {object} * @memberof GraphQLResponse */ data?: object; /** * Errors resulting from the GraphQL query * @type {Array} * @memberof GraphQLResponse */ errors?: Array; } /** * * @export * @interface Icon */ export interface Icon { /** * The unique identifier for this Service Offering Icon * @type {string} * @memberof Icon */ id?: string; /** * The Image reference containing the binary image data for this icon * @type {string} * @memberof Icon */ image_id?: string; /** * Stores the Source Ref for this icon * @type {string} * @memberof Icon */ source_ref?: string; /** * The source ID for this icon * @type {string} * @memberof Icon */ source_id?: string; /** * The portfolio this icon belongs to. * @type {string} * @memberof Icon */ portfolio_id?: string; /** * The portfolio_item this icon belongs to. * @type {string} * @memberof Icon */ portfolio_item_id?: string; } /** * * @export * @interface ImportServicePlan */ export interface ImportServicePlan { /** * The Portfolio Item to import the service plans for. * @type {string} * @memberof ImportServicePlan */ portfolio_item_id?: string; } /** * * @export * @interface Order */ export interface Order { /** * * @type {string} * @memberof Order */ id?: string; /** * * @type {string} * @memberof Order */ user_id?: string; /** * Current State of the order. * @type {string} * @memberof Order */ state?: OrderStateEnum; /** * * @type {string} * @memberof Order */ created_at?: string; /** * The time at which the order request was sent to the catalog inventory Service * @type {string} * @memberof Order */ order_request_sent_at?: string | null; /** * * @type {string} * @memberof Order */ completed_at?: string; /** * * @type {string} * @memberof Order */ owner?: string; } /** * @export * @enum {string} */ export declare enum OrderStateEnum { Created = "Created", ApprovalPending = "Approval Pending", Ordered = "Ordered", Failed = "Failed", Completed = "Completed", Canceled = "Canceled" } /** * * @export * @interface OrderItem */ export interface OrderItem { /** * * @type {string} * @memberof OrderItem */ id?: string; /** * Name of the Portfolio Item or Order Process * @type {string} * @memberof OrderItem */ name?: string; /** * * @type {number} * @memberof OrderItem */ count: number; /** * * @type {object} * @memberof OrderItem */ service_parameters?: object | null; /** * The provider specific parameters needed to provision this service. This might include namespaces, special keys. * @type {object} * @memberof OrderItem */ provider_control_parameters?: object | null; /** * Stores the Portfolio Item ID. * @type {string} * @memberof OrderItem */ portfolio_item_id: string; /** * Current state of this order item. * @type {string} * @memberof OrderItem */ state?: OrderItemStateEnum; /** * The Order that the OrderItem belongs to. * @type {string} * @memberof OrderItem */ order_id?: string; /** * * @type {string} * @memberof OrderItem */ created_at?: string; /** * The time at which the order request was sent to the catalog inventory Service * @type {string} * @memberof OrderItem */ order_request_sent_at?: string; /** * * @type {string} * @memberof OrderItem */ completed_at?: string; /** * * @type {string} * @memberof OrderItem */ updated_at?: string; /** * * @type {string} * @memberof OrderItem */ owner?: string; /** * The external url of the service instance used with relation to this order item * @type {string} * @memberof OrderItem */ external_url?: string; /** * The insights request id can be used to collect log data for this order item as its processed by the system * @type {string} * @memberof OrderItem */ insights_request_id?: string; /** * The sequence that this order item is ran relative to the other order items within the order. * @type {number} * @memberof OrderItem */ process_sequence?: number; /** * Denotes the scope in which the order item will run for the order it belongs to. It can be \'before\', \'after\', or \'product\' * @type {string} * @memberof OrderItem */ process_scope?: string; /** * Contains a prefix-stripped key/value object that contains all of the information exposed from product provisioning. Must be exposed from Tower with prefix \'expose_to_cloud_redhat_com_\' * @type {object} * @memberof OrderItem */ artifacts?: object; } /** * @export * @enum {string} */ export declare enum OrderItemStateEnum { Created = "Created", ApprovalPending = "Approval Pending", Ordered = "Ordered", Failed = "Failed", Completed = "Completed", Approved = "Approved", Denied = "Denied", Canceled = "Canceled" } /** * * @export * @interface OrderItemsCollection */ export interface OrderItemsCollection { /** * * @type {CollectionMetadata} * @memberof OrderItemsCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof OrderItemsCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof OrderItemsCollection */ data?: Array; } /** * * @export * @interface OrderProcess */ export interface OrderProcess { /** * * @type {string} * @memberof OrderProcess */ id?: string; /** * The name of the order process. * @type {string} * @memberof OrderProcess */ name?: string; /** * The order process description. * @type {string} * @memberof OrderProcess */ description?: string | null; /** * * @type {string} * @memberof OrderProcess */ created_at?: string; /** * * @type {string} * @memberof OrderProcess */ updated_at?: string; /** * The ID of the portfolio item associated to the \'before\' step * @type {string} * @memberof OrderProcess */ before_portfolio_item_id?: string; /** * The ID of the portfolio item associated to the \'after\' step * @type {string} * @memberof OrderProcess */ after_portfolio_item_id?: string; /** * The ID of the portfolio item associated to the item\'s return * @type {string} * @memberof OrderProcess */ return_portfolio_item_id?: string; /** * JSON Metadata about the order process * @type {object} * @memberof OrderProcess */ metadata?: object; } /** * * @export * @interface OrderProcessAssociationsToRemove */ export interface OrderProcessAssociationsToRemove { /** * * @type {Array} * @memberof OrderProcessAssociationsToRemove */ associations_to_remove?: Array; } /** * @export * @enum {string} */ export declare enum OrderProcessAssociationsToRemoveAssociationsToRemoveEnum { Before = "before", After = "after", Return = "return" } /** * * @export * @interface OrderProcessCollection */ export interface OrderProcessCollection { /** * * @type {CollectionMetadata} * @memberof OrderProcessCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof OrderProcessCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof OrderProcessCollection */ data?: Array; } /** * * @export * @interface OrderProcessPortfolioItemId */ export interface OrderProcessPortfolioItemId { /** * * @type {string} * @memberof OrderProcessPortfolioItemId */ portfolio_item_id?: string; } /** * * @export * @interface OrdersCollection */ export interface OrdersCollection { /** * * @type {CollectionMetadata} * @memberof OrdersCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof OrdersCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof OrdersCollection */ data?: Array; } /** * * @export * @interface PatchModifiedServicePlan */ export interface PatchModifiedServicePlan { /** * the new modified schema for the service plan * @type {object} * @memberof PatchModifiedServicePlan */ modified?: object; } /** * * @export * @interface Portfolio */ export interface Portfolio { /** * * @type {string} * @memberof Portfolio */ id?: string; /** * * @type {string} * @memberof Portfolio */ name?: string; /** * * @type {string} * @memberof Portfolio */ description?: string | null; /** * * @type {boolean} * @memberof Portfolio */ enabled?: boolean; /** * * @type {string} * @memberof Portfolio */ owner?: string; /** * The Portfolio Icon ID * @type {string} * @memberof Portfolio */ icon_id?: string; /** * * @type {string} * @memberof Portfolio */ created_at?: string; /** * * @type {string} * @memberof Portfolio */ updated_at?: string; /** * JSON Metadata about the portfolio * @type {object} * @memberof Portfolio */ metadata?: object; } /** * * @export * @interface PortfolioItem */ export interface PortfolioItem { /** * * @type {string} * @memberof PortfolioItem */ id?: string; /** * * @type {boolean} * @memberof PortfolioItem */ favorite?: boolean; /** * * @type {string} * @memberof PortfolioItem */ name?: string; /** * * @type {string} * @memberof PortfolioItem */ description?: string | null; /** * * @type {boolean} * @memberof PortfolioItem */ orphan?: boolean; /** * * @type {string} * @memberof PortfolioItem */ state?: string; /** * * @type {string} * @memberof PortfolioItem */ long_description?: string | null; /** * * @type {string} * @memberof PortfolioItem */ distributor?: string | null; /** * * @type {string} * @memberof PortfolioItem */ documentation_url?: string | null; /** * * @type {string} * @memberof PortfolioItem */ support_url?: string | null; /** * * @type {string} * @memberof PortfolioItem */ owner?: string; /** * The source reference this product was created from * @type {string} * @memberof PortfolioItem */ service_offering_source_ref?: string; /** * The service offering type stored by the catalog inventory Service * @type {string} * @memberof PortfolioItem */ service_offering_type?: string; /** * ID of a parent portfolio * @type {string} * @memberof PortfolioItem */ portfolio_id?: string; /** * The Portfolio Item Icon ID * @type {string} * @memberof PortfolioItem */ icon_id?: string; /** * * @type {string} * @memberof PortfolioItem */ created_at?: string; /** * * @type {string} * @memberof PortfolioItem */ updated_at?: string; /** * JSON Metadata about the portfolio item * @type {object} * @memberof PortfolioItem */ metadata?: object; } /** * * @export * @interface PortfolioItemNextName */ export interface PortfolioItemNextName { /** * * @type {string} * @memberof PortfolioItemNextName */ next_name?: string; } /** * * @export * @interface PortfolioItemsCollection */ export interface PortfolioItemsCollection { /** * * @type {CollectionMetadata} * @memberof PortfolioItemsCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof PortfolioItemsCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof PortfolioItemsCollection */ data?: Array; } /** * * @export * @interface PortfoliosCollection */ export interface PortfoliosCollection { /** * * @type {CollectionMetadata} * @memberof PortfoliosCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof PortfoliosCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof PortfoliosCollection */ data?: Array; } /** * * @export * @interface ProgressMessage */ export interface ProgressMessage { /** * * @type {string} * @memberof ProgressMessage */ received_at?: string; /** * * @type {string} * @memberof ProgressMessage */ level?: ProgressMessageLevelEnum; /** * * @type {string} * @memberof ProgressMessage */ message?: string; /** * * @type {string} * @memberof ProgressMessage */ order_item_id?: string; } /** * @export * @enum {string} */ export declare enum ProgressMessageLevelEnum { Info = "info", Error = "error", Warning = "warning", Debug = "debug" } /** * * @export * @interface ProgressMessagesCollection */ export interface ProgressMessagesCollection { /** * * @type {CollectionMetadata} * @memberof ProgressMessagesCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof ProgressMessagesCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof ProgressMessagesCollection */ data?: Array; } /** * The desired increment relative to its current position, or placement to top or bottom of the list. * @export * @interface Reposition */ export interface Reposition { /** * Move the record up (negative) or down (positive) in the list. Do not set it if placement is used * @type {number} * @memberof Reposition */ increment?: number | null; /** * Place the record to the top or bottom of the list. Do not set it if increment is used * @type {string} * @memberof Reposition */ placement?: RepositionPlacementEnum; } /** * @export * @enum {string} */ export declare enum RepositionPlacementEnum { Bottom = "bottom", Top = "top" } /** * Resource object definition * @export * @interface ResourceObject */ export interface ResourceObject { /** * Object type * @type {string} * @memberof ResourceObject */ object_type: string; /** * Name of the application that the object belongs to * @type {string} * @memberof ResourceObject */ app_name: string; /** * ID of the object * @type {string} * @memberof ResourceObject */ object_id: string; } /** * * @export * @interface RestoreKey */ export interface RestoreKey { /** * * @type {string} * @memberof RestoreKey */ restore_key?: string; } /** * * @export * @interface ServicePlan */ export interface ServicePlan { /** * The name of the service plan. * @type {string} * @memberof ServicePlan */ name?: string; /** * The service plan description. * @type {string} * @memberof ServicePlan */ description?: string; /** * JSON schema for the object. * @type {object} * @memberof ServicePlan */ create_json_schema?: object; /** * The reference ID of the Portfolio Item * @type {string} * @memberof ServicePlan */ portfolio_item_id?: string; /** * The unique identifier for this service plan. * @type {string} * @memberof ServicePlan */ id?: string; /** * Whether or not the ServicePlan has been imported for editing * @type {boolean} * @memberof ServicePlan */ imported?: boolean; /** * Whether or not the ServicePlan has a modified schema * @type {boolean} * @memberof ServicePlan */ modified?: boolean; } /** * * @export * @interface Setting */ export interface Setting { /** * * @type {string} * @memberof Setting */ name?: string; /** * * @type {string} * @memberof Setting */ value?: string; } /** * * @export * @interface ShareInfo */ export interface ShareInfo { /** * The Group UUID * @type {string} * @memberof ShareInfo */ group_uuid?: string; /** * The Group Name * @type {string} * @memberof ShareInfo */ group_name?: string; /** * One or more permissions currently applied to this group. * @type {Array} * @memberof ShareInfo */ permissions?: Array; } /** * @export * @enum {string} */ export declare enum ShareInfoPermissionsEnum { Read = "read", Update = "update", Delete = "delete", Order = "order" } /** * * @export * @interface SharePolicy */ export interface SharePolicy { /** * The permissions to apply for this share. The valid values are read, update, delete and order * @type {Array} * @memberof SharePolicy */ permissions: Array; /** * An array of group UUID\'s retrieved from the RBAC Service with whom the resource has to be shared. * @type {Array} * @memberof SharePolicy */ group_uuids: Array; } /** * @export * @enum {string} */ export declare enum SharePolicyPermissionsEnum { Read = "read", Update = "update", Delete = "delete", Order = "order" } /** * * @export * @interface SubstitutionParameters */ export interface SubstitutionParameters { /** * substitutable string * @type {string} * @memberof SubstitutionParameters */ attributes?: SubstitutionParametersAttributesEnum; } /** * @export * @enum {string} */ export declare enum SubstitutionParametersAttributesEnum { OrderApprovalDecision = "order.approval.decision", OrderApprovalReason = "order.approval.reason", OrderApprovalUpdatedAt = "order.approval.updated_at", OrderCreatedAt = "order.created_at", OrderOrderId = "order.order_id", OrderOrderedByEmail = "order.ordered_by.email", OrderOrderedByName = "order.ordered_by.name", ProductDescription = "product.description", ProductHelpUrl = "product.help_url", ProductLongDescription = "product.long_description", ProductName = "product.name", ProductPlatform = "product.platform", ProductPortfolioDescription = "product.portfolio.description", ProductPortfolioName = "product.portfolio.name", ProductStatus = "product.status", ProductSupportUrl = "product.support_url", ProductVendor = "product.vendor" } /** * * @export * @interface Tag */ export interface Tag { /** * * @type {string} * @memberof Tag */ tag?: string; } /** * * @export * @interface TagsCollection */ export interface TagsCollection { /** * * @type {CollectionMetadata} * @memberof TagsCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof TagsCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof TagsCollection */ data?: Array; } /** * * @export * @interface Tenant */ export interface Tenant { /** * The Request account number * @type {string} * @memberof Tenant */ external_tenant?: string; /** * The internal tenant id * @type {string} * @memberof Tenant */ id?: string; /** * Tenant Seeded * @type {boolean} * @memberof Tenant */ seeded?: boolean; } /** * The tenant settings and schema * @export * @interface TenantSettings */ export interface TenantSettings { /** * The current settings for this tenant * @type {object} * @memberof TenantSettings */ current?: object; /** * JSON Schema for the Tenant Settings * @type {object} * @memberof TenantSettings */ schema?: object; } /** * * @export * @interface TenantsCollection */ export interface TenantsCollection { /** * * @type {CollectionMetadata} * @memberof TenantsCollection */ meta?: CollectionMetadata; /** * * @type {CollectionLinks} * @memberof TenantsCollection */ links?: CollectionLinks; /** * * @type {Array} * @memberof TenantsCollection */ data?: Array; } /** * * @export * @interface UnsharePolicy */ export interface UnsharePolicy { /** * The permissions to remove for this resource. * @type {Array} * @memberof UnsharePolicy */ permissions: Array; /** * An array of group UUID\'s retrieved from the RBAC Service from which the permissions have to be removed. If group uuids are not specified we will unshare it from all groups. * @type {Array} * @memberof UnsharePolicy */ group_uuids?: Array; } /** * @export * @enum {string} */ export declare enum UnsharePolicyPermissionsEnum { Read = "read", Update = "update", Delete = "delete", Order = "order" } /** * DefaultApi - axios parameter creator * @export */ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Return this API document in JSON format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDocumentation: (options?: any) => Promise; /** * Performs a GraphQL Query * @summary Perform a GraphQL Query * @param {GraphQLRequest} graphQLRequest GraphQL Query Request * @param {*} [options] Override http request option. * @throws {RequiredError} */ postGraphQL: (graphQLRequest: GraphQLRequest, options?: any) => Promise; }; /** * DefaultApi - functional programming interface * @export */ export declare const DefaultApiFp: (configuration?: Configuration) => { /** * * @summary Return this API document in JSON format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDocumentation(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Performs a GraphQL Query * @summary Perform a GraphQL Query * @param {GraphQLRequest} graphQLRequest GraphQL Query Request * @param {*} [options] Override http request option. * @throws {RequiredError} */ postGraphQL(graphQLRequest: GraphQLRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DefaultApi - factory interface * @export */ export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Return this API document in JSON format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDocumentation(options?: any): AxiosPromise; /** * Performs a GraphQL Query * @summary Perform a GraphQL Query * @param {GraphQLRequest} graphQLRequest GraphQL Query Request * @param {*} [options] Override http request option. * @throws {RequiredError} */ postGraphQL(graphQLRequest: GraphQLRequest, options?: any): AxiosPromise; }; /** * DefaultApi - object-oriented interface * @export * @class DefaultApi * @extends {BaseAPI} */ export declare class DefaultApi extends BaseAPI { /** * * @summary Return this API document in JSON format * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getDocumentation(options?: any): Promise>; /** * Performs a GraphQL Query * @summary Perform a GraphQL Query * @param {GraphQLRequest} graphQLRequest GraphQL Query Request * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ postGraphQL(graphQLRequest: GraphQLRequest, options?: any): Promise>; } /** * IconApi - axios parameter creator * @export */ export declare const IconApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates an Icon from the specified parameters * @summary Create an Icon * @param {any} [content] The binary image contents, maximum size is 250KB * @param {string} [portfolioId] The Portfolio this Icon belongs to * @param {string} [portfolioItemId] The Portfolio Item this Icon belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIcon: (content?: any, portfolioId?: string, portfolioItemId?: string, options?: any) => Promise; /** * Deletes the icon based on the icon ID passed * @summary Delete an existing Icon * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyIcon: (id: string, options?: any) => Promise; }; /** * IconApi - functional programming interface * @export */ export declare const IconApiFp: (configuration?: Configuration) => { /** * Creates an Icon from the specified parameters * @summary Create an Icon * @param {any} [content] The binary image contents, maximum size is 250KB * @param {string} [portfolioId] The Portfolio this Icon belongs to * @param {string} [portfolioItemId] The Portfolio Item this Icon belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIcon(content?: any, portfolioId?: string, portfolioItemId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the icon based on the icon ID passed * @summary Delete an existing Icon * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyIcon(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IconApi - factory interface * @export */ export declare const IconApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates an Icon from the specified parameters * @summary Create an Icon * @param {any} [content] The binary image contents, maximum size is 250KB * @param {string} [portfolioId] The Portfolio this Icon belongs to * @param {string} [portfolioItemId] The Portfolio Item this Icon belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIcon(content?: any, portfolioId?: string, portfolioItemId?: string, options?: any): AxiosPromise; /** * Deletes the icon based on the icon ID passed * @summary Delete an existing Icon * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyIcon(id: string, options?: any): AxiosPromise; }; /** * IconApi - object-oriented interface * @export * @class IconApi * @extends {BaseAPI} */ export declare class IconApi extends BaseAPI { /** * Creates an Icon from the specified parameters * @summary Create an Icon * @param {any} [content] The binary image contents, maximum size is 250KB * @param {string} [portfolioId] The Portfolio this Icon belongs to * @param {string} [portfolioItemId] The Portfolio Item this Icon belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IconApi */ createIcon(content?: any, portfolioId?: string, portfolioItemId?: string, options?: any): Promise>; /** * Deletes the icon based on the icon ID passed * @summary Delete an existing Icon * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IconApi */ destroyIcon(id: string, options?: any): Promise>; } /** * OrderApi - axios parameter creator * @export */ export declare const OrderApiAxiosParamCreator: (configuration?: Configuration) => { /** * Adds an order item to an order in pending state * @summary Add an order item to an order in pending state * @param {string} orderId The Order ID * @param {OrderItem} orderItem * @param {*} [options] Override http request option. * @throws {RequiredError} */ addToOrder: (orderId: string, orderItem: OrderItem, options?: any) => Promise; /** * Returns an updated order. * @summary Cancels a given order * @param {string} orderId The Order ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrder: (orderId: string, options?: any) => Promise; /** * Creates a new order. * @summary Create a new order * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrder: (options?: any) => Promise; /** * Deletes the Order based on order ID passed * @summary Delete an existing Order * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrder: (id: string, options?: any) => Promise; /** * Gets a list of items associated with an order. * @summary Gets a list of items in a given order * @param {string} orderId The Order ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItemsFromOrder: (orderId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Gets a list of progress messages associated with an order. As the order is being processed the provider can update the progress messages. * @summary Gets a list of progress messages in an order * @param {string} orderId The Order ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderProgressMessages: (orderId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Gets a list of orders associated with the logged in user. * @summary Get a list of orders * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrders: (limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Restores the order specified by the order ID. * @summary Restore specific Order * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreOrder: (id: string, restoreKey: RestoreKey, options?: any) => Promise; /** * Get a specific order based on the order ID * @summary Get a specific order * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrder: (id: string, options?: any) => Promise; /** * Gets an order item associated with an order. * @summary Gets an individual order item from a given order * @param {string} orderId The Order ID * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderItemFromOrder: (orderId: string, id: string, options?: any) => Promise; /** * Returns an updated order. * @summary Submit a given order * @param {string} orderId The Order ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitOrder: (orderId: string, options?: any) => Promise; }; /** * OrderApi - functional programming interface * @export */ export declare const OrderApiFp: (configuration?: Configuration) => { /** * Adds an order item to an order in pending state * @summary Add an order item to an order in pending state * @param {string} orderId The Order ID * @param {OrderItem} orderItem * @param {*} [options] Override http request option. * @throws {RequiredError} */ addToOrder(orderId: string, orderItem: OrderItem, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns an updated order. * @summary Cancels a given order * @param {string} orderId The Order ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrder(orderId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new order. * @summary Create a new order * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrder(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the Order based on order ID passed * @summary Delete an existing Order * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrder(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of items associated with an order. * @summary Gets a list of items in a given order * @param {string} orderId The Order ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItemsFromOrder(orderId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of progress messages associated with an order. As the order is being processed the provider can update the progress messages. * @summary Gets a list of progress messages in an order * @param {string} orderId The Order ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderProgressMessages(orderId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of orders associated with the logged in user. * @summary Get a list of orders * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrders(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Restores the order specified by the order ID. * @summary Restore specific Order * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreOrder(id: string, restoreKey: RestoreKey, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a specific order based on the order ID * @summary Get a specific order * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrder(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets an order item associated with an order. * @summary Gets an individual order item from a given order * @param {string} orderId The Order ID * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderItemFromOrder(orderId: string, id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns an updated order. * @summary Submit a given order * @param {string} orderId The Order ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitOrder(orderId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OrderApi - factory interface * @export */ export declare const OrderApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Adds an order item to an order in pending state * @summary Add an order item to an order in pending state * @param {string} orderId The Order ID * @param {OrderItem} orderItem * @param {*} [options] Override http request option. * @throws {RequiredError} */ addToOrder(orderId: string, orderItem: OrderItem, options?: any): AxiosPromise; /** * Returns an updated order. * @summary Cancels a given order * @param {string} orderId The Order ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrder(orderId: string, options?: any): AxiosPromise; /** * Creates a new order. * @summary Create a new order * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrder(options?: any): AxiosPromise; /** * Deletes the Order based on order ID passed * @summary Delete an existing Order * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrder(id: string, options?: any): AxiosPromise; /** * Gets a list of items associated with an order. * @summary Gets a list of items in a given order * @param {string} orderId The Order ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItemsFromOrder(orderId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Gets a list of progress messages associated with an order. As the order is being processed the provider can update the progress messages. * @summary Gets a list of progress messages in an order * @param {string} orderId The Order ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderProgressMessages(orderId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Gets a list of orders associated with the logged in user. * @summary Get a list of orders * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrders(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Restores the order specified by the order ID. * @summary Restore specific Order * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreOrder(id: string, restoreKey: RestoreKey, options?: any): AxiosPromise; /** * Get a specific order based on the order ID * @summary Get a specific order * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrder(id: string, options?: any): AxiosPromise; /** * Gets an order item associated with an order. * @summary Gets an individual order item from a given order * @param {string} orderId The Order ID * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderItemFromOrder(orderId: string, id: string, options?: any): AxiosPromise; /** * Returns an updated order. * @summary Submit a given order * @param {string} orderId The Order ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitOrder(orderId: string, options?: any): AxiosPromise; }; /** * OrderApi - object-oriented interface * @export * @class OrderApi * @extends {BaseAPI} */ export declare class OrderApi extends BaseAPI { /** * Adds an order item to an order in pending state * @summary Add an order item to an order in pending state * @param {string} orderId The Order ID * @param {OrderItem} orderItem * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ addToOrder(orderId: string, orderItem: OrderItem, options?: any): Promise>; /** * Returns an updated order. * @summary Cancels a given order * @param {string} orderId The Order ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ cancelOrder(orderId: string, options?: any): Promise>; /** * Creates a new order. * @summary Create a new order * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ createOrder(options?: any): Promise>; /** * Deletes the Order based on order ID passed * @summary Delete an existing Order * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ destroyOrder(id: string, options?: any): Promise>; /** * Gets a list of items associated with an order. * @summary Gets a list of items in a given order * @param {string} orderId The Order ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ listOrderItemsFromOrder(orderId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Gets a list of progress messages associated with an order. As the order is being processed the provider can update the progress messages. * @summary Gets a list of progress messages in an order * @param {string} orderId The Order ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ listOrderProgressMessages(orderId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Gets a list of orders associated with the logged in user. * @summary Get a list of orders * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ listOrders(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Restores the order specified by the order ID. * @summary Restore specific Order * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ restoreOrder(id: string, restoreKey: RestoreKey, options?: any): Promise>; /** * Get a specific order based on the order ID * @summary Get a specific order * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ showOrder(id: string, options?: any): Promise>; /** * Gets an order item associated with an order. * @summary Gets an individual order item from a given order * @param {string} orderId The Order ID * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ showOrderItemFromOrder(orderId: string, id: string, options?: any): Promise>; /** * Returns an updated order. * @summary Submit a given order * @param {string} orderId The Order ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ submitOrder(orderId: string, options?: any): Promise>; } /** * OrderItemApi - axios parameter creator * @export */ export declare const OrderItemApiAxiosParamCreator: (configuration?: Configuration) => { /** * Deletes the order item based on order item ID passed * @summary Delete an existing OrderItem * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrderItem: (id: string, options?: any) => Promise; /** * Gets a list of approval request associated with an order item. As the item is being approved one can check the status of the approvals. * @summary Gets a list of approval requests for an item * @param {string} orderItemId The Order Item ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listApprovalRequests: (orderItemId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Gets a list of progress messages associated with an order item. As the item is being processed the provider can update the progress messages. * @summary Gets a list of progress messages in an item * @param {string} orderItemId The Order Item ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItemProgressMessages: (orderItemId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Gets a list of order items. * @summary List Order Items * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItems: (limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Restores the order item specified by the order item ID. * @summary Restore specific Order item * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreOrderItem: (id: string, restoreKey: RestoreKey, options?: any) => Promise; /** * Gets a specific order item based on the order item ID passed * @summary Gets a specific order item * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderItem: (id: string, options?: any) => Promise; }; /** * OrderItemApi - functional programming interface * @export */ export declare const OrderItemApiFp: (configuration?: Configuration) => { /** * Deletes the order item based on order item ID passed * @summary Delete an existing OrderItem * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrderItem(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of approval request associated with an order item. As the item is being approved one can check the status of the approvals. * @summary Gets a list of approval requests for an item * @param {string} orderItemId The Order Item ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listApprovalRequests(orderItemId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of progress messages associated with an order item. As the item is being processed the provider can update the progress messages. * @summary Gets a list of progress messages in an item * @param {string} orderItemId The Order Item ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItemProgressMessages(orderItemId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of order items. * @summary List Order Items * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItems(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Restores the order item specified by the order item ID. * @summary Restore specific Order item * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreOrderItem(id: string, restoreKey: RestoreKey, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a specific order item based on the order item ID passed * @summary Gets a specific order item * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderItem(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OrderItemApi - factory interface * @export */ export declare const OrderItemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Deletes the order item based on order item ID passed * @summary Delete an existing OrderItem * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrderItem(id: string, options?: any): AxiosPromise; /** * Gets a list of approval request associated with an order item. As the item is being approved one can check the status of the approvals. * @summary Gets a list of approval requests for an item * @param {string} orderItemId The Order Item ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listApprovalRequests(orderItemId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Gets a list of progress messages associated with an order item. As the item is being processed the provider can update the progress messages. * @summary Gets a list of progress messages in an item * @param {string} orderItemId The Order Item ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItemProgressMessages(orderItemId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Gets a list of order items. * @summary List Order Items * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderItems(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Restores the order item specified by the order item ID. * @summary Restore specific Order item * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreOrderItem(id: string, restoreKey: RestoreKey, options?: any): AxiosPromise; /** * Gets a specific order item based on the order item ID passed * @summary Gets a specific order item * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderItem(id: string, options?: any): AxiosPromise; }; /** * OrderItemApi - object-oriented interface * @export * @class OrderItemApi * @extends {BaseAPI} */ export declare class OrderItemApi extends BaseAPI { /** * Deletes the order item based on order item ID passed * @summary Delete an existing OrderItem * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderItemApi */ destroyOrderItem(id: string, options?: any): Promise>; /** * Gets a list of approval request associated with an order item. As the item is being approved one can check the status of the approvals. * @summary Gets a list of approval requests for an item * @param {string} orderItemId The Order Item ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderItemApi */ listApprovalRequests(orderItemId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Gets a list of progress messages associated with an order item. As the item is being processed the provider can update the progress messages. * @summary Gets a list of progress messages in an item * @param {string} orderItemId The Order Item ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderItemApi */ listOrderItemProgressMessages(orderItemId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Gets a list of order items. * @summary List Order Items * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderItemApi */ listOrderItems(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Restores the order item specified by the order item ID. * @summary Restore specific Order item * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderItemApi */ restoreOrderItem(id: string, restoreKey: RestoreKey, options?: any): Promise>; /** * Gets a specific order item based on the order item ID passed * @summary Gets a specific order item * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderItemApi */ showOrderItem(id: string, options?: any): Promise>; } /** * OrderProcessApi - axios parameter creator * @export */ export declare const OrderProcessApiAxiosParamCreator: (configuration?: Configuration) => { /** * Defines the product that will be executed after ordering when using this Order Process * @summary Adds an \'after\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessAfterItem: (id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any) => Promise; /** * Defines the product that will be executed before ordering when using this Order Process * @summary Adds a \'before\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessBeforeItem: (id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any) => Promise; /** * Defines the product that will be executed on return when using this Order Process * @summary Adds \'return\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessReturnItem: (id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any) => Promise; /** * Adds an order process. * @summary Add a new order process * @param {OrderProcess} orderProcess Parameters needed to add an OrderProcess * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrderProcess: (orderProcess: OrderProcess, options?: any) => Promise; /** * Deletes the order process specified by the ID. * @summary Delete an existing order process * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrderProcess: (id: string, options?: any) => Promise; /** * Links a tag to an order process * @summary Links a tag to an order process * @param {string} id ID of the resource * @param {ResourceObject} resourceObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkTagToOrderProcess: (id: string, resourceObject: ResourceObject, options?: any) => Promise; /** * Gets a list of order processes. Optionally select order processes linked to a resource object whose app_name, object_type and object_id are specified by query parameters. * @summary List OrderProcesses * @param {string} [appName] Name of the application. * @param {string} [objectId] Id of the resource object. * @param {string} [objectType] Type of the resource object. * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderProcesses: (appName?: string, objectId?: string, objectType?: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Removes the association to the product(s) defined in the \'before\' and/or \'after\' that would be executed when using this Order Process * @summary Removes the \'before\' and/or \'after\' product(s) for an Order Process * @param {string} id ID of the resource * @param {OrderProcessAssociationsToRemove} orderProcessAssociationsToRemove * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeOrderProcessAssociation: (id: string, orderProcessAssociationsToRemove: OrderProcessAssociationsToRemove, options?: any) => Promise; /** * Adjust the position of an order process related to others by an offset number * @summary Adjust the position of an order process * @param {string} id ID of the resource * @param {Reposition} reposition How many levels should the sequence be brought up or down * @param {*} [options] Override http request option. * @throws {RequiredError} */ reposition: (id: string, reposition: Reposition, options?: any) => Promise; /** * Gets the order process specified by the order process ID. * @summary Get a specific order process * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderProcess: (id: string, options?: any) => Promise; /** * Unlinks a tag from an order process * @summary Unlinks a tag from an order process * @param {string} id ID of the resource * @param {ResourceObject} resourceObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkTagFromOrderProcess: (id: string, resourceObject: ResourceObject, options?: any) => Promise; /** * Returns the edited order process. * @summary Edit an existing order process * @param {string} id ID of the resource * @param {OrderProcess} orderProcess Parameters needed to update a OrderProcess * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOrderProcess: (id: string, orderProcess: OrderProcess, options?: any) => Promise; }; /** * OrderProcessApi - functional programming interface * @export */ export declare const OrderProcessApiFp: (configuration?: Configuration) => { /** * Defines the product that will be executed after ordering when using this Order Process * @summary Adds an \'after\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessAfterItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Defines the product that will be executed before ordering when using this Order Process * @summary Adds a \'before\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessBeforeItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Defines the product that will be executed on return when using this Order Process * @summary Adds \'return\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessReturnItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adds an order process. * @summary Add a new order process * @param {OrderProcess} orderProcess Parameters needed to add an OrderProcess * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrderProcess(orderProcess: OrderProcess, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the order process specified by the ID. * @summary Delete an existing order process * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrderProcess(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Links a tag to an order process * @summary Links a tag to an order process * @param {string} id ID of the resource * @param {ResourceObject} resourceObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkTagToOrderProcess(id: string, resourceObject: ResourceObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of order processes. Optionally select order processes linked to a resource object whose app_name, object_type and object_id are specified by query parameters. * @summary List OrderProcesses * @param {string} [appName] Name of the application. * @param {string} [objectId] Id of the resource object. * @param {string} [objectType] Type of the resource object. * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderProcesses(appName?: string, objectId?: string, objectType?: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes the association to the product(s) defined in the \'before\' and/or \'after\' that would be executed when using this Order Process * @summary Removes the \'before\' and/or \'after\' product(s) for an Order Process * @param {string} id ID of the resource * @param {OrderProcessAssociationsToRemove} orderProcessAssociationsToRemove * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeOrderProcessAssociation(id: string, orderProcessAssociationsToRemove: OrderProcessAssociationsToRemove, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adjust the position of an order process related to others by an offset number * @summary Adjust the position of an order process * @param {string} id ID of the resource * @param {Reposition} reposition How many levels should the sequence be brought up or down * @param {*} [options] Override http request option. * @throws {RequiredError} */ reposition(id: string, reposition: Reposition, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the order process specified by the order process ID. * @summary Get a specific order process * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderProcess(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Unlinks a tag from an order process * @summary Unlinks a tag from an order process * @param {string} id ID of the resource * @param {ResourceObject} resourceObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkTagFromOrderProcess(id: string, resourceObject: ResourceObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the edited order process. * @summary Edit an existing order process * @param {string} id ID of the resource * @param {OrderProcess} orderProcess Parameters needed to update a OrderProcess * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOrderProcess(id: string, orderProcess: OrderProcess, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OrderProcessApi - factory interface * @export */ export declare const OrderProcessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Defines the product that will be executed after ordering when using this Order Process * @summary Adds an \'after\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessAfterItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): AxiosPromise; /** * Defines the product that will be executed before ordering when using this Order Process * @summary Adds a \'before\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessBeforeItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): AxiosPromise; /** * Defines the product that will be executed on return when using this Order Process * @summary Adds \'return\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrderProcessReturnItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): AxiosPromise; /** * Adds an order process. * @summary Add a new order process * @param {OrderProcess} orderProcess Parameters needed to add an OrderProcess * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrderProcess(orderProcess: OrderProcess, options?: any): AxiosPromise; /** * Deletes the order process specified by the ID. * @summary Delete an existing order process * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyOrderProcess(id: string, options?: any): AxiosPromise; /** * Links a tag to an order process * @summary Links a tag to an order process * @param {string} id ID of the resource * @param {ResourceObject} resourceObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkTagToOrderProcess(id: string, resourceObject: ResourceObject, options?: any): AxiosPromise; /** * Gets a list of order processes. Optionally select order processes linked to a resource object whose app_name, object_type and object_id are specified by query parameters. * @summary List OrderProcesses * @param {string} [appName] Name of the application. * @param {string} [objectId] Id of the resource object. * @param {string} [objectType] Type of the resource object. * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrderProcesses(appName?: string, objectId?: string, objectType?: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Removes the association to the product(s) defined in the \'before\' and/or \'after\' that would be executed when using this Order Process * @summary Removes the \'before\' and/or \'after\' product(s) for an Order Process * @param {string} id ID of the resource * @param {OrderProcessAssociationsToRemove} orderProcessAssociationsToRemove * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeOrderProcessAssociation(id: string, orderProcessAssociationsToRemove: OrderProcessAssociationsToRemove, options?: any): AxiosPromise; /** * Adjust the position of an order process related to others by an offset number * @summary Adjust the position of an order process * @param {string} id ID of the resource * @param {Reposition} reposition How many levels should the sequence be brought up or down * @param {*} [options] Override http request option. * @throws {RequiredError} */ reposition(id: string, reposition: Reposition, options?: any): AxiosPromise; /** * Gets the order process specified by the order process ID. * @summary Get a specific order process * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showOrderProcess(id: string, options?: any): AxiosPromise; /** * Unlinks a tag from an order process * @summary Unlinks a tag from an order process * @param {string} id ID of the resource * @param {ResourceObject} resourceObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkTagFromOrderProcess(id: string, resourceObject: ResourceObject, options?: any): AxiosPromise; /** * Returns the edited order process. * @summary Edit an existing order process * @param {string} id ID of the resource * @param {OrderProcess} orderProcess Parameters needed to update a OrderProcess * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOrderProcess(id: string, orderProcess: OrderProcess, options?: any): AxiosPromise; }; /** * OrderProcessApi - object-oriented interface * @export * @class OrderProcessApi * @extends {BaseAPI} */ export declare class OrderProcessApi extends BaseAPI { /** * Defines the product that will be executed after ordering when using this Order Process * @summary Adds an \'after\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ addOrderProcessAfterItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): Promise>; /** * Defines the product that will be executed before ordering when using this Order Process * @summary Adds a \'before\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ addOrderProcessBeforeItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): Promise>; /** * Defines the product that will be executed on return when using this Order Process * @summary Adds \'return\' product for an Order Process * @param {string} id ID of the resource * @param {OrderProcessPortfolioItemId} orderProcessPortfolioItemId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ addOrderProcessReturnItem(id: string, orderProcessPortfolioItemId: OrderProcessPortfolioItemId, options?: any): Promise>; /** * Adds an order process. * @summary Add a new order process * @param {OrderProcess} orderProcess Parameters needed to add an OrderProcess * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ createOrderProcess(orderProcess: OrderProcess, options?: any): Promise>; /** * Deletes the order process specified by the ID. * @summary Delete an existing order process * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ destroyOrderProcess(id: string, options?: any): Promise>; /** * Links a tag to an order process * @summary Links a tag to an order process * @param {string} id ID of the resource * @param {ResourceObject} resourceObject * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ linkTagToOrderProcess(id: string, resourceObject: ResourceObject, options?: any): Promise>; /** * Gets a list of order processes. Optionally select order processes linked to a resource object whose app_name, object_type and object_id are specified by query parameters. * @summary List OrderProcesses * @param {string} [appName] Name of the application. * @param {string} [objectId] Id of the resource object. * @param {string} [objectType] Type of the resource object. * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ listOrderProcesses(appName?: string, objectId?: string, objectType?: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Removes the association to the product(s) defined in the \'before\' and/or \'after\' that would be executed when using this Order Process * @summary Removes the \'before\' and/or \'after\' product(s) for an Order Process * @param {string} id ID of the resource * @param {OrderProcessAssociationsToRemove} orderProcessAssociationsToRemove * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ removeOrderProcessAssociation(id: string, orderProcessAssociationsToRemove: OrderProcessAssociationsToRemove, options?: any): Promise>; /** * Adjust the position of an order process related to others by an offset number * @summary Adjust the position of an order process * @param {string} id ID of the resource * @param {Reposition} reposition How many levels should the sequence be brought up or down * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ reposition(id: string, reposition: Reposition, options?: any): Promise>; /** * Gets the order process specified by the order process ID. * @summary Get a specific order process * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ showOrderProcess(id: string, options?: any): Promise>; /** * Unlinks a tag from an order process * @summary Unlinks a tag from an order process * @param {string} id ID of the resource * @param {ResourceObject} resourceObject * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ unlinkTagFromOrderProcess(id: string, resourceObject: ResourceObject, options?: any): Promise>; /** * Returns the edited order process. * @summary Edit an existing order process * @param {string} id ID of the resource * @param {OrderProcess} orderProcess Parameters needed to update a OrderProcess * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderProcessApi */ updateOrderProcess(id: string, orderProcess: OrderProcess, options?: any): Promise>; } /** * PortfolioApi - axios parameter creator * @export */ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configuration) => { /** * Adds a single tag to Portfolio object * @summary Add Tag for Portfolio * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPortfolioTag: (id: string, tag: Array, options?: any) => Promise; /** * Adds a portfolio. * @summary Add a new portfolio * @param {Portfolio} portfolio Parameters needed to add a Portfolio * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPortfolio: (portfolio: Portfolio, options?: any) => Promise; /** * Deletes the portfolio specified by the ID. * @summary Delete an existing portfolio * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyPortfolio: (id: string, options?: any) => Promise; /** * Gets all portfilio items in the portfolio specified by the given ID. * @summary Get all portfolio items from a specific portfolio * @param {string} portfolioId The Portfolio ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchPortfolioItemsWithPortfolio: (portfolioId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Returns an array of Tag objects * @summary List Tags for Portfolio * @param {string} id ID of the resource * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioTags: (id: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Gets a list of portfolios. * @summary List portfolios * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolios: (limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Make a copy of the Portfolio. * @summary Make a copy of the Portfolio * @param {string} portfolioId The Portfolio ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCopyPortfolio: (portfolioId: string, options?: any) => Promise; /** * Remove Tags from Portfolio * @summary Remove Tags from Portfolio * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePortfolioTags: (id: string, tag: Array, options?: any) => Promise; /** * Fetch share information about a portfolio * @summary Fetch share information about this portfolio, the response would include a collection of groups and permissions with each group * @param {string} portfolioId The Portfolio ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ shareInfo: (portfolioId: string, options?: any) => Promise; /** * Share a Portfolio with one or more groups with specific permissions * @summary Share a portfolio with one or more groups with specific permission * @param {string} portfolioId The Portfolio ID * @param {SharePolicy} sharePolicy * @param {*} [options] Override http request option. * @throws {RequiredError} */ sharePortfolio: (portfolioId: string, sharePolicy: SharePolicy, options?: any) => Promise; /** * Gets the portfolio specified by the portfolio ID. * @summary Get a specific portfolio * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolio: (id: string, options?: any) => Promise; /** * Fetch the specified portfolio\'s icon image. * @summary Fetches the specified portfolio\'s icon image * @param {string} portfolioId The Portfolio ID * @param {string} [cacheId] Artificial string to help avoid falsey browser cache. This can occur after changing static resources like images. The browser will return an outdated cached response. Appending different query will result in a new async call, instead of retrieving the resource from the browser cache. * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioIcon: (portfolioId: string, cacheId?: string, options?: any) => Promise; /** * Undeletes the portfolio specified by the portfolio ID. * @summary Undelete specific portfolio * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ unDeletePortfolio: (id: string, restoreKey: RestoreKey, options?: any) => Promise; /** * Unshare a Portfolio with one or more groups with specific permissions * @summary Unshare a portfolio from one or more groups with specific permission * @param {string} portfolioId The Portfolio ID * @param {UnsharePolicy} unsharePolicy * @param {*} [options] Override http request option. * @throws {RequiredError} */ unsharePortfolio: (portfolioId: string, unsharePolicy: UnsharePolicy, options?: any) => Promise; /** * Returns the edited portfolio. * @summary Edit an existing portfolio * @param {string} id ID of the resource * @param {Portfolio} portfolio Parameters needed to update a Portfolio * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePortfolio: (id: string, portfolio: Portfolio, options?: any) => Promise; }; /** * PortfolioApi - functional programming interface * @export */ export declare const PortfolioApiFp: (configuration?: Configuration) => { /** * Adds a single tag to Portfolio object * @summary Add Tag for Portfolio * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPortfolioTag(id: string, tag: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Adds a portfolio. * @summary Add a new portfolio * @param {Portfolio} portfolio Parameters needed to add a Portfolio * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPortfolio(portfolio: Portfolio, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the portfolio specified by the ID. * @summary Delete an existing portfolio * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyPortfolio(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets all portfilio items in the portfolio specified by the given ID. * @summary Get all portfolio items from a specific portfolio * @param {string} portfolioId The Portfolio ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchPortfolioItemsWithPortfolio(portfolioId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns an array of Tag objects * @summary List Tags for Portfolio * @param {string} id ID of the resource * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioTags(id: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of portfolios. * @summary List portfolios * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolios(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Make a copy of the Portfolio. * @summary Make a copy of the Portfolio * @param {string} portfolioId The Portfolio ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCopyPortfolio(portfolioId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove Tags from Portfolio * @summary Remove Tags from Portfolio * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePortfolioTags(id: string, tag: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch share information about a portfolio * @summary Fetch share information about this portfolio, the response would include a collection of groups and permissions with each group * @param {string} portfolioId The Portfolio ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ shareInfo(portfolioId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Share a Portfolio with one or more groups with specific permissions * @summary Share a portfolio with one or more groups with specific permission * @param {string} portfolioId The Portfolio ID * @param {SharePolicy} sharePolicy * @param {*} [options] Override http request option. * @throws {RequiredError} */ sharePortfolio(portfolioId: string, sharePolicy: SharePolicy, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the portfolio specified by the portfolio ID. * @summary Get a specific portfolio * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolio(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch the specified portfolio\'s icon image. * @summary Fetches the specified portfolio\'s icon image * @param {string} portfolioId The Portfolio ID * @param {string} [cacheId] Artificial string to help avoid falsey browser cache. This can occur after changing static resources like images. The browser will return an outdated cached response. Appending different query will result in a new async call, instead of retrieving the resource from the browser cache. * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioIcon(portfolioId: string, cacheId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Undeletes the portfolio specified by the portfolio ID. * @summary Undelete specific portfolio * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ unDeletePortfolio(id: string, restoreKey: RestoreKey, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Unshare a Portfolio with one or more groups with specific permissions * @summary Unshare a portfolio from one or more groups with specific permission * @param {string} portfolioId The Portfolio ID * @param {UnsharePolicy} unsharePolicy * @param {*} [options] Override http request option. * @throws {RequiredError} */ unsharePortfolio(portfolioId: string, unsharePolicy: UnsharePolicy, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the edited portfolio. * @summary Edit an existing portfolio * @param {string} id ID of the resource * @param {Portfolio} portfolio Parameters needed to update a Portfolio * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePortfolio(id: string, portfolio: Portfolio, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PortfolioApi - factory interface * @export */ export declare const PortfolioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Adds a single tag to Portfolio object * @summary Add Tag for Portfolio * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPortfolioTag(id: string, tag: Array, options?: any): AxiosPromise>; /** * Adds a portfolio. * @summary Add a new portfolio * @param {Portfolio} portfolio Parameters needed to add a Portfolio * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPortfolio(portfolio: Portfolio, options?: any): AxiosPromise; /** * Deletes the portfolio specified by the ID. * @summary Delete an existing portfolio * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyPortfolio(id: string, options?: any): AxiosPromise; /** * Gets all portfilio items in the portfolio specified by the given ID. * @summary Get all portfolio items from a specific portfolio * @param {string} portfolioId The Portfolio ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchPortfolioItemsWithPortfolio(portfolioId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Returns an array of Tag objects * @summary List Tags for Portfolio * @param {string} id ID of the resource * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioTags(id: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Gets a list of portfolios. * @summary List portfolios * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolios(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Make a copy of the Portfolio. * @summary Make a copy of the Portfolio * @param {string} portfolioId The Portfolio ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCopyPortfolio(portfolioId: string, options?: any): AxiosPromise; /** * Remove Tags from Portfolio * @summary Remove Tags from Portfolio * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePortfolioTags(id: string, tag: Array, options?: any): AxiosPromise; /** * Fetch share information about a portfolio * @summary Fetch share information about this portfolio, the response would include a collection of groups and permissions with each group * @param {string} portfolioId The Portfolio ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ shareInfo(portfolioId: string, options?: any): AxiosPromise>; /** * Share a Portfolio with one or more groups with specific permissions * @summary Share a portfolio with one or more groups with specific permission * @param {string} portfolioId The Portfolio ID * @param {SharePolicy} sharePolicy * @param {*} [options] Override http request option. * @throws {RequiredError} */ sharePortfolio(portfolioId: string, sharePolicy: SharePolicy, options?: any): AxiosPromise; /** * Gets the portfolio specified by the portfolio ID. * @summary Get a specific portfolio * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolio(id: string, options?: any): AxiosPromise; /** * Fetch the specified portfolio\'s icon image. * @summary Fetches the specified portfolio\'s icon image * @param {string} portfolioId The Portfolio ID * @param {string} [cacheId] Artificial string to help avoid falsey browser cache. This can occur after changing static resources like images. The browser will return an outdated cached response. Appending different query will result in a new async call, instead of retrieving the resource from the browser cache. * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioIcon(portfolioId: string, cacheId?: string, options?: any): AxiosPromise; /** * Undeletes the portfolio specified by the portfolio ID. * @summary Undelete specific portfolio * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ unDeletePortfolio(id: string, restoreKey: RestoreKey, options?: any): AxiosPromise; /** * Unshare a Portfolio with one or more groups with specific permissions * @summary Unshare a portfolio from one or more groups with specific permission * @param {string} portfolioId The Portfolio ID * @param {UnsharePolicy} unsharePolicy * @param {*} [options] Override http request option. * @throws {RequiredError} */ unsharePortfolio(portfolioId: string, unsharePolicy: UnsharePolicy, options?: any): AxiosPromise; /** * Returns the edited portfolio. * @summary Edit an existing portfolio * @param {string} id ID of the resource * @param {Portfolio} portfolio Parameters needed to update a Portfolio * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePortfolio(id: string, portfolio: Portfolio, options?: any): AxiosPromise; }; /** * PortfolioApi - object-oriented interface * @export * @class PortfolioApi * @extends {BaseAPI} */ export declare class PortfolioApi extends BaseAPI { /** * Adds a single tag to Portfolio object * @summary Add Tag for Portfolio * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ addPortfolioTag(id: string, tag: Array, options?: any): Promise>; /** * Adds a portfolio. * @summary Add a new portfolio * @param {Portfolio} portfolio Parameters needed to add a Portfolio * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ createPortfolio(portfolio: Portfolio, options?: any): Promise>; /** * Deletes the portfolio specified by the ID. * @summary Delete an existing portfolio * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ destroyPortfolio(id: string, options?: any): Promise>; /** * Gets all portfilio items in the portfolio specified by the given ID. * @summary Get all portfolio items from a specific portfolio * @param {string} portfolioId The Portfolio ID * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ fetchPortfolioItemsWithPortfolio(portfolioId: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Returns an array of Tag objects * @summary List Tags for Portfolio * @param {string} id ID of the resource * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ listPortfolioTags(id: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Gets a list of portfolios. * @summary List portfolios * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ listPortfolios(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Make a copy of the Portfolio. * @summary Make a copy of the Portfolio * @param {string} portfolioId The Portfolio ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ postCopyPortfolio(portfolioId: string, options?: any): Promise>; /** * Remove Tags from Portfolio * @summary Remove Tags from Portfolio * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ removePortfolioTags(id: string, tag: Array, options?: any): Promise>; /** * Fetch share information about a portfolio * @summary Fetch share information about this portfolio, the response would include a collection of groups and permissions with each group * @param {string} portfolioId The Portfolio ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ shareInfo(portfolioId: string, options?: any): Promise>; /** * Share a Portfolio with one or more groups with specific permissions * @summary Share a portfolio with one or more groups with specific permission * @param {string} portfolioId The Portfolio ID * @param {SharePolicy} sharePolicy * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ sharePortfolio(portfolioId: string, sharePolicy: SharePolicy, options?: any): Promise>; /** * Gets the portfolio specified by the portfolio ID. * @summary Get a specific portfolio * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ showPortfolio(id: string, options?: any): Promise>; /** * Fetch the specified portfolio\'s icon image. * @summary Fetches the specified portfolio\'s icon image * @param {string} portfolioId The Portfolio ID * @param {string} [cacheId] Artificial string to help avoid falsey browser cache. This can occur after changing static resources like images. The browser will return an outdated cached response. Appending different query will result in a new async call, instead of retrieving the resource from the browser cache. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ showPortfolioIcon(portfolioId: string, cacheId?: string, options?: any): Promise>; /** * Undeletes the portfolio specified by the portfolio ID. * @summary Undelete specific portfolio * @param {string} id ID of the resource * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ unDeletePortfolio(id: string, restoreKey: RestoreKey, options?: any): Promise>; /** * Unshare a Portfolio with one or more groups with specific permissions * @summary Unshare a portfolio from one or more groups with specific permission * @param {string} portfolioId The Portfolio ID * @param {UnsharePolicy} unsharePolicy * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ unsharePortfolio(portfolioId: string, unsharePolicy: UnsharePolicy, options?: any): Promise>; /** * Returns the edited portfolio. * @summary Edit an existing portfolio * @param {string} id ID of the resource * @param {Portfolio} portfolio Parameters needed to update a Portfolio * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioApi */ updatePortfolio(id: string, portfolio: Portfolio, options?: any): Promise>; } /** * PortfolioItemApi - axios parameter creator * @export */ export declare const PortfolioItemApiAxiosParamCreator: (configuration?: Configuration) => { /** * Adds a single tag to a Portfolio Item object * @summary Add Tag for Portfolio Item * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPortfolioItemTag: (id: string, tag: Array, options?: any) => Promise; /** * Adds a name and description for a portfolio item and returns the newly created portfolio item. * @summary Add a new portfolio item * @param {CreatePortfolioItem} createPortfolioItem * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPortfolioItem: (createPortfolioItem: CreatePortfolioItem, options?: any) => Promise; /** * Deletes the portfolio item based on portfolio item ID passed * @summary Delete an existing portfolio item * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyPortfolioItem: (id: string, options?: any) => Promise; /** * Get the next name for a the Portfolio Item prior to a copy operation * @summary Get the next name for a the Portfolio Item prior to a copy operation * @param {string} portfolioItemId The Portfolio Item ID * @param {string} [destinationPortfolioId] The destination portfolio to compare names against * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPortfolioItemNextName: (portfolioItemId: string, destinationPortfolioId?: string, options?: any) => Promise; /** * Returns an array of Tag objects * @summary List Tags for Portfolio Items * @param {string} id ID of the resource * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioItemTags: (id: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Gets a list of portfolio items. * @summary List all portfolio items * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioItems: (limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any) => Promise; /** * Gets all service plans for a portfolio item. * @summary Gets all service plans for a specific portfolio item; requires a connection to the catalog inventory service. * @param {string} portfolioItemId The Portfolio Item ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listServicePlans: (portfolioItemId: string, options?: any) => Promise; /** * Make a copy of the Portfolio Item. * @summary Make a copy of the Portfolio Item * @param {string} portfolioItemId The Portfolio Item ID * @param {CopyPortfolioItem} [copyPortfolioItem] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCopyPortfolioItem: (portfolioItemId: string, copyPortfolioItem?: CopyPortfolioItem, options?: any) => Promise; /** * Remove Tags from Portfolio Item * @summary Remove Tags from Portfolio Item * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePortfolioItemTags: (id: string, tag: Array, options?: any) => Promise; /** * Gets a specific portfolio item based on the portfolio item ID passed * @summary Gets a specific portfolio item * @param {string} id ID of the resource * @param {boolean} [showDiscarded] Whether or not to display the discarded result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioItem: (id: string, showDiscarded?: boolean, options?: any) => Promise; /** * Fetch the specified portfolio item\'s icon image. * @summary Fetches the specified portfolio item\'s icon image * @param {string} portfolioItemId The Portfolio Item ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioItemIcon: (portfolioItemId: string, options?: any) => Promise; /** * If a record has been discarded, this operation will undelete it so it can be requested normally. * @summary Undelete a specified Portfolio Item * @param {string} portfolioItemId The Portfolio Item ID * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ unDeletePortfolioItem: (portfolioItemId: string, restoreKey: RestoreKey, options?: any) => Promise; /** * Edits portfolio item specified by the given ID. * @summary Edit an existing portfolio item * @param {string} id ID of the resource * @param {PortfolioItem} portfolioItem Parameters needed to update a Portfolio Item * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePortfolioItem: (id: string, portfolioItem: PortfolioItem, options?: any) => Promise; }; /** * PortfolioItemApi - functional programming interface * @export */ export declare const PortfolioItemApiFp: (configuration?: Configuration) => { /** * Adds a single tag to a Portfolio Item object * @summary Add Tag for Portfolio Item * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPortfolioItemTag(id: string, tag: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Adds a name and description for a portfolio item and returns the newly created portfolio item. * @summary Add a new portfolio item * @param {CreatePortfolioItem} createPortfolioItem * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPortfolioItem(createPortfolioItem: CreatePortfolioItem, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the portfolio item based on portfolio item ID passed * @summary Delete an existing portfolio item * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyPortfolioItem(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the next name for a the Portfolio Item prior to a copy operation * @summary Get the next name for a the Portfolio Item prior to a copy operation * @param {string} portfolioItemId The Portfolio Item ID * @param {string} [destinationPortfolioId] The destination portfolio to compare names against * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPortfolioItemNextName(portfolioItemId: string, destinationPortfolioId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns an array of Tag objects * @summary List Tags for Portfolio Items * @param {string} id ID of the resource * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioItemTags(id: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of portfolio items. * @summary List all portfolio items * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioItems(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets all service plans for a portfolio item. * @summary Gets all service plans for a specific portfolio item; requires a connection to the catalog inventory service. * @param {string} portfolioItemId The Portfolio Item ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listServicePlans(portfolioItemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Make a copy of the Portfolio Item. * @summary Make a copy of the Portfolio Item * @param {string} portfolioItemId The Portfolio Item ID * @param {CopyPortfolioItem} [copyPortfolioItem] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCopyPortfolioItem(portfolioItemId: string, copyPortfolioItem?: CopyPortfolioItem, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove Tags from Portfolio Item * @summary Remove Tags from Portfolio Item * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePortfolioItemTags(id: string, tag: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a specific portfolio item based on the portfolio item ID passed * @summary Gets a specific portfolio item * @param {string} id ID of the resource * @param {boolean} [showDiscarded] Whether or not to display the discarded result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioItem(id: string, showDiscarded?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch the specified portfolio item\'s icon image. * @summary Fetches the specified portfolio item\'s icon image * @param {string} portfolioItemId The Portfolio Item ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioItemIcon(portfolioItemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * If a record has been discarded, this operation will undelete it so it can be requested normally. * @summary Undelete a specified Portfolio Item * @param {string} portfolioItemId The Portfolio Item ID * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ unDeletePortfolioItem(portfolioItemId: string, restoreKey: RestoreKey, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Edits portfolio item specified by the given ID. * @summary Edit an existing portfolio item * @param {string} id ID of the resource * @param {PortfolioItem} portfolioItem Parameters needed to update a Portfolio Item * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePortfolioItem(id: string, portfolioItem: PortfolioItem, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PortfolioItemApi - factory interface * @export */ export declare const PortfolioItemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Adds a single tag to a Portfolio Item object * @summary Add Tag for Portfolio Item * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPortfolioItemTag(id: string, tag: Array, options?: any): AxiosPromise>; /** * Adds a name and description for a portfolio item and returns the newly created portfolio item. * @summary Add a new portfolio item * @param {CreatePortfolioItem} createPortfolioItem * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPortfolioItem(createPortfolioItem: CreatePortfolioItem, options?: any): AxiosPromise; /** * Deletes the portfolio item based on portfolio item ID passed * @summary Delete an existing portfolio item * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroyPortfolioItem(id: string, options?: any): AxiosPromise; /** * Get the next name for a the Portfolio Item prior to a copy operation * @summary Get the next name for a the Portfolio Item prior to a copy operation * @param {string} portfolioItemId The Portfolio Item ID * @param {string} [destinationPortfolioId] The destination portfolio to compare names against * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPortfolioItemNextName(portfolioItemId: string, destinationPortfolioId?: string, options?: any): AxiosPromise; /** * Returns an array of Tag objects * @summary List Tags for Portfolio Items * @param {string} id ID of the resource * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioItemTags(id: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Gets a list of portfolio items. * @summary List all portfolio items * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPortfolioItems(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): AxiosPromise; /** * Gets all service plans for a portfolio item. * @summary Gets all service plans for a specific portfolio item; requires a connection to the catalog inventory service. * @param {string} portfolioItemId The Portfolio Item ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listServicePlans(portfolioItemId: string, options?: any): AxiosPromise>; /** * Make a copy of the Portfolio Item. * @summary Make a copy of the Portfolio Item * @param {string} portfolioItemId The Portfolio Item ID * @param {CopyPortfolioItem} [copyPortfolioItem] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCopyPortfolioItem(portfolioItemId: string, copyPortfolioItem?: CopyPortfolioItem, options?: any): AxiosPromise; /** * Remove Tags from Portfolio Item * @summary Remove Tags from Portfolio Item * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePortfolioItemTags(id: string, tag: Array, options?: any): AxiosPromise; /** * Gets a specific portfolio item based on the portfolio item ID passed * @summary Gets a specific portfolio item * @param {string} id ID of the resource * @param {boolean} [showDiscarded] Whether or not to display the discarded result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioItem(id: string, showDiscarded?: boolean, options?: any): AxiosPromise; /** * Fetch the specified portfolio item\'s icon image. * @summary Fetches the specified portfolio item\'s icon image * @param {string} portfolioItemId The Portfolio Item ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ showPortfolioItemIcon(portfolioItemId: string, options?: any): AxiosPromise; /** * If a record has been discarded, this operation will undelete it so it can be requested normally. * @summary Undelete a specified Portfolio Item * @param {string} portfolioItemId The Portfolio Item ID * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ unDeletePortfolioItem(portfolioItemId: string, restoreKey: RestoreKey, options?: any): AxiosPromise; /** * Edits portfolio item specified by the given ID. * @summary Edit an existing portfolio item * @param {string} id ID of the resource * @param {PortfolioItem} portfolioItem Parameters needed to update a Portfolio Item * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePortfolioItem(id: string, portfolioItem: PortfolioItem, options?: any): AxiosPromise; }; /** * PortfolioItemApi - object-oriented interface * @export * @class PortfolioItemApi * @extends {BaseAPI} */ export declare class PortfolioItemApi extends BaseAPI { /** * Adds a single tag to a Portfolio Item object * @summary Add Tag for Portfolio Item * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ addPortfolioItemTag(id: string, tag: Array, options?: any): Promise>; /** * Adds a name and description for a portfolio item and returns the newly created portfolio item. * @summary Add a new portfolio item * @param {CreatePortfolioItem} createPortfolioItem * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ createPortfolioItem(createPortfolioItem: CreatePortfolioItem, options?: any): Promise>; /** * Deletes the portfolio item based on portfolio item ID passed * @summary Delete an existing portfolio item * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ destroyPortfolioItem(id: string, options?: any): Promise>; /** * Get the next name for a the Portfolio Item prior to a copy operation * @summary Get the next name for a the Portfolio Item prior to a copy operation * @param {string} portfolioItemId The Portfolio Item ID * @param {string} [destinationPortfolioId] The destination portfolio to compare names against * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ getPortfolioItemNextName(portfolioItemId: string, destinationPortfolioId?: string, options?: any): Promise>; /** * Returns an array of Tag objects * @summary List Tags for Portfolio Items * @param {string} id ID of the resource * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ listPortfolioItemTags(id: string, limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Gets a list of portfolio items. * @summary List all portfolio items * @param {number} [limit] The numbers of items to return per page. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {object} [filter] Filter for querying collections. * @param {string} [sortBy] Field to sort collection by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ listPortfolioItems(limit?: number, offset?: number, filter?: object, sortBy?: string, options?: any): Promise>; /** * Gets all service plans for a portfolio item. * @summary Gets all service plans for a specific portfolio item; requires a connection to the catalog inventory service. * @param {string} portfolioItemId The Portfolio Item ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ listServicePlans(portfolioItemId: string, options?: any): Promise>; /** * Make a copy of the Portfolio Item. * @summary Make a copy of the Portfolio Item * @param {string} portfolioItemId The Portfolio Item ID * @param {CopyPortfolioItem} [copyPortfolioItem] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ postCopyPortfolioItem(portfolioItemId: string, copyPortfolioItem?: CopyPortfolioItem, options?: any): Promise>; /** * Remove Tags from Portfolio Item * @summary Remove Tags from Portfolio Item * @param {string} id ID of the resource * @param {Array} tag * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ removePortfolioItemTags(id: string, tag: Array, options?: any): Promise>; /** * Gets a specific portfolio item based on the portfolio item ID passed * @summary Gets a specific portfolio item * @param {string} id ID of the resource * @param {boolean} [showDiscarded] Whether or not to display the discarded result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ showPortfolioItem(id: string, showDiscarded?: boolean, options?: any): Promise>; /** * Fetch the specified portfolio item\'s icon image. * @summary Fetches the specified portfolio item\'s icon image * @param {string} portfolioItemId The Portfolio Item ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ showPortfolioItemIcon(portfolioItemId: string, options?: any): Promise>; /** * If a record has been discarded, this operation will undelete it so it can be requested normally. * @summary Undelete a specified Portfolio Item * @param {string} portfolioItemId The Portfolio Item ID * @param {RestoreKey} restoreKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ unDeletePortfolioItem(portfolioItemId: string, restoreKey: RestoreKey, options?: any): Promise>; /** * Edits portfolio item specified by the given ID. * @summary Edit an existing portfolio item * @param {string} id ID of the resource * @param {PortfolioItem} portfolioItem Parameters needed to update a Portfolio Item * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PortfolioItemApi */ updatePortfolioItem(id: string, portfolioItem: PortfolioItem, options?: any): Promise>; } /** * ServicePlansApi - axios parameter creator * @export */ export declare const ServicePlansApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the new Service Plan * @summary Create Service Plan * @param {ImportServicePlan} [importServicePlan] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createServicePlan: (importServicePlan?: ImportServicePlan, options?: any) => Promise; /** * * @summary Patch Service Plan Modified Schema * @param {string} id ID of the resource * @param {PatchModifiedServicePlan} [patchModifiedServicePlan] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchServicePlanModified: (id: string, patchModifiedServicePlan?: PatchModifiedServicePlan, options?: any) => Promise; /** * Resets the Service Plan\'s Modified schema and returns the new one if it has been reset * @summary Reset Service Plan Modified schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetServicePlanModified: (id: string, options?: any) => Promise; /** * Returns the specified Service Plan * @summary Show Service Plan * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlan: (id: string, options?: any) => Promise; /** * Returns the specified Service Plan\'s base schema * @summary Show Service Plan Base Schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlanBase: (id: string, options?: any) => Promise; /** * Returns the specified Service Plan\'s modified schema * @summary Show Service Plan modified Schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlanModified: (id: string, options?: any) => Promise; }; /** * ServicePlansApi - functional programming interface * @export */ export declare const ServicePlansApiFp: (configuration?: Configuration) => { /** * Returns the new Service Plan * @summary Create Service Plan * @param {ImportServicePlan} [importServicePlan] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createServicePlan(importServicePlan?: ImportServicePlan, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary Patch Service Plan Modified Schema * @param {string} id ID of the resource * @param {PatchModifiedServicePlan} [patchModifiedServicePlan] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchServicePlanModified(id: string, patchModifiedServicePlan?: PatchModifiedServicePlan, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resets the Service Plan\'s Modified schema and returns the new one if it has been reset * @summary Reset Service Plan Modified schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetServicePlanModified(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the specified Service Plan * @summary Show Service Plan * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlan(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the specified Service Plan\'s base schema * @summary Show Service Plan Base Schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlanBase(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the specified Service Plan\'s modified schema * @summary Show Service Plan modified Schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlanModified(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ServicePlansApi - factory interface * @export */ export declare const ServicePlansApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the new Service Plan * @summary Create Service Plan * @param {ImportServicePlan} [importServicePlan] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createServicePlan(importServicePlan?: ImportServicePlan, options?: any): AxiosPromise>; /** * * @summary Patch Service Plan Modified Schema * @param {string} id ID of the resource * @param {PatchModifiedServicePlan} [patchModifiedServicePlan] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchServicePlanModified(id: string, patchModifiedServicePlan?: PatchModifiedServicePlan, options?: any): AxiosPromise; /** * Resets the Service Plan\'s Modified schema and returns the new one if it has been reset * @summary Reset Service Plan Modified schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetServicePlanModified(id: string, options?: any): AxiosPromise>; /** * Returns the specified Service Plan * @summary Show Service Plan * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlan(id: string, options?: any): AxiosPromise; /** * Returns the specified Service Plan\'s base schema * @summary Show Service Plan Base Schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlanBase(id: string, options?: any): AxiosPromise; /** * Returns the specified Service Plan\'s modified schema * @summary Show Service Plan modified Schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showServicePlanModified(id: string, options?: any): AxiosPromise; }; /** * ServicePlansApi - object-oriented interface * @export * @class ServicePlansApi * @extends {BaseAPI} */ export declare class ServicePlansApi extends BaseAPI { /** * Returns the new Service Plan * @summary Create Service Plan * @param {ImportServicePlan} [importServicePlan] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ServicePlansApi */ createServicePlan(importServicePlan?: ImportServicePlan, options?: any): Promise>; /** * * @summary Patch Service Plan Modified Schema * @param {string} id ID of the resource * @param {PatchModifiedServicePlan} [patchModifiedServicePlan] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ServicePlansApi */ patchServicePlanModified(id: string, patchModifiedServicePlan?: PatchModifiedServicePlan, options?: any): Promise>; /** * Resets the Service Plan\'s Modified schema and returns the new one if it has been reset * @summary Reset Service Plan Modified schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ServicePlansApi */ resetServicePlanModified(id: string, options?: any): Promise>; /** * Returns the specified Service Plan * @summary Show Service Plan * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ServicePlansApi */ showServicePlan(id: string, options?: any): Promise>; /** * Returns the specified Service Plan\'s base schema * @summary Show Service Plan Base Schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ServicePlansApi */ showServicePlanBase(id: string, options?: any): Promise>; /** * Returns the specified Service Plan\'s modified schema * @summary Show Service Plan modified Schema * @param {string} id ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ServicePlansApi */ showServicePlanModified(id: string, options?: any): Promise>; } /** * SettingsApi - axios parameter creator * @export */ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create Tenant Setting * @summary Create Tenant Setting * @param {Setting} setting Json encoded key/value pair to create a new setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSetting: (setting: Setting, options?: any) => Promise; /** * Delete a Tenant Setting * @summary Delete a Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroySetting: (name: string, options?: any) => Promise; /** * List Tenant Settings * @summary List Tenant Settings * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSettings: (options?: any) => Promise; /** * Get a specific Tenant Setting * @summary Get a specific Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ showSetting: (name: string, options?: any) => Promise; /** * Update a Tenant Setting * @summary Update a Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSetting: (name: string, options?: any) => Promise; }; /** * SettingsApi - functional programming interface * @export */ export declare const SettingsApiFp: (configuration?: Configuration) => { /** * Create Tenant Setting * @summary Create Tenant Setting * @param {Setting} setting Json encoded key/value pair to create a new setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSetting(setting: Setting, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a Tenant Setting * @summary Delete a Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroySetting(name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Tenant Settings * @summary List Tenant Settings * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSettings(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a specific Tenant Setting * @summary Get a specific Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ showSetting(name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a Tenant Setting * @summary Update a Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSetting(name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SettingsApi - factory interface * @export */ export declare const SettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create Tenant Setting * @summary Create Tenant Setting * @param {Setting} setting Json encoded key/value pair to create a new setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSetting(setting: Setting, options?: any): AxiosPromise; /** * Delete a Tenant Setting * @summary Delete a Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ destroySetting(name: string, options?: any): AxiosPromise; /** * List Tenant Settings * @summary List Tenant Settings * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSettings(options?: any): AxiosPromise; /** * Get a specific Tenant Setting * @summary Get a specific Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ showSetting(name: string, options?: any): AxiosPromise; /** * Update a Tenant Setting * @summary Update a Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSetting(name: string, options?: any): AxiosPromise; }; /** * SettingsApi - object-oriented interface * @export * @class SettingsApi * @extends {BaseAPI} */ export declare class SettingsApi extends BaseAPI { /** * Create Tenant Setting * @summary Create Tenant Setting * @param {Setting} setting Json encoded key/value pair to create a new setting * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SettingsApi */ createSetting(setting: Setting, options?: any): Promise>; /** * Delete a Tenant Setting * @summary Delete a Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SettingsApi */ destroySetting(name: string, options?: any): Promise>; /** * List Tenant Settings * @summary List Tenant Settings * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SettingsApi */ listSettings(options?: any): Promise>; /** * Get a specific Tenant Setting * @summary Get a specific Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SettingsApi */ showSetting(name: string, options?: any): Promise>; /** * Update a Tenant Setting * @summary Update a Tenant Setting * @param {string} name name of the setting * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SettingsApi */ updateSetting(name: string, options?: any): Promise>; } /** * TagsApi - axios parameter creator * @export */ export declare const TagsApiAxiosParamCreator: (configuration?: Configuration) => { /** * List Tags * @summary List Tags * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTags: (options?: any) => Promise; }; /** * TagsApi - functional programming interface * @export */ export declare const TagsApiFp: (configuration?: Configuration) => { /** * List Tags * @summary List Tags * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTags(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TagsApi - factory interface * @export */ export declare const TagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * List Tags * @summary List Tags * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTags(options?: any): AxiosPromise; }; /** * TagsApi - object-oriented interface * @export * @class TagsApi * @extends {BaseAPI} */ export declare class TagsApi extends BaseAPI { /** * List Tags * @summary List Tags * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TagsApi */ listTags(options?: any): Promise>; } /** * TenantApi - axios parameter creator * @export */ export declare const TenantApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a list of tenants. * @summary List Tenants * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTenants: (options?: any) => Promise; /** * Gets the tenant specified by the tenant id. * @summary Get a specific Tenant * @param {string} tenantId ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showTenant: (tenantId: string, options?: any) => Promise; /** * Run a task to seed the Tenant Groups required for an org admin to onboard additional users. * @summary Seed Tenant Groups * @param {string} tenantId ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ tenantSeed: (tenantId: string, options?: any) => Promise; }; /** * TenantApi - functional programming interface * @export */ export declare const TenantApiFp: (configuration?: Configuration) => { /** * Get a list of tenants. * @summary List Tenants * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTenants(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the tenant specified by the tenant id. * @summary Get a specific Tenant * @param {string} tenantId ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showTenant(tenantId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Run a task to seed the Tenant Groups required for an org admin to onboard additional users. * @summary Seed Tenant Groups * @param {string} tenantId ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ tenantSeed(tenantId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TenantApi - factory interface * @export */ export declare const TenantApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a list of tenants. * @summary List Tenants * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTenants(options?: any): AxiosPromise; /** * Gets the tenant specified by the tenant id. * @summary Get a specific Tenant * @param {string} tenantId ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ showTenant(tenantId: string, options?: any): AxiosPromise; /** * Run a task to seed the Tenant Groups required for an org admin to onboard additional users. * @summary Seed Tenant Groups * @param {string} tenantId ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ tenantSeed(tenantId: string, options?: any): AxiosPromise; }; /** * TenantApi - object-oriented interface * @export * @class TenantApi * @extends {BaseAPI} */ export declare class TenantApi extends BaseAPI { /** * Get a list of tenants. * @summary List Tenants * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TenantApi */ listTenants(options?: any): Promise>; /** * Gets the tenant specified by the tenant id. * @summary Get a specific Tenant * @param {string} tenantId ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TenantApi */ showTenant(tenantId: string, options?: any): Promise>; /** * Run a task to seed the Tenant Groups required for an org admin to onboard additional users. * @summary Seed Tenant Groups * @param {string} tenantId ID of the resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TenantApi */ tenantSeed(tenantId: string, options?: any): Promise>; }