action agco_ats_clients_get_available_subscriptions {
  label: "Get a Client's Available Update Group Subscriptions"
  description: "No Documentation Found."
  provider: agco_ats
  method: GET
  path: "/api/v2/Clients/{ID}/AvailableUpdateGroupSubscriptions"
  encoding: json
  input: {
    type: "object"
    properties: {
      ID: {
        type: "string"
      }
      UpdateGroupID: {
        type: "string"
      }
      limit: {
        type: "integer"
        format: "int32"
      }
      offset: {
        type: "integer"
        format: "int32"
      }
    }
    required: ["ID"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "A response containing a page of results and metadata concerning the results"
    required: ["Entities", "Metadata"]
    properties: {
      Entities: {
        type: "array"
        items: {
          type: "object"
          properties: {
            AvailableSubscriptions: {
              type: "array"
              description: "The available subscriptions for this update group."
              items: {
                type: "object"
                properties: {
                  PackageType: {
                    type: "object"
                    required: ["Description"]
                    properties: {
                      Attribute: {
                        type: "string"
                        description: "The inventory attribute (from the InventoryPackage) used to determine what version of this package type is installed."
                      }
                      Category: {
                        type: "string"
                        description: "The inventory category (from the InventoryPackage) used to determine what version of this package type is installed."
                      }
                      Description: {
                        type: "string"
                        description: "The description of the package type"
                      }
                      Icon: {
                        type: "string"
                        description: "Optional.  The icon to use for the PackageType, in base 64"
                      }
                      InventoryFrequency: {
                        type: "integer"
                        format: "int32"
                        description: "The number of minutes to wait before requesting another inventory.  The default value is 1440 (24 hours)."
                      }
                      InventoryPackage: {
                        type: "string"
                        description: "The inventory package used to determine what version of this package type is installed."
                      }
                      LocalizedDescription: {
                        type: "string"
                        description: "Optional. The StringID used to localize the description of the PackageType"
                      }
                      LocalizedName: {
                        type: "string"
                        description: "Optional. The StringID used to localize the name of the PackageType"
                      }
                      MaxDeltaPackages: {
                        type: "integer"
                        format: "int32"
                        description: "The maximum number of \"chained\" delta packages to use when updating the client"
                      }
                      PackageTypeID: {
                        type: "string"
                        description: "Read Only. The package type id."
                      }
                    }
                  }
                  SubscriptionType: {
                    type: "string"
                    description: "The type of subscription supported."
                    enum: ["Required", "IncludeByDefault", "ExcludeByDefault"]
                  }
                }
              }
            }
            UpdateGroup: {
              type: "object"
              required: ["Description", "UpdateType", "Priority"]
              properties: {
                Description: {
                  type: "string"
                  description: "The description of the update group"
                }
                ID: {
                  type: "string"
                }
                InventoryFrequency: {
                  type: "integer"
                  format: "int32"
                  description: "The time in minutes between inventory checks. Default value is 1440 minutes (one day)."
                }
                InventoryPackage: {
                  type: "string"
                  description: "The Package ID of the package used for inventory"
                }
                LocalizedDescription: {
                  type: "string"
                  description: "Optional. The StringID used to localize the description of the update group"
                }
                LocalizedName: {
                  type: "string"
                  description: "Optional. The StringID used to localize the name of the update group"
                }
                Priority: {
                  type: "integer"
                  format: "int32"
                  description: "The execution priority of the package relative to other packages in the bundle. Range 1 - 100, lower value indication higher priority."
                }
                ReportField: {
                  type: "string"
                  description: "A field to return in the status report for this update group.
\n            Specify the field with the format [Label]: {[InventoryPackageID].[Category].[Attribute]}.  (i.e. example: {bec778ca-278d-424a-867a-4653a1a19e86.MyCategory.MyAttribute})"
                }
                UpdateType: {
                  type: "string"
                  description: "The update type name"
                }
                ValidatingField: {
                  type: "string"
                  description: "A field used for validation in the status report for this update group.
\n            Specify the field with the format [Label]: {[InventoryPackageID].[Category].[Attribute]}.  (i.e. example: {bec778ca-278d-424a-867a-4653a1a19e86.MyCategory.MyAttribute})"
                }
                ValueToValidate: {
                  type: "string"
                  description: "The value to validate the ValidationField against."
                }
                Version: {
                  type: "string"
                  format: "byte"
                  description: "The version of the UpdateGroup, this value is incremented with each modification to a related Bundle or PackageType"
                }
              }
            }
          }
        }
      }
      Metadata: {
        type: "object"
        description: "Metadata for the paged response"
        required: ["Limit", "Offset", "TotalCount"]
        properties: {
          Limit: {
            type: "integer"
            format: "int32"
            description: "The number of entities this paged response is limited to."
          }
          Offset: {
            type: "integer"
            format: "int32"
            description: "The number of entities prior to this page of items."
          }
          TotalCount: {
            type: "integer"
            format: "int32"
            description: "The total number of entities matching the request."
          }
        }
      }
    }
  }
}