diff --git a/en/docs/connectors/catalog/erp-business/pricefx/action-reference.md b/en/docs/connectors/catalog/erp-business/pricefx/action-reference.md new file mode 100644 index 0000000000..222c405b6c --- /dev/null +++ b/en/docs/connectors/catalog/erp-business/pricefx/action-reference.md @@ -0,0 +1,12678 @@ +--- +connector: true +connector_name: "pricefx" +title: "Actions" +description: "Available operations in the ballerinax/pricefx connector." +--- + +# Actions + +The `ballerinax/pricefx` package exposes the following clients: + +| Client | Purpose | +|--------|---------| +| [`Client`](#client) | Provides access to the Pricefx Backend API for managing products, customers, sellers, price lists, calculation grids, quotes, contracts, rebate agreements, sales compensations, attachments, and more. | + +--- + +## Client + +### Configuration + +#### PricefxCredentials + +`PricefxCredentials` is a union of four records - `BasicCredentials`, `JwtCredentials`, `OAuth2Credentials`, or `ExternalJwtCredentials`. Pick the one matching the credentials you hold and pass it as the `auth` field of `ConnectionConfig`. + +**BasicCredentials** + +| Field | Type | Default | Description | +|-------|------|---------|-------------| +| `username` | string | Required | Your Pricefx username | +| `password` | string | Required | Your Pricefx password | +| `partition` | string | Required | Your Pricefx partition name | + +**JwtCredentials** + +| Field | Type | Default | Description | +|-------|------|---------|-------------| +| `jwt` | string | Required | A Pricefx-issued JWT you already hold, sent directly as the `X-PriceFx-jwt` header, with no exchange. Intended for the non-expiring integration tokens produced by `generateJwtToken` (or the time-limited ones from `generateTimedJwtToken`). Cannot be refreshed by the connector - a rejected token surfaces as an error rather than being retried, so avoid pasting in a short-lived session token here | + +**OAuth2Credentials** + +| Field | Type | Default | Description | +|-------|------|---------|-------------| +| `clientId` | string | Required | The client identifier, as registered in Pricefx's `oauthConfiguration` | +| `clientSecret` | string | Optional | The client secret, if one was configured for this client | +| `refreshToken` | string | Required | A refresh token from a completed Authorization Code Grant flow | + +**ExternalJwtCredentials** + +| Field | Type | Default | Description | +|-------|------|---------|-------------| +| `systemName` | string | Required | The external system's name, as configured in `externalJWTConfiguration` | +| `jwt` | string | Required | A JWT signed by that system | + +#### ConnectionConfig + +Provides a set of configurations for controlling the behaviours when communicating with the Pricefx API. + +| Field | Type | Default | Description | +|-------|------|---------|-------------| +| `auth` | PricefxCredentials | Required | How to authenticate - one of the four `PricefxCredentials` records above | +| `httpVersion` | http:HttpVersion | http:HTTP_2_0 | The HTTP version understood by the client | +| `http1Settings` | oas:ClientHttp1Settings | Optional | Configurations related to HTTP/1.x protocol | +| `http2Settings` | http:ClientHttp2Settings | Optional | Configurations related to HTTP/2 protocol | +| `timeout` | decimal | 60 | The maximum time to wait (in seconds) for a response before closing the connection | +| `forwarded` | string | "disable" | The choice of setting `forwarded`/`x-forwarded` header | +| `poolConfig` | http:PoolConfiguration | Optional | Configurations associated with request pooling | +| `cache` | http:CacheConfig | Optional | HTTP caching related configurations | +| `compression` | http:Compression | http:COMPRESSION_AUTO | Specifies the way of handling compression (`accept-encoding`) header | +| `circuitBreaker` | http:CircuitBreakerConfig | Optional | Configurations associated with the behaviour of the Circuit Breaker | +| `retryConfig` | http:RetryConfig | Optional | Configurations associated with retrying | +| `responseLimits` | http:ResponseLimitConfigs | Optional | Configurations associated with inbound response size limits | +| `secureSocket` | http:ClientSecureSocket | Optional | SSL/TLS-related options | +| `proxy` | http:ProxyConfig | Optional | Proxy server related options | +| `validation` | boolean | true | Enables the inbound payload validation functionality provided by the constraint package | +| `laxDataBinding` | boolean | true | Enables relaxed data binding on the client side, treating `nil` values and absent fields as optional | + +### Initializing the client + +```ballerina +import ballerinax/pricefx; +import ballerinax/pricefx.oas; + +configurable string username = ?; +configurable string password = ?; +configurable string partition = ?; +configurable string serviceUrl = ?; + +pricefx:Client pricefxClient = check new ({auth: {username, password, partition}}, serviceUrl); +``` + +### Operations + +#### User Admin + +
+addUser + +
+ +Add a User + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddUserRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UserResponse|error` + +**Sample code:** + +```ballerina +oas:UserResponse result = check pricefxClient->addUser(payload); +``` + +
+
+ +
+assignBusinessRole + +
+ +Assign a Business Role + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AssignBusinessRoleRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignBusinessRoleResponse|error` + +**Sample code:** + +```ballerina +oas:AssignBusinessRoleResponse result = check pricefxClient->assignBusinessRole(payload); +``` + +
+
+ +
+assignBusinessRoleToUser + +
+ +Assign a Business Role to a User + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `userId` | string | Yes | The ID of the user you want to assign a role to. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806** | +| `payload` | oas:AssignBusinessRoleToUserRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignBusinessRoleToUserResponse|error` + +**Sample code:** + +```ballerina +oas:AssignBusinessRoleToUserResponse result = check pricefxClient->assignBusinessRoleToUser(userId, payload); +``` + +
+
+ +
+assignGroupToBusinessRole + +
+ +Assign a Group to a Business Role + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AssignGroupToBusinessRoleRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignGroupToBusinessRoleResponse|error` + +**Sample code:** + +```ballerina +oas:AssignGroupToBusinessRoleResponse result = check pricefxClient->assignGroupToBusinessRole(payload); +``` + +
+
+ +
+assignRoleToBusinessRole + +
+ +Assign a Role to a Business Role + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AssignRoleToBusinessRoleRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignRoleToBusinessRoleResponse|error` + +**Sample code:** + +```ballerina +oas:AssignRoleToBusinessRoleResponse result = check pricefxClient->assignRoleToBusinessRole(payload); +``` + +
+
+ +
+assignRoleToUser + +
+ +Assign a Role to a User + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `userId` | string | Yes | The ID of the user you want to assign a role to. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806** | +| `payload` | oas:AssignRoleToUserRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignRoleToUserResponse|error` + +**Sample code:** + +```ballerina +oas:AssignRoleToUserResponse result = check pricefxClient->assignRoleToUser(userId, payload); +``` + +
+
+ +
+assignRoleToUsers + +
+ +Assign a Role to Users + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AssignRoleToUsersRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignRoleToUsersResponse|error` + +**Sample code:** + +```ballerina +oas:AssignRoleToUsersResponse result = check pricefxClient->assignRoleToUsers(payload); +``` + +
+
+ +
+assignUserGroupToUsers + +
+ +Assign a User Group to Users + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AssignUserGroupToUsersRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignUserGroupToUsersResponse|error` + +**Sample code:** + +```ballerina +oas:AssignUserGroupToUsersResponse result = check pricefxClient->assignUserGroupToUsers(payload); +``` + +
+
+ +
+assignUserToUserGroup + +
+ +Assign a User to a User Group + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `userId` | string | Yes | The ID of the user you want to add to the group. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806** | +| `payload` | oas:AssignUserToUserGroupRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignUserToUserGroupResponse|error` + +**Sample code:** + +```ballerina +oas:AssignUserToUserGroupResponse result = check pricefxClient->assignUserToUserGroup(userId, payload); +``` + +
+
+ +
+changeCurrentUserPassword + +
+ +Change a Current User Password + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ChangeCurrentUserPasswordRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ChangeCurrentUserPasswordResponse|error` + +**Sample code:** + +```ballerina +oas:ChangeCurrentUserPasswordResponse result = check pricefxClient->changeCurrentUserPassword(payload); +``` + +
+
+ +
+changeUserPassword + +
+ +Change a User Password + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `userId` | string | Yes | Enter the ID of the user whose password you want to change. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806** | +| `payload` | oas:ChangeUserPasswordRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ChangeUserPasswordResponse|error` + +**Sample code:** + +```ballerina +oas:ChangeUserPasswordResponse result = check pricefxClient->changeUserPassword(userId, payload); +``` + +
+
+ +
+copyRoles + +
+ +Copy Roles + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:CopyRolesRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CopyRolesResponse|error` + +**Sample code:** + +```ballerina +oas:CopyRolesResponse result = check pricefxClient->copyRoles(payload); +``` + +
+
+ +
+copyUser + +
+ +Copy a User + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `userid` | string | Yes | The ID of the user you want to copy. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CopyUserResponse|error` + +**Sample code:** + +```ballerina +oas:CopyUserResponse result = check pricefxClient->copyUser(userid); +``` + +
+
+ +
+deleteBusinessRole + +
+ +Delete a Business Role + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteBusinessRoleRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteBusinessRoleResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteBusinessRoleResponse result = check pricefxClient->deleteBusinessRole(payload); +``` + +
+
+ +
+deleteUser + +
+ +Delete a User + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteUserRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UserResponse|error` + +**Sample code:** + +```ballerina +oas:UserResponse result = check pricefxClient->deleteUser(payload); +``` + +
+
+ +
+deleteUserGroup + +
+ +Delete a User Group + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteUserGroupRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteUserGroupResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteUserGroupResponse result = check pricefxClient->deleteUserGroup(payload); +``` + +
+
+ +
+generateJwtToken + +
+ +Generate a JWT Token + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:GenerateJWTTokenRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenerateJWTTokenResponse|error` + +**Sample code:** + +```ballerina +oas:GenerateJWTTokenResponse result = check pricefxClient->generateJwtToken(payload); +``` + +
+
+ +
+generateTimedJwtToken + +
+ +Generate a JWT Token (time limited) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `minutes` | string | Yes | The number of minutes in which the token expires | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenerateJWTTokenTimeLimitedResponse|error` + +**Sample code:** + +```ballerina +oas:GenerateJWTTokenTimeLimitedResponse result = check pricefxClient->generateTimedJwtToken(minutes); +``` + +
+
+ +
+getOneTimeToken + +
+ +Get a One Time Token + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetOneTimeTokenResponse|error` + +**Sample code:** + +```ballerina +oas:GetOneTimeTokenResponse result = check pricefxClient->getOneTimeToken(); +``` + +
+
+ +
+getUserAuditReport + +
+ +Get a User Audit Report + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "R"|"UG"|"BR" | Yes | Specify whether you want to retrieve a report based on user roles (`R`), user groups (`UG`), or business roles (`BR`) | +| `id` | string | Yes | Specify the `id`of the user role, user group, or business role for which you want to retrieve users. Call the `/fetch/R`, `/fetch/UG`, or `/fetch/BR` endpoint to retrieve a list with corresponding user roles, user groups, or business roles | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UserAuditReportEnvelope|error` + +**Sample code:** + +```ballerina +oas:UserAuditReportEnvelope result = check pricefxClient->getUserAuditReport(typeCode, id, payload); +``` + +
+
+ +
+listGroupsOfBusinessRole + +
+ +List Groups of the Business Role + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `businessroleId` | string | Yes | The ID of the business role you want to retrieve user roles for. The `businessroleId` is the `typedId` without the `BR` suffix. For example, `businessroleId` of the **53.BR** is **53** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListGroupsOfBusinessRoleResponse|error` + +**Sample code:** + +```ballerina +oas:ListGroupsOfBusinessRoleResponse result = check pricefxClient->listGroupsOfBusinessRole(businessroleId); +``` + +
+
+ +
+listRolesOfBusinessRole + +
+ +List Roles of the Business Role + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `businessroleId` | string | Yes | The ID of the business role you want to retrieve user roles for. The `businessroleId` is the `typedId` without the `BR` suffix. For example, `businessroleId` of the **53.BR** is **53** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListRolesOfBusinessRoleResponse|error` + +**Sample code:** + +```ballerina +oas:ListRolesOfBusinessRoleResponse result = check pricefxClient->listRolesOfBusinessRole(businessroleId); +``` + +
+
+ +
+listUserSBusinessRoles + +
+ +List User's Business Roles + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `userId` | string | Yes | The ID of the user you want to retrieve business roles for. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListUserBusinessRolesResponse|error` + +**Sample code:** + +```ballerina +oas:ListUserBusinessRolesResponse result = check pricefxClient->listUserSBusinessRoles(userId); +``` + +
+
+ +
+listUserSRoles + +
+ +List User's Roles + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `userId` | string | Yes | The ID of the user you want to retrieve roles for. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListUserRolesResponse|error` + +**Sample code:** + +```ballerina +oas:ListUserRolesResponse result = check pricefxClient->listUserSRoles(userId); +``` + +
+
+ +
+listUserSUserGroups + +
+ +List User's User Groups + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `userId` | string | Yes | The ID of the user you want to retrieve groups for. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListUsersUserGroupsResponse|error` + +**Sample code:** + +```ballerina +oas:ListUsersUserGroupsResponse result = check pricefxClient->listUserSUserGroups(userId); +``` + +
+
+ +
+listUsers + +
+ +List Users + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListUsersRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListUsersResponse|error` + +**Sample code:** + +```ballerina +oas:ListUsersResponse result = check pricefxClient->listUsers(payload); +``` + +
+
+ +
+updateUser + +
+ +Update a User + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateUserRequest | Yes | Specify the user by `typedId` and define the new value of the field you want to update in the `data` object | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UserResponse|error` + +**Sample code:** + +```ballerina +oas:UserResponse result = check pricefxClient->updateUser(payload); +``` + +
+
+ +#### Products + +
+addProduct + +
+ +Add a Product + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddProductRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductResponse|error` + +**Sample code:** + +```ballerina +oas:ProductResponse result = check pricefxClient->addProduct(payload); +``` + +
+
+ +
+bulkInsertProducts + +
+ +Insert Bulk Products + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:InsertBulkProductsRequest | Yes | Specify product field names in the `header` object and fields values in the `data` object.<p> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LoadDataResponse|error` + +**Sample code:** + +```ballerina +oas:LoadDataResponse result = check pricefxClient->bulkInsertProducts(payload); +``` + +
+
+ +
+deleteProduct + +
+ +Delete a Product + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteProductRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteProductResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteProductResponse result = check pricefxClient->deleteProduct(payload); +``` + +
+
+ +
+getProductBomTree + +
+ +List BoM for a Product + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `sku` | string | Yes | The `sku` of the product you want to retrieve the Bill of Materials for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListBoMForProductResponse|error` + +**Sample code:** + +```ballerina +oas:ListBoMForProductResponse result = check pricefxClient->getProductBomTree(sku); +``` + +
+
+ +
+listProducts + +
+ +List Products + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListProductsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductResponse|error` + +**Sample code:** + +```ballerina +oas:ProductResponse result = check pricefxClient->listProducts(payload); +``` + +
+
+ +
+listRecommendations + +
+ +List Recommendations + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListRecommendationsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListRecommendationsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListRecommendationsEnvelope result = check pricefxClient->listRecommendations(payload); +``` + +
+
+ +
+searchProducts + +
+ +Search a Product + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:SearchProductRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SearchProductResponse|error` + +**Sample code:** + +```ballerina +oas:SearchProductResponse result = check pricefxClient->searchProducts(payload); +``` + +
+
+ +
+searchProductsByQuery + +
+ +Search a Product (URL) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `query` | string | Yes | The query to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SearchProductURLResponse|error` + +**Sample code:** + +```ballerina +oas:SearchProductURLResponse result = check pricefxClient->searchProductsByQuery(query); +``` + +
+
+ +
+updateProduct + +
+ +Update a Product + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateProductRequest | Yes | Updates specified fields of the record. Only one record can be updated per request (unless batched).<p> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductResponse|error` + +**Sample code:** + +```ballerina +oas:ProductResponse result = check pricefxClient->updateProduct(payload); +``` + +
+
+ +
+upsertProduct + +
+ +Upsert a Product + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpsertProductRequest | Yes | Either `sku` or `typedId` must be specified in order to *update* an existing product | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductResponse|error` + +**Sample code:** + +```ballerina +oas:ProductResponse result = check pricefxClient->upsertProduct(payload); +``` + +
+
+ +#### Product Extensions + +
+deleteProductExtension + +
+ +Delete a Product Extension + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteProductExtensionRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteProductExtensionResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteProductExtensionResponse result = check pricefxClient->deleteProductExtension(payload); +``` + +
+
+ +
+getProductAttributeMeta + +
+ +Get Product Attribute Meta + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductAttributeMetaEnvelope|error` + +**Sample code:** + +```ballerina +oas:ProductAttributeMetaEnvelope result = check pricefxClient->getProductAttributeMeta(payload); +``` + +
+
+ +
+insertBulkProductExtensions + +
+ +Insert Bulk Product Extensions + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:InsertBulkProductExtensionsRequest | Yes | Specify product extension field names in the `header` object and field values in the `data` object | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->insertBulkProductExtensions(payload); +``` + +
+
+ +
+listProductExtensionObjects + +
+ +List Product Extension Objects + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `productMasterExtensionName` | string | Yes | Enter the name of Product Extension you want to retrieve objects from. You can find the name in **Administration** > **Configuration** > **Master Data** > **Product Master Extension** or using the **/configurationmanager.get/productextension** endpoint | +| `payload` | oas:ListProductExtensionObjectsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ListProductExtensionObjectsQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ProductExtensionResponse|error` + +**Sample code:** + +```ballerina +oas:ProductExtensionResponse result = check pricefxClient->listProductExtensionObjects(productMasterExtensionName, payload, queries); +``` + +
+
+ +
+upsertProductExtension + +
+ +Upsert a Product Extension + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpsertProductExtensionRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductResponse|error` + +**Sample code:** + +```ballerina +oas:ProductResponse result = check pricefxClient->upsertProductExtension(payload); +``` + +
+
+ +#### Product Image + +
+deleteUploadSlotViaGet + +
+ +3. Delete an Upload Slot + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `slotId` | string | Yes | Enter the ID of the slot you want to delete | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteUploadSlotResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteUploadSlotResponse result = check pricefxClient->deleteUploadSlotViaGet(slotId); +``` + +
+
+ +
+getNewUploadSlot + +
+ +1. Create an Upload Slot + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CreateUploadSlotResponse|error` + +**Sample code:** + +```ballerina +oas:CreateUploadSlotResponse result = check pricefxClient->getNewUploadSlot(); +``` + +
+
+ +
+uploadProductImage + +
+ +2. Upload a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `slotId` | string | Yes | Enter the ID of the slot you want to use for the upload | +| `sku` | string | Yes | Enter the `sku` of the product you want to add the product image to | +| `payload` | oas:TypedIdslotIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->uploadProductImage(slotId, sku, payload); +``` + +
+
+ +#### Competition Data + +
+getProductCompetition + +
+ +Get Competition Data + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:GetCompetitionDataRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetCompetitionDataResponse|error` + +**Sample code:** + +```ballerina +oas:GetCompetitionDataResponse result = check pricefxClient->getProductCompetition(payload); +``` + +
+
+ +
+getProductSetCompetition + +
+ +Get a Product Set + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `label` | string | Yes | Enter the name of the product set you want to retrieve | +| `payload` | oas:GetProductSetRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetProductSetResponse|error` + +**Sample code:** + +```ballerina +oas:GetProductSetResponse result = check pricefxClient->getProductSetCompetition(label, payload); +``` + +
+
+ +
+importProductCompetition + +
+ +Import Competition Data + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ImportCompetitionDataRequest | Yes | The competition product details | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ImportCompetitionDataResponse|error` + +**Sample code:** + +```ballerina +oas:ImportCompetitionDataResponse result = check pricefxClient->importProductCompetition(payload); +``` + +
+
+ +
+listProductSets + +
+ +List Product Sets + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListProductSetsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListProductSetsResponse|error` + +**Sample code:** + +```ballerina +oas:ListProductSetsResponse result = check pricefxClient->listProductSets(payload); +``` + +
+
+ +#### Customers + +
+addCustomer + +
+ +Add a Customer + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddCustomerRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CustomerResponse|error` + +**Sample code:** + +```ballerina +oas:CustomerResponse result = check pricefxClient->addCustomer(payload); +``` + +
+
+ +
+assignCustomers + +
+ +Assign Customers + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AssignCustomersRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignmentResponse|error` + +**Sample code:** + +```ballerina +oas:AssignmentResponse result = check pricefxClient->assignCustomers(payload); +``` + +
+
+ +
+bulkInsertCustomers + +
+ +Insert Bulk Customers + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:InsertBulkCustomersRequest | Yes | Specify customer field names in the `header` object and fields values in the `data` object.<p> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LoadDataResponse|error` + +**Sample code:** + +```ballerina +oas:LoadDataResponse result = check pricefxClient->bulkInsertCustomers(payload); +``` + +
+
+ +
+deleteCustomer + +
+ +Delete a Customer + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCustomerRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCustomerResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteCustomerResponse result = check pricefxClient->deleteCustomer(payload); +``` + +
+
+ +
+getCustomer + +
+ +Get a Customer + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Customer you want to retrieve details for. The `id` is the `typedId` without the **C** suffix. For example, the `id` parameter of the item with `typedId` = **2147492200.C** is **2147492200** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CustomerResponse|error` + +**Sample code:** + +```ballerina +oas:CustomerResponse result = check pricefxClient->getCustomer(id); +``` + +
+
+ +
+listCustomerAssignments + +
+ +List Customer Assignments + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the entity you want to retrieve assignments for | +| `payload` | oas:ListCustomerAssignmentsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AssignmentResponse|error` + +**Sample code:** + +```ballerina +oas:AssignmentResponse result = check pricefxClient->listCustomerAssignments(typedId, payload); +``` + +
+
+ +
+listCustomers + +
+ +List Customers + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListCustomersRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CustomerResponse|error` + +**Sample code:** + +```ballerina +oas:CustomerResponse result = check pricefxClient->listCustomers(payload); +``` + +
+
+ +
+updateCustomer + +
+ +Update a Customer + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateCustomerRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CustomerResponse|error` + +**Sample code:** + +```ballerina +oas:CustomerResponse result = check pricefxClient->updateCustomer(payload); +``` + +
+
+ +
+upsertCustomer + +
+ +Upsert a Customer + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpsertCustomerRequest | Yes | If the customer does not exist yet, at least the `customerId` must be specified in the payload.<p> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CustomerResponse|error` + +**Sample code:** + +```ballerina +oas:CustomerResponse result = check pricefxClient->upsertCustomer(payload); +``` + +
+
+ +#### Customer Extensions + +
+deleteCustomerExtension + +
+ +Delete a Customer Extension + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCustomerExtensionRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCustomerExtensionResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteCustomerExtensionResponse result = check pricefxClient->deleteCustomerExtension(payload); +``` + +
+
+ +
+insertBulkCustomerExtensions + +
+ +Insert Bulk Customer Extensions + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:InsertBulkCustomerExtensionsRequest | Yes | Specify customer extension field names in the `header` object and field values in the `data` object.<p> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LoadDataResponse|error` + +**Sample code:** + +```ballerina +oas:LoadDataResponse result = check pricefxClient->insertBulkCustomerExtensions(payload); +``` + +
+
+ +
+listCustomerExtensionObjects + +
+ +List Customer Extension Objects + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `customerMasterExtensionName` | string | Yes | Enter the name of Customer Extension you want to retrieve objects from. You can find the name in **Administration** > **Configuration** > **Master Data** > **Customer Master Extension** or using the **/configurationmanager.get/customerextension** endpoint | +| `payload` | oas:ListCustomerExtensionObjectsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ListCustomerExtensionObjectsQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ListCustomerExtensionObjectsResponse|error` + +**Sample code:** + +```ballerina +oas:ListCustomerExtensionObjectsResponse result = check pricefxClient->listCustomerExtensionObjects(customerMasterExtensionName, payload, queries); +``` + +
+
+ +
+uploadFileToPxCxSx + +
+ +Upload a File to PX/CX/SX + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "PX"|"CX"|"SX" | Yes | Type code of the table you want to upload the file to | +| `target` | string | Yes | The name of the PX/CX/SX table | +| `uploadSlotId` | string | Yes | `id` of the upload slot. Use the **uploadslotmanager.newuploadslot** endpoint to retrieve the `id` | +| `payload` | oas:TargetuploadSlotIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:UploadFileToPxCxSxQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->uploadFileToPxCxSx(typeCode, target, uploadSlotId, payload, queries); +``` + +
+
+ +
+upsertCustomerExtension + +
+ +Upsert a Customer Extension + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpsertCustomerExtensionRequest | Yes | **Please note**: The data sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/CXAM`** operation | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpsertCustomerExtensionResponse|error` + +**Sample code:** + +```ballerina +oas:UpsertCustomerExtensionResponse result = check pricefxClient->upsertCustomerExtension(payload); +``` + +
+
+ +#### Sellers + +
+addSeller + +
+ +Add a Seller + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddSellerRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddSellerEnvelope|error` + +**Sample code:** + +```ballerina +oas:AddSellerEnvelope result = check pricefxClient->addSeller(payload); +``` + +
+
+ +
+deleteSeller + +
+ +Delete a Seller + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteSellerRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteSellerEnvelope|error` + +**Sample code:** + +```ballerina +oas:DeleteSellerEnvelope result = check pricefxClient->deleteSeller(payload); +``` + +
+
+ +
+listSellers + +
+ +List Sellers + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListSellersRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListSellersEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListSellersEnvelope result = check pricefxClient->listSellers(payload); +``` + +
+
+ +
+updateSeller + +
+ +Update a Seller + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateSellerRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateSellerEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateSellerEnvelope result = check pricefxClient->updateSeller(payload); +``` + +
+
+ +#### Seller Extensions + +
+addSellerExtension + +
+ +Add a Seller Extension + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddSellerExtensionRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddSellerExtensionResponse|error` + +**Sample code:** + +```ballerina +oas:AddSellerExtensionResponse result = check pricefxClient->addSellerExtension(payload); +``` + +
+
+ +
+deleteSellerExtension + +
+ +Delete a Seller Extension + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteSellerExtensionRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteSellerExtensionResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteSellerExtensionResponse result = check pricefxClient->deleteSellerExtension(payload); +``` + +
+
+ +
+getSellerExtension + +
+ +Get a Seller Extension + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `sellerId` | string | Yes | The `SellerId` of the seller in the Seller Extension table you want to retrieve details for | +| `sXCategory` | string | Yes | The Seller Extension category (the `Name` from the *Seller Master Extension* table) | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SellerExtensionEnvelope|error` + +**Sample code:** + +```ballerina +oas:SellerExtensionEnvelope result = check pricefxClient->getSellerExtension(sellerId, sXCategory); +``` + +
+
+ +
+importSellerExtensionFile + +
+ +Import a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `sXCategory` | string | Yes | The Seller Extension category (the `Name` from the *Seller Master Extension* table) | +| `slotId` | string | Yes | The ID that is returned by the **/uploadmanager.newuploadslot** (Create an Upload Slot) endpoint | +| `payload` | oas:ImportSXFileRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ImportSellerExtensionFileQueries | Yes | Queries to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->importSellerExtensionFile(sXCategory, slotId, payload, queries); +``` + +
+
+ +
+insertBulkSellerExtensions + +
+ +Insert Bulk Seller Extensions + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:InsertBulkProductExtensionsRequest1 | Yes | Specify seller extension field names in the `header` object and field values in the `data` object | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->insertBulkSellerExtensions(payload); +``` + +
+
+ +
+listSellerExtensions + +
+ +List Seller Extensions + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `sXCategory` | string | Yes | The Seller Extension category (the `Name` from the *Seller Master Extension* table) | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SellerExtensionEnvelope|error` + +**Sample code:** + +```ballerina +oas:SellerExtensionEnvelope result = check pricefxClient->listSellerExtensions(sXCategory); +``` + +
+
+ +
+updateSellerExtension + +
+ +Update a Seller Extension + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateSXBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateSellerExtensionEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateSellerExtensionEnvelope result = check pricefxClient->updateSellerExtension(payload); +``` + +
+
+ +#### Condition Records + +
+addConditionRecordItemMeta + +
+ +Add a Condition Record Item Attribute Meta + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddCRCIMBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConditionRecordItemMetaOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConditionRecordItemMetaOperationEnvelope result = check pricefxClient->addConditionRecordItemMeta(payload); +``` + +
+
+ +
+addConditionRecordSet + +
+ +Add a Condition Record Set + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddCRCSBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConditionRecordSetOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConditionRecordSetOperationEnvelope result = check pricefxClient->addConditionRecordSet(payload); +``` + +
+
+ +
+deleteConditionRecordItemMeta + +
+ +Delete a Condition Record Item Attribute Meta + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCRCIMBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConditionRecordItemMetaOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConditionRecordItemMetaOperationEnvelope result = check pricefxClient->deleteConditionRecordItemMeta(payload); +``` + +
+
+ +
+deleteConditionRecordSet + +
+ +Delete a Condition Records Set + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DcrmanagerDeletemassopidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConditionRecordSetOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConditionRecordSetOperationEnvelope result = check pricefxClient->deleteConditionRecordSet(payload); +``` + +
+
+ +
+getConditionRecordItem + +
+ +Get a Condition Record Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConditionRecordItemEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConditionRecordItemEnvelope result = check pricefxClient->getConditionRecordItem(payload); +``` + +
+
+ +
+getConditionRecordItemMeta + +
+ +Get a Condition Record Item Attribute Meta + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:FetchCRCIMBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConditionRecordItemMetaEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConditionRecordItemMetaEnvelope result = check pricefxClient->getConditionRecordItemMeta(payload); +``` + +
+
+ +
+getConditionRecordSetItems + +
+ +Get Condition Record Set Items With Set Id Validation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ConditionrecordsetFetchCRCI3Body | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConditionRecordSetItemsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConditionRecordSetItemsEnvelope result = check pricefxClient->getConditionRecordSetItems(payload); +``` + +
+
+ +
+listConditionRecordSets + +
+ +List Condition Record Sets + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListConditionRecordSetsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListConditionRecordSetsEnvelope result = check pricefxClient->listConditionRecordSets(payload); +``` + +
+
+ +
+updateConditionRecordItemMeta + +
+ +Update a Condition Record Item Attribute Meta + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateCRCIMBody | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateConditionRecordItemMetaEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateConditionRecordItemMetaEnvelope result = check pricefxClient->updateConditionRecordItemMeta(payload); +``` + +
+
+ +
+updateConditionRecordSet + +
+ +Update a Condition Record Set + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the ConditionRecordSet object you want to update | +| `payload` | oas:ConditionrecordsetUpdateidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConditionRecordSetOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConditionRecordSetOperationEnvelope result = check pricefxClient->updateConditionRecordSet(id, payload); +``` + +
+
+ +#### Price Lists + +
+addPriceListType + +
+ +Add a Price List Type + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddPLTTBody | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceListTypeOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:PriceListTypeOperationEnvelope result = check pricefxClient->addPriceListType(payload); +``` + +
+
+ +
+calculatePriceList + +
+ +Calculate a Pricelist + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price List you want to calculate. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837** | +| `payload` | oas:PricelistmanagerCalculateidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CalculatePricelistResponse|error` + +**Sample code:** + +```ballerina +oas:CalculatePricelistResponse result = check pricefxClient->calculatePriceList(id, payload); +``` + +
+
+ +
+createPriceList + +
+ +Create a Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:CreatePriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CreatePriceListResponse|error` + +**Sample code:** + +```ballerina +oas:CreatePriceListResponse result = check pricefxClient->createPriceList(payload); +``` + +
+
+ +
+createPriceListRevision + +
+ +Create a Revision + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price List you want to create a revision for. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837** | +| `payload` | oas:CreateRevisionRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceListItemResponse|error` + +**Sample code:** + +```ballerina +oas:PriceListItemResponse result = check pricefxClient->createPriceListRevision(id, payload); +``` + +
+
+ +
+deletePriceList + +
+ +Delete a Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeletePriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeletePriceListResponse|error` + +**Sample code:** + +```ballerina +oas:DeletePriceListResponse result = check pricefxClient->deletePriceList(payload); +``` + +
+
+ +
+deletePriceListItems + +
+ +Delete a Price List Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | Enter the ID of the Price List where you want to delete an item from | +| `payload` | oas:DeletePriceListItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeletePriceListItemResponse|error` + +**Sample code:** + +```ballerina +oas:DeletePriceListItemResponse result = check pricefxClient->deletePriceListItems(id, payload); +``` + +
+
+ +
+deletePriceListType + +
+ +Delete a Price List Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeletePLTTBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceListTypeOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:PriceListTypeOperationEnvelope result = check pricefxClient->deletePriceListType(payload); +``` + +
+
+ +
+getPriceList + +
+ +Get a Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price List you want to retrieve details for. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:GetPriceListResponse result = check pricefxClient->getPriceList(id); +``` + +
+
+ +
+listPriceListItems + +
+ +List Price List Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price List you want to retrieve items for. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837** | +| `payload` | oas:ListPriceListItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceListItemResponse|error` + +**Sample code:** + +```ballerina +oas:PriceListItemResponse result = check pricefxClient->listPriceListItems(id, payload); +``` + +
+
+ +
+listPriceListTypes + +
+ +List Price List Types + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListPriceListTypesEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListPriceListTypesEnvelope result = check pricefxClient->listPriceListTypes(); +``` + +
+
+ +
+listPriceLists + +
+ +List Price Lists + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListPriceListsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListPriceListsResponse|error` + +**Sample code:** + +```ballerina +oas:ListPriceListsResponse result = check pricefxClient->listPriceLists(payload); +``` + +
+
+ +
+revokePriceList + +
+ +Revoke a Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The id to be sent with the request | +| `payload` | oas:PricelistmanagerSubmitidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceListItemResponse|error` + +**Sample code:** + +```ballerina +oas:PriceListItemResponse result = check pricefxClient->revokePriceList(id, payload); +``` + +
+
+ +
+submitPriceList + +
+ +Submit a Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price List you want to submit. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837** | +| `payload` | oas:PricelistmanagerSubmitidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceListItemResponse|error` + +**Sample code:** + +```ballerina +oas:PriceListItemResponse result = check pricefxClient->submitPriceList(id, payload); +``` + +
+
+ +
+updatePriceListDetail + +
+ +Update a Pricelist Detail + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price List whose Item you want to update. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837** | +| `payload` | oas:UpdatePricelistDetailRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdatePricelistDetailResponse|error` + +**Sample code:** + +```ballerina +oas:UpdatePricelistDetailResponse result = check pricefxClient->updatePriceListDetail(id, payload); +``` + +
+
+ +
+updatePriceListType + +
+ +Update a Price List Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdatePLTTBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceListTypeOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:PriceListTypeOperationEnvelope result = check pricefxClient->updatePriceListType(payload); +``` + +
+
+ +#### Manual Price Lists + +
+addManualPriceListProducts + +
+ +Add Products to a Manual Pricelist + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List where you want to add products to | +| `payload` | oas:AddProductsToManualPriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->addManualPriceListProducts(id, payload); +``` + +
+
+ +
+addManualPriceListProductsNoRecalc + +
+ +Add Products to a Manual Price List (No Recalculation) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List where you want to add products to | +| `payload` | oas:AddProductsToManualPriceListNoRecalcRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddProductsToManualPriceListNoRecalcResponse|error` + +**Sample code:** + +```ballerina +oas:AddProductsToManualPriceListNoRecalcResponse result = check pricefxClient->addManualPriceListProductsNoRecalc(id, payload); +``` + +
+
+ +
+calculateManualPriceList + +
+ +Calculate a Manual Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List you want to start the calculation for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CalculateManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:CalculateManualPriceListResponse result = check pricefxClient->calculateManualPriceList(id); +``` + +
+
+ +
+copyManualPriceList + +
+ +Copy a Manual Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List you want to copy | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:ManualPriceListResponse result = check pricefxClient->copyManualPriceList(id); +``` + +
+
+ +
+createManualPriceList + +
+ +Create a Manual Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:CreateManualPriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:ManualPriceListResponse result = check pricefxClient->createManualPriceList(payload); +``` + +
+
+ +
+deleteManualPriceList + +
+ +Delete a Manual Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteManualPriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:ManualPriceListResponse result = check pricefxClient->deleteManualPriceList(payload); +``` + +
+
+ +
+deleteManualPriceListProduct + +
+ +Delete a Product from a Manual Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List whose product you want to delete | +| `payload` | oas:DeleteProductFromManualPriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductResponse|error` + +**Sample code:** + +```ballerina +oas:ProductResponse result = check pricefxClient->deleteManualPriceListProduct(id, payload); +``` + +
+
+ +
+deleteManualPriceListProducts + +
+ +Delete Products from a Manual Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List whose products you want to delete | +| `payload` | oas:DeleteProductsFromManualPriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteProductsFromManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteProductsFromManualPriceListResponse result = check pricefxClient->deleteManualPriceListProducts(id, payload); +``` + +
+
+ +
+listManualPriceListProducts + +
+ +List Products From a Manual Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List you want to retrieve products from | +| `payload` | oas:ListProductsFromManualPriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListProductsFromManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:ListProductsFromManualPriceListResponse result = check pricefxClient->listManualPriceListProducts(id, payload); +``` + +
+
+ +
+listManualPriceLists + +
+ +List Manual Price Lists + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListManualPriceListsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:ManualPriceListResponse result = check pricefxClient->listManualPriceLists(payload); +``` + +
+
+ +
+massEditManualPriceListItems + +
+ +Mass Edit a Manual Price List Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List whose products you want to update | +| `payload` | oas:MassEditMPLRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassEditManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:MassEditManualPriceListResponse result = check pricefxClient->massEditManualPriceListItems(id, payload); +``` + +
+
+ +
+updateManualPriceListItem + +
+ +Update a Manual Price List Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List whose item you want to update | +| `payload` | oas:UpdateManualPriceListRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateManualPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateManualPriceListResponse result = check pricefxClient->updateManualPriceListItem(id, payload); +``` + +
+
+ +
+upsertManualPriceListProduct + +
+ +Upsert a Product in a Manual Price List + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Manual Price List whose product you want to create or update | +| `payload` | oas:UpsertProductManualPriceListRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductResponse|error` + +**Sample code:** + +```ballerina +oas:ProductResponse result = check pricefxClient->upsertManualPriceListProduct(id, payload); +``` + +
+
+ +#### Calculation Grids + +
+acceptCalculationGridItem + +
+ +Submit a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Calculation Grid you want to submit items for. You can retrieve the `id` of the CG, for example, by calling the `/fetch/CG` endpoint | +| `payload` | oas:SubmitCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SubmitCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:SubmitCalculationGridItemResponse result = check pricefxClient->acceptCalculationGridItem(id, payload); +``` + +
+
+ +
+addCalculationGrid + +
+ +Add a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddCalculationGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:AddCalculationGridResponse result = check pricefxClient->addCalculationGrid(payload); +``` + +
+
+ +
+addCalculationGridItem + +
+ +Add a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `keyNumber` | "1"|"2"|"3"|"4"|"5"|"6" | Yes | Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys | +| `payload` | oas:AddCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:AddCalculationGridItemResponse result = check pricefxClient->addCalculationGridItem(keyNumber, payload); +``` + +
+
+ +
+calculateCalculationGrid + +
+ +Calculate a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Calculation Grid you want to calculate | +| `payload` | oas:CalculateCalculationGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CalculateCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:CalculateCalculationGridResponse result = check pricefxClient->calculateCalculationGrid(id, payload); +``` + +
+
+ +
+deleteCalculationGrid + +
+ +Delete a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCalculationGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteCalculationGridResponse result = check pricefxClient->deleteCalculationGrid(payload); +``` + +
+
+ +
+deleteCalculationGridItem + +
+ +Delete a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `keyNumber` | "1"|"2"|"3"|"4"|"5"|"6" | Yes | Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys | +| `payload` | oas:DeleteCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteCalculationGridItemResponse result = check pricefxClient->deleteCalculationGridItem(keyNumber, payload); +``` + +
+
+ +
+getCalculationGrid + +
+ +Get a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | ID of the Calculation Grid you want to retrieve | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:GetCalculationGridResponse result = check pricefxClient->getCalculationGrid(id, payload); +``` + +
+
+ +
+getCalculationGridItem + +
+ +Get a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `keyNumber` | "1"|"2"|"3"|"4"|"5"|"6" | Yes | Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys | +| `id` | string | Yes | `id` of the Calculation Grid Item you want to fetch | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:GetCalculationGridItemResponse result = check pricefxClient->getCalculationGridItem(keyNumber, id, payload); +``` + +
+
+ +
+listCalculationGridItems + +
+ +List Calculation Grid Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `keyNumber` | "1"|"2"|"3"|"4"|"5"|"6" | Yes | Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys | +| `payload` | oas:ListCalculationGridItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCalculationGridItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ListCalculationGridItemsResponse result = check pricefxClient->listCalculationGridItems(keyNumber, payload); +``` + +
+
+ +
+listCalculationGrids + +
+ +List Calculation Grids + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCalculationGridsResponse|error` + +**Sample code:** + +```ballerina +oas:ListCalculationGridsResponse result = check pricefxClient->listCalculationGrids(payload); +``` + +
+
+ +
+rejectCalculationGridItem + +
+ +Deny a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Calculation Grid you want to deny items for. You can retrieve the `id` of the CG, for example, by calling the `/fetch/CG` endpoint | +| `payload` | oas:DenyCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DenyCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:DenyCalculationGridItemResponse result = check pricefxClient->rejectCalculationGridItem(id, payload); +``` + +
+
+ +
+updateCalculationGrid + +
+ +Update a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateCalculationGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateCalculationGridResponse result = check pricefxClient->updateCalculationGrid(payload); +``` + +
+
+ +
+updateCalculationGridItem + +
+ +Update a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Calculation Grid Item you want to update | +| `payload` | oas:UpdateCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateCalculationGridItemResponse result = check pricefxClient->updateCalculationGridItem(id, payload); +``` + +
+
+ +#### Calculated Field Sets + +
+calculateCfs + +
+ +Calculate a CFS + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` is the `typedId` without the type suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CalculateCFSResponse|error` + +**Sample code:** + +```ballerina +oas:CalculateCFSResponse result = check pricefxClient->calculateCfs(id); +``` + +
+
+ +
+cancelCfsCalculation + +
+ +Cancel a CFS Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` is the `typedId` without the type suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->cancelCfsCalculation(id); +``` + +
+
+ +
+deleteCalculatedFieldSet + +
+ +Delete a Calculated Field Set + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCalculatedFieldSetRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->deleteCalculatedFieldSet(payload); +``` + +
+
+ +
+listCalculatedFieldSets + +
+ +List Calculated Field Sets + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCalculatedFieldSetsResponse|error` + +**Sample code:** + +```ballerina +oas:ListCalculatedFieldSetsResponse result = check pricefxClient->listCalculatedFieldSets(); +``` + +
+
+ +#### Live Price Grids + +
+addLivePriceGridType + +
+ +Add a Live Price Grid Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddPGTTBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LivePriceGridTypeOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:LivePriceGridTypeOperationEnvelope result = check pricefxClient->addLivePriceGridType(payload); +``` + +
+
+ +
+addPriceGridItemsToPriceGrid + +
+ +Add Price Grid Items to a Price Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Live Price Grid where you want to add Price Grid Items to. `id` is the `typedId` without **PG** suffix. For example, the `id` attribute of the item with `typedId` = **649.PG** is **649**. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint | +| `payload` | oas:AddPriceGridItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddPriceGridItemsToPriceGridResponse|error` + +**Sample code:** + +```ballerina +oas:AddPriceGridItemsToPriceGridResponse result = check pricefxClient->addPriceGridItemsToPriceGrid(id, payload); +``` + +
+
+ +
+calculatePriceGrid + +
+ +Calculate a Price Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The id to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CalculatePriceGridResponse|error` + +**Sample code:** + +```ballerina +oas:CalculatePriceGridResponse result = check pricefxClient->calculatePriceGrid(id); +``` + +
+
+ +
+cancelPriceGridCalculation + +
+ +Cancel a Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Live Price Grid whose running calculation should be cancelled | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CancelCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:CancelCalculationResponse result = check pricefxClient->cancelPriceGridCalculation(id); +``` + +
+
+ +
+convertToPriceList + +
+ +Convert to Price List + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The id to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConvertPriceListResponse|error` + +**Sample code:** + +```ballerina +oas:ConvertPriceListResponse result = check pricefxClient->convertToPriceList(id); +``` + +
+
+ +
+copyPriceGrid + +
+ +Copy a Price Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Live Price Grid you want to copy. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CopyPriceGridResponse|error` + +**Sample code:** + +```ballerina +oas:CopyPriceGridResponse result = check pricefxClient->copyPriceGrid(id); +``` + +
+
+ +
+countMassActionItems + +
+ +Count Mass Action Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The id to be sent with the request | +| `payload` | oas:CountMassActionItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CountMassActionItemsResponse|error` + +**Sample code:** + +```ballerina +oas:CountMassActionItemsResponse result = check pricefxClient->countMassActionItems(id, payload); +``` + +
+
+ +
+deleteLivePriceGrid + +
+ +Delete a Live Price Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteLivePriceGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteLivePriceGridResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteLivePriceGridResponse result = check pricefxClient->deleteLivePriceGrid(payload); +``` + +
+
+ +
+deleteLivePriceGridType + +
+ +Delete a Live Price Grid Type + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeletePLTTBody | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LivePriceGridTypeOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:LivePriceGridTypeOperationEnvelope result = check pricefxClient->deleteLivePriceGridType(payload); +``` + +
+
+ +
+deletePriceGridItem + +
+ +Delete a Price Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price Grid you want to delete the Price Grid Item from | +| `payload` | oas:DeletePriceGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:PriceGridItemResponse result = check pricefxClient->deletePriceGridItem(id, payload); +``` + +
+
+ +
+deletePriceGridItemFilter + +
+ +Delete a Price Grid Item (Filter) + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price Grid that contains Price Grid Items you want to delete | +| `payload` | oas:DeletePriceGridItemFilterRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->deletePriceGridItemFilter(id, payload); +``` + +
+
+ +
+denyLivePriceGridItem + +
+ +Deny a Live Price Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price Grid that contains the Price Grid Item you want to deny | +| `payload` | oas:DenyLivePriceGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:PriceGridItemResponse result = check pricefxClient->denyLivePriceGridItem(id, payload); +``` + +
+
+ +
+downloadLivePriceGridExcelFile + +
+ +Download a Live Price Grid Excel File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id1` | string | Yes | The id1 to be sent with the request | +| `id2` | string | Yes | The id2 to be sent with the request | +| `id3` | string | Yes | The id3 to be sent with the request | +| `id4` | string | Yes | The id4 to be sent with the request | +| `id5` | string | Yes | The id5 to be sent with the request | +| `id6` | string | Yes | The id6 to be sent with the request | +| `id7` | string | Yes | The id7 to be sent with the request | +| `id8` | string | Yes | The id8 to be sent with the request | +| `id9` | string | Yes | The id9 to be sent with the request | +| `id10` | string | Yes | The id10 to be sent with the request | +| `id11` | string | Yes | The id11 to be sent with the request | +| `id12` | string | Yes | The id12 to be sent with the request | +| `id13` | string | Yes | IDs of the Price Grids you want to download | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:DownloadLivePriceGridExcelFileQueries | Yes | Queries to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->downloadLivePriceGridExcelFile(id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, id12, id13, queries); +``` + +
+
+ +
+getLivePriceGrid + +
+ +Get a Live Price Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Live Price Grid you want to retrieve details for. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetLivePriceGridResponse|error` + +**Sample code:** + +```ballerina +oas:GetLivePriceGridResponse result = check pricefxClient->getLivePriceGrid(id); +``` + +
+
+ +
+listLivePriceGridItems + +
+ +List Live Price Grid Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Live Price Grid you want to retrieve items for. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint | +| `payload` | oas:ListLivePriceGridItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListLivePriceGridItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ListLivePriceGridItemsResponse result = check pricefxClient->listLivePriceGridItems(id, payload); +``` + +
+
+ +
+listLivePriceGridTypes + +
+ +List Live Price Grid Types + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListLivePriceGridTypesEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListLivePriceGridTypesEnvelope result = check pricefxClient->listLivePriceGridTypes(); +``` + +
+
+ +
+listLivePriceGrids + +
+ +List Live Price Grids + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListLivePriceGridsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListLivePriceGridsResponse|error` + +**Sample code:** + +```ballerina +oas:ListLivePriceGridsResponse result = check pricefxClient->listLivePriceGrids(payload); +``` + +
+
+ +
+massEditPriceGridItems + +
+ +Mass Edit Price Grid Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Live Price Grid whose items you want to edit. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint | +| `payload` | oas:MassEditPriceGridItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassEditPriceGridItemsResponse|error` + +**Sample code:** + +```ballerina +oas:MassEditPriceGridItemsResponse result = check pricefxClient->massEditPriceGridItems(id, payload); +``` + +
+
+ +
+performMassAction + +
+ +Perform a Mass Action + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price Grid that contains items you want to apply workflow actions to | +| `payload` | oas:PerformMassActionRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PerformMassActionResponse|error` + +**Sample code:** + +```ballerina +oas:PerformMassActionResponse result = check pricefxClient->performMassAction(id, payload); +``` + +
+
+ +
+submitProducts + +
+ +Submit Products + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Live Price Grid you want to submit items for. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint | +| `payload` | oas:SubmitProductsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SubmitProductsResponse|error` + +**Sample code:** + +```ballerina +oas:SubmitProductsResponse result = check pricefxClient->submitProducts(id, payload); +``` + +
+
+ +
+updateLivePriceGridItem + +
+ +Update a Live Price Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price Grid whose item you want to update. `id` is the `typedId` without **PG** suffix. For example, the `id` attribute of the item with `typedId` = **649.PG** is **649**. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint | +| `payload` | oas:UpdateLivePriceGridItemRequest | Yes | We have performed an update action on the `comments` field in our request sample >>> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:PriceGridItemResponse result = check pricefxClient->updateLivePriceGridItem(id, payload); +``` + +
+
+ +
+updateLivePriceGridItemNo + +
+ +Update a Live Price Grid Item (No Recalculation) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the Price Grid whose item you want to update. `id` is the `typedId` without **PG** suffix. For example, the `id` attribute of the item with `typedId` = **649.PG** is **649**. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint | +| `payload` | oas:UpdateLivePriceGridItemNoRecalcRequest | Yes | We have performed an update action on the `comments` field in our request sample >>> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PriceGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:PriceGridItemResponse result = check pricefxClient->updateLivePriceGridItemNo(id, payload); +``` + +
+
+ +
+updateLivePriceGridType + +
+ +Update a Live Price Grid Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdatePGTTBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LivePriceGridTypeOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:LivePriceGridTypeOperationEnvelope result = check pricefxClient->updateLivePriceGridType(payload); +``` + +
+
+ +#### Quotes + +
+addQuoteProducts + +
+ +Add Products to a Quote + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddProductsToQuoteRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QuoteResponse|error` + +**Sample code:** + +```ballerina +oas:QuoteResponse result = check pricefxClient->addQuoteProducts(payload); +``` + +
+
+ +
+convertQuoteToDeal + +
+ +Convert to a Deal + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `identifier` | string | Yes | Can be either the `uniqueName` or the `typedId` | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QuoteResponse|error` + +**Sample code:** + +```ballerina +oas:QuoteResponse result = check pricefxClient->convertQuoteToDeal(identifier); +``` + +
+
+ +
+copyQuote + +
+ +Copy a Quote + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CopyQuoteEnvelope|error` + +**Sample code:** + +```ballerina +oas:CopyQuoteEnvelope result = check pricefxClient->copyQuote(typedId, payload); +``` + +
+
+ +
+createClic + +
+ +Create a Quote + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "Q"|"QTMP" | Yes | Enter the type code of the entity you want to create | +| `payload` | oas:ClicmanagerCreateTypeCodeBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ClicOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ClicOperationEnvelope result = check pricefxClient->createClic(typeCode, payload); +``` + +
+
+ +
+createQuoteRevision + +
+ +Create a New Revision + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `identifier` | string | Yes | Can be either the `uniqueName` or the `typedId` | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QuoteResponse|error` + +**Sample code:** + +```ballerina +oas:QuoteResponse result = check pricefxClient->createQuoteRevision(identifier); +``` + +
+
+ +
+exportQuoteDocx + +
+ +Export a DOCX File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | Specify the `uniqueName` of the quote you want to download | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ExportQuoteDocxQueries | Yes | Queries to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->exportQuoteDocx(uniqueName, queries); +``` + +
+
+ +
+exportQuoteExcel + +
+ +Export an Excel File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | Specify the `uniqueName` of the quote you want to download | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ExportQuoteExcelQueries | Yes | Queries to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->exportQuoteExcel(uniqueName, queries); +``` + +
+
+ +
+exportQuotePdf + +
+ +Export a PDF File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | Specify the `uniqueName` of the quote you want to download | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ExportQuotePdfQueries | Yes | Queries to be sent with the request | + +**Returns:** `record` + +**Sample code:** + +```ballerina +record result = check pricefxClient->exportQuotePdf(uniqueName, queries); +``` + +
+
+ +
+getClicDraftHeader + +
+ +Get a Temporary Data + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Quote you want to retrieve the temporary data from | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ClicDraftHeaderEnvelope|error` + +**Sample code:** + +```ballerina +oas:ClicDraftHeaderEnvelope result = check pricefxClient->getClicDraftHeader(typedId, payload); +``` + +
+
+ +
+getClicFolderStats + +
+ +Get Folder Statistics + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | typedId of the document whose folder statistics you want to fetch | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:GetClicFolderStatsQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ClicFolderStatsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ClicFolderStatsEnvelope result = check pricefxClient->getClicFolderStats(typedId, queries); +``` + +
+
+ +
+getQuote + +
+ +Get a Quote + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedID` | string | Yes | Enter the quote typed ID. You get the `typedId` in the response when fetching all quotes using the `/quotemanager.fetchlist` endpoint | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QuoteResponse|error` + +**Sample code:** + +```ballerina +oas:QuoteResponse result = check pricefxClient->getQuote(typedID); +``` + +
+
+ +
+listQuoteProducts + +
+ +List Products + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListProductsRequest1 | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->listQuoteProducts(payload); +``` + +
+
+ +
+listQuotes + +
+ +List Quotes + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListQuotesRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListQuotesResponse|error` + +**Sample code:** + +```ballerina +oas:ListQuotesResponse result = check pricefxClient->listQuotes(payload); +``` + +
+
+ +
+markQuoteLost + +
+ +Mark an Offer as Lost + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `identifier` | string | Yes | Can be either the `uniqueName` or the `typedId` | +| `payload` | oas:MarkOfferAsLostRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QuoteResponse|error` + +**Sample code:** + +```ballerina +oas:QuoteResponse result = check pricefxClient->markQuoteLost(identifier, payload); +``` + +
+
+ +
+recalculateQuote + +
+ +Recalculate a Quote + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:RecalculateQuoteRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QuoteResponse|error` + +**Sample code:** + +```ballerina +oas:QuoteResponse result = check pricefxClient->recalculateQuote(payload); +``` + +
+
+ +
+revokeQuote + +
+ +Revoke a Deal + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `identifier` | string | Yes | Can be either the `uniqueName` or the `typedId` | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RevokeDealResponse|error` + +**Sample code:** + +```ballerina +oas:RevokeDealResponse result = check pricefxClient->revokeQuote(identifier); +``` + +
+
+ +
+saveClicDraft + +
+ +Save a Temporary Data + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Temporary Quote you want to save | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ClicOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ClicOperationEnvelope result = check pricefxClient->saveClicDraft(typedId, payload); +``` + +
+
+ +
+submitQuote + +
+ +Submit a Quote + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:SubmitQuoteRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QuoteResponse|error` + +**Sample code:** + +```ballerina +oas:QuoteResponse result = check pricefxClient->submitQuote(payload); +``` + +
+
+ +
+undoRevokeQuote + +
+ +Undo Quote Revocation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->undoRevokeQuote(typedId); +``` + +
+
+ +
+upsertQuote + +
+ +Upsert a Quote + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpsertQuoteRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QuoteResponse|error` + +**Sample code:** + +```ballerina +oas:QuoteResponse result = check pricefxClient->upsertQuote(payload); +``` + +
+
+ +#### Contracts (Agreements & Promotions) + +
+addContractLineItems + +
+ +Add Contract Line Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddContractLineItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ContractModelResponse|error` + +**Sample code:** + +```ballerina +oas:ContractModelResponse result = check pricefxClient->addContractLineItems(payload); +``` + +
+
+ +
+exportContractPdf + +
+ +Export a PDF File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | Specify the `uniqueName` of the A&P you want to download | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->exportContractPdf(uniqueName); +``` + +
+
+ +
+getContract + +
+ +Get a Contract + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | `uniqueName` of the Contract you want to retrieve details for. Alternatively, `typedId` can be also used | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ContractModelResponse|error` + +**Sample code:** + +```ballerina +oas:ContractModelResponse result = check pricefxClient->getContract(uniqueName); +``` + +
+
+ +
+listContractCalculations + +
+ +List Contract Calculations + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListContractCalculationsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListContractCalculationsEnvelope result = check pricefxClient->listContractCalculations(payload); +``` + +
+
+ +
+listContractPriceRecords + +
+ +List Contract Price Records + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:FetchCPRBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListContractPriceRecords|error` + +**Sample code:** + +```ballerina +oas:ListContractPriceRecords result = check pricefxClient->listContractPriceRecords(payload); +``` + +
+
+ +
+listContracts + +
+ +List Contracts + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListContractsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ContractResponse|error` + +**Sample code:** + +```ballerina +oas:ContractResponse result = check pricefxClient->listContracts(payload); +``` + +
+
+ +
+submitContract + +
+ +Submit a Contract + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:SubmitContractRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ContractModelResponse|error` + +**Sample code:** + +```ballerina +oas:ContractModelResponse result = check pricefxClient->submitContract(payload); +``` + +
+
+ +
+undoRevokeContract + +
+ +Undo Agreement & Promotion Revocation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->undoRevokeContract(typedId); +``` + +
+
+ +
+upsertContract + +
+ +Upsert a Contract + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpsertContractRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ContractModelResponse|error` + +**Sample code:** + +```ballerina +oas:ContractModelResponse result = check pricefxClient->upsertContract(payload); +``` + +
+
+ +#### Rebate Agreements + +
+addRebateAgreementItems + +
+ +Add Rebate Agreement Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:GetCustomerRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RebateAgreementResponse|error` + +**Sample code:** + +```ballerina +oas:RebateAgreementResponse result = check pricefxClient->addRebateAgreementItems(payload); +``` + +
+
+ +
+deleteRebateAgreement + +
+ +Delete a Rebate Agreement + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteRebateAgreementRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RebateAgreementResponse|error` + +**Sample code:** + +```ballerina +oas:RebateAgreementResponse result = check pricefxClient->deleteRebateAgreement(payload); +``` + +
+
+ +
+getRebateAgreement + +
+ +Get a Rebate Agreement + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The `uniqueName` of the Rebate Agreement you want to retrieve details for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RebateAgreementResponse|error` + +**Sample code:** + +```ballerina +oas:RebateAgreementResponse result = check pricefxClient->getRebateAgreement(uniqueName); +``` + +
+
+ +
+listRebateAgreementItems + +
+ +List Rebate Agreement Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListRebateAgreementItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListRebateAgreementItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ListRebateAgreementItemsResponse result = check pricefxClient->listRebateAgreementItems(payload); +``` + +
+
+ +
+listRebateAgreements + +
+ +List Rebate Agreements + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListRebateAgreementsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListRebateAgreementsResponse|error` + +**Sample code:** + +```ballerina +oas:ListRebateAgreementsResponse result = check pricefxClient->listRebateAgreements(payload); +``` + +
+
+ +
+undoRebateAgreementRevocation + +
+ +Undo Rebate Agreement Revocation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->undoRebateAgreementRevocation(typedId); +``` + +
+
+ +
+undoRebateRecordRevocation + +
+ +Undo Rebate Record Revocation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->undoRebateRecordRevocation(typedId); +``` + +
+
+ +
+upsertRebateAgreement + +
+ +Upsert a Rebate Agreement + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpsertRebateAgreementRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RebateAgreementResponse|error` + +**Sample code:** + +```ballerina +oas:RebateAgreementResponse result = check pricefxClient->upsertRebateAgreement(payload); +``` + +
+
+ +#### Rebate Calculations + +
+addRebateCalculation + +
+ +Add a Rebate Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddRRSCBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddRebateCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:AddRebateCalculationResponse result = check pricefxClient->addRebateCalculation(payload); +``` + +
+
+ +
+deleteRebateCalculation + +
+ +Delete a Rebate Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteRebateCalculationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteRebateCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteRebateCalculationResponse result = check pricefxClient->deleteRebateCalculation(payload); +``` + +
+
+ +
+listRebateCalculations + +
+ +List Rebate Calculations + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:FetchRRSCBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListRebateCalculationsResponse|error` + +**Sample code:** + +```ballerina +oas:ListRebateCalculationsResponse result = check pricefxClient->listRebateCalculations(payload); +``` + +
+
+ +
+runRebateCalculation + +
+ +Run a Rebate Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:RebaterecordCalculatesetBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RunRebateCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:RunRebateCalculationResponse result = check pricefxClient->runRebateCalculation(payload); +``` + +
+
+ +
+saveRebateCalculation + +
+ +Save a Rebate Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:SaveRebateCalculationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SaveRebateCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:SaveRebateCalculationResponse result = check pricefxClient->saveRebateCalculation(payload); +``` + +
+
+ +#### Rebate Record Group + +
+calculateRebateRecordGroup + +
+ +Calculate a Rebate Record Group + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Rebate Record Group you want to calculate | +| `payload` | oas:RebaterecordgroupCalculatetypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CalculateRebateRecordGroupEnvelope|error` + +**Sample code:** + +```ballerina +oas:CalculateRebateRecordGroupEnvelope result = check pricefxClient->calculateRebateRecordGroup(typedId, payload); +``` + +
+
+ +
+getRebateRecordGroup + +
+ +Get a Rebate Record Group + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->getRebateRecordGroup(payload); +``` + +
+
+ +
+massSubmitRebateRecordGroupItems + +
+ +Mass Submit Rebate Record Groups + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | oas:RebaterecordgroupMasssubmittypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassSubmitRRGResponse|error` + +**Sample code:** + +```ballerina +oas:MassSubmitRRGResponse result = check pricefxClient->massSubmitRebateRecordGroupItems(typedId, payload); +``` + +
+
+ +
+massSubmitRebateRecordGroups + +
+ +Mass Submit Rebate Record Groups + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:RebaterecordgroupMasssubmittypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassSubmitRebateRecordGroupsEnvelope|error` + +**Sample code:** + +```ballerina +oas:MassSubmitRebateRecordGroupsEnvelope result = check pricefxClient->massSubmitRebateRecordGroups(payload); +``` + +
+
+ +
+previewRebateRecordGroupWorkflow + +
+ +Preview a Rebate Record Group Workflow + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | oas:RebaterecordgroupPreviewtypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RebateRecordGroupWorkflowEnvelope|error` + +**Sample code:** + +```ballerina +oas:RebateRecordGroupWorkflowEnvelope result = check pricefxClient->previewRebateRecordGroupWorkflow(typedId, payload); +``` + +
+
+ +
+revokeRebateRecordGroup + +
+ +Revoke a Rebate Record Group + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Rebate Record Group you want to revoke | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RevokeRebateRecordGroupEnvelope|error` + +**Sample code:** + +```ballerina +oas:RevokeRebateRecordGroupEnvelope result = check pricefxClient->revokeRebateRecordGroup(typedId); +``` + +
+
+ +
+shouldSubmitRrgAsynchronously + +
+ +Should Submit a RRG Asynchronously + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Rebate Record Group you want to return the async threshold boolean for | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CheckFileExistsEnvelope|error` + +**Sample code:** + +```ballerina +oas:CheckFileExistsEnvelope result = check pricefxClient->shouldSubmitRrgAsynchronously(typedId, payload); +``` + +
+
+ +
+submitRebateRecordGroup + +
+ +Submit a Rebate Record Group + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Rebate Record Group you want to submit | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SubmitRebateRecordGroup|error` + +**Sample code:** + +```ballerina +oas:SubmitRebateRecordGroup result = check pricefxClient->submitRebateRecordGroup(typedId, payload); +``` + +
+
+ +
+undoRebateRecordGroupRevocation + +
+ +Undo Rebate Record Group Revocation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->undoRebateRecordGroupRevocation(typedId); +``` + +
+
+ +#### Sales Compensations + +
+addCalculation + +
+ +Add a Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddCalculationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:AddCalculationResponse result = check pricefxClient->addCalculation(payload); +``` + +
+
+ +
+addCompensationType + +
+ +Add a Compensation Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddCompensationTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddCompensationTypeEnvelope|error` + +**Sample code:** + +```ballerina +oas:AddCompensationTypeEnvelope result = check pricefxClient->addCompensationType(payload); +``` + +
+
+ +
+addConditionType + +
+ +Add a Condition Type + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddConditionTypeRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddConditionTypeEnvelope|error` + +**Sample code:** + +```ballerina +oas:AddConditionTypeEnvelope result = check pricefxClient->addConditionType(payload); +``` + +
+
+ +
+deleteCalculation + +
+ +Delete a Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCalculationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteCalculationResponse result = check pricefxClient->deleteCalculation(payload); +``` + +
+
+ +
+deleteCompensationPlan + +
+ +Delete a Compensation Plan + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCompensationPlanRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCompensationPlanResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteCompensationPlanResponse result = check pricefxClient->deleteCompensationPlan(payload); +``` + +
+
+ +
+deleteCompensationType + +
+ +Delete a Compensation Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCOHTBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCompensationTypeEnvelope|error` + +**Sample code:** + +```ballerina +oas:DeleteCompensationTypeEnvelope result = check pricefxClient->deleteCompensationType(payload); +``` + +
+
+ +
+deleteConditionType + +
+ +Delete a Condition Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteConditionTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteConditionTypeEnvelope|error` + +**Sample code:** + +```ballerina +oas:DeleteConditionTypeEnvelope result = check pricefxClient->deleteConditionType(payload); +``` + +
+
+ +
+duplicateCompensationPlan + +
+ +Duplicate a Compensation Plan + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Compensation Plan you want to duplicate | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DuplicateCompensationPlanEnvelope|error` + +**Sample code:** + +```ballerina +oas:DuplicateCompensationPlanEnvelope result = check pricefxClient->duplicateCompensationPlan(typedId); +``` + +
+
+ +
+getSignatureStatus + +
+ +Get a Signature Status + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Compensation document you want to retrieve the signature status for | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetSignatureStatusResponse|error` + +**Sample code:** + +```ballerina +oas:GetSignatureStatusResponse result = check pricefxClient->getSignatureStatus(typedId, payload); +``` + +
+
+ +
+getSignedDocument + +
+ +Get a Signed Document + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | A `uniqueName` of the Compensation Plan you want to download a signed file for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->getSignedDocument(uniqueName); +``` + +
+
+ +
+listAccrualRecords + +
+ +List Accrual Records + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListAccrualRecordsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListAccrualRecordsResponse|error` + +**Sample code:** + +```ballerina +oas:ListAccrualRecordsResponse result = check pricefxClient->listAccrualRecords(payload); +``` + +
+
+ +
+listCalculations + +
+ +List Calculations + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListCalculationsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCalculationsResponse|error` + +**Sample code:** + +```ballerina +oas:ListCalculationsResponse result = check pricefxClient->listCalculations(payload); +``` + +
+
+ +
+listCompensationPlans + +
+ +List Compensation Plans + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListCompensationPlansRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCompensationPlansResponse|error` + +**Sample code:** + +```ballerina +oas:ListCompensationPlansResponse result = check pricefxClient->listCompensationPlans(payload); +``` + +
+
+ +
+listCompensationRecords + +
+ +List Compensation Records + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `compensationRecordSetId` | string | Yes | ID of the CompensationRecordSet into which this Compensation Record belongs. By default it belongs to "Default" CompensationRecordSet, but you can change it when you create the Compensation Record. This can be useful if you create different "kinds" of Compensation Records which will be used to calculate different results at different times | +| `payload` | oas:ListCompensationRecordsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCompensationRecordsResponse|error` + +**Sample code:** + +```ballerina +oas:ListCompensationRecordsResponse result = check pricefxClient->listCompensationRecords(compensationRecordSetId, payload); +``` + +
+
+ +
+listCompensationTypes + +
+ +List Compensation Types + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListCompensationTypesRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCompensationTypesEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListCompensationTypesEnvelope result = check pricefxClient->listCompensationTypes(payload); +``` + +
+
+ +
+listConditionTypes + +
+ +List Condition Types + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListConditionTypesRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListConditionTypesEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListConditionTypesEnvelope result = check pricefxClient->listConditionTypes(payload); +``` + +
+
+ +
+recalculateQuoteContractRebate + +
+ +Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the document you want to calculate | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:RecalculateQuoteContractRebateQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:RecalculateClicEnvelope|error` + +**Sample code:** + +```ballerina +oas:RecalculateClicEnvelope result = check pricefxClient->recalculateQuoteContractRebate(typedId, queries); +``` + +
+
+ +
+revokeCompensationRecord + +
+ +Revoke a Compensation Record + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Compensation Record you want to revoke | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->revokeCompensationRecord(typedId); +``` + +
+
+ +
+runCalculation + +
+ +Run a Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:RunCalculationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RunCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:RunCalculationResponse result = check pricefxClient->runCalculation(payload); +``` + +
+
+ +
+saveCalculation + +
+ +Save Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:SaveCalculationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SaveCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:SaveCalculationResponse result = check pricefxClient->saveCalculation(payload); +``` + +
+
+ +
+saveCompensationRecord + +
+ +Save a Compensation Record + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:SaveCompensationRecordRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SaveCompensationRecordResponse|error` + +**Sample code:** + +```ballerina +oas:SaveCompensationRecordResponse result = check pricefxClient->saveCompensationRecord(payload); +``` + +
+
+ +
+sendDocumentToSign + +
+ +Send a Document to Sign + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Compensation whose data you want to send via the e-signature system | +| `payload` | oas:CreateSignatureRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CreateSignatureResponse|error` + +**Sample code:** + +```ballerina +oas:CreateSignatureResponse result = check pricefxClient->sendDocumentToSign(typedId, payload); +``` + +
+
+ +
+undoCompensationPlanRevocation + +
+ +Undo Compensation Plan Revocation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->undoCompensationPlanRevocation(typedId); +``` + +
+
+ +
+undoCompensationRecordRevocation + +
+ +Undo Compensation Record Revocation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->undoCompensationRecordRevocation(typedId); +``` + +
+
+ +
+updateCompensationRecord + +
+ +Update a Compensation Record + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateCompensationRecordRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateCompensationRecordResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateCompensationRecordResponse result = check pricefxClient->updateCompensationRecord(payload); +``` + +
+
+ +
+updateCompensationType + +
+ +Update a Compensation Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateCompensationTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateCompensationTypeEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateCompensationTypeEnvelope result = check pricefxClient->updateCompensationType(payload); +``` + +
+
+ +
+updateConditionType + +
+ +Update a Condition Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateConditionTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateConditionTypeEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateConditionTypeEnvelope result = check pricefxClient->updateConditionType(payload); +``` + +
+
+ +
+updateQuoteContractRebateAgreement + +
+ +Update a Quote/Contract/Rebate Agreement/Compensation Plan + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Compensation Plan you want to update | +| `payload` | oas:ClicmanagerUpdatetypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateClicEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateClicEnvelope result = check pricefxClient->updateQuoteContractRebateAgreement(typedId, payload); +``` + +
+
+ +
+upsertCompensationPlan + +
+ +Upsert a Compensation Plan + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpsertCompensationPlanRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpsertCompensationPlanResponse|error` + +**Sample code:** + +```ballerina +oas:UpsertCompensationPlanResponse result = check pricefxClient->upsertCompensationPlan(payload); +``` + +
+
+ +#### Claims + +
+addClaim + +
+ +Add a Claim + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddClaimRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddClaimResponse|error` + +**Sample code:** + +```ballerina +oas:AddClaimResponse result = check pricefxClient->addClaim(payload); +``` + +
+
+ +
+calculateClaim + +
+ +Calculate a Claim + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the claim whose items you want to calculate | +| `payload` | oas:CalculateClaimRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CalculateClaimResponse|error` + +**Sample code:** + +```ballerina +oas:CalculateClaimResponse result = check pricefxClient->calculateClaim(typedId, payload); +``` + +
+
+ +
+cancelClaimCalculation + +
+ +Cancel a Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the claim whose item calculation you want to cancel | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CancelClaimCalculationResponse|error` + +**Sample code:** + +```ballerina +oas:CancelClaimCalculationResponse result = check pricefxClient->cancelClaimCalculation(typedId, payload); +``` + +
+
+ +
+getSummary + +
+ +Get a Summary + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetClaimItemsSummaryResponse|error` + +**Sample code:** + +```ballerina +oas:GetClaimItemsSummaryResponse result = check pricefxClient->getSummary(typedId, payload); +``` + +
+
+ +
+listClaims + +
+ +List Claims + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListClaimsRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListClaimsResponse|error` + +**Sample code:** + +```ballerina +oas:ListClaimsResponse result = check pricefxClient->listClaims(payload); +``` + +
+
+ +
+listItems + +
+ +List Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListClaimItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ListClaimItemsResponse result = check pricefxClient->listItems(typedId, payload); +``` + +
+
+ +
+rejectItems + +
+ +Reject Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Claim whose items you want to reject | +| `payload` | oas:RejectClaimItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RejectClaimItemsResponse|error` + +**Sample code:** + +```ballerina +oas:RejectClaimItemsResponse result = check pricefxClient->rejectItems(typedId, payload); +``` + +
+
+ +
+removeItems + +
+ +Remove Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Claim whose items you want to remove | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RemoveClaimItemsResponse|error` + +**Sample code:** + +```ballerina +oas:RemoveClaimItemsResponse result = check pricefxClient->removeItems(typedId, payload); +``` + +
+
+ +
+submitClaim + +
+ +Submit a Claim + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Claim you want to submit | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SubmitClaimResponse|error` + +**Sample code:** + +```ballerina +oas:SubmitClaimResponse result = check pricefxClient->submitClaim(typedId, payload); +``` + +
+
+ +
+updateClaim + +
+ +Update a Claim + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateClaimRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateClaimResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateClaimResponse result = check pricefxClient->updateClaim(payload); +``` + +
+
+ +
+validateItems + +
+ +Validate Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Claim whose items you want to validate | +| `payload` | oas:ValidateClaimItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ValidateClaimItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ValidateClaimItemsResponse result = check pricefxClient->validateItems(typedId, payload); +``` + +
+
+ +#### Claim Types + +
+addClaimType + +
+ +Add a Claim Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddClaimTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddClaimTypeResponse|error` + +**Sample code:** + +```ballerina +oas:AddClaimTypeResponse result = check pricefxClient->addClaimType(payload); +``` + +
+
+ +
+deleteClaimType + +
+ +Delete a Claim Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteClaimTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteClaimTypeResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteClaimTypeResponse result = check pricefxClient->deleteClaimType(payload); +``` + +
+
+ +
+listClaimTypes + +
+ +List Claim Types + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListClaimTypesRequest | Yes | The example of the request body contains the filter. The call returns Claim Types whose `name` equals to "claimType" | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListClaimTypesResponse|error` + +**Sample code:** + +```ballerina +oas:ListClaimTypesResponse result = check pricefxClient->listClaimTypes(payload); +``` + +
+
+ +
+updateClaimType + +
+ +Update a Claim Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateClaimTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateClaimTypeResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateClaimTypeResponse result = check pricefxClient->updateClaimType(payload); +``` + +
+
+ +#### Attachments + +
+checkFileExists + +
+ +Check a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `binaryDataId` | string | Yes | If the `typedId` is, for example, 1145.BD then the binaryDataId is **1145** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CheckFileExistsEnvelope|error` + +**Sample code:** + +```ballerina +oas:CheckFileExistsEnvelope result = check pricefxClient->checkFileExists(binaryDataId); +``` + +
+
+ +
+createUploadSlot + +
+ +1. Create an Upload Slot + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:CreateUploadSlotQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:CreateUploadSlotEnvelope|error` + +**Sample code:** + +```ballerina +oas:CreateUploadSlotEnvelope result = check pricefxClient->createUploadSlot(queries); +``` + +
+
+ +
+deleteFile + +
+ +Delete a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the document whose attachment you want to delete | +| `binaryDataId` | string | Yes | If the `typedId` is, for example, 1145.BD then the binaryDataId is **1145** | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->deleteFile(typedId, binaryDataId, payload); +``` + +
+
+ +
+deleteUploadSlot + +
+ +3. Delete an Upload Slot + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `slotId` | string | Yes | Enter the ID of the slot you want to delete | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UploadSlotOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:UploadSlotOperationEnvelope result = check pricefxClient->deleteUploadSlot(slotId); +``` + +
+
+ +
+downloadAttachmentData + +
+ +Download an Attachment + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `binaryDataId` | string | Yes | If the typedId is, for example, 1146.BD then the binaryDataId is **1146** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:DownloadAttachmentDataQueries | Yes | Queries to be sent with the request | + +**Returns:** `byte[]|error` + +**Sample code:** + +```ballerina +byte[] result = check pricefxClient->downloadAttachmentData(binaryDataId, queries); +``` + +
+
+ +
+downloadFile + +
+ +Download a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the document you want to download the attachment from | +| `binaryDataId` | string | Yes | If the `typedId` is, for example, 1145.BD then the binaryDataId is **1145** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:DownloadFileQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:FileDownloadEnvelope|error` + +**Sample code:** + +```ballerina +oas:FileDownloadEnvelope result = check pricefxClient->downloadFile(typedId, binaryDataId, queries); +``` + +
+
+ +
+downloadFileViaPost + +
+ +Download a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the document you want to download the attachment from | +| `binaryDataId` | string | Yes | If the `typedId` is, for example, 1145.BD then the binaryDataId is **1145** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:DownloadFileViaPostQueries | Yes | Queries to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->downloadFileViaPost(typedId, binaryDataId, queries); +``` + +
+
+ +
+editAttachment + +
+ +2. Upload a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `ownerTypedId` | string | Yes | The `TypedId` of the document owning the attachment | +| `binaryDataId` | string | Yes | The `binaryDataId` of the attachment to replace | +| `slotId` | string | Yes | The upload `slot_id` containing the new file | +| `payload` | oas:BinaryDataIdslotIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:FileDownloadEnvelope|error` + +**Sample code:** + +```ballerina +oas:FileDownloadEnvelope result = check pricefxClient->editAttachment(ownerTypedId, binaryDataId, slotId, payload); +``` + +
+
+ +
+getUploadProgress + +
+ +Get Upload Progress + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uploadslot` | string | Yes | Upload Slot Id | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UploadSlotOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:UploadSlotOperationEnvelope result = check pricefxClient->getUploadProgress(uploadslot); +``` + +
+
+ +
+listFiles + +
+ +List Files + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the document you want to list attachments for | +| `payload` | oas:BdmanagerListtypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListFilesEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListFilesEnvelope result = check pricefxClient->listFiles(typedId, payload); +``` + +
+
+ +
+updateFile + +
+ +Update a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the document whose attachment's metadata you want to update | +| `payload` | oas:BdmanagerUpdatetypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateFileEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateFileEnvelope result = check pricefxClient->updateFile(typedId, payload); +``` + +
+
+ +
+uploadFile + +
+ +2. Upload a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the document you want to attach the file to | +| `slotId` | string | Yes | The ID of the slot you want to use for the upload. retrieve the slot ID using the `/uploadmanager.newuploadslot` (Create an Upload Slot) endpoint | +| `payload` | oas:TypedIdslotIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:FileOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:FileOperationEnvelope result = check pricefxClient->uploadFile(typedId, slotId, payload); +``` + +
+
+ +#### Comments + +
+addComment + +
+ +Add a Comment + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:CommentmanagerAddBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CommentOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:CommentOperationEnvelope result = check pricefxClient->addComment(payload); +``` + +
+
+ +
+deleteComment + +
+ +Delete a Comment + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | Comment or CommentThread typedId | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCommentEnvelope|error` + +**Sample code:** + +```ballerina +oas:DeleteCommentEnvelope result = check pricefxClient->deleteComment(typedId); +``` + +
+
+ +
+editComment + +
+ +Edit a Comment + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | typedId of the comment you want to edit | +| `payload` | oas:CommentmanagerEdittypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CommentOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:CommentOperationEnvelope result = check pricefxClient->editComment(typedId, payload); +``` + +
+
+ +
+listCommentThreads + +
+ +List Comment Threads + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | typedId of the object you want to fetch comments for | +| `payload` | oas:CommentmanagerFetchthreadstypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ListCommentThreadsQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ListCommentThreadsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListCommentThreadsEnvelope result = check pricefxClient->listCommentThreads(typedId, payload, queries); +``` + +
+
+ +
+replyToComment + +
+ +Reply To a Comment + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:CommentmanagerReplyBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CommentOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:CommentOperationEnvelope result = check pricefxClient->replyToComment(payload); +``` + +
+
+ +
+resolveComment + +
+ +Resolve a Comment + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId of the comment thread | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ResolveCommentEnvelope|error` + +**Sample code:** + +```ballerina +oas:ResolveCommentEnvelope result = check pricefxClient->resolveComment(typedId, payload); +``` + +
+
+ +
+unresolveComment + +
+ +Unresolve a Comment + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId of the comment thread | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ResolveCommentEnvelope|error` + +**Sample code:** + +```ballerina +oas:ResolveCommentEnvelope result = check pricefxClient->unresolveComment(typedId, payload); +``` + +
+
+ +#### Custom Forms + +
+changeCustomFormStatus + +
+ +Change a Custom Form Status + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Custom Form whose status you want to change | +| `payload` | oas:ChangeCustomFormStatusRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ChangeCustomFormStatusResponse|error` + +**Sample code:** + +```ballerina +oas:ChangeCustomFormStatusResponse result = check pricefxClient->changeCustomFormStatus(typedId, payload); +``` + +
+
+ +
+createCustomForm + +
+ +Create a Custom Form + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:CreateCustomFormRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CreateCustomFormEnvelope|error` + +**Sample code:** + +```ballerina +oas:CreateCustomFormEnvelope result = check pricefxClient->createCustomForm(payload); +``` + +
+
+ +
+createCustomFormRevision + +
+ +Create a Custom Form Revision + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Custom Form you want to create a revision from | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CustomFormRevisionEnvelope|error` + +**Sample code:** + +```ballerina +oas:CustomFormRevisionEnvelope result = check pricefxClient->createCustomFormRevision(typedId, payload); +``` + +
+
+ +
+createCustomFormType + +
+ +Create a Custom Form Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:CreateCustomFormTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CreateCustomFormTypeResponse|error` + +**Sample code:** + +```ballerina +oas:CreateCustomFormTypeResponse result = check pricefxClient->createCustomFormType(payload); +``` + +
+
+ +
+deleteCustomForm + +
+ +Delete a Custom Form + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCustomFormRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->deleteCustomForm(payload); +``` + +
+
+ +
+deleteCustomFormType + +
+ +Delete a Custom Form Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCFOTBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCustomFormTypeEnvelope|error` + +**Sample code:** + +```ballerina +oas:DeleteCustomFormTypeEnvelope result = check pricefxClient->deleteCustomFormType(payload); +``` + +
+
+ +
+duplicateCustomForm + +
+ +Duplicate a Custom Form + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Custom Form you want to duplicate | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CustomFormRevisionEnvelope|error` + +**Sample code:** + +```ballerina +oas:CustomFormRevisionEnvelope result = check pricefxClient->duplicateCustomForm(typedId, payload); +``` + +
+
+ +
+getCustomForm + +
+ +Get a Custom Form + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Custom Form you want to retrieve details for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetCustomFormResponse|error` + +**Sample code:** + +```ballerina +oas:GetCustomFormResponse result = check pricefxClient->getCustomForm(typedId); +``` + +
+
+ +
+listCustomFormTypes + +
+ +List Custom Form Types + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListCustomFormTypesRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCustomFormTypesResponse|error` + +**Sample code:** + +```ballerina +oas:ListCustomFormTypesResponse result = check pricefxClient->listCustomFormTypes(payload); +``` + +
+
+ +
+listCustomForms + +
+ +List Custom Forms + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListCustomFormsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCustomFormsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListCustomFormsEnvelope result = check pricefxClient->listCustomForms(payload); +``` + +
+
+ +
+previewCustomFormWorkflow + +
+ +Preview a Custom Form Workflow + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:PreviewCustomFormWorkflowResponse|error` + +**Sample code:** + +```ballerina +oas:PreviewCustomFormWorkflowResponse result = check pricefxClient->previewCustomFormWorkflow(payload); +``` + +
+
+ +
+updateCustomForm + +
+ +Update a Custom Form + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateCustomFormRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateCustomFormEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateCustomFormEnvelope result = check pricefxClient->updateCustomForm(payload); +``` + +
+
+ +
+updateCustomFormType + +
+ +Update a Custom Form Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateCustomFormTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateCustomFormTypeResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateCustomFormTypeResponse result = check pricefxClient->updateCustomFormType(payload); +``` + +
+
+ +#### Data Change Requests + +
+addDataChangeRequest + +
+ +Add a Data Change Request + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddDCRRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddDCRResponse|error` + +**Sample code:** + +```ballerina +oas:AddDCRResponse result = check pricefxClient->addDataChangeRequest(payload); +``` + +
+
+ +
+addDataChangeRequestItem + +
+ +Add a Data Change Request Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request you want to add the Data Change Request Item to | +| `payload` | oas:AddDCRIRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddDCRIResponse|error` + +**Sample code:** + +```ballerina +oas:AddDCRIResponse result = check pricefxClient->addDataChangeRequestItem(id, payload); +``` + +
+
+ +
+deleteDataChangeRequestItem + +
+ +Delete a Data Change Request Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request whose item you want to delete | +| `payload` | oas:DeleteDCRIRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteDCRIResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteDCRIResponse result = check pricefxClient->deleteDataChangeRequestItem(id, payload); +``` + +
+
+ +
+deleteDataChangeRequestMassChange + +
+ +Delete a Data Change Request Mass Change + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request | +| `payload` | oas:DcrmanagerDeletemassopidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DataChangeRequestMassChangeEnvelope|error` + +**Sample code:** + +```ballerina +oas:DataChangeRequestMassChangeEnvelope result = check pricefxClient->deleteDataChangeRequestMassChange(id, payload); +``` + +
+
+ +
+getDataChangeRequest + +
+ +Get a Data Change Request + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request you want to retrieve | +| `payload` | oas:GetDCRRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetDCRResponse|error` + +**Sample code:** + +```ballerina +oas:GetDCRResponse result = check pricefxClient->getDataChangeRequest(id, payload); +``` + +
+
+ +
+getDataChangeRequestChanges + +
+ +Get a Data Change Request (changes only) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request you want to retrieve changed items for | +| `payload` | oas:GetDCRRequestChangeOnly | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetDCRResponseChangeOnly|error` + +**Sample code:** + +```ballerina +oas:GetDCRResponseChangeOnly result = check pricefxClient->getDataChangeRequestChanges(id, payload); +``` + +
+
+ +
+getDataChangeRequestMassChanges + +
+ +Get Data Change Request Mass Changes + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request | +| `payload` | oas:DcrmanagerFetchmassopidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DataChangeRequestMassChangeEnvelope|error` + +**Sample code:** + +```ballerina +oas:DataChangeRequestMassChangeEnvelope result = check pricefxClient->getDataChangeRequestMassChanges(id, payload); +``` + +
+
+ +
+massEditDataChangeRequestItems + +
+ +Mass Edit Data Change Request Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request | +| `payload` | oas:DcrmanagerAddmassopidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DataChangeRequestMassChangeEnvelope|error` + +**Sample code:** + +```ballerina +oas:DataChangeRequestMassChangeEnvelope result = check pricefxClient->massEditDataChangeRequestItems(id, payload); +``` + +
+
+ +
+submitDataChangeRequest + +
+ +Submit a Data Change Request + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the DCR to be submitted | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SubmitDCRResponse|error` + +**Sample code:** + +```ballerina +oas:SubmitDCRResponse result = check pricefxClient->submitDataChangeRequest(id, payload); +``` + +
+
+ +
+submitDataChangeRequestAsync + +
+ +Submit a Data Change Request (async) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the DCR to be submitted | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SubmitDCRAsyncResponse|error` + +**Sample code:** + +```ballerina +oas:SubmitDCRAsyncResponse result = check pricefxClient->submitDataChangeRequestAsync(id, payload); +``` + +
+
+ +
+updateDataChangeRequestItem + +
+ +Update a Data Change Request Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request whose item you want to update | +| `payload` | oas:UpdateDCRIRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateDCRIResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateDCRIResponse result = check pricefxClient->updateDataChangeRequestItem(id, payload); +``` + +
+
+ +
+updateDataChangeRequestMassChanges + +
+ +Update Data Change Request Mass Changes + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Data Change Request | +| `payload` | oas:DcrmanagerUpdatemassopidBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DataChangeRequestMassChangeEnvelope|error` + +**Sample code:** + +```ballerina +oas:DataChangeRequestMassChangeEnvelope result = check pricefxClient->updateDataChangeRequestMassChanges(id, payload); +``` + +
+
+ +#### Data Manager + +
+createDMFieldCollection + +
+ +Create a DMFieldCollection + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `fcType` | "DMDS"|"DMT" | Yes | The type of FC (FieldCollection) you want to create | +| `payload` | oas:DatamartCreatefcfcTypeBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->createDMFieldCollection(fcType, payload); +``` + +
+
+ +
+createDataManagerEntity + +
+ +Create a Data Manager Entity + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "DMF"|"DM"|"DMDS" | Yes | The type code of the **Field Collection** you want to update | +| `payload` | oas:CreateDataManagerEntityRequest | Yes | Either `uniqueName` or `typedId` must be provided in the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DmObjectResponse|error` + +**Sample code:** + +```ballerina +oas:DmObjectResponse result = check pricefxClient->createDataManagerEntity(typeCode, payload); +``` + +
+
+ +
+deleteDataManagerEntity + +
+ +Delete a Data Manager Entity + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "DM"|"DMF"|"DMDS" | Yes | The type code of the **Field Collection** you want to delete | +| `payload` | oas:DeleteDataManagerEntityRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteDataManagerEntityResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteDataManagerEntityResponse result = check pricefxClient->deleteDataManagerEntity(typeCode, payload); +``` + +
+
+ +
+deleteDatamartOrphanObjects + +
+ +Delete Datamart Orphan Objects + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DatamartOrphanObjectsEnvelope|error` + +**Sample code:** + +```ballerina +oas:DatamartOrphanObjectsEnvelope result = check pricefxClient->deleteDatamartOrphanObjects(); +``` + +
+
+ +
+executeDataLoadLogic + +
+ +Execute a Data Load Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Data Load you want to evaluate | +| `logicName` | string | Yes | The name of the logic you want to execute | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ExecuteDataLoadLogicResponse|error` + +**Sample code:** + +```ballerina +oas:ExecuteDataLoadLogicResponse result = check pricefxClient->executeDataLoadLogic(typedId, logicName); +``` + +
+
+ +
+exportCsvFile + +
+ +Export a CSV File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ExportCSVFileRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ExportCsvFileQueries | Yes | Queries to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->exportCsvFile(payload, queries); +``` + +
+
+ +
+exportDatamart + +
+ +Export Datamart + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `fcTypedIdOrSourceName` | string | Yes | Restricts the export to a specific source, identified by either the 'typedId' or 'sourceName'. | +| `payload` | oas:ExportDatamartRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ExportDatamartQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ExportDatamartResponse|error` + +**Sample code:** + +```ballerina +oas:ExportDatamartResponse result = check pricefxClient->exportDatamart(fcTypedIdOrSourceName, payload, queries); +``` + +
+
+ +
+exportExcelFileXlsx + +
+ +Export an Excel File (XLSX) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ExportExcelFileRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ExportExcelFileXlsxQueries | Yes | Queries to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->exportExcelFileXlsx(payload, queries); +``` + +
+
+ +
+fetchDataMartObject + +
+ +Get a DM Object - **typedUniquename** – Format: "*<typeCode>.<uniqueName>*" (e.g., DMDS.SalesTransactions) - **typedId** – Format: "*<dbId>.<typeCode>*" (e.g., 123456.DMDS)' - **"*"** (asterisk) – Asterisk can be used when you are providing a **source$query** in `data` within the request body + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `objectId` | string | Yes | Use one of the following object identifiers: | +| `payload` | oas:GetDMObjectRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:FetchDataMartObjectQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:GetDMObjectResponse|error` + +**Sample code:** + +```ballerina +oas:GetDMObjectResponse result = check pricefxClient->fetchDataMartObject(objectId, payload, queries); +``` + +
+
+ +
+getActionStatus + +
+ +Get Action Status + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `actionUUID` | string | Yes | The actionUUID to be sent with the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetActionStatusResponse|error` + +**Sample code:** + +```ballerina +oas:GetActionStatusResponse result = check pricefxClient->getActionStatus(actionUUID); +``` + +
+
+ +
+getDataMartObject + +
+ +Get a DM Object - **typedUniquename** – Format: "*<typeCode>.<uniqueName>*" (e.g., DMDS.SalesTransactions) - **typedId** – Format: "*<dbId>.<typeCode>*" (e.g., 123456.DMDS)' - **"*"** (asterisk) – Asterisk can be used when you are providing a **source$query** in `data` within the request body + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `objectId` | string | Yes | Use one of the following object identifiers: | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:GetDataMartObjectQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:DataMartObjectEnvelope|error` + +**Sample code:** + +```ballerina +oas:DataMartObjectEnvelope result = check pricefxClient->getDataMartObject(objectId, queries); +``` + +
+
+ +
+getDmExportFile + +
+ +Get a DM Export File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `fileName` | string | Yes | The name of the file previously created by a `datamart.export` request. The filename needs to be an exact match - no wildcards allowed, hence only one file at the time can be fetched | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->getDmExportFile(fileName); +``` + +
+
+ +
+getDmObjectNo + +
+ +Get a DM Object (no count) - **typedUniquename** – Format: "*<typeCode>.<uniqueName>*" (e.g., DMDS.SalesTransactions) - **typedId** – Format: "*<dbId>.<typeCode>*" (e.g., 123456.DMDS) - **"*"** (asterisk) – Asterisk can be used when you are providing a **source$query** in `data` within the request body + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `objectId` | string | Yes | Use one of the following object identifiers: | +| `payload` | oas:GetDMObjectNoCountRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetDMObjectNoCountResponse|error` + +**Sample code:** + +```ballerina +oas:GetDMObjectNoCountResponse result = check pricefxClient->getDmObjectNo(objectId, payload); +``` + +
+
+ +
+importDataLoad + +
+ +Import a Data Load + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ImportDataLoadRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->importDataLoad(payload); +``` + +
+
+ +
+importDataMartFile + +
+ +Import a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `slotId` | string | Yes | The `id` of the slot. Create the slot and retrieve the `id` using the **/uploadmanager.newuploadslot** endpoint | +| `typedId` | string | Yes | The `typedId` of the Data Manager entity | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->importDataMartFile(slotId, typedId); +``` + +
+
+ +
+listCharts + +
+ +List Charts + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListChartsResponse|error` + +**Sample code:** + +```ballerina +oas:ListChartsResponse result = check pricefxClient->listCharts(); +``` + +
+
+ +
+listDataLoads + +
+ +List Data Loads + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListDataLoadsResponse|error` + +**Sample code:** + +```ballerina +oas:ListDataLoadsResponse result = check pricefxClient->listDataLoads(); +``` + +
+
+ +
+listDataLoadsWith + +
+ +List Data Loads (with validation and schedules) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListDataLoadsWithValidationResponse|error` + +**Sample code:** + +```ballerina +oas:ListDataLoadsWithValidationResponse result = check pricefxClient->listDataLoadsWith(); +``` + +
+
+ +
+listDataManagerEntities + +
+ +List Data Manager Entities + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "DM"|"DMDS"|"DMF"|"DMT" | Yes | The type code of the **Field Collection** | +| `payload` | oas:ListDataManagerEntitiesRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DmObjectResponse|error` + +**Sample code:** + +```ballerina +oas:DmObjectResponse result = check pricefxClient->listDataManagerEntities(typeCode, payload); +``` + +
+
+ +
+listDatamartOrphanObjects + +
+ +List Datamart Orphan Objects + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DatamartOrphanObjectsEnvelope|error` + +**Sample code:** + +```ballerina +oas:DatamartOrphanObjectsEnvelope result = check pricefxClient->listDatamartOrphanObjects(); +``` + +
+
+ +
+listRollups + +
+ +List Rollups + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListRollupsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListRollupsResponse|error` + +**Sample code:** + +```ballerina +oas:ListRollupsResponse result = check pricefxClient->listRollups(payload); +``` + +
+
+ +
+massEditDataMartObject + +
+ +Mass Edit + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the object you want to perform the mass edit action for | +| `payload` | oas:MassEditRequest1 | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassEditDatamartResponse|error` + +**Sample code:** + +```ballerina +oas:MassEditDatamartResponse result = check pricefxClient->massEditDataMartObject(typedId, payload); +``` + +
+
+ +
+queryDataManagerObject + +
+ +Query a Data Manager Object + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:QueryDataManagerObjectRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:QueryDataManagerObjectQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:QueryDataManagerObjectResponse|error` + +**Sample code:** + +```ballerina +oas:QueryDataManagerObjectResponse result = check pricefxClient->queryDataManagerObject(payload, queries); +``` + +
+
+ +
+restoreDefaultDataSources + +
+ +Restore Default Data Sources + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `dataSourceName` | "Product"|"Customer"|"uom"|"ccy"|"cal" | Yes | The name of the Data Source you want to create. | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RestoreDefaultDataSourcesResponse|error` + +**Sample code:** + +```ballerina +oas:RestoreDefaultDataSourcesResponse result = check pricefxClient->restoreDefaultDataSources(dataSourceName); +``` + +
+
+ +
+runDataLoad + +
+ +Run a Data Load + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:RunDataLoadRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RunDataLoadResponse|error` + +**Sample code:** + +```ballerina +oas:RunDataLoadResponse result = check pricefxClient->runDataLoad(payload); +``` + +
+
+ +
+saveDataLoad + +
+ +Save a Data Load + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DatamartUpdatedataloadBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DataLoadEnvelope|error` + +**Sample code:** + +```ballerina +oas:DataLoadEnvelope result = check pricefxClient->saveDataLoad(payload); +``` + +
+
+ +
+sqlQueryDataManagerObject + +
+ +SQL Query a Data Manager Object + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DatamartSqlqueryBody | Yes | `sources` that SQL can use are query definitions. The sources become CTEs (Common Table Expression) in the final SQL. These are then used as a reference in the main query instead of referring to the actual tables directly. The request example compares the volume by month 2019 to 2020 | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:SqlQueryDataManagerObjectQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:QueryDataManagerObjectResponse|error` + +**Sample code:** + +```ballerina +oas:QueryDataManagerObjectResponse result = check pricefxClient->sqlQueryDataManagerObject(payload, queries); +``` + +
+
+ +
+updateDataManagerEntity + +
+ +Update a Data Manager Entity + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "DMF"|"DM"|"DMDS" | Yes | The type code of the **Field Collection** you want to update | +| `payload` | oas:UpdateDataManagerEntityRequest | Yes | Either `uniqueName` or `typedId` must be provided in the request | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DmObjectResponse|error` + +**Sample code:** + +```ballerina +oas:DmObjectResponse result = check pricefxClient->updateDataManagerEntity(typeCode, payload); +``` + +
+
+ +
+uploadBulkDataToDataSource + +
+ +Upload a Bulk Data to Data Source + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `datasourceUniqueName` | string | Yes | The unique name of the Data Source where you want to upload the data to. You can also use `typedId` or the source name | +| `payload` | oas:UploadBulkDataToDataSourceRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:BulkDataUploadEnvelope|error` + +**Sample code:** + +```ballerina +oas:BulkDataUploadEnvelope result = check pricefxClient->uploadBulkDataToDataSource(datasourceUniqueName, payload); +``` + +
+
+ +#### Imports + +
+deleteImportChanges + +
+ +Delete Import Changes + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ImportmanagerDeletechangesBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->deleteImportChanges(payload); +``` + +
+
+ +
+listImportManagerChanges + +
+ +List ImportManager Changes + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The uniqueName to be sent with the request | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListImportManagerChangesEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListImportManagerChangesEnvelope result = check pricefxClient->listImportManagerChanges(uniqueName, payload); +``` + +
+
+ +
+massDeleteImports + +
+ +Mass Delete Imports + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | oas:ImportmanagerMassdeletetypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassDeleteImportsEnvelope|error` + +**Sample code:** + +```ballerina +oas:MassDeleteImportsEnvelope result = check pricefxClient->massDeleteImports(typedId, payload); +``` + +
+
+ +
+massEditImports + +
+ +Mass Edit Imports + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | oas:ImportmanagerMassedittypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassEditImportsEnvelope|error` + +**Sample code:** + +```ballerina +oas:MassEditImportsEnvelope result = check pricefxClient->massEditImports(typedId, payload); +``` + +
+
+ +
+saveImportChange + +
+ +Save Import Change + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SaveImportChangeEnvelope|error` + +**Sample code:** + +```ballerina +oas:SaveImportChangeEnvelope result = check pricefxClient->saveImportChange(payload); +``` + +
+
+ +
+submitChanges + +
+ +Submit Changes + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | typedId of the import | +| `payload` | oas:ImportmanagerSubmittypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ImportManagerUploadEnvelope|error` + +**Sample code:** + +```ballerina +oas:ImportManagerUploadEnvelope result = check pricefxClient->submitChanges(typedId, payload); +``` + +
+
+ +
+uploadExcelToImportManager + +
+ +Upload Excel to Import Manager + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "P"|"PX" | Yes | Target object type code | +| `target` | string | Yes | Provides additional details about the target object, such as specifying a PX name if required | +| `slotId` | string | Yes | ID of the Upload Slot | +| `payload` | oas:TypeCodetargetBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:UploadExcelToImportManagerQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ImportManagerUploadEnvelope|error` + +**Sample code:** + +```ballerina +oas:ImportManagerUploadEnvelope result = check pricefxClient->uploadExcelToImportManager(typeCode, target, slotId, payload, queries); +``` + +
+
+ +#### Lookup Tables / Company Parameters + +
+addLookupTable + +
+ +Add a Lookup Table + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddLookupTableRequest | Yes | The request must contain all fields that are part of the business key for that object and all non-nullable fields | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddLookupTableResponse|error` + +**Sample code:** + +```ballerina +oas:AddLookupTableResponse result = check pricefxClient->addLookupTable(payload); +``` + +
+
+ +
+addLookupTableValue + +
+ +Add a Lookup Table Value + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method | +| `payload` | oas:AddLookupTableValueRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddLookupTableValueResponse|error` + +**Sample code:** + +```ballerina +oas:AddLookupTableValueResponse result = check pricefxClient->addLookupTableValue(tableId, payload); +``` + +
+
+ +
+copyLookupTable + +
+ +Copy a Lookup Table + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table you want to copy | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CopyLookupTableResponse|error` + +**Sample code:** + +```ballerina +oas:CopyLookupTableResponse result = check pricefxClient->copyLookupTable(tableId); +``` + +
+
+ +
+deleteColumnValuesMatrix + +
+ +Delete Column Values (Matrix only) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method | +| `columnName` | string | Yes | Enter the name of the column you want to delete values from | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->deleteColumnValuesMatrix(tableId, columnName); +``` + +
+
+ +
+deleteLookupTable + +
+ +Delete a Lookup Table + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteLookupTableRequest | Yes | Specify the `typedId` of the Lookup Table (Company Parameters) you want to delete | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteLookupTableResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteLookupTableResponse result = check pricefxClient->deleteLookupTable(payload); +``` + +
+
+ +
+deleteLookupTableValue + +
+ +Delete a Lookup Table Value + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method | +| `payload` | oas:DeleteLookupTableValueRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteLookupTableValueResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteLookupTableValueResponse result = check pricefxClient->deleteLookupTableValue(tableId, payload); +``` + +
+
+ +
+getLogicReferences + +
+ +Get Logic References + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table you want to retrieve logic references for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetLogicReferencesResponse|error` + +**Sample code:** + +```ballerina +oas:GetLogicReferencesResponse result = check pricefxClient->getLogicReferences(tableId); +``` + +
+
+ +
+insertBulkDataToLookupTable + +
+ +Insert Bulk Data to Lookup Table + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "JLTV"|"JLTVM"|"LT"|"LTT"|"LTV"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM" | Yes | Enter the type code of the Lookup Table entity you want to insert a data to | +| `payload` | oas:InsertBulkDataToLookupTableRequest | Yes | We used `/lookuptablemanager.loaddata/MLTV` in the request example to insert bulk data to Matrix Lookup Table. Notice that the `lookupTable` is used in the `header` section and then ID of the Lookup Table in the `data` section | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:InsertBulkDataLookupTableResponse|error` + +**Sample code:** + +```ballerina +oas:InsertBulkDataLookupTableResponse result = check pricefxClient->insertBulkDataToLookupTable(typeCode, payload); +``` + +
+
+ +
+listAllLookupTableValues + +
+ +List All Lookup Table Values + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method | +| `payload` | oas:ListAllLookupTableValuesRequest | Yes | You can specify the start and end row to limit the number of retrieved records | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ListAllLookupTableValuesQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ListAllLookupTableValuesResponse|error` + +**Sample code:** + +```ballerina +oas:ListAllLookupTableValuesResponse result = check pricefxClient->listAllLookupTableValues(tableId, payload, queries); +``` + +
+
+ +
+listAllLookupTables + +
+ +List All Lookup Tables + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListAllLookupTablesRequest | Yes | You can specify the start and end row to limit the number of retrieved Lookup Tables / Company Parameters | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListAllLookupTablesResponse|error` + +**Sample code:** + +```ballerina +oas:ListAllLookupTablesResponse result = check pricefxClient->listAllLookupTables(payload); +``` + +
+
+ +
+massDeleteLookupTableValues + +
+ +Mass Delete Lookup Table Values + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method | +| `payload` | oas:TableIdBatchBody | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:MassDeleteLookupTableValuesQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:DeleteLookupTableValueResponse1|error` + +**Sample code:** + +```ballerina +oas:DeleteLookupTableValueResponse1 result = check pricefxClient->massDeleteLookupTableValues(tableId, payload, queries); +``` + +
+
+ +
+massEditLookupTable + +
+ +Mass Edit + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | The ID of the Lookup Table whose values you want to update | +| `payload` | oas:MassEditRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassEditResponse|error` + +**Sample code:** + +```ballerina +oas:MassEditResponse result = check pricefxClient->massEditLookupTable(tableId, payload); +``` + +
+
+ +
+updateLookupTable + +
+ +Update a Lookup Table + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateLookupTableRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateLookupTableResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateLookupTableResponse result = check pricefxClient->updateLookupTable(payload); +``` + +
+
+ +
+updateLookupTableValue + +
+ +Update a Lookup Table Value + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method | +| `payload` | oas:UpdateLookupTableValueRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateLookupTableValueResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateLookupTableValueResponse result = check pricefxClient->updateLookupTableValue(tableId, payload); +``` + +
+
+ +
+upsertLookupTableValue + +
+ +Upsert a Lookup Table Value + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableId` | string | Yes | Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method | +| `payload` | oas:UpsertLookupTableValueRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpsertLookupTableValueResponse|error` + +**Sample code:** + +```ballerina +oas:UpsertLookupTableValueResponse result = check pricefxClient->upsertLookupTableValue(tableId, payload); +``` + +
+
+ +#### Key-Value Store + +
+countKeys + +
+ +Count Keys + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | The table to count keys from | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->countKeys(tableName); +``` + +
+
+ +
+createKvTable + +
+ +Create a KV Table + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | A name of the table you want create. Only lower case letters, numbers and underscores are allowed. Do not use special characters | +| `payload` | oas:CreateKVTableRequest | Yes | The sample request creates a table with four columns: sku, customer, record and payload (TEXT).<br> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->createKvTable(tableName, payload); +``` + +
+
+ +
+deleteKey + +
+ +Delete a Key + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | The tableName to be sent with the request | +| `payload` | oas:DeleteKVKeyRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->deleteKey(tableName, payload); +``` + +
+
+ +
+dropKvTable + +
+ +Drop a KV Table + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | A name of the table you want drop. Only lower case letters, numbers and underscores are allowed. Do not use special characters | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `record` + +**Sample code:** + +```ballerina +record result = check pricefxClient->dropKvTable(tableName, payload); +``` + +
+
+ +
+getKey + +
+ +Get a Key + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | A name of the table you want to retrieve the "payload" from | +| `payload` | oas:GetKVKeyRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->getKey(tableName, payload); +``` + +
+
+ +
+getTableInfo + +
+ +Get a Table Info + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | A name of the table you want to retrieve information about | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetKVTableInfoResponse|error` + +**Sample code:** + +```ballerina +oas:GetKVTableInfoResponse result = check pricefxClient->getTableInfo(tableName); +``` + +
+
+ +
+insertBulkKvData + +
+ +Insert Bulk KV Data + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | A name of the table you want upload data to | +| `payload` | oas:InsertBulkKVDataRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->insertBulkKvData(tableName, payload); +``` + +
+
+ +
+listKvTables + +
+ +List KV Tables + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListKVTablesResponse|error` + +**Sample code:** + +```ballerina +oas:ListKVTablesResponse result = check pricefxClient->listKvTables(); +``` + +
+
+ +
+searchKvTable + +
+ +Search a KV Table + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | A name of the table you want to search the pattern for | +| `payload` | oas:SearchKVTableRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SearchKvTableEnvelope[]|error` + +**Sample code:** + +```ballerina +oas:SearchKvTableEnvelope[] result = check pricefxClient->searchKvTable(tableName, payload); +``` + +
+
+ +
+truncateTable + +
+ +Truncate a Table + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | The table you want to remove the keys from | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:TruncateKVTableResponse|error` + +**Sample code:** + +```ballerina +oas:TruncateKVTableResponse result = check pricefxClient->truncateTable(tableName); +``` + +
+
+ +
+upsertKey + +
+ +Upsert a Key + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `tableName` | string | Yes | A name of the table you want to upsert the key into | +| `payload` | oas:UpsertKVKeyRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpsertKVKeyResponse|error` + +**Sample code:** + +```ballerina +oas:UpsertKVKeyResponse result = check pricefxClient->upsertKey(tableName, payload); +``` + +
+
+ +#### Logics + +
+copyLogic + +
+ +Copy a Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the logic. you want to copy. The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.F** is **2147484837** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CopyLogicResponse|error` + +**Sample code:** + +```ballerina +oas:CopyLogicResponse result = check pricefxClient->copyLogic(id); +``` + +
+
+ +
+deleteLogic + +
+ +Delete a Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the logic you want to delete. `id` is the `typedId` without **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484835.F** is **2147484835** | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteLogicResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteLogicResponse result = check pricefxClient->deleteLogic(id); +``` + +
+
+ +
+executeLibraryFunction + +
+ +Execute Library Function + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `formulaName` | string | Yes | Name of the formula library containing the function | +| `elementName` | string | Yes | Name of the library element containing the function | +| `functionName` | string | Yes | Name of the function to execute | +| `payload` | oas:ElementNamefunctionNameBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->executeLibraryFunction(formulaName, elementName, functionName, payload); +``` + +
+
+ +
+executeLogicInService + +
+ +Execute a Logic Without a Context in a Service + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The name (`uniqueName`) of the logic you want to execute | +| `payload` | record {record {} data?;} | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LogicResponse|error` + +**Sample code:** + +```ballerina +oas:LogicResponse result = check pricefxClient->executeLogicInService(uniqueName, payload); +``` + +
+
+ +
+executeLogicInServiceReadOnly + +
+ +Execute a Logic Without a Context in a Service (Read-Only) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The name (`uniqueName`) of the logic you want to execute | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ExecuteLogicReadOnlyResponse|error` + +**Sample code:** + +```ballerina +oas:ExecuteLogicReadOnlyResponse result = check pricefxClient->executeLogicInServiceReadOnly(uniqueName); +``` + +
+
+ +
+executeLogicRead + +
+ +Execute a Logic (Read-Only) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The name (`uniqueName`) of the logic you want to execute | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ExecuteLogicReadOnlyResponse|error` + +**Sample code:** + +```ballerina +oas:ExecuteLogicReadOnlyResponse result = check pricefxClient->executeLogicRead(uniqueName); +``` + +
+
+ +
+executeLogicWithout + +
+ +Execute a Logic (Without a Context) + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The name (`uniqueName`) of the logic you want to execute | +| `payload` | record {record {} data?;} | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ExecuteLogicWithoutQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ExecuteLogicWithoutProductContextResponse|error` + +**Sample code:** + +```ballerina +oas:ExecuteLogicWithoutProductContextResponse result = check pricefxClient->executeLogicWithout(uniqueName, payload, queries); +``` + +
+
+ +
+executeNamedProductLogic + +
+ +Execute a Logic + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `sku` | string | Yes | The `sku` or `typedId` of the product you want to execute the assigned logic for | +| `uniqueName` | string | Yes | The name (`uniqueName`) of the logic you want to execute | +| `payload` | record {record {} data?;} | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ExecuteLogicResponse|error` + +**Sample code:** + +```ballerina +oas:ExecuteLogicResponse result = check pricefxClient->executeNamedProductLogic(sku, uniqueName, payload); +``` + +
+
+ +
+executeProductLogic + +
+ +Execute an Assigned Logic + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `sku` | string | Yes | The `sku` or `typedId` of the product you want to execute the logic for | +| `payload` | record {record {} data?;} | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ExecuteAssignedLogicResponse|error` + +**Sample code:** + +```ballerina +oas:ExecuteAssignedLogicResponse result = check pricefxClient->executeProductLogic(sku, payload); +``` + +
+
+ +
+generateParameters + +
+ +Generate Parameters + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:GenerateParametersRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenerateParametersResponse|error` + +**Sample code:** + +```ballerina +oas:GenerateParametersResponse result = check pricefxClient->generateParameters(payload); +``` + +
+
+ +
+getDefaultPricingLogicName + +
+ +Get a Default Pricing Logic Name + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetDefaultPricingLogicNameResponse|error` + +**Sample code:** + +```ballerina +oas:GetDefaultPricingLogicNameResponse result = check pricefxClient->getDefaultPricingLogicName(); +``` + +
+
+ +
+getLogic + +
+ +Get a Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the logic you want to retrieve details for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetLogicResponse|error` + +**Sample code:** + +```ballerina +oas:GetLogicResponse result = check pricefxClient->getLogic(id); +``` + +
+
+ +
+listElements + +
+ +List Elements + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The name (`uniqueName`) of the logic you want to list elements for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListElementsResponse|error` + +**Sample code:** + +```ballerina +oas:ListElementsResponse result = check pricefxClient->listElements(uniqueName); +``` + +
+
+ +
+listFunctions + +
+ +List Functions + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListFunctionsResponse|error` + +**Sample code:** + +```ballerina +oas:ListFunctionsResponse result = check pricefxClient->listFunctions(); +``` + +
+
+ +
+listLibraries + +
+ +List Libraries + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListLibrariesResponse|error` + +**Sample code:** + +```ballerina +oas:ListLibrariesResponse result = check pricefxClient->listLibraries(); +``` + +
+
+ +
+listLogicParametersInput + +
+ +List Logic Parameters (Input Fields) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The name (`uniqueName`) of the logic you want to list parameters for. If omitted, the logic as specified in the product’s master is used, otherwise the passed logic is used | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListLogicInputFieldsResponse|error` + +**Sample code:** + +```ballerina +oas:ListLogicInputFieldsResponse result = check pricefxClient->listLogicParametersInput(uniqueName); +``` + +
+
+ +
+listLogics + +
+ +List Logics + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListLogicsResponse|error` + +**Sample code:** + +```ballerina +oas:ListLogicsResponse result = check pricefxClient->listLogics(); +``` + +
+
+ +
+setDefaultPricingLogic + +
+ +Set a Default Pricing Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `uniqueName` | string | Yes | The name (`uniqueName`) of the logic that will be set as default. Leave blank to clear the default pricing logic | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SetDefaultPricingLogicResponse|error` + +**Sample code:** + +```ballerina +oas:SetDefaultPricingLogicResponse result = check pricefxClient->setDefaultPricingLogic(uniqueName); +``` + +
+
+ +
+syntaxCheck + +
+ +Syntax Check + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:SyntaxCheckRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->syntaxCheck(payload); +``` + +
+
+ +
+testLogic + +
+ +Test a Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:TestLogicRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:TestLogicEnvelope|error` + +**Sample code:** + +```ballerina +oas:TestLogicEnvelope result = check pricefxClient->testLogic(payload); +``` + +
+
+ +
+updateLogic + +
+ +Update a Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the logic. The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.F** is **2147484837** | +| `payload` | record {record {decimal version?; string typedId?; string uniqueName?; string label?; string validAfter?; string status?; anydata simulationSet?; anydata userGroupEdit?; anydata userGroupViewDetails?; anydata formulaNature?; string lastUpdateByName?; record {decimal version?; string typedId?; string elementName?; string elementLabel?; anydata elementDescription?; string[] elementGroups?; anydata conditionElementName?; boolean hideWarnings?; boolean excludeFromExport?; boolean protectedExpression?; decimal elementTimeout?; decimal displayOptions?; string? formatType?; anydata elementSuffix?; boolean allowOverride?; boolean summarize?; boolean hideOnNull?; anydata userGroup?; anydata cssProperties?; anydata resultGroup?; string combinationType?; boolean storeInAttributeExtension?; anydata criticalAlert?; anydata redAlert?; anydata yellowAlert?; anydata labelTranslations?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?; string formulaExpression?;}[] elements?; record {}[] inputDescriptors?; string formulaType?; anydata createdByName?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?;} data?;} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LogicResponse|error` + +**Sample code:** + +```ballerina +oas:LogicResponse result = check pricefxClient->updateLogic(id, payload); +``` + +
+
+ +
+updateLogicNo + +
+ +Update a Logic (No syntax check) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the logic. The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.F** is **2147484837** | +| `payload` | record {record {decimal version?; string typedId?; string uniqueName?; string label?; string validAfter?; string status?; anydata simulationSet?; anydata userGroupEdit?; anydata userGroupViewDetails?; anydata formulaNature?; string lastUpdateByName?; record {decimal version?; string typedId?; string elementName?; string elementLabel?; anydata elementDescription?; string[] elementGroups?; anydata conditionElementName?; boolean hideWarnings?; boolean excludeFromExport?; boolean protectedExpression?; decimal elementTimeout?; decimal displayOptions?; string? formatType?; anydata elementSuffix?; boolean allowOverride?; boolean summarize?; boolean hideOnNull?; anydata userGroup?; anydata cssProperties?; anydata resultGroup?; string combinationType?; boolean storeInAttributeExtension?; anydata criticalAlert?; anydata redAlert?; anydata yellowAlert?; anydata labelTranslations?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?; string formulaExpression?;}[] elements?; record {}[] inputDescriptors?; string formulaType?; anydata createdByName?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?;} data?;} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LogicResponse|error` + +**Sample code:** + +```ballerina +oas:LogicResponse result = check pricefxClient->updateLogicNo(id, payload); +``` + +
+
+ +
+updateLogicPartial + +
+ +Update a Logic (Partial) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The ID of the logic. The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.F** is **2147484837** | +| `payload` | record {record {decimal version?; string typedId?; string uniqueName?; string label?; string validAfter?; string status?; anydata simulationSet?; anydata userGroupEdit?; anydata userGroupViewDetails?; anydata formulaNature?; string lastUpdateByName?; record {decimal version?; string typedId?; string elementName?; string elementLabel?; anydata elementDescription?; string[] elementGroups?; anydata conditionElementName?; boolean hideWarnings?; boolean excludeFromExport?; boolean protectedExpression?; decimal elementTimeout?; decimal displayOptions?; string? formatType?; anydata elementSuffix?; boolean allowOverride?; boolean summarize?; boolean hideOnNull?; anydata userGroup?; anydata cssProperties?; anydata resultGroup?; string combinationType?; boolean storeInAttributeExtension?; anydata criticalAlert?; anydata redAlert?; anydata yellowAlert?; anydata labelTranslations?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?; string formulaExpression?;}[] elements?; record {}[] inputDescriptors?; string formulaType?; anydata createdByName?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?;} data?;} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LogicResponse|error` + +**Sample code:** + +```ballerina +oas:LogicResponse result = check pricefxClient->updateLogicPartial(id, payload); +``` + +
+
+ +#### Calculation Grids + +
+acceptCalculationGridItem + +
+ +Submit a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Calculation Grid you want to submit items for. You can retrieve the `id` of the CG, for example, by calling the `/fetch/CG` endpoint | +| `payload` | oas:SubmitCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SubmitCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:SubmitCalculationGridItemResponse result = check pricefxClient->acceptCalculationGridItem(id, payload); +``` + +
+
+ +
+addCalculationGrid + +
+ +Add a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddCalculationGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:AddCalculationGridResponse result = check pricefxClient->addCalculationGrid(payload); +``` + +
+
+ +
+addCalculationGridItem + +
+ +Add a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `keyNumber` | "1"|"2"|"3"|"4"|"5"|"6" | Yes | Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys | +| `payload` | oas:AddCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:AddCalculationGridItemResponse result = check pricefxClient->addCalculationGridItem(keyNumber, payload); +``` + +
+
+ +
+calculateCalculationGrid + +
+ +Calculate a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Calculation Grid you want to calculate | +| `payload` | oas:CalculateCalculationGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CalculateCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:CalculateCalculationGridResponse result = check pricefxClient->calculateCalculationGrid(id, payload); +``` + +
+
+ +
+deleteCalculationGrid + +
+ +Delete a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteCalculationGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteCalculationGridResponse result = check pricefxClient->deleteCalculationGrid(payload); +``` + +
+
+ +
+deleteCalculationGridItem + +
+ +Delete a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `keyNumber` | "1"|"2"|"3"|"4"|"5"|"6" | Yes | Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys | +| `payload` | oas:DeleteCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteCalculationGridItemResponse result = check pricefxClient->deleteCalculationGridItem(keyNumber, payload); +``` + +
+
+ +
+getCalculationGrid + +
+ +Get a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | ID of the Calculation Grid you want to retrieve | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:GetCalculationGridResponse result = check pricefxClient->getCalculationGrid(id, payload); +``` + +
+
+ +
+getCalculationGridItem + +
+ +Get a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `keyNumber` | "1"|"2"|"3"|"4"|"5"|"6" | Yes | Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys | +| `id` | string | Yes | `id` of the Calculation Grid Item you want to fetch | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:GetCalculationGridItemResponse result = check pricefxClient->getCalculationGridItem(keyNumber, id, payload); +``` + +
+
+ +
+listCalculationGridItems + +
+ +List Calculation Grid Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `keyNumber` | "1"|"2"|"3"|"4"|"5"|"6" | Yes | Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys | +| `payload` | oas:ListCalculationGridItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCalculationGridItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ListCalculationGridItemsResponse result = check pricefxClient->listCalculationGridItems(keyNumber, payload); +``` + +
+
+ +
+listCalculationGrids + +
+ +List Calculation Grids + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListCalculationGridsResponse|error` + +**Sample code:** + +```ballerina +oas:ListCalculationGridsResponse result = check pricefxClient->listCalculationGrids(payload); +``` + +
+
+ +
+rejectCalculationGridItem + +
+ +Deny a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | The `id` of the Calculation Grid you want to deny items for. You can retrieve the `id` of the CG, for example, by calling the `/fetch/CG` endpoint | +| `payload` | oas:DenyCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DenyCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:DenyCalculationGridItemResponse result = check pricefxClient->rejectCalculationGridItem(id, payload); +``` + +
+
+ +
+updateCalculationGrid + +
+ +Update a Calculation Grid + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateCalculationGridRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateCalculationGridResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateCalculationGridResponse result = check pricefxClient->updateCalculationGrid(payload); +``` + +
+
+ +
+updateCalculationGridItem + +
+ +Update a Calculation Grid Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Calculation Grid Item you want to update | +| `payload` | oas:UpdateCalculationGridItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateCalculationGridItemResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateCalculationGridItemResponse result = check pricefxClient->updateCalculationGridItem(id, payload); +``` + +
+
+ +#### Action Types + +
+addActionType + +
+ +Add an Action Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddActionTypeRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddActionTypeResponse|error` + +**Sample code:** + +```ballerina +oas:AddActionTypeResponse result = check pricefxClient->addActionType(payload); +``` + +
+
+ +
+deleteActionItemType + +
+ +Delete an Action Item Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {record {string typedId;} data;} | Yes | The general delete request. Deletes the object specified by `typedId` in the request body | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteActionItemTypeResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteActionItemTypeResponse result = check pricefxClient->deleteActionItemType(payload); +``` + +
+
+ +
+listActionTypes + +
+ +List Action Types + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {int endRow?; record {}? oldValues?; string operationType?; int startRow?; string textMatchStyle?; record {string _constructor?; string operator?; record {string fieldName?; string operator?; string value?;}[] criteria?;} data?;} | Yes | A general fetch request. A filter can be applied | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListActionTypesResponse|error` + +**Sample code:** + +```ballerina +oas:ListActionTypesResponse result = check pricefxClient->listActionTypes(payload); +``` + +
+
+ +
+updateActionType + +
+ +Update an Action Type + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateAITBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateActionTypeResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateActionTypeResponse result = check pricefxClient->updateActionType(payload); +``` + +
+
+ +#### Actions + +
+createActionItem + +
+ +Create an Action Item + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddActionItemRequest | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddActionItemResponse|error` + +**Sample code:** + +```ballerina +oas:AddActionItemResponse result = check pricefxClient->createActionItem(payload); +``` + +
+
+ +
+deleteActionItem + +
+ +Delete an Action Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteActionItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteActionItemResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteActionItemResponse result = check pricefxClient->deleteActionItem(payload); +``` + +
+
+ +
+executeLogic + +
+ +Execute a Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The `typeCode` of the Action Item you want to execute the calculation for | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ExecuteActionItemLogicResponse|error` + +**Sample code:** + +```ballerina +oas:ExecuteActionItemLogicResponse result = check pricefxClient->executeLogic(typeCode, payload); +``` + +
+
+ +
+listActionItems + +
+ +List Action Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:FetchAIBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListActionItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ListActionItemsResponse result = check pricefxClient->listActionItems(payload); +``` + +
+
+ +
+updateActionItem + +
+ +Update an Action Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateActionItemRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateActionItemResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateActionItemResponse result = check pricefxClient->updateActionItem(payload); +``` + +
+
+ +#### Jobs & Tasks + +
+cancelJob + +
+ +Cancel a Job + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` if the job you want to cancel | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->cancelJob(id, payload); +``` + +
+
+ +
+listJobs + +
+ +List Jobs + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {int endRow?; record {}? oldValues?; string operationType?; int startRow?; string textMatchStyle?; record {string _constructor?; string operator?; record {string fieldName?; string operator?; string value?;}[] criteria?;} data?;} | Yes | A general fetch request. A filter can be applied | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListJSTResponse|error` + +**Sample code:** + +```ballerina +oas:ListJSTResponse result = check pricefxClient->listJobs(payload); +``` + +
+
+ +#### Workflow + +
+addApproverStep + +
+ +Add an Approver Step + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `currentStepId` | string | Yes | The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint | +| `payload` | oas:AddApproverStepRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddApproverStepResponse|error` + +**Sample code:** + +```ballerina +oas:AddApproverStepResponse result = check pricefxClient->addApproverStep(currentStepId, payload); +``` + +
+
+ +
+addWatcherStep + +
+ +Add a Watcher Step + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `currentStepId` | string | Yes | The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint | +| `payload` | oas:AddWatcherStepRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddWatcherStepResponse|error` + +**Sample code:** + +```ballerina +oas:AddWatcherStepResponse result = check pricefxClient->addWatcherStep(currentStepId, payload); +``` + +
+
+ +
+approveDocument + +
+ +Approve a Document + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `currentStepId` | string | Yes | The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint | +| `payload` | oas:ApproveDocumentRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ApproveDocumentResponse|error` + +**Sample code:** + +```ballerina +oas:ApproveDocumentResponse result = check pricefxClient->approveDocument(currentStepId, payload); +``` + +
+
+ +
+denyDocument + +
+ +Deny a Document + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `currentStepId` | string | Yes | The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint | +| `payload` | oas:DenyDocumentRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DenyDocumentResponse|error` + +**Sample code:** + +```ballerina +oas:DenyDocumentResponse result = check pricefxClient->denyDocument(currentStepId, payload); +``` + +
+
+ +
+fetchPendingReviews + +
+ +Fetch Pending Reviews + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:FetchPendingReviewsEnvelope|error` + +**Sample code:** + +```ballerina +oas:FetchPendingReviewsEnvelope result = check pricefxClient->fetchPendingReviews(); +``` + +
+
+ +
+getWorkflowDocument + +
+ +Get a Workflow Document + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the approvable object you want to retrieve workflow details for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetWorkflowDocumentResponse|error` + +**Sample code:** + +```ballerina +oas:GetWorkflowDocumentResponse result = check pricefxClient->getWorkflowDocument(typedId); +``` + +
+
+ +
+listPendingApprovals + +
+ +List Pending Approvals + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListPendingApprovalsResponse|error` + +**Sample code:** + +```ballerina +oas:ListPendingApprovalsResponse result = check pricefxClient->listPendingApprovals(); +``` + +
+
+ +
+listUserSPendingApprovals + +
+ +List User's Pending Approvals + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `loginName` | string | Yes | The login name of the user you want to retrieve Pending Workflows for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListUserPendingApprovalsResponse|error` + +**Sample code:** + +```ballerina +oas:ListUserPendingApprovalsResponse result = check pricefxClient->listUserSPendingApprovals(loginName); +``` + +
+
+ +
+listWorkflows + +
+ +List Workflows + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListWorkflowsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListWorkflowsResponse|error` + +**Sample code:** + +```ballerina +oas:ListWorkflowsResponse result = check pricefxClient->listWorkflows(payload); +``` + +
+
+ +
+setReviewAsDone + +
+ +Set a Review as Done + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | typedId of the object to mark as reviewed | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->setReviewAsDone(typedId, payload); +``` + +
+
+ +
+updateReviewStatus + +
+ +Update a Review Status + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | typedId of the object to update | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->updateReviewStatus(typedId, payload); +``` + +
+
+ +
+withdrawDocument + +
+ +Withdraw a Document + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `currentStepId` | string | Yes | The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:WithdrawDocumentResponse|error` + +**Sample code:** + +```ballerina +oas:WithdrawDocumentResponse result = check pricefxClient->withdrawDocument(currentStepId); +``` + +
+
+ +#### Workflow Delegation + +
+createWorkflowDelegation + +
+ +Create a Workflow Delegation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:CreateWorkflowDelegationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:CreateWorkflowDelegationResponse|error` + +**Sample code:** + +```ballerina +oas:CreateWorkflowDelegationResponse result = check pricefxClient->createWorkflowDelegation(payload); +``` + +
+
+ +
+deactivateWorkflowDelegation + +
+ +Deactivate a Workflow Delegation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeactivateWorkflowDelegationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeactivateWorkflowDelegationResponse|error` + +**Sample code:** + +```ballerina +oas:DeactivateWorkflowDelegationResponse result = check pricefxClient->deactivateWorkflowDelegation(payload); +``` + +
+
+ +
+deleteWorkflowDelegation + +
+ +Delete a Workflow Delegation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:DeleteWorkflowDelegationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteWorkflowDelegationResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteWorkflowDelegationResponse result = check pricefxClient->deleteWorkflowDelegation(payload); +``` + +
+
+ +
+listDelegatedWorkflows + +
+ +List Delegated Workflows + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListDelegatedWorkflowsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListDelegatedWorkflowsResponse|error` + +**Sample code:** + +```ballerina +oas:ListDelegatedWorkflowsResponse result = check pricefxClient->listDelegatedWorkflows(payload); +``` + +
+
+ +
+updateWorkflowDelegation + +
+ +Update a Workflow Delegation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateWorkflowDelegationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateWorkflowDelegationResponse|error` + +**Sample code:** + +```ballerina +oas:UpdateWorkflowDelegationResponse result = check pricefxClient->updateWorkflowDelegation(payload); +``` + +
+
+ +
+validateWorkflowDelegation + +
+ +Validate a Workflow Delegation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ValidateWorkflowDelegationRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ValidateWorkflowDelegationResponse|error` + +**Sample code:** + +```ballerina +oas:ValidateWorkflowDelegationResponse result = check pricefxClient->validateWorkflowDelegation(payload); +``` + +
+
+ +#### Notifications + +
+deleteNotification + +
+ +Delete a Notification + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:NotificationSetreadBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteNotificationEnvelope|error` + +**Sample code:** + +```ballerina +oas:DeleteNotificationEnvelope result = check pricefxClient->deleteNotification(payload); +``` + +
+
+ +
+listNotifications + +
+ +List Notifications + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:NotificationListBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListNotificationsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListNotificationsEnvelope result = check pricefxClient->listNotifications(payload); +``` + +
+
+ +
+markAsRead + +
+ +Mark as Read + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->markAsRead(payload); +``` + +
+
+ +
+sendValidationMessage + +
+ +Send a Validation Message + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:NotificationSendBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->sendValidationMessage(payload); +``` + +
+
+ +#### Internationalization + +
+addNewInternationalizationMessage + +
+ +Add a New Internationalization Message + payload - + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:I18nmanagerPutBody | Yes | | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AddInternationalizationMessageEnvelope|error` + +**Sample code:** + +```ballerina +oas:AddInternationalizationMessageEnvelope result = check pricefxClient->addNewInternationalizationMessage(payload); +``` + +
+
+ +
+deleteInternationalizationMessages + +
+ +Delete Internationalization Messages + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:I18nmanagerDeleteKeysBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->deleteInternationalizationMessages(payload); +``` + +
+
+ +
+listInternationalizationMessages + +
+ +List Internationalization Messages + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:I18nmanagerFetchWithExtraDataBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListInternationalizationMessagesEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListInternationalizationMessagesEnvelope result = check pricefxClient->listInternationalizationMessages(payload); +``` + +
+
+ +#### Clicmanager + +
+addLineItems + +
+ +Add Line Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | typed ID of the target CLIC document | +| `payload` | oas:ClicmanagerAdditemstypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `record` + +**Sample code:** + +```ballerina +record result = check pricefxClient->addLineItems(typedId, payload); +``` + +
+
+ +
+fetchActivities + +
+ +Fetch Activities + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ActivitylogFetchBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `record` + +**Sample code:** + +```ballerina +record result = check pricefxClient->fetchActivities(payload); +``` + +
+
+ +
+getClicHeader + +
+ +Get a Quote/Contract/Rebate Agreement/Compensation Plan Header + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Contract, Quote, or Rebate Agreement you want to return details for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetQuoteContractRebateAgreementResponse|error` + +**Sample code:** + +```ballerina +oas:GetQuoteContractRebateAgreementResponse result = check pricefxClient->getClicHeader(typedId); +``` + +
+
+ +
+importClicLineItems + +
+ +Import Line Items (w/o Input Types) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | oas:ClicmanagerImportlineitemstypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ClicOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ClicOperationEnvelope result = check pricefxClient->importClicLineItems(typedId, payload); +``` + +
+
+ +
+listClicObjects + +
+ +List CLIC Objects + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Quote/Contract/Rebate Agreement/Compensation Plan you want to retrieve line items for | +| `payload` | oas:GetCLICrequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ListClicObjectsQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:GetCLICresponse|error` + +**Sample code:** + +```ballerina +oas:GetCLICresponse result = check pricefxClient->listClicObjects(typedId, payload, queries); +``` + +
+
+ +
+listUniqueClicItems + +
+ +List Unique CLIC Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListUniqueCLICItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ListUniqueCLICItemsResponse result = check pricefxClient->listUniqueClicItems(typedId, payload); +``` + +
+
+ +
+removeAllClicLineItems + +
+ +Delete All Line Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the object you want to remove all line items from | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ClicOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ClicOperationEnvelope result = check pricefxClient->removeAllClicLineItems(typedId, payload); +``` + +
+
+ +
+sendEmail + +
+ +Send an Email + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:SendEmailRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->sendEmail(payload); +``` + +
+
+ +
+setClicLostReason + +
+ +Mark an Offer as Lost (with reason) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the Quote you want set as lost | +| `payload` | oas:MarkOfferLostWithReasonRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SetClicLostReasonEnvelope|error` + +**Sample code:** + +```ballerina +oas:SetClicLostReasonEnvelope result = check pricefxClient->setClicLostReason(typedId, payload); +``` + +
+
+ +
+submitClic + +
+ +Submit a Quote/Contract/Rebate Agreement + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Contract, Quote, or Rebate Agreement you want to submit | +| `payload` | oas:SubmitQuoteContractRebateAgreementRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SubmitQuoteContractRebateAgreementResponse|error` + +**Sample code:** + +```ballerina +oas:SubmitQuoteContractRebateAgreementResponse result = check pricefxClient->submitClic(typedId, payload); +``` + +
+
+ +
+updateClicLineItems + +
+ +Update CLIC Line Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the CLIC object (e.g., a Quote) you want to update line items for | +| `payload` | oas:UpdateCLICLineItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpdateClicLineItemsEnvelope|error` + +**Sample code:** + +```ballerina +oas:UpdateClicLineItemsEnvelope result = check pricefxClient->updateClicLineItems(typedId, payload); +``` + +
+
+ +#### Advanced Configuration Options + +
+getAdvancedConfigurationProperty + +
+ +Get Advanced Configuration Property + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `propertyname` | string | Yes | Name of the configuration property to retrieve | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:AdvancedConfigPropertyEnvelope|error` + +**Sample code:** + +```ballerina +oas:AdvancedConfigPropertyEnvelope result = check pricefxClient->getAdvancedConfigurationProperty(propertyname); +``` + +
+
+ +#### Admin Tools + +
+changeTermsOfUse + +
+ +changeTermsOfUse + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AccountmanagerChangetermsofuseBody | Yes | | +| `headers` | map<string|string[]> | No | | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->changeTermsOfUse(payload); +``` + +
+
+ +
+pingWithout + +
+ +Ping (without authentication) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->pingWithout(); +``` + +
+
+ +#### Configuration + +
+getExternalApplicationProperties + +
+ +Get External Application Properties + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetexternalapppropertiesResponse|error` + +**Sample code:** + +```ballerina +oas:GetexternalapppropertiesResponse result = check pricefxClient->getExternalApplicationProperties(); +``` + +
+
+ +#### Visual Configuration + +
+addConfigurationStorage + +
+ +Add a Configuration Storage + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:AddJCSBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConfigurationStorageOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConfigurationStorageOperationEnvelope result = check pricefxClient->addConfigurationStorage(payload); +``` + +
+
+ +
+deleteConfigurationStorage + +
+ +Delete a Configuration Storage + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConfigurationStorageOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConfigurationStorageOperationEnvelope result = check pricefxClient->deleteConfigurationStorage(payload); +``` + +
+
+ +
+deployConfigurationStorage + +
+ +Deploy a Configuration Storage + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:JcsmanagerDeployBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConfigurationStorageOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConfigurationStorageOperationEnvelope result = check pricefxClient->deployConfigurationStorage(payload); +``` + +
+
+ +
+getConfigurationStorage + +
+ +Get a Configuration Storage + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:FetchJCSBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetConfigurationStorageEnvelope|error` + +**Sample code:** + +```ballerina +oas:GetConfigurationStorageEnvelope result = check pricefxClient->getConfigurationStorage(payload); +``` + +
+
+ +
+updateConfigurationStorage + +
+ +Update a Configuration Storage + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:UpdateJCSBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ConfigurationStorageOperationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ConfigurationStorageOperationEnvelope result = check pricefxClient->updateConfigurationStorage(payload); +``` + +
+
+ +#### Metadata + +
+listAttributeFieldsMetadata + +
+ +List Attribute Fields' Metadata + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "ACTT"|"AI"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CL"|"CLLI"|"CLLIAM"|"CLR"|"CLT"|"CN"|"CO"|"COAM"|"COCT"|"COCTAM"|"COHT"|"COHTAM"|"COLI"|"COR"|"CORAM"|"COROLI"|"CORS"|"CORSC"|"COT"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX10"|"CX20"|"CX3"|"CX30"|"CX50"|"CX6"|"CX8"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DP"|"DPR"|"DPT"|"DREF"|"DREG"|"EDL"|"ET"|"EVT"|"F"|"FE"|"FN"|"HEVT"|"HRT"|"HRTAM"|"IDC"|"IE"|"ISH"|"JLTV"|"JLTV2"|"JLTVM"|"JST"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MC"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MN"|"MO"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"NT"|"P"|"PAM"|"PBOME"|"PCOMP"|"PCOMPCO"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLPGTT"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX10"|"PX20"|"PX3"|"PX30"|"PX50"|"PX6"|"PX8"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAROLI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"SL"|"SLAM"|"SX10"|"SX20"|"SX3"|"SX30"|"SX50"|"SX6"|"SX8"|"SXAM"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI" | Yes | Enter the type code of the entity you want to retrieve information for. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ListAttributeFieldsMetadataQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ListAttributeFieldsMetadata|error` + +**Sample code:** + +```ballerina +oas:ListAttributeFieldsMetadata result = check pricefxClient->listAttributeFieldsMetadata(typeCode, queries); +``` + +
+
+ +
+listEntityFields + +
+ +List Entity Fields + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "ACTT"|"AI"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CL"|"CLLI"|"CLLIAM"|"CLR"|"CLT"|"CN"|"CO"|"COAM"|"COCT"|"COCTAM"|"COHT"|"COHTAM"|"COLI"|"COR"|"CORAM"|"COROLI"|"CORS"|"CORSC"|"COT"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX10"|"CX20"|"CX3"|"CX30"|"CX50"|"CX6"|"CX8"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DP"|"DPR"|"DPT"|"DREF"|"DREG"|"EDL"|"ET"|"EVT"|"F"|"FE"|"FN"|"HEVT"|"HRT"|"HRTAM"|"IDC"|"IE"|"ISH"|"JLTV"|"JLTV2"|"JLTVM"|"JST"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MC"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MN"|"MO"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"NT"|"P"|"PAM"|"PBOME"|"PCOMP"|"PCOMPCO"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLPGTT"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX10"|"PX20"|"PX3"|"PX30"|"PX50"|"PX6"|"PX8"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAROLI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"SL"|"SLAM"|"SX10"|"SX20"|"SX3"|"SX30"|"SX50"|"SX6"|"SX8"|"SXAM"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI" | Yes | Enter the type code of the entity you want to retrieve information for. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:ListEntityFieldsQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ListEntityFieldsResponse|error` + +**Sample code:** + +```ballerina +oas:ListEntityFieldsResponse result = check pricefxClient->listEntityFields(typeCode, queries); +``` + +
+
+ +#### General + +
+createObject + +
+ +Create an Object + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) | +| `payload` | oas:CreateObjectRequest_1 | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->createObject(typeCode, payload); +``` + +
+
+ +
+deleteColumnValues + +
+ +Delete Column Values + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) | +| `columnName` | string | Yes | The name of the column/attribute you want to remove values from | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteColumnValuesResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteColumnValuesResponse result = check pricefxClient->deleteColumnValues(typeCode, columnName); +``` + +
+
+ +
+deleteObject + +
+ +Delete an Object + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "ACTT"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CLLI"|"CN"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DREG"|"DWT"|"ET"|"EVT"|"F"|"FE"|"FN"|"IDC"|"IE"|"ISH"|"JST"|"JLTV"|"JLTVM"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"P"|"PAM"|"PAPIJ"|"PBOME"|"PCOMP"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI" | Yes | Enter the type code of the entity you want to delete the object from. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article | +| `payload` | oas:DeleteObjectRequest_1 | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteObjectResponse_1|error` + +**Sample code:** + +```ballerina +oas:DeleteObjectResponse_1 result = check pricefxClient->deleteObject(typeCode, payload); +``` + +
+
+ +
+deleteObjects + +
+ +Delete Objects + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) | +| `payload` | oas:DeleteObjectsForceFilterRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:DeleteObjectsResponse|error` + +**Sample code:** + +```ballerina +oas:DeleteObjectsResponse result = check pricefxClient->deleteObjects(typeCode, payload); +``` + +
+
+ +
+getObject + +
+ +Get an Object + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) | +| `id` | string | Yes | The ID of the object you want to retrieve details for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetObjectResponse_1|error` + +**Sample code:** + +```ballerina +oas:GetObjectResponse_1 result = check pricefxClient->getObject(typeCode, id); +``` + +
+
+ +
+getQueryApiMetadata + +
+ +Get Query API Metadata + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:QueryapiExecuteBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:QueryApiMetadataEnvelope|error` + +**Sample code:** + +```ballerina +oas:QueryApiMetadataEnvelope result = check pricefxClient->getQueryApiMetadata(payload); +``` + +
+
+ +
+insertBulkData + +
+ +Insert Bulk Data + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | oas:TypeCodeEnum | Yes | Specify the type code for the entity you want to work with. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article.' | +| `payload` | oas:InsertBulkDataRequest | Yes | The **`/loaddata/P`** endpoint (Insert Bulk Products) is used in our example.<p> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:LoadDataResponse|error` + +**Sample code:** + +```ballerina +oas:LoadDataResponse result = check pricefxClient->insertBulkData(typeCode, payload); +``` + +
+
+ +
+insertBulkDataFromFile + +
+ +Insert Bulk Data From a File + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "C"|"CDESC"|"CX"|"JLTV"|"LTV"|"MLTV"|"P"|"PBOME"|"PCOMP"|"PDESC"|"PR"|"PX"|"PXREF"|"SL"|"SX"|"TODO"|"UG" | Yes | Enter the type code of the entity you want to insert a data to. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article | +| `payload` | oas:InsertBulkDataFromFileRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:InsertBulkDataFromFileQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:InsertBulkDataFromFileResponse|error` + +**Sample code:** + +```ballerina +oas:InsertBulkDataFromFileResponse result = check pricefxClient->insertBulkDataFromFile(typeCode, payload, queries); +``` + +
+
+ +
+insertBulkDataFromFileAsync + +
+ +Insert Bulk Data From a File (async) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "C"|"CDESC"|"CX"|"JLTV"|"LTV"|"MLTV"|"P"|"PBOME"|"PCOMP"|"PDESC"|"PR"|"PX"|"PXREF"|"SL"|"SX"|"TODO"|"UG" | Yes | Enter the type code of the entity you want to insert a data to. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article | +| `payload` | oas:InsertBulkDataFromFileAsyncRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:InsertBulkDataFromFileAsyncQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:InsertBulkDataFromFileAsyncResponse|error` + +**Sample code:** + +```ballerina +oas:InsertBulkDataFromFileAsyncResponse result = check pricefxClient->insertBulkDataFromFileAsync(typeCode, payload, queries); +``` + +
+
+ +
+listObjects + +
+ +List Objects + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) | +| `payload` | oas:ListObjectsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->listObjects(typeCode, payload); +``` + +
+
+ +
+listTypeCodes + +
+ +List Type Codes + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:TypeCodesResponse|error?` + +**Sample code:** + +```ballerina +oas:TypeCodesResponse|error? result = check pricefxClient->listTypeCodes(); +``` + +
+
+ +
+massUpdate + +
+ +Mass Update + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) | +| `payload` | oas:MassUpdateRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:MassUpdateResponse|error` + +**Sample code:** + +```ballerina +oas:MassUpdateResponse result = check pricefxClient->massUpdate(typeCode, payload); +``` + +
+
+ +
+queryApiExecute + +
+ +Query API Execute + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:QueryapiExecuteBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:QueryApiExecuteQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:QueryApiExecuteEnvelope|error` + +**Sample code:** + +```ballerina +oas:QueryApiExecuteEnvelope result = check pricefxClient->queryApiExecute(payload, queries); +``` + +
+
+ +
+updateObject + +
+ +Update an Object + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) | +| `payload` | oas:UpdateObjectRequest | Yes | <!-- theme: warning --> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->updateObject(typeCode, payload); +``` + +
+
+ +
+updateObjectReturningOldData + +
+ +Update an Object (and return old data) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | string | Yes | The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) | +| `payload` | oas:UpdateObjectReturnOldDataRequest | Yes | <!-- theme: warning --> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `error?` + +**Sample code:** + +```ballerina +error? result = check pricefxClient->updateObjectReturningOldData(typeCode, payload); +``` + +
+
+ +
+upsertObject + +
+ +Upsert an Object + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | "ACTT"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CLLI"|"CN"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DREG"|"DWT"|"ET"|"EVT"|"F"|"FE"|"FN"|"IDC"|"IE"|"ISH"|"JST"|"JLTV"|"JLTVM"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"P"|"PAM"|"PAPIJ"|"PBOME"|"PCOMP"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI" | Yes | Enter the Type code of the entity you want to insert a data to. See [the list of Type codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article | +| `payload` | oas:UpsertObjectRequest | Yes | The **`/integrate/P`** endpoint (Upsert a Product) is used in our example.<p> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ProductResponse|error` + +**Sample code:** + +```ballerina +oas:ProductResponse result = check pricefxClient->upsertObject(typeCode, payload); +``` + +
+
+ +
+upsertObjectReturningOldData + +
+ +Upsert an Object (and return old data) + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typeCode` | oas:TypeCodeEnum | Yes | Specify the type code for the entity you want to work with. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article.' | +| `payload` | oas:UpsertObjectReturnOldDataRequest | Yes | The **`/integrate/P/returnolddata`** endpoint (upserts a product) is used in our example.<p> | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:UpsertObjectReturnOldDataResponse|error` + +**Sample code:** + +```ballerina +oas:UpsertObjectReturnOldDataResponse result = check pricefxClient->upsertObjectReturningOldData(typeCode, payload); +``` + +
+
+ +#### Optimization + +
+calculateModelObjectStep + +
+ +Calculate a Model Object Step + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to recalculate the step for | +| `stepName` | "definition"|"configuration"|"results"|"projections"|"parallel" | Yes | Enter the name of the step you want to calculate | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:CalculateModelObjectStepQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:ModelCalculationStepEnvelope|error` + +**Sample code:** + +```ballerina +oas:ModelCalculationStepEnvelope result = check pricefxClient->calculateModelObjectStep(typedId, stepName, queries); +``` + +
+
+ +
+cancelCalculationStep + +
+ +Cancel a Calculation Step + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to cancel the calculation step for | +| `stepName` | string | Yes | The name of the step you want to cancel | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:JobStatusTrackerResponse|error` + +**Sample code:** + +```ballerina +oas:JobStatusTrackerResponse result = check pricefxClient->cancelCalculationStep(typedId, stepName); +``` + +
+
+ +
+duplicateModel + +
+ +Duplicate a Model + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The typedId to be sent with the request | +| `payload` | oas:OptimizationModelduplicatetypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ModelDuplicationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ModelDuplicationEnvelope result = check pricefxClient->duplicateModel(typedId, payload); +``` + +
+
+ +
+executeModelLogic + +
+ +Execute a Model Logic + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to execute the logic for | +| `stepName` | string | Yes | The name of the step you want to execute the logic for | +| `formulaName` | string | Yes | The name of the logic you want to execute | +| `payload` | oas:ExecuteModelLogicRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ExecuteModelLogicResponse|error` + +**Sample code:** + +```ballerina +oas:ExecuteModelLogicResponse result = check pricefxClient->executeModelLogic(typedId, stepName, formulaName, payload); +``` + +
+
+ +
+exportModels + +
+ +Export Models + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:OptimizationModelexportBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->exportModels(payload); +``` + +
+
+ +
+getCalculationStatus + +
+ +Get a Calculation Status + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to retrieve the calculation status for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:JobStatusTrackerResponse|error` + +**Sample code:** + +```ballerina +oas:JobStatusTrackerResponse result = check pricefxClient->getCalculationStatus(typedId); +``` + +
+
+ +
+getParallelCalculationItem + +
+ +Get a Parallel Calculation Item + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `id` | string | Yes | `id` of the Parallel Calculation Item (PCI) you want to retrieve | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GetParallelCalculationItemResponse|error` + +**Sample code:** + +```ballerina +oas:GetParallelCalculationItemResponse result = check pricefxClient->getParallelCalculationItem(id, payload); +``` + +
+
+ +
+getStepCalculationStatus + +
+ +Get a Step Calculation Status + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to retrieve the calculation status for | +| `stepName` | string | Yes | The name of the step you want to calculate | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:JobStatusTrackerResponse|error` + +**Sample code:** + +```ballerina +oas:JobStatusTrackerResponse result = check pricefxClient->getStepCalculationStatus(typedId, stepName); +``` + +
+
+ +
+importModels + +
+ +Import Models + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:OptimizationModelimportBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ModelDuplicationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ModelDuplicationEnvelope result = check pricefxClient->importModels(payload); +``` + +
+
+ +
+listModelLogicParameters + +
+ +List Model Logic Parameters + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to retrieve logic parameters for | +| `stepName` | string | Yes | The name of the step you want to list logic parameters for | +| `formulaName` | string | Yes | The name of the logic you want to get parameters for | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListModelLogicParametersResponse|error` + +**Sample code:** + +```ballerina +oas:ListModelLogicParametersResponse result = check pricefxClient->listModelLogicParameters(typedId, stepName, formulaName); +``` + +
+
+ +
+listParallelCalculationItems + +
+ +List Parallel Calculation Items + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:ListParallelCalculationItemsRequest | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListParallelCalculationItemsResponse|error` + +**Sample code:** + +```ballerina +oas:ListParallelCalculationItemsResponse result = check pricefxClient->listParallelCalculationItems(payload); +``` + +
+
+ +
+loadDataIntoFieldCollection + +
+ +Load Data Into FieldCollection + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | Specifies the typedId (format: `{id}.{type}`) of the FieldCollection to load data into. Type must be either `DMDS` or `DMT` | +| `payload` | oas:DatamartLoadfctypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `http:Response|error` + +**Sample code:** + +```ballerina +http:Response result = check pricefxClient->loadDataIntoFieldCollection(typedId, payload); +``` + +
+
+ +
+recalculateCalculationOfStep + +
+ +Recalculate a Calculation of a Step + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to recalculate the step for | +| `stepName` | "definition"|"configuration"|"results"|"projections"|"parallel" | Yes | Enter the name of the step you want to calculate | +| `calcName` | string | Yes | The name of the calculation you want to recalculate | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RecalculateCalculationOfStepResponse|error` + +**Sample code:** + +```ballerina +oas:RecalculateCalculationOfStepResponse result = check pricefxClient->recalculateCalculationOfStep(typedId, stepName, calcName, payload); +``` + +
+
+ +
+recalculateItemsOfParallelCalculation + +
+ +Recalculate Items of a Parallel Calculation + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to recalculate the step for | +| `stepName` | "definition"|"configuration"|"results"|"projections"|"parallel" | Yes | Enter the name of the step you want to calculate | +| `calcName` | string | Yes | The name of the calculation you want to recalculate | +| `payload` | oas:CalcNameItemBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ParallelCalculationEnvelope|error` + +**Sample code:** + +```ballerina +oas:ParallelCalculationEnvelope result = check pricefxClient->recalculateItemsOfParallelCalculation(typedId, stepName, calcName, payload); +``` + +
+
+ +
+revokeModel + +
+ +Revoke a Model + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | `typedId` of the model you want to revoke | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:RevokeModelResponse|error` + +**Sample code:** + +```ballerina +oas:RevokeModelResponse result = check pricefxClient->revokeModel(typedId, payload); +``` + +
+
+ +
+saveModel + +
+ +Save a Model + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to save | +| `stepName` | "definition"|"configuration"|"results"|"projections" | Yes | Enter the name of the step you want to save. Steps are defined in the Model Class that is associated to the Model Object | +| `payload` | oas:SaveModelRequest | Yes | The `data` property can only contain the `state` field, all the rest fields will be ignored (and cannot be updated even with update/MO endpoint) | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SaveModelResponse|error` + +**Sample code:** + +```ballerina +oas:SaveModelResponse result = check pricefxClient->saveModel(typedId, stepName, payload); +``` + +
+
+ +
+submitModel + +
+ +Submit a Model + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `typedId` | string | Yes | The `typedId` of the Model Object you want to submit | +| `payload` | record {} | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:SaveModelResponse|error` + +**Sample code:** + +```ballerina +oas:SaveModelResponse result = check pricefxClient->submitModel(typedId, payload); +``` + +
+
+ +
+updateJobStatusTrackerEntry + +
+ +Update Job Status Tracker Entry + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:OptimizationUpdatejstBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:JobStatusTrackerUpdateEnvelope|error` + +**Sample code:** + +```ballerina +oas:JobStatusTrackerUpdateEnvelope result = check pricefxClient->updateJobStatusTrackerEntry(payload); +``` + +
+
+ +#### Logs + +
+getLokiLog + +
+ +Get a Loki Log + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | +| `queries` | *oas:GetLokiLogQueries | Yes | Queries to be sent with the request | + +**Returns:** `oas:LokiLogEnvelope|error` + +**Sample code:** + +```ballerina +oas:LokiLogEnvelope result = check pricefxClient->getLokiLog(queries); +``` + +
+
+ +
+listEmailTasks + +
+ +List Email Tasks + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:NotificationListBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListEmailTasksEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListEmailTasksEnvelope result = check pricefxClient->listEmailTasks(payload); +``` + +
+
+ +
+listEventTasks + +
+ +List Event Tasks + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:NotificationListBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListEventTasksEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListEventTasksEnvelope result = check pricefxClient->listEventTasks(payload); +``` + +
+
+ +
+listLogins + +
+ +List Logins + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:BdmanagerListtypedIdBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListLoginsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListLoginsEnvelope result = check pricefxClient->listLogins(payload); +``` + +
+
+ +
+listSecurityConfigurationEvents + +
+ +List Security & Configuration Events + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `payload` | oas:NotificationListBody | Yes | Request payload | +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:ListSecurityConfigEventsEnvelope|error` + +**Sample code:** + +```ballerina +oas:ListSecurityConfigEventsEnvelope result = check pricefxClient->listSecurityConfigurationEvents(payload); +``` + +
+
+ +#### Heartbeat + +
+listTasks + +
+ +List Tasks + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:GenericDataResponse|error` + +**Sample code:** + +```ballerina +oas:GenericDataResponse result = check pricefxClient->listTasks(); +``` + +
+
+ +#### MCP + +
+getMcpRoles + +
+ +Get MCP Roles + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:McpRolesEnvelope|error` + +**Sample code:** + +```ballerina +oas:McpRolesEnvelope result = check pricefxClient->getMcpRoles(); +``` + +
+
+ +
+getMcpTools + +
+ +Get MCP Tools + +**Parameters:** + +| Name | Type | Required | Description | +|------|------|----------|--------------| +| `headers` | map<string|string[]> | No | Headers to be sent with the request | + +**Returns:** `oas:McpToolsEnvelope|error` + +**Sample code:** + +```ballerina +oas:McpToolsEnvelope result = check pricefxClient->getMcpTools(); +``` + +
+
diff --git a/en/docs/connectors/catalog/erp-business/pricefx/example.md b/en/docs/connectors/catalog/erp-business/pricefx/example.md new file mode 100644 index 0000000000..9cc010ab23 --- /dev/null +++ b/en/docs/connectors/catalog/erp-business/pricefx/example.md @@ -0,0 +1,115 @@ +--- +title: Example +--- + +# Example + +## What you'll build + +This example builds an automation that connects to Pricefx and lists the price list types defined in your partition. The automation calls the **List Price List Types** operation and logs the result. + +**Operations used:** +- **List Price List Types** : Retrieves the price list types configured for your partition. + +## Architecture + +```mermaid +flowchart LR + A((User)) --> B[List Price List Types] + B --> C[Pricefx Connector] + C --> D[(Pricefx)] +``` + +## Prerequisites + +- A Pricefx username, password, and partition. See the connector's [Setup Guide](setup-guide.md). + +## Setting up the Pricefx integration + +> **New to WSO2 Integrator?** Follow the [Create a New Integration](../../../../develop/create-integrations/create-a-new-integration.md) guide to set up your integration first, then return here to add the connector. + +## Adding the Pricefx connector + +### Step 1: Open the connector palette + +Select **Add Connection** in the **Connections** section. + +![Pricefx connector palette open before selection](/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_01_palette.png) + +### Step 2: Select the Pricefx connector + +Enter "pricefx" in the search box to filter the connector list, then select the **Pricefx** connector card (`ballerinax/pricefx`) to open its connection configuration form. + +## Configuring the Pricefx connection + +### Step 3: Bind the connection parameters to configurable variables + +Bind the required connection fields to configurable variables. + +- **Config** : The authentication method to use. Select **BasicCredentials** and bind its `username`, `password`, and `partition` fields. + +![Pricefx connection form with the username, password, and partition bound before saving](/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_02_connection_form.png) + +### Step 4: Save the connection + +Select **Save Connection** and verify that the connection appears in the **Connections** section. + +![Pricefx connection visible after saving](/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_03_connections_list.png) + +### Step 5: Set actual values for your configurables + +1. Select **Configurations** at the bottom of the project tree under **Data Mappers**. +2. Enter a value for each configurable listed below before you run the integration. + +- **username** (`string`) : Your Pricefx username. +- **password** (`string`) : Your Pricefx password. +- **partition** (`string`) : Your Pricefx partition name. + +## Configuring the Pricefx List Price List Types operation + +### Step 6: Add an automation entry point + +1. In the left panel under **Entry Points**, select **+** (**Add Entry Point**). +2. Under **Automation**, select **Automation**. +3. In the **Create New Automation** dialog, accept the default settings and select **Create**. + +The canvas switches to the Automation flow view, showing a Start node, an Error Handler node, and an End node. + +### Step 7: Select the List Price List Types operation + +1. In the automation flow body on the canvas, select the **+** (Add Step) button between the Start and Error Handler nodes to open the step-addition panel. +2. Under **Connections** in the step panel, select the **pricefxClient** connection node to expand it and reveal all available Pricefx API operations. + +![Pricefx connection expanded to display operations before selection](/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_04_operations_panel.png) + +3. Select **List Price List Types** from the list. This operation has no required parameters, so only the result variable needs a name. + +- **Result** : The name of the variable that holds the returned price list types. + +![Pricefx List Price List Types operation with the result variable set before saving](/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_05_operation_form.png) + +4. Select **Save** to add the Pricefx operation step to the automation flow. + +### Step 8: Log the List Price List Types result + +Add a log action for the returned value, then return to the visual flow. + +![Completed Pricefx flow with the configured operation](/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_06_completed_flow.png) + +## Try it yourself + +Try this sample in WSO2 Integration Platform. + +[![Deploy to Devant](https://openindevant.choreoapps.dev/images/DeployDevant-White.svg)](https://console.devant.dev/new?gh=wso2/integration-samples/tree/main/integrator-default-profile/connectors/pricefx_connector_sample) + +[View source on GitHub](https://github.com/wso2/integration-samples/tree/main/integrator-default-profile/connectors/pricefx_connector_sample) + +## More code examples + +The `Pricefx` connector offers practical examples illustrating its use in various scenarios. +Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-pricefx/tree/main/examples/), covering the following use cases: + +1. [Product catalog management](https://github.com/ballerina-platform/module-ballerinax-pricefx/tree/main/examples/product-catalog-management): Add a new product to the catalog, update one of its fields, then list matching products to confirm the change. +2. [Customer quote workflow](https://github.com/ballerina-platform/module-ballerinax-pricefx/tree/main/examples/customer-quote-workflow): Add a new customer, create a quote for them, then submit the quote for approval. +3. [Price list calculation](https://github.com/ballerina-platform/module-ballerinax-pricefx/tree/main/examples/price-list-calculation): Create a new price list, run its calculation, then fetch the calculated price list. +4. [Attachment upload workflow](https://github.com/ballerina-platform/module-ballerinax-pricefx/tree/main/examples/attachment-upload-workflow): Create an upload slot for a customer record, upload a file to it, then list the customer's files. diff --git a/en/docs/connectors/catalog/erp-business/pricefx/overview.md b/en/docs/connectors/catalog/erp-business/pricefx/overview.md new file mode 100644 index 0000000000..5a73fb5aef --- /dev/null +++ b/en/docs/connectors/catalog/erp-business/pricefx/overview.md @@ -0,0 +1,39 @@ +--- +connector: true +connector_name: "pricefx" +title: "Pricefx" +description: "Overview of the ballerinax/pricefx connector for WSO2 Integrator." +--- + +[Pricefx](https://www.pricefx.com/) is a cloud-native pricing and revenue management platform that helps enterprises manage price lists, calculation grids, quotes, contracts, and rebate agreements across their sales organization. The `ballerinax/pricefx` connector provides a client for the [Pricefx Backend API](https://api.pricefx.com/), covering master data (products, customers, sellers), pricing (price lists, manual price lists, calculation grids, condition records), sales (quotes, contracts, rebate agreements, sales compensations), and platform administration (users, workflow, data manager, notifications, comments, custom forms, and more). + +## Key Features + +- Manage products, customers, sellers, and their extension fields +- Create, calculate, and manage price lists, manual price lists, and calculation grids +- Build quotes, submit and revoke them, and convert them to deals +- Manage contracts (agreements and promotions) and rebate agreements +- Run rebate calculations and manage rebate record groups +- Handle sales compensation plans and records +- Upload, download, and manage attachments and files +- Manage users, business roles, and workflow delegations +- Work with the Data Manager, lookup tables, and key-value stores +- Authenticate with username/password, an API key, OAuth 2.0, or a pre-signed external JWT +- Transparent re-authentication - the client automatically refreshes a short-lived token and retries once whenever a request comes back unauthenticated + +## Actions + +The connector exposes a single client for interacting with the Pricefx API. + +| Client | Actions | +|---|---| +| [`Client`](action-reference.md#client) | Manages Pricefx products, customers, sellers, condition records, price lists, manual price lists, calculation grids, quotes, contracts, rebate agreements and calculations, sales compensations, attachments, users, workflow, data manager, and authentication. | + +## Documentation + +- [Setup Guide](setup-guide.md) - Get Pricefx credentials +- [Actions](action-reference.md) - Available operations + +## How to contribute + +Contribute to the connector's development on GitHub: [module-ballerinax-pricefx](https://github.com/ballerina-platform/module-ballerinax-pricefx). diff --git a/en/docs/connectors/catalog/erp-business/pricefx/setup-guide.md b/en/docs/connectors/catalog/erp-business/pricefx/setup-guide.md new file mode 100644 index 0000000000..c56b93f27b --- /dev/null +++ b/en/docs/connectors/catalog/erp-business/pricefx/setup-guide.md @@ -0,0 +1,97 @@ +--- +connector: true +connector_name: "pricefx" +title: "Setup Guide" +description: "How to set up and configure the ballerinax/pricefx connector." +--- + +# Setup Guide + +This guide walks you through getting the details the connector needs to authenticate and communicate with your Pricefx partition. + +## Choose an authentication method + +The connector supports several ways to authenticate with Pricefx. Provide exactly one of the following credential combinations. + +### 1. Basic Authentication + +The most common setup, and the one to reach for first. + +Your user name, password, and partition are provisioned when your Pricefx account is created - ask your Pricefx administrator if you don't already have them. The partition name also appears in your instance's login URL, in the form `https://.pricefx.com/pricefx/`. + +You only pay for a Basic authenticated request once: the connector uses your username, password, and partition to bootstrap a session token when the client is created, then reuses that token for every request afterward instead of sending your credentials again. + +### 2. JWT Token Authentication + +Provide `jwt` on its own - no username, password, or partition needed. + +If you already have a non-expiring Pricefx JWT, you can use it directly by setting it as `jwt`. + +### 3. OAuth 2.0 Authentication + +Provide `clientId`, `refreshToken`, and optionally `clientSecret`. + +#### Registering an OAuth client + +On the Pricefx side, go to **Administration > Configuration > System Configuration > Advanced Configuration Options** and add a per-partition configuration named `oauthConfiguration` with a value shaped like this: + +```json +{ + "knownClients": { + "": { + "redirect_uri": "", + "client_secret": "", + "client_description": "A short label shown on the consent screen" + } + } +} +``` + +- The key you choose under `knownClients` (`` above) is the value you set as `clientId`. +- `client_secret`, if you set one, is the value you set as `clientSecret`. +- `redirect_uri` must match wherever your integration is set up to receive the sign-in redirect. + +#### Getting a refresh token + +`refreshToken` comes from signing in once through Pricefx's OAuth 2.0 consent screen for the client you just registered, and approving access. That sign-in step is interactive (it happens in a browser) and can't be automated by this connector, but it's a one-time setup step - the consent screen hands back a refresh token as part of the exchange, and that's the value you configure here. + +Once you have a refresh token, the connector fetches and refreshes access tokens automatically - you never need to repeat that step. + +### 4. External JWT Authentication + +You can use a third-party JSON Web Token for authentication (for example, with Salesforce as the signer). As with SAML, no hard-coded per-user credentials are needed - instead, a system-to-system trust relationship is established using signed tokens. + +#### Configuring the trust relationship + +On the Pricefx side, go to **Administration > Configuration > System Configuration > Advanced Configuration Options** and add a per-partition configuration named `externalJWTConfiguration` with a value shaped like this: + +```json +{ + "entries": { + "": { + "publicKey": "", + "permissions": "" + } + } +} +``` + +- **`externalSystemName`** - a JSON-safe name for the external system (letters, digits only - no whitespace). This is the same name you pass as `systemName` to the connector. You can register as many external systems as you like, each under its own name. +- **`publicKey`** - the external system's public key, as a PEM-formatted string. Pricefx only supports RSA keys. +- **`permissions`** - leave `null` (or omit it) to not further restrict permissions beyond what the authenticated user already has. If you provide a list of permission-name strings instead, a token issued under this configuration can only call endpoints whose required permission is in that list. + + :::caution + The `permissions` list is only an additional filter, on top of the authenticated user's own permissions - it can't grant a user something they couldn't otherwise do. Use it to restrict a given trust relationship to a narrower set of API calls than the user would normally have access to. + ::: + +Once the trust relationship is configured, give the connector two values: `systemName`, set to the name you registered above, and `jwt`, set to a JWT signed by that external system. + +The connector automatically re-authenticates and retries once whenever a request comes back unauthenticated, so a long-lived client instance keeps working without manual re-initialization. + +## Note your service URL + +The connector connects to `https://.pricefx.com/pricefx/` by default. Confirm your node and partition name with your Pricefx administrator if you're not sure. + +## Next steps + +- [Actions](action-reference.md) - Available operations diff --git a/en/docs/connectors/catalog/index.mdx b/en/docs/connectors/catalog/index.mdx index e6eae342d5..e2432f397c 100644 --- a/en/docs/connectors/catalog/index.mdx +++ b/en/docs/connectors/catalog/index.mdx @@ -131,6 +131,7 @@ Find the right connector for your integration. Use the search bar or filter by c { name: "PayPal Payments", description: "Payment platform with authorization, capture, void, and refund operations", operations: "Authorize, Capture, Void, Refund, Show Details", auth: "OAuth 2.0 (Client Credentials)", link: "finance-accounting/paypal.payments/paypal-payments-connector-overview", category: "Finance & Accounting", icon: "https://bcentral-packageicons.azureedge.net/images/ballerinax_paypal.payments_2.0.1.png" }, { name: "PayPal Subscriptions", description: "PayPal recurring billing platform for creating subscription plans and managing subscription lifecycles", operations: "Create, Read, Update, Activate, Deactivate, Suspend, Cancel, Revise, Capture, List", auth: "OAuth 2.0", link: "finance-accounting/paypal.subscriptions/paypal-subscriptions-connector-overview", category: "Finance & Accounting", icon: "https://bcentral-packageicons.azureedge.net/images/ballerinax_paypal.subscriptions_1.0.1.png" }, { name: "People HR", description: "HR management system with employee records, holidays, salaries, vacancies, applicants, and appraisals", operations: "Create, Read, Update, Delete, Query", auth: "API Key", link: "hrms/peoplehr/people-hr-connector-overview", category: "HRMS", icon: "https://bcentral-packageicons.azureedge.net/images/ballerinax_peoplehr_2.2.1.png" }, + { name: "Pricefx", description: "Cloud-native pricing and revenue management: products, customers, price lists, calculation grids, quotes, contracts, and rebate agreements", operations: "Create, Read, Update, Delete, List, Search, Calculate, Submit", auth: "Username/Password, API Key, OAuth 2.0, External JWT", link: "erp-business/pricefx/overview", category: "ERP & Business" }, { name: "PostgreSQL", description: "Object-relational database with SQL queries, batch operations, stored procedures, and CDC triggers", operations: "Query, Execute, Batch Execute, Call, CDC", auth: "Username/Password", link: "database/postgresql/connector-overview", category: "Database", icon: "https://bcentral-packageicons.azureedge.net/images/ballerinax_postgresql_1.17.0.png" }, { name: "RabbitMQ", description: "AMQP 0-9-1 message broker with queue/exchange management, pub/sub, and consumer services", operations: "Publish, Consume, Queue Declare, Exchange Declare, Bind, Ack, Nack", auth: "Username / Password", link: "messaging/rabbitmq/connector-overview", category: "Messaging", icon: "https://bcentral-packageicons.azureedge.net/images/ballerinax_rabbitmq_3.3.3.png" }, { name: "Redis", description: "In-memory data store with string, list, set, sorted set, and hash operations", operations: "Get, Set, List, Hash, Set, Sorted Set, Key Management", auth: "Password / ACL", link: "database/redis/connector-overview", category: "Database", icon: "https://bcentral-packageicons.azureedge.net/images/ballerinax_redis_3.2.0.png" }, diff --git a/en/sidebars.ts b/en/sidebars.ts index 4580c3e587..9a31243686 100644 --- a/en/sidebars.ts +++ b/en/sidebars.ts @@ -1387,6 +1387,16 @@ const sidebars: SidebarsConfig = { 'connectors/catalog/hrms/peoplehr/example', ], }, + { + type: 'category', + label: 'Pricefx', + link: { type: 'doc', id: 'connectors/catalog/erp-business/pricefx/overview' }, + items: [ + 'connectors/catalog/erp-business/pricefx/setup-guide', + 'connectors/catalog/erp-business/pricefx/action-reference', + 'connectors/catalog/erp-business/pricefx/example', + ], + }, { type: 'category', diff --git a/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_01_palette.png b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_01_palette.png new file mode 100644 index 0000000000..7fe3df3337 Binary files /dev/null and b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_01_palette.png differ diff --git a/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_02_connection_form.png b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_02_connection_form.png new file mode 100644 index 0000000000..39caeffab9 Binary files /dev/null and b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_02_connection_form.png differ diff --git a/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_03_connections_list.png b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_03_connections_list.png new file mode 100644 index 0000000000..32b5beaff0 Binary files /dev/null and b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_03_connections_list.png differ diff --git a/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_04_operations_panel.png b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_04_operations_panel.png new file mode 100644 index 0000000000..5caee49e4a Binary files /dev/null and b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_04_operations_panel.png differ diff --git a/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_05_operation_form.png b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_05_operation_form.png new file mode 100644 index 0000000000..2efcb1c5e4 Binary files /dev/null and b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_05_operation_form.png differ diff --git a/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_06_completed_flow.png b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_06_completed_flow.png new file mode 100644 index 0000000000..46458d6dd0 Binary files /dev/null and b/en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_06_completed_flow.png differ