custom-object.ts

/**
 * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
 * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
 * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
 */

import { BaseResource, CreatedBy, LastModifiedBy } from './common.js'

export interface CustomObject extends BaseResource {
  /**
   *	Unique identifier of the CustomObject.
   *
   */
  readonly id: string
  /**
   *	Current version of the CustomObject.
   *
   *
   */
  readonly version: number
  /**
   *	Date and time (UTC) the CustomObject was initially created.
   *
   *
   */
  readonly createdAt: string
  /**
   *	Date and time (UTC) the CustomObject was last updated.
   *
   *
   */
  readonly lastModifiedAt: string
  /**
   *	Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked).
   *
   *
   */
  readonly lastModifiedBy?: LastModifiedBy
  /**
   *	Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked).
   *
   *
   */
  readonly createdBy?: CreatedBy
  /**
   *	Namespace to group CustomObjects.
   *
   *
   */
  readonly container: string
  /**
   *	User-defined unique identifier of the CustomObject within the defined `container`.
   *
   *
   */
  readonly key: string
  /**
   *	JSON standard types Number, String, Boolean, Array, Object, and [common API data types](/../api/types).
   *	For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed.
   *	If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.
   *
   *
   */
  readonly value: any
}
export interface CustomObjectDraft {
  /**
   *	Namespace to group CustomObjects.
   *
   *
   */
  readonly container: string
  /**
   *	User-defined unique identifier of the CustomObject within the defined `container`.
   *
   *
   */
  readonly key: string
  /**
   *	JSON standard types Number, String, Boolean, Array, Object, and [common API data types](/../api/types).
   *	For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed.
   *	If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.
   *
   *
   */
  readonly value: any
  /**
   *	Current version of the CustomObject.
   *
   *
   */
  readonly version?: number
}
/**
 *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [CustomObject](ctp:api:type:CustomObject).
 *
 */
export interface CustomObjectPagedQueryResponse {
  /**
   *	Number of [results requested](/../api/general-concepts#limit).
   *
   *
   */
  readonly limit: number
  /**
   *	Number of [elements skipped](/../api/general-concepts#offset).
   *
   *
   */
  readonly offset: number
  /**
   *	Actual number of results returned.
   *
   *
   */
  readonly count: number
  /**
   *	The total number of results matching the query.
   *	This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
   *	This field is returned by default.
   *	For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
   *	When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
   *
   *
   */
  readonly total?: number
  /**
   *	[CustomObjects](ctp:api:type:CustomObject) matching the query.
   *
   *
   */
  readonly results: CustomObject[]
}
/**
 *	[Reference](ctp:api:type:Reference) to a [CustomObject](ctp:api:type:CustomObject).
 *
 */
export interface CustomObjectReference {
  readonly typeId: 'key-value-document'
  /**
   *	Unique identifier of the referenced [CustomObject](ctp:api:type:CustomObject).
   *
   *
   */
  readonly id: string
  /**
   *	Contains the representation of the expanded CustomObject. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for CustomObjects.
   *
   *
   */
  readonly obj?: CustomObject
}