ProductParameterAPI

All URIs are relative to https://mgmtapi.geins.io

Method	HTTP request	Description
batchReplaceProductParameterValues	POST /API/ProductParameter/Values	Replace multiple product parameter values
batchUpdateProductParameterValues	PUT /API/ProductParameter/Values	Update multiple product parameter values
createOrUpdateProductParameterValue	POST /API/ProductParameter/Value	Create or update a new product parameter value
createProductParameter	POST /API/ProductParameter	Create a new product parameter
createProductParameterGroup	POST /API/ProductParameter/Group	Create a new product parameter group
createProductParameterPredefinedValue	POST /API/ProductParameter/PredefinedValue	Create a new predefined value for a product parameter
getProductParameterById	GET /API/ProductParameter/{id}	Get a specific product parameter
getProductParameterGroupById	GET /API/ProductParameter/Group/{id}	Get a specific product parameter group
getProductParameterPredefinedValue	GET /API/ProductParameter/PredefinedValue/{id}	Get a specific predefined value for a product parameter
getProductParameterValue	GET /API/ProductParameter/Value/{id}	Get a specific product parameter value
updateProductParameter	PUT /API/ProductParameter/{id}	Updates a product parameter
updateProductParameterGroup	PUT /API/ProductParameter/Group/{id}	Update a product parameter group

batchReplaceProductParameterValues

    open class func batchReplaceProductParameterValues(productParameterBatch: ProductParameterModelsWriteProductParameterValueBatch, completion: @escaping (_ data: Envelope?, _ error: Error?) -> Void)

Replace multiple product parameter values

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let productParameterBatch = ProductParameter.Models.Write.ProductParameterValueBatch(productParameterValues: [ProductParameter.Models.Write.ProductParameterValue(productId: 123, parameterId: 123, value: "value_example", localizedDescriptions: [Shared.Models.LocalizableContent(languageCode: "languageCode_example", content: "content_example")])]) // ProductParameterModelsWriteProductParameterValueBatch | The product parameter values to replace.

// Replace multiple product parameter values
ProductParameterAPI.batchReplaceProductParameterValues(productParameterBatch: productParameterBatch) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
productParameterBatch	ProductParameterModelsWriteProductParameterValueBatch	The product parameter values to replace.

Return type

Envelope

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

batchUpdateProductParameterValues

    open class func batchUpdateProductParameterValues(productParameterBatch: ProductParameterModelsWriteProductParameterValueBatch, completion: @escaping (_ data: Envelope?, _ error: Error?) -> Void)

Update multiple product parameter values

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let productParameterBatch = ProductParameter.Models.Write.ProductParameterValueBatch(productParameterValues: [ProductParameter.Models.Write.ProductParameterValue(productId: 123, parameterId: 123, value: "value_example", localizedDescriptions: [Shared.Models.LocalizableContent(languageCode: "languageCode_example", content: "content_example")])]) // ProductParameterModelsWriteProductParameterValueBatch | The product parameter values update.

// Update multiple product parameter values
ProductParameterAPI.batchUpdateProductParameterValues(productParameterBatch: productParameterBatch) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
productParameterBatch	ProductParameterModelsWriteProductParameterValueBatch	The product parameter values update.

Return type

Envelope

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createOrUpdateProductParameterValue

    open class func createOrUpdateProductParameterValue(productParameterValue: ProductParameterModelsWriteProductParameterValue, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameterValue?, _ error: Error?) -> Void)

Create or update a new product parameter value

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let productParameterValue = ProductParameter.Models.Write.ProductParameterValue(productId: 123, parameterId: 123, value: "value_example", localizedDescriptions: [Shared.Models.LocalizableContent(languageCode: "languageCode_example", content: "content_example")]) // ProductParameterModelsWriteProductParameterValue | The product parameter value to create or update.

// Create or update a new product parameter value
ProductParameterAPI.createOrUpdateProductParameterValue(productParameterValue: productParameterValue) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
productParameterValue	ProductParameterModelsWriteProductParameterValue	The product parameter value to create or update.

Return type

EnvelopeProductParameterModelsReadProductParameterValue

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createProductParameter

    open class func createProductParameter(productParameter: ProductParameterModelsWriteProductParameter, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameter?, _ error: Error?) -> Void)

Create a new product parameter

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let productParameter = ProductParameter.Models.Write.ProductParameter(parameterId: 123, groupId: 123, parameterType: 123, name: "name_example", localizedNames: [Shared.Models.LocalizableContent(languageCode: "languageCode_example", content: "content_example")]) // ProductParameterModelsWriteProductParameter | The product parameter to create.

// Create a new product parameter
ProductParameterAPI.createProductParameter(productParameter: productParameter) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
productParameter	ProductParameterModelsWriteProductParameter	The product parameter to create.

Return type

EnvelopeProductParameterModelsReadProductParameter

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createProductParameterGroup

    open class func createProductParameterGroup(productParameterGroup: ProductParameterModelsWriteProductParameterGroup, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameterGroup?, _ error: Error?) -> Void)

Create a new product parameter group

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let productParameterGroup = ProductParameter.Models.Write.ProductParameterGroup(name: "name_example", localizedNames: [Shared.Models.LocalizableContent(languageCode: "languageCode_example", content: "content_example")], parameterIds: [123]) // ProductParameterModelsWriteProductParameterGroup | The product parameter group to create.

// Create a new product parameter group
ProductParameterAPI.createProductParameterGroup(productParameterGroup: productParameterGroup) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
productParameterGroup	ProductParameterModelsWriteProductParameterGroup	The product parameter group to create.

Return type

EnvelopeProductParameterModelsReadProductParameterGroup

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createProductParameterPredefinedValue

    open class func createProductParameterPredefinedValue(productParameterPredefinedValue: ProductParameterModelsWriteProductParameterPredefinedValue, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameterPredefinedValue?, _ error: Error?) -> Void)

Create a new predefined value for a product parameter

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let productParameterPredefinedValue = ProductParameter.Models.Write.ProductParameterPredefinedValue(parameterId: 123, predefinedValueId: 123, name: "name_example", localizedNames: [Shared.Models.LocalizableContent(languageCode: "languageCode_example", content: "content_example")]) // ProductParameterModelsWriteProductParameterPredefinedValue | The predefined value to create.

// Create a new predefined value for a product parameter
ProductParameterAPI.createProductParameterPredefinedValue(productParameterPredefinedValue: productParameterPredefinedValue) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
productParameterPredefinedValue	ProductParameterModelsWriteProductParameterPredefinedValue	The predefined value to create.

Return type

EnvelopeProductParameterModelsReadProductParameterPredefinedValue

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProductParameterById

    open class func getProductParameterById(id: Int, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameter?, _ error: Error?) -> Void)

Get a specific product parameter

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let id = 987 // Int | The id of the product parameter to get.

// Get a specific product parameter
ProductParameterAPI.getProductParameterById(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	The id of the product parameter to get.

Return type

EnvelopeProductParameterModelsReadProductParameter

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProductParameterGroupById

    open class func getProductParameterGroupById(id: Int, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameterGroup?, _ error: Error?) -> Void)

Get a specific product parameter group

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let id = 987 // Int | The id of the product parameter group to get.

// Get a specific product parameter group
ProductParameterAPI.getProductParameterGroupById(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	The id of the product parameter group to get.

Return type

EnvelopeProductParameterModelsReadProductParameterGroup

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProductParameterPredefinedValue

    open class func getProductParameterPredefinedValue(id: Int, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameterValue?, _ error: Error?) -> Void)

Get a specific predefined value for a product parameter

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let id = 987 // Int | The id of the predefined value to get.

// Get a specific predefined value for a product parameter
ProductParameterAPI.getProductParameterPredefinedValue(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	The id of the predefined value to get.

Return type

EnvelopeProductParameterModelsReadProductParameterValue

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProductParameterValue

    open class func getProductParameterValue(id: Int, predefinedValueId: String? = nil, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameterValue?, _ error: Error?) -> Void)

Get a specific product parameter value

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let id = 987 // Int | The id of the product parameter value to get.
let predefinedValueId = "predefinedValueId_example" // String | The predefined value id of the product parameter value to get. Only applicable for {ProductParameter.Models.ProductParameterType.Multi}. (optional)

// Get a specific product parameter value
ProductParameterAPI.getProductParameterValue(id: id, predefinedValueId: predefinedValueId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	The id of the product parameter value to get.
predefinedValueId	String	The predefined value id of the product parameter value to get. Only applicable for {ProductParameter.Models.ProductParameterType.Multi}.	[optional]

Return type

EnvelopeProductParameterModelsReadProductParameterValue

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateProductParameter

    open class func updateProductParameter(id: Int, productParameter: ProductParameterModelsWriteProductParameter, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameter?, _ error: Error?) -> Void)

Updates a product parameter

Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let id = 987 // Int | The id of the product parameter to update.
let productParameter = ProductParameter.Models.Write.ProductParameter(parameterId: 123, groupId: 123, parameterType: 123, name: "name_example", localizedNames: [Shared.Models.LocalizableContent(languageCode: "languageCode_example", content: "content_example")]) // ProductParameterModelsWriteProductParameter | The product parameter data to update.

// Updates a product parameter
ProductParameterAPI.updateProductParameter(id: id, productParameter: productParameter) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	The id of the product parameter to update.
productParameter	ProductParameterModelsWriteProductParameter	The product parameter data to update.

Return type

EnvelopeProductParameterModelsReadProductParameter

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateProductParameterGroup

    open class func updateProductParameterGroup(id: Int, productParameterGroup: ProductParameterModelsWriteProductParameterGroup, completion: @escaping (_ data: EnvelopeProductParameterModelsReadProductParameterGroup?, _ error: Error?) -> Void)

Update a product parameter group

Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let id = 987 // Int | The id of the product parameter group to update.
let productParameterGroup = ProductParameter.Models.Write.ProductParameterGroup(name: "name_example", localizedNames: [Shared.Models.LocalizableContent(languageCode: "languageCode_example", content: "content_example")], parameterIds: [123]) // ProductParameterModelsWriteProductParameterGroup | The product parameter group data to update.

// Update a product parameter group
ProductParameterAPI.updateProductParameterGroup(id: id, productParameterGroup: productParameterGroup) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	The id of the product parameter group to update.
productParameterGroup	ProductParameterModelsWriteProductParameterGroup	The product parameter group data to update.

Return type

EnvelopeProductParameterModelsReadProductParameterGroup

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ProductParameterAPI.md

Latest commit

History

ProductParameterAPI.md

File metadata and controls

ProductParameterAPI

batchReplaceProductParameterValues

Example

Parameters

Return type

Authorization

HTTP request headers

batchUpdateProductParameterValues

Example

Parameters

Return type

Authorization

HTTP request headers

createOrUpdateProductParameterValue

Example

Parameters

Return type

Authorization

HTTP request headers

createProductParameter

Example

Parameters

Return type

Authorization

HTTP request headers

createProductParameterGroup

Example

Parameters

Return type

Authorization

HTTP request headers

createProductParameterPredefinedValue

Example

Parameters

Return type

Authorization

HTTP request headers

getProductParameterById

Example

Parameters

Return type

Authorization

HTTP request headers

getProductParameterGroupById

Example

Parameters

Return type

Authorization

HTTP request headers

getProductParameterPredefinedValue

Example

Parameters

Return type

Authorization

HTTP request headers

getProductParameterValue

Example

Parameters

Return type

Authorization

HTTP request headers

updateProductParameter

Example

Parameters

Return type

Authorization

HTTP request headers

updateProductParameterGroup

Example

Parameters

Return type

Authorization

HTTP request headers