{
  "openapi": "3.0.1",
  "info": {
    "title": "Store Widget Subscriptions",
    "description": "Create and administer a collection of all store widget subscriptions.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "paths": {
    "/store-widget-subscriptions": {
      "get": {
        "tags": [
          "store-widget-subscriptions"
        ],
        "description": "Get the collection of all store widget subscriptions.",
        "operationId": "getStoreWidgetSubscriptions",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The identifier for store widget subscription.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The store identifier.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "pageLayoutWidgetDefId",
            "in": "query",
            "description": "The identifier for widget definition.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "state",
            "in": "query",
            "description": "The state of store widget subscription.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "definitionXml",
            "in": "query",
            "description": "The XML of widget definition.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of store widget subscriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreWidgetSubscriptionCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "store-widget-subscriptions"
        ],
        "description": "Create a store widget subscriptions.",
        "operationId": "createStoreWidgetSubscription",
        "requestBody": {
          "description": "Store widget subscription.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreWidgetSubscription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "headers": {
              "Location": {
                "description": "The URI of the subscriptions.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetStoreWidgetSubscriptionById": {
                "operationRef": "#/paths/~1store-widget-subscriptions~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /store-widget-subscriptions/{id}`.\n"
              },
              "DeleteStoreWidgetSubscriptionById": {
                "operationRef": "#/paths/~1store-widget-subscriptions~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id`value used in the request body can be used as the `id`parameter in `DELETE /store-widget-subscriptions/{id}`.\n"
              },
              "UpdateStoreWidgetSubscriptionById": {
                "operationRef": "#/paths/~1store-widget-subscriptions~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id`value used in the request body can be used as the `id`parameter in `PATCH /store-widget-subscriptions/{id}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "StoreWidgetSubscription"
      }
    },
    "/store-widget-subscriptions/{id}": {
      "get": {
        "tags": [
          "store-widget-subscriptions"
        ],
        "description": "Get a store widget subscription by Id.",
        "operationId": "getStoreWidgetSubscriptionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The identifier for store widget subscription.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Store widget subscription.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreWidgetSubscription"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "store-widget-subscriptions"
        ],
        "description": "Delete a store widget subscription by Id.",
        "operationId": "deleteStoreWidgetSubscriptionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The identifier for store widget subscription.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "store-widget-subscriptions"
        ],
        "description": "Update a store widget subscription by Id.",
        "operationId": "updateStoreWidgetSubscriptionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The identifier for store widget subscription.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "Store widget subscription.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreWidgetSubscription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "StoreWidgetSubscription"
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "StoreWidgetSubscription": {
        "type": "object",
        "required": [
          "storeId",
          "id",
          "pageLayoutWidgetDefId"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The identifier for store widget subscription.",
            "format": "int64"
          },
          "storeId": {
            "type": "integer",
            "description": "The store identifier.",
            "format": "int32"
          },
          "pageLayoutWidgetDefId": {
            "type": "integer",
            "description": "The identifier for widget definition.",
            "format": "int64"
          },
          "state": {
            "type": "boolean",
            "description": "The state of store widget subscription."
          },
          "definitionXml": {
            "type": "string",
            "description": "The XML of widget definition."
          }
        },
        "description": "Store widget subscription."
      },
      "StoreWidgetSubscriptionCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/StoreWidgetSubscription"
            }
          }
        },
        "description": "A collection of store widget subscriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}