@itentialopensource/adapter-calix_support_cloud 0.1.2 → 0.2.0

package/report/adapter-openapi.yaml

@@ -0,0 +1,3359 @@
+openapi: 3.0.0
+info:
+  title: Calix Support Cloud - Subscriber/Device API
+  description: >-
+    ## Authentication
+
+    All requests to this API must be authenticated using Basic authentication. To obtain the credentials for this, access Calix Cloud's administrative menu and look for the "API for Web Clients (HTTPS)" username and password.
+
+
+    ## URL
+
+    The base URLs for requests are:
+
+
+    |Data Center Location |URL |
+
+    |---------------------|----|
+
+    |United States|https://gcs.calix.com:8444/|
+
+    |Canada|https://gcs-ca.calix.com:8444/|
+
+
+    ## Request/Response Body Encoding
+
+    All requests and respsonses to this API use JSON encoding, unless otherwise specified.
+
+
+    ## HTTP Response Status Codes
+
+    Common HTTP Response Codes used by the API are shown below:
+
+
+    |Status Code	|Description	|Result or cause|
+
+    |---|---|---|
+
+    |200	|OK			|The request was handled successfully|
+
+    |400	|Bad Request	|The request contains invalid URL path and/or query parameters and/or payload.|
+
+    |401	|Unauthorized	|The HTTP request does not contain a valid HTTP Basic Authentication Header|
+
+    |403	|Forbidden		|The server understood the request but refused to fulfill it due to one of the following reasons:<br><ul><li>Tried to create a resource that already exists</li><li>Tried to edit a read-only attribute</li></ul>|
+
+    |404	|Not Found		|No existing record can be found by the given id string or other query parameter.|
+
+    |500	|Internal Server Error	|API Server failed to process the request due to an internal error.<br>Please report this failure to Calix Support.|
+
+
+    ## API Retrieval Limits
+
+    Starting in the 20.2 release, the CSC API limits the number of responses to "retrieve all" requests. To retrieve all elements beyond the default, use the following parameters:
+
+
+    |Parameter | Permitted Values | Description|
+
+    |---|---|---|
+
+    |limit | 1-500 | Specifies the number of records to return. If no limit is present, the default limit of 100 is used.|
+
+    |skip| >=0 | Specifies an offset, in number of records to skip from the beginning of the returned values. Default is zero.|
+
+
+    For example:
+
+
+    | URL and parameters | Result rows retrieved |
+
+    |---|---|
+
+    |https://gcs.calix.com:8444/api/device | 1-100 |
+
+    |https://gcs.calix.com:8444/api/device?limit=200 | 1-200 |
+
+    |https://gcs.calix.com:8444/api/device?limit=200&skip=200 | 201-400 |
+  contact: {}
+  version: '1.0'
+servers:
+- url: http://example.com/:8444/api
+  variables: {}
+- url: https://gcs.calix.com:8444/api
+  variables: {}
+paths:
+  /device:
+    get:
+      tags:
+      - Device Data Management
+      summary: RetrieveAllDevices
+      description: >-
+        Retrieve a list of all devices, returning a JSON array of device JSON objects, each describing a device.
+
+        There is no filtering nor limit/offset capability with this request.
+      operationId: RetrieveAllDevices
+      parameters: []
+      responses:
+        '200':
+          description: OK
+          headers:
+            Transfer-Encoding:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: chunked
+                  example: chunked
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/RetrieveAllDevice'
+                description: ''
+                example:
+                - _id: 12837558-000631-CXNK001D9030
+                  manufacturer: Calix
+                  manufacturerOUI: '000631'
+                  productClass: ENT
+                  modelName: '844E-1'
+                  hardwareVersion: '3000219601'
+                  softwareVersion: 12.2.8.1.11
+                  serialNumber: CXNK001D9030
+                  registrationId: ''
+                  macAddress: 00:06:31:ed:f7:b0
+                  periodicInformInterval: 86400
+                  dataModelName: tr098
+                  timezoneOffset: -08:00
+                  ipAddress: 192.168.92.2
+                  changeCounter: 24
+                  defaultGateway: 192.168.92.1
+                  subnetMask: 255.255.255.0
+                  wapGatewaySn: FTX133981PW
+                  provRecordStatus: Succeeded
+                  opMode: RG
+                  wanAccessType: CopperEthernet
+                  stunEnabled: true
+                  udpConnectionRequestAddr: 99.111.154.74:30005
+                  lastInformTime: 2019-04-17T05:40:38.904Z
+                  createTime: 2019-03-20T13:36:00.657Z
+                  hardwareSerialNumber: '261503000429'
+                - _id: 12837558-000631-CXNK001D9031
+                  manufacturerOUI: '000631'
+                  serialNumber: CXNK001D9031
+                  createTime: 2019-04-09T16:04:36.630Z
+                - _id: 12837558-CCBE59-CXNK005763A3
+                  manufacturer: Calix
+                  manufacturerOUI: CCBE59
+                  productClass: GigaSpire
+                  modelName: GS2020E
+                  hardwareVersion: '3000282601'
+                  softwareVersion: 19.1.0.1.4
+                  serialNumber: CXNK005763A3
+                  registrationId: ''
+                  macAddress: cc:be:59:fc:07:70
+                  periodicInformInterval: 86400
+                  dataModelName: tr098
+                  timezoneOffset: -04:00
+                  ipAddress: 192.168.10.191
+                  changeCounter: 1
+                  opRole: Controller
+                  defaultGateway: 192.168.10.1
+                  subnetMask: 255.255.255.0
+                  opMode: RG
+                  wanAccessType: CopperEthernet
+                  stunEnabled: true
+                  lastInformTime: 2019-05-20T18:13:01.371Z
+                  createTime: 2019-05-10T18:53:59.776Z
+                  hardwareSerialNumber: '391806000136'
+                - _id: 12837558-44657F-CXNK005A77A9
+                  manufacturer: Calix
+                  manufacturerOUI: 44657F
+                  productClass: GigaSpire
+                  modelName: GS2026E
+                  hardwareVersion: '3000281011'
+                  softwareVersion: 19.1.0.1.4
+                  serialNumber: CXNK005A77A9
+                  registrationId: ''
+                  macAddress: 44:65:7f:14:8f:60
+                  periodicInformInterval: 86400
+                  dataModelName: tr098
+                  timezoneOffset: -04:00
+                  ipAddress: 192.168.1.71
+                  changeCounter: 15
+                  opRole: Controller
+                  defaultGateway: 192.168.1.254
+                  subnetMask: 255.255.255.0
+                  opMode: RG
+                  wanAccessType: CopperEthernet
+                  stunEnabled: true
+                  udpConnectionRequestAddr: 99.111.154.74:60018
+                  lastInformTime: 2019-05-21T13:18:01.219Z
+                  createTime: 2019-04-08T20:55:53.295Z
+                  hardwareSerialNumber: '391809000281'
+              example:
+              - _id: 12837558-000631-CXNK001D9030
+                manufacturer: Calix
+                manufacturerOUI: '000631'
+                productClass: ENT
+                modelName: '844E-1'
+                hardwareVersion: '3000219601'
+                softwareVersion: 12.2.8.1.11
+                serialNumber: CXNK001D9030
+                registrationId: ''
+                macAddress: 00:06:31:ed:f7:b0
+                periodicInformInterval: 86400
+                dataModelName: tr098
+                timezoneOffset: -08:00
+                ipAddress: 192.168.92.2
+                changeCounter: 24
+                defaultGateway: 192.168.92.1
+                subnetMask: 255.255.255.0
+                wapGatewaySn: FTX133981PW
+                provRecordStatus: Succeeded
+                opMode: RG
+                wanAccessType: CopperEthernet
+                stunEnabled: true
+                udpConnectionRequestAddr: 99.111.154.74:30005
+                lastInformTime: 2019-04-17T05:40:38.904Z
+                createTime: 2019-03-20T13:36:00.657Z
+                hardwareSerialNumber: '261503000429'
+              - _id: 12837558-000631-CXNK001D9031
+                manufacturerOUI: '000631'
+                serialNumber: CXNK001D9031
+                createTime: 2019-04-09T16:04:36.630Z
+              - _id: 12837558-CCBE59-CXNK005763A3
+                manufacturer: Calix
+                manufacturerOUI: CCBE59
+                productClass: GigaSpire
+                modelName: GS2020E
+                hardwareVersion: '3000282601'
+                softwareVersion: 19.1.0.1.4
+                serialNumber: CXNK005763A3
+                registrationId: ''
+                macAddress: cc:be:59:fc:07:70
+                periodicInformInterval: 86400
+                dataModelName: tr098
+                timezoneOffset: -04:00
+                ipAddress: 192.168.10.191
+                changeCounter: 1
+                opRole: Controller
+                defaultGateway: 192.168.10.1
+                subnetMask: 255.255.255.0
+                opMode: RG
+                wanAccessType: CopperEthernet
+                stunEnabled: true
+                lastInformTime: 2019-05-20T18:13:01.371Z
+                createTime: 2019-05-10T18:53:59.776Z
+                hardwareSerialNumber: '391806000136'
+              - _id: 12837558-44657F-CXNK005A77A9
+                manufacturer: Calix
+                manufacturerOUI: 44657F
+                productClass: GigaSpire
+                modelName: GS2026E
+                hardwareVersion: '3000281011'
+                softwareVersion: 19.1.0.1.4
+                serialNumber: CXNK005A77A9
+                registrationId: ''
+                macAddress: 44:65:7f:14:8f:60
+                periodicInformInterval: 86400
+                dataModelName: tr098
+                timezoneOffset: -04:00
+                ipAddress: 192.168.1.71
+                changeCounter: 15
+                opRole: Controller
+                defaultGateway: 192.168.1.254
+                subnetMask: 255.255.255.0
+                opMode: RG
+                wanAccessType: CopperEthernet
+                stunEnabled: true
+                udpConnectionRequestAddr: 99.111.154.74:60018
+                lastInformTime: 2019-05-21T13:18:01.219Z
+                createTime: 2019-04-08T20:55:53.295Z
+                hardwareSerialNumber: '391809000281'
+      deprecated: false
+  /device/{deviceid}:
+    get:
+      tags:
+      - Device Data Management
+      summary: RetrieveDeviceByID
+      description: Retrieve a single device using its internal _id. Returns a JSON object describing the device.
+      operationId: RetrieveDeviceByID
+      parameters:
+      - name: deviceid
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '893'
+                  example: '893'
+          content:
+            application/json:
+              schema:
+                allOf:
+                - $ref: '#/components/schemas/RetrieveDeviceByID'
+                - example:
+                    _id: 12837558-000631-CXNK001D9030
+                    manufacturer: Calix
+                    manufacturerOUI: '000631'
+                    productClass: ENT
+                    modelName: '844E-1'
+                    hardwareVersion: '3000219601'
+                    softwareVersion: 12.2.8.1.11
+                    serialNumber: CXNK001D9030
+                    registrationId: ''
+                    macAddress: 00:06:31:ed:f7:b0
+                    periodicInformInterval: 86400
+                    dataModelName: tr098
+                    timezoneOffset: -08:00
+                    ipAddress: 192.168.92.2
+                    changeCounter: 24
+                    defaultGateway: 192.168.92.1
+                    subnetMask: 255.255.255.0
+                    wapGatewaySn: FTX133981PW
+                    provRecordStatus: Succeeded
+                    opMode: RG
+                    wanAccessType: CopperEthernet
+                    stunEnabled: true
+                    udpConnectionRequestAddr: 99.111.154.74:30005
+                    lastInformTime: 2019-04-17T05:40:38.904Z
+                    createTime: 2019-03-20T13:36:00.657Z
+                    hardwareSerialNumber: '261503000429'
+              example:
+                _id: 12837558-000631-CXNK001D9030
+                manufacturer: Calix
+                manufacturerOUI: '000631'
+                productClass: ENT
+                modelName: '844E-1'
+                hardwareVersion: '3000219601'
+                softwareVersion: 12.2.8.1.11
+                serialNumber: CXNK001D9030
+                registrationId: ''
+                macAddress: 00:06:31:ed:f7:b0
+                periodicInformInterval: 86400
+                dataModelName: tr098
+                timezoneOffset: -08:00
+                ipAddress: 192.168.92.2
+                changeCounter: 24
+                defaultGateway: 192.168.92.1
+                subnetMask: 255.255.255.0
+                wapGatewaySn: FTX133981PW
+                provRecordStatus: Succeeded
+                opMode: RG
+                wanAccessType: CopperEthernet
+                stunEnabled: true
+                udpConnectionRequestAddr: 99.111.154.74:30005
+                lastInformTime: 2019-04-17T05:40:38.904Z
+                createTime: 2019-03-20T13:36:00.657Z
+                hardwareSerialNumber: '261503000429'
+      deprecated: false
+    delete:
+      tags:
+      - Device Data Management
+      summary: DeleteDevice
+      description: Delete a single device using its internal _id. Returns only a status code for success/failure; no body.
+      operationId: DeleteDevice
+      parameters:
+      - name: deviceid
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '0'
+                  example: '0'
+          content: {}
+      deprecated: false
+  /subscriber:
+    post:
+      tags:
+      - Subscriber Management
+      summary: CreateSubscriber
+      description: >-
+        Create a new subscriber, using a valid subscriber JSON object which does not contain "createTime" or "_id".
+
+
+        Returns the _id value of the subscriber record if successful.
+      operationId: CreateSubscriber
+      parameters: []
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/CreateSubscriberRequest'
+              - example:
+                  customId: '67890'
+                  name: Test user
+                  locations:
+                  - address:
+                      streetLine1: 123 Oak St
+                      city: Anytown
+                      state: ZZ
+                      zip: '00000'
+                      country: USA
+                    contacts:
+                    - phone: 919-123-4567
+                      email: some@user.org
+                    devices:
+                    - CXNK00001234
+            example:
+              customId: '67890'
+              name: Test user
+              locations:
+              - address:
+                  streetLine1: 123 Oak St
+                  city: Anytown
+                  state: ZZ
+                  zip: '00000'
+                  country: USA
+                contacts:
+                - phone: 919-123-4567
+                  email: some@user.org
+                devices:
+                - CXNK00001234
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '36'
+                  example: '36'
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: 45600aa6-ee09-4c0d-98e3-9569bc908673
+              example: 45600aa6-ee09-4c0d-98e3-9569bc908673
+      deprecated: false
+    get:
+      tags:
+      - Subscriber Management
+      summary: RetrieveAllSubscribers
+      description: >-
+        Retrieve a list of all subscribers, returning a JSON array of subscriber JSON objects, each describing a subscriber.
+
+        There is no filtering nor limit/offset capability with this request.
+      operationId: RetrieveAllSubscribers
+      parameters: []
+      responses:
+        '200':
+          description: OK
+          headers:
+            Transfer-Encoding:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: chunked
+                  example: chunked
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/RetrieveAllSubscriber'
+                description: ''
+                example:
+                - _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+                  customId: '67890'
+                  name: Test user
+                  locations:
+                  - address:
+                      streetLine1: 123 Oak St
+                      city: Anytown
+                      state: ZZ
+                      zip: '00000'
+                      country: USA
+                    contacts:
+                    - phone: 919-123-4567
+                      email: some@user.org
+                    devices:
+                    - CXNK00001234
+              example:
+              - _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+                customId: '67890'
+                name: Test user
+                locations:
+                - address:
+                    streetLine1: 123 Oak St
+                    city: Anytown
+                    state: ZZ
+                    zip: '00000'
+                    country: USA
+                  contacts:
+                  - phone: 919-123-4567
+                    email: some@user.org
+                  devices:
+                  - CXNK00001234
+      deprecated: false
+    put:
+      tags:
+      - Subscriber Management
+      summary: UpdateSubscriberorreplaceassociatedsystem
+      description: >-
+        To update subscriber details, first retrieve the subscriber record, and then PUT the record back with your changes, and all other elements intact.
+
+
+        To use this to replace a system and maintain configuration, retrieve the record with the old system ID (in "devices"), and PUT the record back with the new system ID substituted. Do not delete and then add; if you do this in one transaction, Cloud understands that this is a system swap-out.
+      operationId: UpdateSubscriberorreplaceassociatedsystem
+      parameters: []
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/UpdateSubscriberorreplaceassociatedsystemRequest'
+              - example:
+                  customId: existingSubscriberLocationID
+                  name: Customer XYZ
+                  _id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+                  locations:
+                  - address: {}
+                    devices:
+                    - CXNKFF00FF00
+                    contacts:
+                    - phone: 312-555-1060
+                      email: me@nowhere.bad
+            example:
+              customId: existingSubscriberLocationID
+              name: Customer XYZ
+              _id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+              locations:
+              - address: {}
+                devices:
+                - CXNKFF00FF00
+                contacts:
+                - phone: 312-555-1060
+                  email: me@nowhere.bad
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '413'
+                  example: '413'
+          content:
+            application/json:
+              schema:
+                allOf:
+                - $ref: '#/components/schemas/RetrieveAllSubscriber'
+                - example:
+                    _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+                    customId: '67890'
+                    name: Test user
+                    locations:
+                    - address:
+                        streetLine1: 123 Oak St
+                        city: Anytown
+                        state: ZZ
+                        zip: '00000'
+                        country: USA
+                      contacts:
+                      - phone: 919-123-4567
+                        email: some@user.org
+                      devices:
+                      - CXNK00001234
+              example:
+                _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+                customId: '67890'
+                name: Test user
+                locations:
+                - address:
+                    streetLine1: 123 Oak St
+                    city: Anytown
+                    state: ZZ
+                    zip: '00000'
+                    country: USA
+                  contacts:
+                  - phone: 919-123-4567
+                    email: some@user.org
+                  devices:
+                  - CXNK00001234
+      deprecated: false
+  /subscriber/{_id}:
+    get:
+      tags:
+      - Subscriber Management
+      summary: RetrieveSubscriberbyInternalID
+      description: >-
+        Retrieve a single subscriber by specifying the internal _id. This value is created by Calix Support Cloud when the subscriber is created.
+
+        Returns a JSON object representing the Subscriber.
+      operationId: RetrieveSubscriberbyInternalID
+      parameters:
+      - name: _id
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '413'
+                  example: '413'
+          content:
+            application/json:
+              schema:
+                allOf:
+                - $ref: '#/components/schemas/RetrieveAllSubscriber'
+                - example:
+                    _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+                    customId: '67890'
+                    name: Test user
+                    locations:
+                    - address:
+                        streetLine1: 123 Oak St
+                        city: Anytown
+                        state: ZZ
+                        zip: '00000'
+                        country: USA
+                      contacts:
+                      - phone: 919-123-4567
+                        email: some@user.org
+                      devices:
+                      - CXNK00001234
+              example:
+                _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+                customId: '67890'
+                name: Test user
+                locations:
+                - address:
+                    streetLine1: 123 Oak St
+                    city: Anytown
+                    state: ZZ
+                    zip: '00000'
+                    country: USA
+                  contacts:
+                  - phone: 919-123-4567
+                    email: some@user.org
+                  devices:
+                  - CXNK00001234
+      deprecated: false
+    delete:
+      tags:
+      - Subscriber Management
+      summary: DeleteSubscriber
+      description: >-
+        Delete a single subscriber by specifying the internal _id. This value is created by Calix Support Cloud when the subscriber is created.
+
+
+        No return body.
+      operationId: DeleteSubscriber
+      parameters:
+      - name: _id
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '0'
+                  example: '0'
+          content: {}
+      deprecated: false
+  /provisioning-record:
+    post:
+      tags:
+      - Device Provisioning Record Management
+      summary: CreateProvisioningRecord
+      description: >-
+        Create a new Provisioning Record, using a valid Provisioning Record JSON objects, which does not contain "_id" or "createTime".
+
+
+        Returns the _id of the created record if successful.
+      operationId: CreateProvisioningRecord
+      parameters: []
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateProvisioningRecordRequest'
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '36'
+                  example: '36'
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: cdfc1c38-5836-4264-94d2-af0be7cf51bd
+              example: cdfc1c38-5836-4264-94d2-af0be7cf51bd
+      deprecated: false
+    get:
+      tags:
+      - Device Provisioning Record Management
+      summary: RetrieveAllProvisioningRecords
+      description: >-
+        Retrieve all Provisioning Records, returning a JSON array of Provisioning Record JSON objects, each describing a full configuration.
+
+
+        There is no filtering nor limit/offset capability with this request.
+      operationId: RetrieveAllProvisioningRecords
+      parameters: []
+      responses:
+        '200':
+          description: OK
+          headers:
+            Transfer-Encoding:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: chunked
+                  example: chunked
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Provisioningrecord'
+                description: ''
+      deprecated: false
+  /provisioning-record/{provisioning-record-id}:
+    get:
+      tags:
+      - Device Provisioning Record Management
+      summary: RetrieveProvisioningRecordbyInternalID
+      description: Retrieve a single Provisioning Record, using the internal ID of the record. Returns a single Provisioning Record JSON object describing a full configuration.
+      operationId: RetrieveProvisioningRecordbyInternalID
+      parameters:
+      - name: provisioning-record-id
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '2012'
+                  example: '2012'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RetrieveProvisioningRecordbyInternalID'
+      deprecated: false
+    delete:
+      tags:
+      - Device Provisioning Record Management
+      summary: DeleteProvisioningRecord
+      description: >-
+        Delete a single Provisioning Record, using the internal _id value.
+
+
+        Returns no body.
+      operationId: DeleteProvisioningRecord
+      parameters:
+      - name: provisioning-record-id
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '0'
+                  example: '0'
+          content: {}
+      deprecated: false
+  /provisioning-record/{prov_record_id}:
+    put:
+      tags:
+      - Device Provisioning Record Management
+      summary: ModifyProvisioningRecord
+      description: >-
+        Modify an existing provisioning record.
+
+        * You must specify the internal _id of the record to modify.
+
+        * When submitting changes, you must include the ENTIRE provisioning record, not just the changed section!
+
+
+        For example, when changing a Wi-Fi SSID on a device with voice service, you must first retrieve the entire Provisioning Record, modify the JSON with the new SSID value, and then submit the entire record to this API call.
+      operationId: ModifyProvisioningRecord
+      parameters:
+      - name: prov_record_id
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ModifyProvisioningRecordRequest'
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '0'
+                  example: '0'
+          content: {}
+      deprecated: false
+  /device-op:
+    post:
+      tags:
+      - TR-69 Device Operations
+      summary: GetParameterValues
+      description: >-
+        In addition to the operation and cpeIdentifier elements, the GetParameterValues contains an element "parameterNames" which is a JSON array of data model objects to retrieve.
+
+
+        The call returns a JSON array, expressing the sections of the device's data model as requested. See the example for details.
+
+
+
+        The call will trigger a Connection Request to the device, which times out after 15 seconds and 3 attempts.
+
+
+
+        If the request cannot be performed successfully, an appropriate HTTP status code (usually “408 Bad Request” or “408 Request Timeout”) will be returned with a detailed error message in the response body, for example:
+
+        ```
+
+        {
+            "error" : "No CPE found with filter {serialNumber:CXNK0020524}!"
+        }
+
+        ```
+
+        Or:
+
+        ```
+
+        {
+            "error" : "Received TR-069/CWMP Fault from Device: 9005 Invalid Parameter Name"
+        }
+
+        ```
+
+        Or:
+
+        ```
+
+        {
+            "error" : " Internal Server ERROR (Timed out waiting for reply)"
+        }
+
+        ```
+      operationId: GetParameterValues
+      parameters: []
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/GetParameterValuesRequest'
+              - example:
+                  operation: GetParameterValues
+                  cpeIdentifier:
+                    serialNumber: CXNK005A77A9
+                  parameterNames:
+                  - InternetGatewayDevice.DeviceInfo.UpTime
+            example:
+              operation: GetParameterValues
+              cpeIdentifier:
+                serialNumber: CXNK005A77A9
+              parameterNames:
+              - InternetGatewayDevice.DeviceInfo.UpTime
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '92'
+                  example: '92'
+          content:
+            application/json:
+              schema:
+                allOf:
+                - $ref: '#/components/schemas/GetParameterValues'
+                - example:
+                    InternetGatewayDevice:
+                      DeviceInfo:
+                        UpTime: '1350121'
+              example:
+                InternetGatewayDevice:
+                  DeviceInfo:
+                    UpTime: '1350121'
+      deprecated: false
+  /group:
+    get:
+      tags:
+      - Device Group Management
+      summary: RetrieveAllDeviceGroups
+      description: >-
+        Retrieves a list of all Device Groups.
+
+
+        Returns a JSON array of JSON objects, each describing a Device Group.
+      operationId: RetrieveAllDeviceGroups
+      parameters: []
+      responses:
+        '200':
+          description: OK
+          headers:
+            Transfer-Encoding:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: chunked
+                  example: chunked
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/RetrieveAllDeviceGroup'
+                description: ''
+                example:
+                - _id: 4a942d03-1b7c-4c7f-9771-b19f143907f5
+                  name: All 844E
+                  description: Dynamic group containing all Calix 844E devices
+                  type: dynamic
+                - _id: e66c8389-e62e-453e-ae84-9029783937b3
+                  name: 844E PPPoE
+                  description: Group for all PPPoE-provisioned devices
+                  type: static
+                  allowInheritance: true
+                - _id: 243d890b-9e41-473e-baa6-5196390ab062
+                  name: All GigaSpire Blast GS2020E
+                  description: ''
+                  type: dynamic
+                - _id: ded2dd56-0d74-4c54-969a-dad4e55b1e46
+                  name: All GigaSpire Max GS2026E
+                  description: ''
+                  type: dynamic
+                - _id: 9110ebfb-97d7-4f0f-8738-8a5b014a0a8a
+                  name: Lab Test GigaSpires
+                  description: Static group for all initial testing of new GigaSpire software
+                  type: static
+                  allowInheritance: true
+              example:
+              - _id: 4a942d03-1b7c-4c7f-9771-b19f143907f5
+                name: All 844E
+                description: Dynamic group containing all Calix 844E devices
+                type: dynamic
+              - _id: e66c8389-e62e-453e-ae84-9029783937b3
+                name: 844E PPPoE
+                description: Group for all PPPoE-provisioned devices
+                type: static
+                allowInheritance: true
+              - _id: 243d890b-9e41-473e-baa6-5196390ab062
+                name: All GigaSpire Blast GS2020E
+                description: ''
+                type: dynamic
+              - _id: ded2dd56-0d74-4c54-969a-dad4e55b1e46
+                name: All GigaSpire Max GS2026E
+                description: ''
+                type: dynamic
+              - _id: 9110ebfb-97d7-4f0f-8738-8a5b014a0a8a
+                name: Lab Test GigaSpires
+                description: Static group for all initial testing of new GigaSpire software
+                type: static
+                allowInheritance: true
+      deprecated: false
+  /group/{group-id}:
+    get:
+      tags:
+      - Device Group Management
+      summary: RetrieveDeviceGroupbyID
+      description: >-
+        Retrieves a single Device Group by its internal ID.
+
+
+        Returns a JSON object describing the Device Group.
+      operationId: RetrieveDeviceGroupbyID
+      parameters:
+      - name: group-id
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '159'
+                  example: '159'
+          content:
+            application/json:
+              schema:
+                allOf:
+                - $ref: '#/components/schemas/RetrieveGroupbyID'
+                - example:
+                    _id: 9110ebfb-97d7-4f0f-8738-8a5b014a0a8a
+                    name: Lab Test GigaSpires
+                    description: ''
+                    type: static
+                    allowInheritance: true
+              example:
+                _id: 9110ebfb-97d7-4f0f-8738-8a5b014a0a8a
+                name: Lab Test GigaSpires
+                description: ''
+                type: static
+                allowInheritance: true
+      deprecated: false
+  /static-group-member:
+    get:
+      tags:
+      - Device Group Management
+      summary: RetrieveAllStaticGroupMemberships
+      description: >-
+        Retrieve all Static Group Membership data.
+
+
+        Returns a JSON Array of Device Group Membership JSON Object records.
+      operationId: RetrieveAllStaticGroupMemberships
+      parameters: []
+      responses:
+        '200':
+          description: OK
+          headers:
+            Transfer-Encoding:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: chunked
+                  example: chunked
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/RetrieveAllStaticGroupMembership'
+                description: ''
+                example:
+                - _id: 6a747bc9-d2e6-4d99-82cd-25a84057e93e
+                  groupId: e66c8389-e62e-453e-ae84-9029783937b3
+                  type: FSAN
+                  memberInfo: CXNK001D9030
+                  orgId: '12837558'
+                  deviceRecordId: 12837558-000631-CXNK001D9030
+                  createTime: 2019-04-15T15:23:57.047Z
+              example:
+              - _id: 6a747bc9-d2e6-4d99-82cd-25a84057e93e
+                groupId: e66c8389-e62e-453e-ae84-9029783937b3
+                type: FSAN
+                memberInfo: CXNK001D9030
+                orgId: '12837558'
+                deviceRecordId: 12837558-000631-CXNK001D9030
+                createTime: 2019-04-15T15:23:57.047Z
+      deprecated: false
+    post:
+      tags:
+      - Device Group Management
+      summary: AddaDeviceorProvisioningRecordtoaStaticGroup
+      description: >-
+        Adds a specified device or provisioning record to a Static Group, by creating a JSON object describing the membership.
+
+
+        Returns the _id of the Device Group Membership record if successful.
+      operationId: AddaDeviceorProvisioningRecordtoaStaticGroup
+      parameters: []
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/AddaDeviceorProvisioningRecordtoaStaticGroupRequest'
+              - example:
+                  groupId: '{{groupId}}'
+                  type: FSAN
+                  memberInfo: '{{fsan}}'
+            example:
+              groupId: '{{groupId}}'
+              type: FSAN
+              memberInfo: '{{fsan}}'
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '36'
+                  example: '36'
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: d74d3aa2-bbb5-4af7-8365-3262ddddf0f5
+              example: d74d3aa2-bbb5-4af7-8365-3262ddddf0f5
+      deprecated: false
+    delete:
+      tags:
+      - Device Group Management
+      summary: RemoveadevicefromaStaticGroupbygroupIDanddevice
+      description: >-
+        Remove a device from a static group by specifying the group _id value and an identifier for the device (FSAN, serial number, Registration ID, or MAC address)
+
+
+        Returns a count of deleted records if successful, or an empty JSON array if no devices match.
+      operationId: RemoveadevicefromaStaticGroupbygroupIDanddevice
+      parameters:
+      - name: groupId
+        in: query
+        description: The _id value of the Static Group to remove the device from.
+        required: true
+        style: form
+        explode: true
+        schema:
+          type: string
+          example: '{{static-group-id}}'
+      - name: memberInfo
+        in: query
+        description: >-
+          One of: FSAN ID, Serial number, Registration ID, or MAC address.
+
+          Use any of these strings to select the device to remove.
+        required: true
+        style: form
+        explode: true
+        schema:
+          type: string
+          example: '{{device-data}}'
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '28'
+                  example: '28'
+          content:
+            application/json:
+              schema:
+                allOf:
+                - $ref: '#/components/schemas/RemoveadevicefromaStaticGroupbygroupIDanddevice'
+                - example:
+                    numberOfRecords: 1
+              example:
+                numberOfRecords: 1
+      deprecated: false
+  /static-group-member/{group-membership-id}:
+    get:
+      tags:
+      - Device Group Management
+      summary: RetrieveSingleStaticGroupMembershipRecord
+      description: >-
+        Retrieve a single Static Group Membership by internal ID.
+
+
+        Returns a Device Group Membership JSON Object record.
+      operationId: RetrieveSingleStaticGroupMembershipRecord
+      parameters:
+      - name: group-membership-id
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers:
+            Content-Length:
+              content:
+                text/plain:
+                  schema:
+                    type: string
+                    example: '281'
+                  example: '281'
+          content:
+            application/json:
+              schema:
+                allOf:
+                - $ref: '#/components/schemas/RetrieveAllStaticGroupMembership'
+                - example:
+                    _id: d74d3aa2-bbb5-4af7-8365-3262ddddf0f5
+                    groupId: e66c8389-e62e-453e-ae84-9029783937b3
+                    type: FSAN
+                    memberInfo: CXNK001D9031
+                    orgId: '12837558'
+                    deviceRecordId: 12837558-000631-CXNK001D9031
+                    createTime: 2019-05-22T15:39:07.329Z
+              example:
+                _id: d74d3aa2-bbb5-4af7-8365-3262ddddf0f5
+                groupId: e66c8389-e62e-453e-ae84-9029783937b3
+                type: FSAN
+                memberInfo: CXNK001D9031
+                orgId: '12837558'
+                deviceRecordId: 12837558-000631-CXNK001D9031
+                createTime: 2019-05-22T15:39:07.329Z
+      deprecated: false
+  /static-group-member/{membership-id}:
+    delete:
+      tags:
+      - Device Group Management
+      summary: RemoveadevicefromaStaticGroupbymembershipID
+      description: >-
+        Remove a device from a static group by specifying the Membership Record _id value.
+
+
+        Returns no body.
+      operationId: RemoveadevicefromaStaticGroupbymembershipID
+      parameters:
+      - name: membership-id
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+components:
+  schemas:
+    RetrieveAllDevice:
+      title: RetrieveAllDevice
+      required:
+      - _id
+      - manufacturerOUI
+      - serialNumber
+      - createTime
+      type: object
+      properties:
+        _id:
+          type: string
+        manufacturer:
+          type: string
+        manufacturerOUI:
+          type: string
+        productClass:
+          type: string
+        modelName:
+          type: string
+        hardwareVersion:
+          type: string
+        softwareVersion:
+          type: string
+        serialNumber:
+          type: string
+        registrationId:
+          type: string
+        macAddress:
+          type: string
+        periodicInformInterval:
+          type: integer
+          format: int32
+        dataModelName:
+          type: string
+        timezoneOffset:
+          type: string
+        ipAddress:
+          type: string
+        changeCounter:
+          type: integer
+          format: int32
+        defaultGateway:
+          type: string
+        subnetMask:
+          type: string
+        wapGatewaySn:
+          type: string
+        provRecordStatus:
+          type: string
+        opMode:
+          type: string
+        wanAccessType:
+          type: string
+        stunEnabled:
+          type: boolean
+        udpConnectionRequestAddr:
+          type: string
+        lastInformTime:
+          type: string
+        createTime:
+          type: string
+        hardwareSerialNumber:
+          type: string
+        opRole:
+          type: string
+      example:
+        _id: 12837558-000631-CXNK001D9030
+        manufacturer: Calix
+        manufacturerOUI: '000631'
+        productClass: ENT
+        modelName: '844E-1'
+        hardwareVersion: '3000219601'
+        softwareVersion: 12.2.8.1.11
+        serialNumber: CXNK001D9030
+        registrationId: ''
+        macAddress: 00:06:31:ed:f7:b0
+        periodicInformInterval: 86400
+        dataModelName: tr098
+        timezoneOffset: -08:00
+        ipAddress: 192.168.92.2
+        changeCounter: 24
+        defaultGateway: 192.168.92.1
+        subnetMask: 255.255.255.0
+        wapGatewaySn: FTX133981PW
+        provRecordStatus: Succeeded
+        opMode: RG
+        wanAccessType: CopperEthernet
+        stunEnabled: true
+        udpConnectionRequestAddr: 99.111.154.74:30005
+        lastInformTime: 2019-04-17T05:40:38.904Z
+        createTime: 2019-03-20T13:36:00.657Z
+        hardwareSerialNumber: '261503000429'
+    RetrieveDeviceByID:
+      title: RetrieveDeviceByID
+      required:
+      - _id
+      - manufacturer
+      - manufacturerOUI
+      - productClass
+      - modelName
+      - hardwareVersion
+      - softwareVersion
+      - serialNumber
+      - registrationId
+      - macAddress
+      - periodicInformInterval
+      - dataModelName
+      - timezoneOffset
+      - ipAddress
+      - changeCounter
+      - defaultGateway
+      - subnetMask
+      - wapGatewaySn
+      - provRecordStatus
+      - opMode
+      - wanAccessType
+      - stunEnabled
+      - udpConnectionRequestAddr
+      - lastInformTime
+      - createTime
+      - hardwareSerialNumber
+      type: object
+      properties:
+        _id:
+          type: string
+        manufacturer:
+          type: string
+        manufacturerOUI:
+          type: string
+        productClass:
+          type: string
+        modelName:
+          type: string
+        hardwareVersion:
+          type: string
+        softwareVersion:
+          type: string
+        serialNumber:
+          type: string
+        registrationId:
+          type: string
+        macAddress:
+          type: string
+        periodicInformInterval:
+          type: integer
+          format: int32
+        dataModelName:
+          type: string
+        timezoneOffset:
+          type: string
+        ipAddress:
+          type: string
+        changeCounter:
+          type: integer
+          format: int32
+        defaultGateway:
+          type: string
+        subnetMask:
+          type: string
+        wapGatewaySn:
+          type: string
+        provRecordStatus:
+          type: string
+        opMode:
+          type: string
+        wanAccessType:
+          type: string
+        stunEnabled:
+          type: boolean
+        udpConnectionRequestAddr:
+          type: string
+        lastInformTime:
+          type: string
+        createTime:
+          type: string
+        hardwareSerialNumber:
+          type: string
+      example:
+        _id: 12837558-000631-CXNK001D9030
+        manufacturer: Calix
+        manufacturerOUI: '000631'
+        productClass: ENT
+        modelName: '844E-1'
+        hardwareVersion: '3000219601'
+        softwareVersion: 12.2.8.1.11
+        serialNumber: CXNK001D9030
+        registrationId: ''
+        macAddress: 00:06:31:ed:f7:b0
+        periodicInformInterval: 86400
+        dataModelName: tr098
+        timezoneOffset: -08:00
+        ipAddress: 192.168.92.2
+        changeCounter: 24
+        defaultGateway: 192.168.92.1
+        subnetMask: 255.255.255.0
+        wapGatewaySn: FTX133981PW
+        provRecordStatus: Succeeded
+        opMode: RG
+        wanAccessType: CopperEthernet
+        stunEnabled: true
+        udpConnectionRequestAddr: 99.111.154.74:30005
+        lastInformTime: 2019-04-17T05:40:38.904Z
+        createTime: 2019-03-20T13:36:00.657Z
+        hardwareSerialNumber: '261503000429'
+    RetrieveDeviceBySerialNumber:
+      title: RetrieveDeviceBySerialNumber
+      required:
+      - _id
+      - manufacturer
+      - manufacturerOUI
+      - productClass
+      - modelName
+      - hardwareVersion
+      - softwareVersion
+      - serialNumber
+      - registrationId
+      - macAddress
+      - periodicInformInterval
+      - dataModelName
+      - timezoneOffset
+      - ipAddress
+      - changeCounter
+      - defaultGateway
+      - subnetMask
+      - wapGatewaySn
+      - provRecordStatus
+      - opMode
+      - wanAccessType
+      - stunEnabled
+      - udpConnectionRequestAddr
+      - lastInformTime
+      - createTime
+      - hardwareSerialNumber
+      type: object
+      properties:
+        _id:
+          type: string
+        manufacturer:
+          type: string
+        manufacturerOUI:
+          type: string
+        productClass:
+          type: string
+        modelName:
+          type: string
+        hardwareVersion:
+          type: string
+        softwareVersion:
+          type: string
+        serialNumber:
+          type: string
+        registrationId:
+          type: string
+        macAddress:
+          type: string
+        periodicInformInterval:
+          type: integer
+          format: int32
+        dataModelName:
+          type: string
+        timezoneOffset:
+          type: string
+        ipAddress:
+          type: string
+        changeCounter:
+          type: integer
+          format: int32
+        defaultGateway:
+          type: string
+        subnetMask:
+          type: string
+        wapGatewaySn:
+          type: string
+        provRecordStatus:
+          type: string
+        opMode:
+          type: string
+        wanAccessType:
+          type: string
+        stunEnabled:
+          type: boolean
+        udpConnectionRequestAddr:
+          type: string
+        lastInformTime:
+          type: string
+        createTime:
+          type: string
+        hardwareSerialNumber:
+          type: string
+      example:
+        _id: 12837558-000631-CXNK001D9030
+        manufacturer: Calix
+        manufacturerOUI: '000631'
+        productClass: ENT
+        modelName: '844E-1'
+        hardwareVersion: '3000219601'
+        softwareVersion: 12.2.8.1.11
+        serialNumber: CXNK001D9030
+        registrationId: ''
+        macAddress: 00:06:31:ed:f7:b0
+        periodicInformInterval: 86400
+        dataModelName: tr098
+        timezoneOffset: -08:00
+        ipAddress: 192.168.92.2
+        changeCounter: 24
+        defaultGateway: 192.168.92.1
+        subnetMask: 255.255.255.0
+        wapGatewaySn: FTX133981PW
+        provRecordStatus: Succeeded
+        opMode: RG
+        wanAccessType: CopperEthernet
+        stunEnabled: true
+        udpConnectionRequestAddr: 99.111.154.74:30005
+        lastInformTime: 2019-04-17T05:40:38.904Z
+        createTime: 2019-03-20T13:36:00.657Z
+        hardwareSerialNumber: '261503000429'
+    RetrieveDeviceByMACAddress:
+      title: RetrieveDeviceByMACAddress
+      required:
+      - _id
+      - manufacturer
+      - manufacturerOUI
+      - productClass
+      - modelName
+      - hardwareVersion
+      - softwareVersion
+      - serialNumber
+      - registrationId
+      - macAddress
+      - periodicInformInterval
+      - dataModelName
+      - timezoneOffset
+      - ipAddress
+      - changeCounter
+      - defaultGateway
+      - subnetMask
+      - wapGatewaySn
+      - provRecordStatus
+      - opMode
+      - wanAccessType
+      - stunEnabled
+      - udpConnectionRequestAddr
+      - lastInformTime
+      - createTime
+      - hardwareSerialNumber
+      type: object
+      properties:
+        _id:
+          type: string
+        manufacturer:
+          type: string
+        manufacturerOUI:
+          type: string
+        productClass:
+          type: string
+        modelName:
+          type: string
+        hardwareVersion:
+          type: string
+        softwareVersion:
+          type: string
+        serialNumber:
+          type: string
+        registrationId:
+          type: string
+        macAddress:
+          type: string
+        periodicInformInterval:
+          type: integer
+          format: int32
+        dataModelName:
+          type: string
+        timezoneOffset:
+          type: string
+        ipAddress:
+          type: string
+        changeCounter:
+          type: integer
+          format: int32
+        defaultGateway:
+          type: string
+        subnetMask:
+          type: string
+        wapGatewaySn:
+          type: string
+        provRecordStatus:
+          type: string
+        opMode:
+          type: string
+        wanAccessType:
+          type: string
+        stunEnabled:
+          type: boolean
+        udpConnectionRequestAddr:
+          type: string
+        lastInformTime:
+          type: string
+        createTime:
+          type: string
+        hardwareSerialNumber:
+          type: string
+      example:
+        _id: 12837558-000631-CXNK001D9030
+        manufacturer: Calix
+        manufacturerOUI: '000631'
+        productClass: ENT
+        modelName: '844E-1'
+        hardwareVersion: '3000219601'
+        softwareVersion: 12.2.8.1.11
+        serialNumber: CXNK001D9030
+        registrationId: ''
+        macAddress: 00:06:31:ed:f7:b0
+        periodicInformInterval: 86400
+        dataModelName: tr098
+        timezoneOffset: -08:00
+        ipAddress: 192.168.92.2
+        changeCounter: 24
+        defaultGateway: 192.168.92.1
+        subnetMask: 255.255.255.0
+        wapGatewaySn: FTX133981PW
+        provRecordStatus: Succeeded
+        opMode: RG
+        wanAccessType: CopperEthernet
+        stunEnabled: true
+        udpConnectionRequestAddr: 99.111.154.74:30005
+        lastInformTime: 2019-04-17T05:40:38.904Z
+        createTime: 2019-03-20T13:36:00.657Z
+        hardwareSerialNumber: '261503000429'
+    RetrieveDeviceByIPAddress:
+      title: RetrieveDeviceByIPAddress
+      required:
+      - _id
+      - manufacturer
+      - manufacturerOUI
+      - productClass
+      - modelName
+      - hardwareVersion
+      - softwareVersion
+      - serialNumber
+      - registrationId
+      - macAddress
+      - periodicInformInterval
+      - dataModelName
+      - timezoneOffset
+      - ipAddress
+      - changeCounter
+      - defaultGateway
+      - subnetMask
+      - wapGatewaySn
+      - provRecordStatus
+      - opMode
+      - wanAccessType
+      - stunEnabled
+      - udpConnectionRequestAddr
+      - lastInformTime
+      - createTime
+      - hardwareSerialNumber
+      type: object
+      properties:
+        _id:
+          type: string
+        manufacturer:
+          type: string
+        manufacturerOUI:
+          type: string
+        productClass:
+          type: string
+        modelName:
+          type: string
+        hardwareVersion:
+          type: string
+        softwareVersion:
+          type: string
+        serialNumber:
+          type: string
+        registrationId:
+          type: string
+        macAddress:
+          type: string
+        periodicInformInterval:
+          type: integer
+          format: int32
+        dataModelName:
+          type: string
+        timezoneOffset:
+          type: string
+        ipAddress:
+          type: string
+        changeCounter:
+          type: integer
+          format: int32
+        defaultGateway:
+          type: string
+        subnetMask:
+          type: string
+        wapGatewaySn:
+          type: string
+        provRecordStatus:
+          type: string
+        opMode:
+          type: string
+        wanAccessType:
+          type: string
+        stunEnabled:
+          type: boolean
+        udpConnectionRequestAddr:
+          type: string
+        lastInformTime:
+          type: string
+        createTime:
+          type: string
+        hardwareSerialNumber:
+          type: string
+      example:
+        _id: 12837558-000631-CXNK001D9030
+        manufacturer: Calix
+        manufacturerOUI: '000631'
+        productClass: ENT
+        modelName: '844E-1'
+        hardwareVersion: '3000219601'
+        softwareVersion: 12.2.8.1.11
+        serialNumber: CXNK001D9030
+        registrationId: ''
+        macAddress: 00:06:31:ed:f7:b0
+        periodicInformInterval: 86400
+        dataModelName: tr098
+        timezoneOffset: -08:00
+        ipAddress: 192.168.92.2
+        changeCounter: 24
+        defaultGateway: 192.168.92.1
+        subnetMask: 255.255.255.0
+        wapGatewaySn: FTX133981PW
+        provRecordStatus: Succeeded
+        opMode: RG
+        wanAccessType: CopperEthernet
+        stunEnabled: true
+        udpConnectionRequestAddr: 99.111.154.74:30005
+        lastInformTime: 2019-04-17T05:40:38.904Z
+        createTime: 2019-03-20T13:36:00.657Z
+        hardwareSerialNumber: '261503000429'
+    CreateSubscriberRequest:
+      title: CreateSubscriberRequest
+      required:
+      - customId
+      - name
+      - locations
+      type: object
+      properties:
+        customId:
+          type: string
+        name:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location'
+          description: ''
+      example:
+        customId: '67890'
+        name: Test user
+        locations:
+        - address:
+            streetLine1: 123 Oak St
+            city: Anytown
+            state: ZZ
+            zip: '00000'
+            country: USA
+          contacts:
+          - phone: 919-123-4567
+            email: some@user.org
+          devices:
+          - CXNK00001234
+    Location:
+      title: Location
+      required:
+      - address
+      - contacts
+      - devices
+      type: object
+      properties:
+        address:
+          allOf:
+          - $ref: '#/components/schemas/Address'
+          - example:
+              streetLine1: 123 Oak St
+              city: Anytown
+              state: ZZ
+              zip: '00000'
+              country: USA
+        contacts:
+          type: array
+          items:
+            $ref: '#/components/schemas/Contact'
+          description: ''
+        devices:
+          type: array
+          items:
+            type: string
+          description: ''
+      example:
+        address:
+          streetLine1: 123 Oak St
+          city: Anytown
+          state: ZZ
+          zip: '00000'
+          country: USA
+        contacts:
+        - phone: 919-123-4567
+          email: some@user.org
+        devices:
+        - CXNK00001234
+    Address:
+      title: Address
+      required:
+      - streetLine1
+      - city
+      - state
+      - zip
+      - country
+      type: object
+      properties:
+        streetLine1:
+          type: string
+        city:
+          type: string
+        state:
+          type: string
+        zip:
+          type: string
+        country:
+          type: string
+      example:
+        streetLine1: 123 Oak St
+        city: Anytown
+        state: ZZ
+        zip: '00000'
+        country: USA
+    Contact:
+      title: Contact
+      required:
+      - phone
+      - email
+      type: object
+      properties:
+        phone:
+          type: string
+        email:
+          type: string
+      example:
+        phone: 919-123-4567
+        email: some@user.org
+    RetrieveAllSubscriber:
+      title: RetrieveAllSubscriber
+      required:
+      - _id
+      - customId
+      - name
+      - locations
+      type: object
+      properties:
+        _id:
+          type: string
+        customId:
+          type: string
+        name:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location'
+          description: ''
+      example:
+        _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+        customId: '67890'
+        name: Test user
+        locations:
+        - address:
+            streetLine1: 123 Oak St
+            city: Anytown
+            state: ZZ
+            zip: '00000'
+            country: USA
+          contacts:
+          - phone: 919-123-4567
+            email: some@user.org
+          devices:
+          - CXNK00001234
+    RetrieveSubscriberbyInternalID:
+      title: RetrieveSubscriberbyInternalID
+      required:
+      - _id
+      - customId
+      - name
+      - locations
+      type: object
+      properties:
+        _id:
+          type: string
+        customId:
+          type: string
+        name:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location'
+          description: ''
+      example:
+        _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+        customId: '67890'
+        name: Test user
+        locations:
+        - address:
+            streetLine1: 123 Oak St
+            city: Anytown
+            state: ZZ
+            zip: '00000'
+            country: USA
+          contacts:
+          - phone: 919-123-4567
+            email: some@user.org
+          devices:
+          - CXNK00001234
+    RetrieveSubscriberbycustomIdSubscriberID:
+      title: RetrieveSubscriberbycustomIdSubscriberID
+      required:
+      - _id
+      - customId
+      - name
+      - locations
+      type: object
+      properties:
+        _id:
+          type: string
+        customId:
+          type: string
+        name:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location'
+          description: ''
+      example:
+        _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+        customId: '67890'
+        name: Test user
+        locations:
+        - address:
+            streetLine1: 123 Oak St
+            city: Anytown
+            state: ZZ
+            zip: '00000'
+            country: USA
+          contacts:
+          - phone: 919-123-4567
+            email: some@user.org
+          devices:
+          - CXNK00001234
+    RetrieveSubscriberbyName:
+      title: RetrieveSubscriberbyName
+      required:
+      - _id
+      - customId
+      - name
+      - locations
+      type: object
+      properties:
+        _id:
+          type: string
+        customId:
+          type: string
+        name:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location'
+          description: ''
+      example:
+        _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+        customId: '67890'
+        name: Test user
+        locations:
+        - address:
+            streetLine1: 123 Oak St
+            city: Anytown
+            state: ZZ
+            zip: '00000'
+            country: USA
+          contacts:
+          - phone: 919-123-4567
+            email: some@user.org
+          devices:
+          - CXNK00001234
+    RetrieveSubscribersbyPhoneNumber:
+      title: RetrieveSubscribersbyPhoneNumber
+      required:
+      - _id
+      - customId
+      - name
+      - locations
+      type: object
+      properties:
+        _id:
+          type: string
+        customId:
+          type: string
+        name:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location'
+          description: ''
+      example:
+        _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+        customId: '67890'
+        name: Test user
+        locations:
+        - address:
+            streetLine1: 123 Oak St
+            city: Anytown
+            state: ZZ
+            zip: '00000'
+            country: USA
+          contacts:
+          - phone: 919-123-4567
+            email: some@user.org
+          devices:
+          - CXNK00001234
+    RetrieveSubscriberbyEmailAddress:
+      title: RetrieveSubscriberbyEmailAddress
+      required:
+      - _id
+      - customId
+      - name
+      - locations
+      type: object
+      properties:
+        _id:
+          type: string
+        customId:
+          type: string
+        name:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location'
+          description: ''
+      example:
+        _id: 7317b27e-528f-4c40-83bc-6d8a46edd0a3
+        customId: '67890'
+        name: Test user
+        locations:
+        - address:
+            streetLine1: 123 Oak St
+            city: Anytown
+            state: ZZ
+            zip: '00000'
+            country: USA
+          contacts:
+          - phone: 919-123-4567
+            email: some@user.org
+          devices:
+          - CXNK00001234
+    UpdateSubscriberorreplaceassociatedsystemRequest:
+      title: UpdateSubscriberorreplaceassociatedsystemRequest
+      required:
+      - customId
+      - name
+      - _id
+      - locations
+      type: object
+      properties:
+        customId:
+          type: string
+        name:
+          type: string
+        _id:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location7'
+          description: ''
+      example:
+        customId: existingSubscriberLocationID
+        name: Customer XYZ
+        _id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+        locations:
+        - address: {}
+          devices:
+          - CXNKFF00FF00
+          contacts:
+          - phone: 312-555-1060
+            email: me@nowhere.bad
+    Location7:
+      title: Location7
+      required:
+      - address
+      - devices
+      - contacts
+      type: object
+      properties:
+        address:
+          type: object
+        devices:
+          type: array
+          items:
+            type: string
+          description: ''
+        contacts:
+          type: array
+          items:
+            $ref: '#/components/schemas/Contact'
+          description: ''
+      example:
+        address: {}
+        devices:
+        - CXNKFF00FF00
+        contacts:
+        - phone: 312-555-1060
+          email: me@nowhere.bad
+    CreateProvisioningRecordRequest:
+      title: CreateProvisioningRecordRequest
+      required:
+      - opMode
+      - deviceId
+      - subscriberId
+      - data
+      - video
+      - voice
+      - wifi
+      - modelName
+      type: object
+      properties:
+        opMode:
+          type: string
+        deviceId:
+          type: string
+        subscriberId:
+          type: string
+        data:
+          allOf:
+          - $ref: '#/components/schemas/Data'
+          - example:
+              Enable: true
+              pppoe:
+                Username: some@user.org
+                Password: my-ppp-password
+              VlanId: 888
+              Pbit: 0
+        video:
+          allOf:
+          - $ref: '#/components/schemas/Video'
+          - example:
+              Enable: true
+              VlanId: 999
+              Pbit: 4
+        voice:
+          $ref: '#/components/schemas/Voice'
+        wifi:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/generatedObject2'
+        modelName:
+          type: string
+    Data:
+      title: Data
+      required:
+      - Enable
+      - pppoe
+      - VlanId
+      - Pbit
+      type: object
+      properties:
+        Enable:
+          type: boolean
+        pppoe:
+          allOf:
+          - $ref: '#/components/schemas/Pppoe'
+          - example:
+              Username: some@user.org
+              Password: my-ppp-password
+        VlanId:
+          type: integer
+          format: int32
+        Pbit:
+          type: integer
+          format: int32
+      example:
+        Enable: true
+        pppoe:
+          Username: some@user.org
+          Password: my-ppp-password
+        VlanId: 888
+        Pbit: 0
+    Pppoe:
+      title: Pppoe
+      required:
+      - Username
+      - Password
+      type: object
+      properties:
+        Username:
+          type: string
+        Password:
+          type: string
+      example:
+        Username: some@user.org
+        Password: my-ppp-password
+    Video:
+      title: Video
+      required:
+      - Enable
+      - VlanId
+      - Pbit
+      type: object
+      properties:
+        Enable:
+          type: boolean
+        VlanId:
+          type: integer
+          format: int32
+        Pbit:
+          type: integer
+          format: int32
+      example:
+        Enable: true
+        VlanId: 999
+        Pbit: 4
+    Voice:
+      title: Voice
+      required:
+      - ServiceType
+      - FaxT38
+      - DialPlan
+      - X_CALIX_SXACC_RG_WAN
+      - Line
+      type: object
+      properties:
+        ServiceType:
+          type: string
+        FaxT38:
+          allOf:
+          - $ref: '#/components/schemas/FaxT38'
+          - example:
+              Enable: false
+        DialPlan:
+          type: string
+        X_CALIX_SXACC_RG_WAN:
+          allOf:
+          - $ref: '#/components/schemas/XCALIXSXACCRGWAN'
+          - example:
+              ServiceConnectionType: DHCP
+        Line:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/generatedObject'
+    FaxT38:
+      title: FaxT38
+      required:
+      - Enable
+      type: object
+      properties:
+        Enable:
+          type: boolean
+      example:
+        Enable: false
+    XCALIXSXACCRGWAN:
+      title: XCALIXSXACCRGWAN
+      required:
+      - ServiceConnectionType
+      type: object
+      properties:
+        ServiceConnectionType:
+          type: string
+      example:
+        ServiceConnectionType: DHCP
+    generatedObject:
+      title: generatedObject
+      required:
+      - Enable
+      - SIP
+      - CallingFeatures
+      - VoiceProcessing
+      type: object
+      properties:
+        Enable:
+          type: string
+        SIP:
+          allOf:
+          - $ref: '#/components/schemas/SIP'
+          - example:
+              AuthUserName: '9191234567'
+              AuthPassword: my-sip-password
+              URI: '9191234567'
+        CallingFeatures:
+          allOf:
+          - $ref: '#/components/schemas/CallingFeatures'
+          - example:
+              CallerIDEnable: true
+              CallWaitingEnable: true
+              X_000631_ThreewayCallingEnable: true
+              MWIEnable: true
+              X_000631_DirectConnectEnable: false
+              X_000631_DirectConnectNumber: ''
+              X_000631_DirectConnectTimer: 0
+        VoiceProcessing:
+          allOf:
+          - $ref: '#/components/schemas/VoiceProcessing'
+          - example:
+              ReceiveGain: -90
+              TransmitGain: -30
+      example:
+        Enable: Enabled
+        SIP:
+          AuthUserName: '9191234567'
+          AuthPassword: my-sip-password
+          URI: '9191234567'
+        CallingFeatures:
+          CallerIDEnable: true
+          CallWaitingEnable: true
+          X_000631_ThreewayCallingEnable: true
+          MWIEnable: true
+          X_000631_DirectConnectEnable: false
+          X_000631_DirectConnectNumber: ''
+          X_000631_DirectConnectTimer: 0
+        VoiceProcessing:
+          ReceiveGain: -90
+          TransmitGain: -30
+    SIP:
+      title: SIP
+      required:
+      - AuthUserName
+      - AuthPassword
+      - URI
+      type: object
+      properties:
+        AuthUserName:
+          type: string
+        AuthPassword:
+          type: string
+        URI:
+          type: string
+      example:
+        AuthUserName: '9191234567'
+        AuthPassword: my-sip-password
+        URI: '9191234567'
+    CallingFeatures:
+      title: CallingFeatures
+      required:
+      - CallerIDEnable
+      - CallWaitingEnable
+      - X_000631_ThreewayCallingEnable
+      - MWIEnable
+      - X_000631_DirectConnectEnable
+      - X_000631_DirectConnectNumber
+      - X_000631_DirectConnectTimer
+      type: object
+      properties:
+        CallerIDEnable:
+          type: boolean
+        CallWaitingEnable:
+          type: boolean
+        X_000631_ThreewayCallingEnable:
+          type: boolean
+        MWIEnable:
+          type: boolean
+        X_000631_DirectConnectEnable:
+          type: boolean
+        X_000631_DirectConnectNumber:
+          type: string
+        X_000631_DirectConnectTimer:
+          type: integer
+          format: int32
+      example:
+        CallerIDEnable: true
+        CallWaitingEnable: true
+        X_000631_ThreewayCallingEnable: true
+        MWIEnable: true
+        X_000631_DirectConnectEnable: false
+        X_000631_DirectConnectNumber: ''
+        X_000631_DirectConnectTimer: 0
+    VoiceProcessing:
+      title: VoiceProcessing
+      required:
+      - ReceiveGain
+      - TransmitGain
+      type: object
+      properties:
+        ReceiveGain:
+          type: integer
+          format: int32
+        TransmitGain:
+          type: integer
+          format: int32
+      example:
+        ReceiveGain: -90
+        TransmitGain: -30
+    generatedObject1:
+      title: generatedObject1
+      required:
+      - Enable
+      type: object
+      properties:
+        Enable:
+          type: string
+      example:
+        Enable: Disabled
+    generatedObject2:
+      title: generatedObject2
+      required:
+      - Enable
+      - SSID
+      - SSIDAdvertisementEnabled
+      - BeaconType
+      - IEEE11iEncryptionModes
+      - WPAEncryptionModes
+      - KeyPassphrase
+      - RadioEnabled
+      type: object
+      properties:
+        Enable:
+          type: boolean
+        SSID:
+          type: string
+        SSIDAdvertisementEnabled:
+          type: boolean
+        BeaconType:
+          type: string
+        IEEE11iEncryptionModes:
+          type: string
+        WPAEncryptionModes:
+          type: string
+        KeyPassphrase:
+          type: string
+        RadioEnabled:
+          type: boolean
+      example:
+        Enable: true
+        SSID: Test User Home
+        SSIDAdvertisementEnabled: true
+        BeaconType: WPAand11i
+        IEEE11iEncryptionModes: AESEncryption
+        WPAEncryptionModes: AESEncryption
+        KeyPassphrase: s3crets!!
+        RadioEnabled: true
+    Provisioningrecord:
+      title: Provisioningrecord
+      required:
+      - _id
+      - orgId
+      - opMode
+      - deviceId
+      - subscriberId
+      - data
+      - video
+      - voice
+      - wifi
+      - modelName
+      type: object
+      properties:
+        _id:
+          type: string
+        orgId:
+          type: string
+        opMode:
+          type: string
+        deviceId:
+          type: string
+        subscriberId:
+          type: string
+        data:
+          allOf:
+          - $ref: '#/components/schemas/Data'
+          - example:
+              Enable: true
+              pppoe:
+                Username: some@user.org
+                Password: my-ppp-password
+              VlanId: 888
+              Pbit: 0
+        video:
+          allOf:
+          - $ref: '#/components/schemas/Video'
+          - example:
+              Enable: true
+              VlanId: 999
+              Pbit: 4
+        voice:
+          $ref: '#/components/schemas/Voice1'
+        wifi:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/generatedObject6'
+        modelName:
+          type: string
+    Voice1:
+      title: Voice1
+      required:
+      - ServiceType
+      - FaxT38
+      - DialPlan
+      - Line
+      type: object
+      properties:
+        ServiceType:
+          type: string
+        FaxT38:
+          allOf:
+          - $ref: '#/components/schemas/FaxT38'
+          - example:
+              Enable: false
+        DialPlan:
+          type: string
+        Line:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/generatedObject'
+    generatedObject6:
+      title: generatedObject6
+      required:
+      - Enable
+      - SSID
+      - SSIDAdvertisementEnabled
+      - BeaconType
+      - IEEE11iEncryptionModes
+      - WPAEncryptionModes
+      - KeyPassphrase
+      type: object
+      properties:
+        Enable:
+          type: boolean
+        SSID:
+          type: string
+        SSIDAdvertisementEnabled:
+          type: boolean
+        BeaconType:
+          type: string
+        IEEE11iEncryptionModes:
+          type: string
+        WPAEncryptionModes:
+          type: string
+        KeyPassphrase:
+          type: string
+      example:
+        Enable: true
+        SSID: Test User Home
+        SSIDAdvertisementEnabled: true
+        BeaconType: WPAand11i
+        IEEE11iEncryptionModes: AESEncryption
+        WPAEncryptionModes: AESEncryption
+        KeyPassphrase: s3crets!!
+    RetrieveProvisioningRecordbyInternalID:
+      title: RetrieveProvisioningRecordbyInternalID
+      required:
+      - _id
+      - opMode
+      - deviceId
+      - subscriberId
+      - data
+      - video
+      - voice
+      - wifi
+      - modelName
+      - orgId
+      type: object
+      properties:
+        _id:
+          type: string
+        opMode:
+          type: string
+        deviceId:
+          type: string
+        subscriberId:
+          type: string
+        data:
+          allOf:
+          - $ref: '#/components/schemas/Data'
+          - example:
+              Enable: true
+              pppoe:
+                Username: some@user.org
+                Password: my-ppp-password
+              VlanId: 888
+              Pbit: 0
+        video:
+          allOf:
+          - $ref: '#/components/schemas/Video'
+          - example:
+              Enable: true
+              VlanId: 999
+              Pbit: 4
+        voice:
+          $ref: '#/components/schemas/Voice1'
+        wifi:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/generatedObject2'
+        modelName:
+          type: string
+        orgId:
+          type: string
+    RetrieveProvisioningRecordsbyDevice:
+      title: RetrieveProvisioningRecordsbyDevice
+      required:
+      - _id
+      - opMode
+      - deviceId
+      - subscriberId
+      - data
+      - video
+      - voice
+      - wifi
+      - modelName
+      - orgId
+      type: object
+      properties:
+        _id:
+          type: string
+        opMode:
+          type: string
+        deviceId:
+          type: string
+        subscriberId:
+          type: string
+        data:
+          allOf:
+          - $ref: '#/components/schemas/Data'
+          - example:
+              Enable: true
+              pppoe:
+                Username: some@user.org
+                Password: my-ppp-password
+              VlanId: 888
+              Pbit: 0
+        video:
+          allOf:
+          - $ref: '#/components/schemas/Video'
+          - example:
+              Enable: true
+              VlanId: 999
+              Pbit: 4
+        voice:
+          $ref: '#/components/schemas/Voice'
+        wifi:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/generatedObject2'
+        modelName:
+          type: string
+        orgId:
+          type: string
+    RetrieveProvisioningRecordsbySubscriber:
+      title: RetrieveProvisioningRecordsbySubscriber
+      required:
+      - _id
+      - opMode
+      - deviceId
+      - subscriberId
+      - data
+      - video
+      - voice
+      - wifi
+      - modelName
+      - orgId
+      type: object
+      properties:
+        _id:
+          type: string
+        opMode:
+          type: string
+        deviceId:
+          type: string
+        subscriberId:
+          type: string
+        data:
+          allOf:
+          - $ref: '#/components/schemas/Data'
+          - example:
+              Enable: true
+              pppoe:
+                Username: some@user.org
+                Password: my-ppp-password
+              VlanId: 888
+              Pbit: 0
+        video:
+          allOf:
+          - $ref: '#/components/schemas/Video'
+          - example:
+              Enable: true
+              VlanId: 999
+              Pbit: 4
+        voice:
+          $ref: '#/components/schemas/Voice'
+        wifi:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/generatedObject2'
+        modelName:
+          type: string
+        orgId:
+          type: string
+    ModifyProvisioningRecordRequest:
+      title: ModifyProvisioningRecordRequest
+      required:
+      - opMode
+      - deviceId
+      - subscriberId
+      - data
+      - video
+      - voice
+      - wifi
+      - modelName
+      type: object
+      properties:
+        opMode:
+          type: string
+        deviceId:
+          type: string
+        subscriberId:
+          type: string
+        data:
+          allOf:
+          - $ref: '#/components/schemas/Data'
+          - example:
+              Enable: true
+              pppoe:
+                Username: some@user.org
+                Password: my-ppp-password
+              VlanId: 888
+              Pbit: 0
+        video:
+          allOf:
+          - $ref: '#/components/schemas/Video'
+          - example:
+              Enable: true
+              VlanId: 999
+              Pbit: 4
+        voice:
+          $ref: '#/components/schemas/Voice1'
+        wifi:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/generatedObject2'
+        modelName:
+          type: string
+    GetParameterValuesRequest:
+      title: GetParameterValuesRequest
+      required:
+      - operation
+      - cpeIdentifier
+      - parameterNames
+      type: object
+      properties:
+        operation:
+          type: string
+        cpeIdentifier:
+          allOf:
+          - $ref: '#/components/schemas/CpeIdentifier'
+          - example:
+              serialNumber: CXNK005A77A9
+        parameterNames:
+          type: array
+          items:
+            type: string
+          description: ''
+      example:
+        operation: GetParameterValues
+        cpeIdentifier:
+          serialNumber: CXNK005A77A9
+        parameterNames:
+        - InternetGatewayDevice.DeviceInfo.UpTime
+    CpeIdentifier:
+      title: CpeIdentifier
+      required:
+      - serialNumber
+      type: object
+      properties:
+        serialNumber:
+          type: string
+      example:
+        serialNumber: CXNK005A77A9
+    GetParameterValues:
+      title: GetParameterValues
+      required:
+      - InternetGatewayDevice
+      type: object
+      properties:
+        InternetGatewayDevice:
+          allOf:
+          - $ref: '#/components/schemas/InternetGatewayDevice'
+          - example:
+              DeviceInfo:
+                UpTime: '1350121'
+      example:
+        InternetGatewayDevice:
+          DeviceInfo:
+            UpTime: '1350121'
+    InternetGatewayDevice:
+      title: InternetGatewayDevice
+      required:
+      - DeviceInfo
+      type: object
+      properties:
+        DeviceInfo:
+          allOf:
+          - $ref: '#/components/schemas/DeviceInfo'
+          - example:
+              UpTime: '1350121'
+      example:
+        DeviceInfo:
+          UpTime: '1350121'
+    DeviceInfo:
+      title: DeviceInfo
+      required:
+      - UpTime
+      type: object
+      properties:
+        UpTime:
+          type: string
+      example:
+        UpTime: '1350121'
+    SetParameterValuesRequest:
+      title: SetParameterValuesRequest
+      required:
+      - operation
+      - cpeIdentifier
+      - parameterValues
+      type: object
+      properties:
+        operation:
+          type: string
+        cpeIdentifier:
+          allOf:
+          - $ref: '#/components/schemas/CpeIdentifier'
+          - example:
+              serialNumber: CXNK005A77A9
+        parameterValues:
+          allOf:
+          - $ref: '#/components/schemas/ParameterValues'
+          - example:
+              InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.X_000631_OperatingChannelBandwidth: 40MHz
+      example:
+        operation: SetParameterValues
+        cpeIdentifier:
+          serialNumber: CXNK005A77A9
+        parameterValues:
+          InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.X_000631_OperatingChannelBandwidth: 40MHz
+    ParameterValues:
+      title: ParameterValues
+      required:
+      - InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.X_000631_OperatingChannelBandwidth
+      type: object
+      properties:
+        InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.X_000631_OperatingChannelBandwidth:
+          type: string
+      example:
+        InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.X_000631_OperatingChannelBandwidth: 40MHz
+    AddObjectRequest:
+      title: AddObjectRequest
+      required:
+      - operation
+      - cpeIdentifier
+      - objectName
+      type: object
+      properties:
+        operation:
+          type: string
+        cpeIdentifier:
+          allOf:
+          - $ref: '#/components/schemas/CpeIdentifier'
+          - example:
+              serialNumber: CXNK005A77A9
+        objectName:
+          type: string
+      example:
+        operation: AddObject
+        cpeIdentifier:
+          serialNumber: CXNK0020803A
+        objectName: InternetGatewayDevice.WANDevice.3.WANConnectionDevice.1.WANIPConnection.9.PortMapping.
+    AddObject-Success:
+      title: AddObject-Success
+      required:
+      - newObjectIndex
+      type: object
+      properties:
+        newObjectIndex:
+          type: integer
+          format: int32
+      example:
+        newObjectIndex: 118
+    DeleteObjectRequest:
+      title: DeleteObjectRequest
+      required:
+      - operation
+      - cpeIdentifier
+      - objectName
+      type: object
+      properties:
+        operation:
+          type: string
+        cpeIdentifier:
+          allOf:
+          - $ref: '#/components/schemas/CpeIdentifier'
+          - example:
+              serialNumber: CXNK005A77A9
+        objectName:
+          type: string
+      example:
+        operation: DeleteObject
+        cpeIdentifier:
+          serialNumber: CXNK0020803A
+        objectName: InternetGatewayDevice.WANDevice.3.WANConnectionDevice.1.WANIPConnection.9.PortMapping.117.
+    RebootRequest:
+      title: RebootRequest
+      required:
+      - operation
+      - cpeIdentifier
+      type: object
+      properties:
+        operation:
+          type: string
+        cpeIdentifier:
+          allOf:
+          - $ref: '#/components/schemas/CpeIdentifier'
+          - example:
+              serialNumber: CXNK005A77A9
+      example:
+        operation: Reboot
+        cpeIdentifier:
+          serialNumber: CXNK005A77A9
+    FactoryResetRequest:
+      title: FactoryResetRequest
+      required:
+      - operation
+      - cpeIdentifier
+      type: object
+      properties:
+        operation:
+          type: string
+        cpeIdentifier:
+          allOf:
+          - $ref: '#/components/schemas/CpeIdentifier'
+          - example:
+              serialNumber: CXNK005A77A9
+      example:
+        operation: FactoryReset
+        cpeIdentifier:
+          serialNumber: CXNK005A77AA
+    RetrieveAllDeviceGroup:
+      title: RetrieveAllDeviceGroup
+      required:
+      - _id
+      - name
+      - description
+      - type
+      type: object
+      properties:
+        _id:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        type:
+          type: string
+        allowInheritance:
+          type: boolean
+      example:
+        _id: 4a942d03-1b7c-4c7f-9771-b19f143907f5
+        name: All 844E
+        description: Dynamic group containing all Calix 844E devices
+        type: dynamic
+    RetrieveGroupbyID:
+      title: RetrieveGroupbyID
+      required:
+      - _id
+      - name
+      - description
+      - type
+      - allowInheritance
+      type: object
+      properties:
+        _id:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        type:
+          type: string
+        allowInheritance:
+          type: boolean
+      example:
+        _id: 9110ebfb-97d7-4f0f-8738-8a5b014a0a8a
+        name: Lab Test GigaSpires
+        description: ''
+        type: static
+        allowInheritance: true
+    RetrieveAllStaticGroupMembership:
+      title: RetrieveAllStaticGroupMembership
+      required:
+      - _id
+      - groupId
+      - type
+      - memberInfo
+      - orgId
+      - deviceRecordId
+      - createTime
+      type: object
+      properties:
+        _id:
+          type: string
+        groupId:
+          type: string
+        type:
+          type: string
+        memberInfo:
+          type: string
+        orgId:
+          type: string
+        deviceRecordId:
+          type: string
+        createTime:
+          type: string
+      example:
+        _id: 6a747bc9-d2e6-4d99-82cd-25a84057e93e
+        groupId: e66c8389-e62e-453e-ae84-9029783937b3
+        type: FSAN
+        memberInfo: CXNK001D9030
+        orgId: '12837558'
+        deviceRecordId: 12837558-000631-CXNK001D9030
+        createTime: 2019-04-15T15:23:57.047Z
+    RetrieveStaticGroupMembershipbyDevice:
+      title: RetrieveStaticGroupMembershipbyDevice
+      required:
+      - _id
+      - groupId
+      - type
+      - memberInfo
+      - orgId
+      - deviceRecordId
+      - createTime
+      type: object
+      properties:
+        _id:
+          type: string
+        groupId:
+          type: string
+        type:
+          type: string
+        memberInfo:
+          type: string
+        orgId:
+          type: string
+        deviceRecordId:
+          type: string
+        createTime:
+          type: string
+      example:
+        _id: 6a747bc9-d2e6-4d99-82cd-25a84057e93e
+        groupId: e66c8389-e62e-453e-ae84-9029783937b3
+        type: FSAN
+        memberInfo: CXNK001D9030
+        orgId: '12837558'
+        deviceRecordId: 12837558-000631-CXNK001D9030
+        createTime: 2019-04-15T15:23:57.047Z
+    RetrieveSingleStaticGroupMembership:
+      title: RetrieveSingleStaticGroupMembership
+      required:
+      - _id
+      - groupId
+      - type
+      - memberInfo
+      - orgId
+      - deviceRecordId
+      - createTime
+      type: object
+      properties:
+        _id:
+          type: string
+        groupId:
+          type: string
+        type:
+          type: string
+        memberInfo:
+          type: string
+        orgId:
+          type: string
+        deviceRecordId:
+          type: string
+        createTime:
+          type: string
+      example:
+        _id: d74d3aa2-bbb5-4af7-8365-3262ddddf0f5
+        groupId: e66c8389-e62e-453e-ae84-9029783937b3
+        type: FSAN
+        memberInfo: CXNK001D9031
+        orgId: '12837558'
+        deviceRecordId: 12837558-000631-CXNK001D9031
+        createTime: 2019-05-22T15:39:07.329Z
+    AddaDeviceorProvisioningRecordtoaStaticGroupRequest:
+      title: AddaDeviceorProvisioningRecordtoaStaticGroupRequest
+      required:
+      - groupId
+      - type
+      - memberInfo
+      type: object
+      properties:
+        groupId:
+          type: string
+        type:
+          type: string
+        memberInfo:
+          type: string
+      example:
+        groupId: '{{groupId}}'
+        type: FSAN
+        memberInfo: '{{fsan}}'
+    RemoveadevicefromaStaticGroupbygroupIDanddevice:
+      title: RemoveadevicefromaStaticGroupbygroupIDanddevice
+      required:
+      - numberOfRecords
+      type: object
+      properties:
+        numberOfRecords:
+          type: integer
+          format: int32
+      example:
+        numberOfRecords: 1
+  securitySchemes:
+    basic:
+      type: http
+      scheme: basic
+security:
+- basic: []
+tags:
+- name: Device Data Management
+  description: >-
+    The Device Management API allows you to view or delete entries for devices which have been discovered by the ACS.
+
+
+    Note that if you are pre-provisioning a device, you will not use this API to create it. To pre-provision:
+
+    * Create a Subscriber record, listing the device's identifier in the locations/devices object.
+
+    * Create a Provisioning Record with the appropriate services or settings.
+
+
+    The device record will then be created once the actual device performs its initial INFORM.
+
+
+    ## Device data model
+
+    The data model consists of these elements:
+
+
+    |Attribute Name |Type |Description |Read/write|
+
+    |---------------|-----|------------|----------|
+
+    |_id			|String|The internal ID string for this CPE device (auto generated by the ACS server).|
+
+    |manufacturer|String|The Manufacturer of the CPE, for example “Calix”.|Read-only|
+
+    |manufacturerOUI|String|Organizational unique identifier of the device manufacture, such as “000631” for Calix.|Read-only|
+
+    |productClass|String|Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the serial number is unique.|Read-only|
+
+    |serialNumber|String|CPE Serial Number, for example “CXNK00186F49”|Read/write|
+
+    |hardwareVersion|String|A string identifying the particular CPE model and version.|Read-only|
+
+    |softwareVersion|String|A string identifying the software version currently installed in the CPE.|Read-only|
+
+    |createTime|String|Date/Time (in ISO8601 format) when this device record was created in the system (either via this API or via auto discovery). This attribute is generated by the ACS server thus read-only to the API clients.|Read-only|
+- name: Subscriber Management
+  description: >
+    Subscriber records contain demographic data such as name, address, and account information, and allow association of devices to the subscriber in order to depict how the service is delivered.
+
+
+    Calix recommends creating one Subscriber record for each unique location where service is delivered. For example, if a single account holder has service at home and at a business, two distinct Subscriber records should be created, each associated only to the device(s) used to deliver service at the respective locations.
+
+
+    The subscriber record contains the following elements:
+
+
+    |Attribute Name		|Type	|Description|
+
+    |---------------|-------|-----------|
+
+    |_id			|String |The internal ID string for this CPE device (auto generated by the ACS server; read-only).|
+
+    |customId		|String	|A customer ID value that can uniquely identify this subscriber location, for example, a circuit ID, or the account number plus street address. This value is displayed in Calix Support Cloud as "Subscriber ID". If a creation or update request contains a “customId” value that is already being used by an existing subscriber record, the request will be rejected with HTTP status code “409 Conflict”.|
+
+    |type			|String	|Type of the subscriber, which must be either "Residential" or "Business"|
+
+    |name			|String	|The display name to be used for this subscriber location. This value can be repeated for multiple Subscriber records.|
+
+    |createTime		|String	|Date/Time (in ISO8601 format) when this subscriber record was created in the system. This attribute is generated by the ACS server thus read-only to the API clients.|
+
+    |locations		|JSON Array| A subscriber may have 0 or 1 location. As of May 2018, support for multiple locations is discontinued. The location is represented as a JSON object, with elements shown below.|
+
+
+    ## locations JSON object definition
+
+    |Element		|Type		|Description|
+
+    |---------------|-----------|-----------|
+
+    |devices		|JSON Array	| An array of strings, with each string in the array referring to a device installed (or to be installed) in this subscriber location. Allowed device identifiers are:<br><ul><li> The _id string of the device already defined in the system.</li><li>The FSAN Serial Number, or other serial number as reported in the TR-69 INFORM message</li><li>The Registration ID for Calix equipment</li><li>A hardware MAC address (as reported in the TR-69 INFORM). This address must contain six groups of two hexadecimal characters, separated by colons in canonical order, such as 00:06:31:00:11:22</li></ul>|
+
+    |address		|JSON Object| Physical address of this location, consisting of elements:<br><ul><li>streetLine1</li><li>streetLine2</li><li>city</li><li>state</li><li>zip</li><li>country</li></ul>|
+
+    |contacts		|JSON Array	| Calix Support Cloud will only use a single contact object, using elements:<br><ul><li>firstName</li><li>lastName</li><li>phone</li><li>email</li></ul>|
+- name: Device Provisioning Record Management
+  description: "Provisioning Records contain persistent configuration information related to a device associated to a subscriber. They can be used to pre-configure service parameters such as Wi-Fi settings, PPPoE credentials, and voice line settings.\n\nA provisioning record consists of the following elements:\n\n|Attribute Name		|Type		|Description|\n|-------------------|-----------|------|\n|_id				|String		|The internal ID of the associated CPE device, generated by the server (read-only).|\n|subscriberId		|String		|The _id value of the subscriber record associated with this device|\n|modelName			|String		|The device's model name, for example \"844G-1\" or \"GS2026E\"|\n|deviceId			|String		|As with the subscriber record, this ID can be one of:<br><ul><li> The _id string of the device already defined in the system.</li><li>The FSAN Serial Number, or other serial number as reported in the TR-69 INFORM message</li><li>The Registration ID for Calix equipment</li><li>A hardware MAC address (as reported in the TR-69 INFORM). This address must contain six groups of two hexadecimal characters, separated by colons in canonical order, such as 00:06:31:00:11:22</li></ul>|\n|opMode				|String		|The operational mode of the device, which must be one of:<br><table><tr><th>Mode</th><th>Description</th></tr><tr><td>RG</td><td>Residential Gateway</td></tr><tr><td>WAP-IGMP</td><td>Wireless Access Point<br>Applies only to 844E devices in extender mode</td></tr><tr><td>Modem</td><td>A DSL modem. Service provisioning is not allowed in this mode.</td></tr><tr><td>Managed ONT</td><td>Applies only to Calix Active Ethernet ONT 844GE. This is an advanced mode, and as such provisioning these devices must be done through the Calix Support Cloud GUI.</td></tr></table>|\n|data				|JSON Object|The data object contains configuration related to the WAN High-Speed Internet (HSI) service. Supported JSON elements are:<br><table><tr><th>Element</th><th>Type</th><th>Description</th></tr><tr><td>Enable</td><td>Boolean</td><td>State of the HSI service (true = enabled, false = disabled)</td></tr>|\n|video				|JSON Object|Contains a single Boolean element \"Enable\" to specify enabled/disabled state of video service.|\n|voice				|JSON Object|A JSON object defining voice service settings, which includes both top-level common attributes as well as per-line settings. Settings common to both lines include:<br><table><tr><th>Element</th><th>Type</th><th>Description</th></tr><tr><td>ServiceType</td><td>String</td><td>Voice protocol, one of:<br><ul><li>SIP</li><li>H.248</li><li>MGCP</li><li>X_000631_TDMGW (Calix TDM Gateway)</li></ul></td></tr><tr><td>FaxT38</td><td>JSON Object</td><td>A JSON object with boolean element \"Enable\" describing the use of T.38 Fax Relay (true = enabled, false = disabled)</td></tr><tr><td>DialPlan</td><td>String</td><td>The internal _id of a dial plan, or the string \"system-default\". Dial plans must be configured via the GUI, and only apply to SIP services.</td></tr></table>See the Voice Configuration Per-Line section below for a detailed description of per-line settings.|\n|wifi				|JSON Object|A JSON object defining Wi-Fi configuration. Each child represents a single SSID configuration. See the Wi-Fi Configuration Per-SSID section below for details.|\n\n## Wi-Fi Configuration Per-SSID\n\nWi-Fi configuration is done on a per-SSID basis, with the top-level element in the JSON object containing an integer index value. For Calix GigaCenter devices, SSID values 1-8 correspond to 2.4 GHz radio SSIDs, and 5-16 correspond to 5 GHz SSIDs. For other manufacturer devices, you will need to explore the device data model to determine the index values.\n\nThe following elements are supported beneath the top-level SSID index:\n\n|Element			|Type		|Description|\n|-------------------|-----------|------|\n|Enable				|Boolean	|Enable or disable service on the SSID|\n|SSID				|String		|The SSID value or Wi-Fi network name|\n|SSIDAdvertisementEnabled |Boolean |Determines whether the SSID should be broadcast (true) or hidden (false)|\n|KeyPassphrase		|String		|The Wi-Fi password, an ASCII value from which the keys are generated|\n|BeaconType			|String		|The beacon type used on this SSID. Possible values:<br><ul><li>None - No SSID present</li><li>Basic - WEP or no security</li><li>WPA - For WPA(v1)</li><li>11i - For WPA2</li><li>WPAand11i - For WPA/WPA2</li><li>BasicandWPAand11i - For WEP/WPA/WPA2</li></ul>|\n|BasicEncryptionModes|String	|Encryption mode to be used with Basic 802.11, must be either \"None\" (for no security) or \"WEPEncryption\" for WEP PSK|\n|BasicAuthenticationMode|String	|Authentication mode to be used with Basic 802.11, must be either \"None\"  or \"EAPAuthentication\" |\n|WPAEncryptionModes|String	|Encryption mode to be used with WPA, must be one of:<br><ul><li>AESEncryption</li><li>TKIPEncryption</li><li>TKIPandAESEncryption</li></ul><br><b>Note that on Calix GigaFamily devices' 5GHz radio, only AESEncryption is supported.</b>|\n|WPAAuthenticationMode|String	|Authentication mode to be used with WPA, must be either \"PSKAuthentication\"  or \"EAPAuthentication\" |\n|RadioEnabled		|Boolean	|Indicates whether or not the access point radio is enabled.<p>Please note that this attribute may not be applicable on all SSID instances. For example, this attribute is only applicable on SSID instance 1 and 9 for Calix GigaCenter/GigaHub devices, controlling the state of the 2.4GHz and 5GHz radios, respectively.|\n\n\n### Calix GigaFamily Examples\n#### WPA/WPA2 Personal\n\nCalix GigaCenter devices use WPA/WPA2-PSK as the default Wi-Fi security mode. To configure this mode, use a configuration such as:\n\n```\n    \"wifi\": {\n      \"1\": {\n        \"BeaconType\" : \"WPAand11i\", \n        \"WPAAuthenticationMode\" : \"PSKAuthentication\", \n        \"WPAEncryptionModes\" : \"TKIPandAESEncryption\", \n        \"IEEE11iAuthenticationMode\" : \"PSKAuthentication\", \n        \"IEEE11iEncryptionModes\" : \"TKIPandAESEncryption\", \n        \"BasicAuthenticationMode\" : \"None\", \n        \"BasicEncryptionModes\" : \"None\", \n        \"SSIDAdvertisementEnabled\": true,\n        \"Enable\": true,\n        \"SSID\": \"John Doe\",\n        \"KeyPassphrase\": \"calix123\",\n        \"RadioEnabled\": true\n    }, \n      \"9\": {\n            \"RadioEnabled\": false\n        }\n    }\n```\n\n#### WPA2 Personal\nTo enable only WPA2, the BeaconType parameter needs to be set to 11i, IEEE11iAuthenticationMode must be set to PSKAuthentication, and\nIEEE11iEncryptionModes must be set to AESEncryption. The below example configures the primary SSID\non both radios to WPA2-Personal with broadcasting enabled:\n```\n\"wifi\": {\n  \"1\": {\n    \"BeaconType\" : \"11i\",\n    \"IEEE11iAuthenticationMode\" : \"PSKAuthentication\",\n    \"IEEE11iEncryptionModes\" : \" AESEncryption\",\n    \"WPAAuthenticationMode\" : \"PSKAuthentication\",\n    \"WPAEncryptionModes\" : \"AESEncryption\",\n    \"BasicAuthenticationMode\" : \"None\",\n    \"BasicEncryptionModes\" : \"None\",\n    \"SSIDAdvertisementEnabled\": true,\n    \"Enable\": true,\n    \"SSID\": \"John Doe\",\n    \"KeyPassphrase\": \"calix123\",\n    \"RadioEnabled\": true\n  }, \n\"9\": {\n    \"BeaconType\" : \"11i\",\n    \"IEEE11iAuthenticationMode\" : \"PSKAuthentication\",\n    \"IEEE11iEncryptionModes\" : \" AESEncryption\",\n    \"WPAAuthenticationMode\" : \"PSKAuthentication\",\n    \"WPAEncryptionModes\" : \"AESEncryption\",\n    \"BasicAuthenticationMode\" : \"None\",\n    \"BasicEncryptionModes\" : \"None\",\n    \"SSIDAdvertisementEnabled\": true,\n    \"Enable\": true,\n    \"SSID\": \"John Doe\",\n    \"KeyPassphrase\": \"calix123\",\n    \"RadioEnabled\": true\n  }\n}\n```\n\n#### No Security\nTo enable an SSID with no security, such as a Guest network, use these parameters:\n* BeaconType = Basic\n* BasicAuthenticationMode = None\n* BasicEncryptionModes = None\n\nThis example sets up the designated guest network slot on the 2.4GHz radio.\n```\n\"wifi\": {\n  \"1\": {  <Primary SSID parameters here> },\n  \"2\": {\n    \"BeaconType\" : \"Basic\", \n    \"BasicAuthenticationMode\" : \"None\", \n    \"BasicEncryptionModes\" : \"None\", \n    \"SSIDAdvertisementEnabled\": true, \n    \"Enable\": true,\n    \"SSID\": \"John Doe\" \n  }, \n  \"9\": {\n    \"RadioEnabled\": false\n  }\n}\n```\n\n## Voice Configuration Per-Line\nThe per-line settings section in the voice object is contained in a \"Line\" object, with each line enumerated by its port number (ie \"1\" or \"2\" for a 2-port ONT).\n\nWithin each line index element, configuration details are specified as follows.\n\n### Common settings for all protocols\n|Element			|Type		|Description|\n|-------------------|-----------|------|\n|Enable				|String		|Administrative state of the voice line, \"Enabled\" or \"Disabled\".|\n|VoiceProcessing		|JSON Object		|Voice processing and loss plan setting:<br><table><tr><th>Element</th><th>Type</th><th>Description</th></tr><tr><td>ReceiveGain</td><td>Integer</td><td>Gain in 0.1 dB to apply to the received voice signal after decoding.<br>Must be in the range between -120 (-12dB) and 60 (6dB).</td></tr><tr><td>TransmitGain</td><td>Integer</td><td>Gain in 01.dB to apply to the transmitted voice signal prior to encoding.<br>Must be in the range between -120 (-12dB) and 60 (6dB).</td></tr></table><br>Reference loss plans:<br><table><tr><th>Loss Plan</th><th>RX Gain</th><th>TX Gain</th></tr><tr><td>GR-909</td><td>-40 (-4dB)</td><td>-20 (-2dB)</td></tr><tr><td>ANSI</td><td>-90 (-9dB)</td><td>-30 (-3dB)</td></tr><tr><td>ETSI-PSTN</td><td>-110 (-11dB)</td><td>-40 (-4dB)</td></tr></table>|\n\n\n### SIP Line settings\n|Element			|Type		|Description|\n|-------------------|-----------|------|\n|SIP				|JSON Object		|SIP settings for the line, with the following syntax:<br><table><tr><th>Element</th><th>Type</th><th>Description</th></tr><tr><td>AuthUserName</td><td>String</td><td>SIP Username</td></tr><tr><td>AuthPassword</td><td>String</td><td>SIP Password</td></tr><tr><td>URI</td><td>String</td><td>SIP URI</td></tr></table>|\n|CallingFeatures	|JSON Object		|Optional endpoint-based calling features. These are generally all enabled except for Direct Connect, and features are controlled from the softswitch. Syntax:<br><table><tr><th>Element</th><th>Type</th><th>Description</th></tr><tr><td>CallerIDEnable</td><td>Boolean</td><td>Enable/Disable Caller ID</td></tr><tr><td>CallWaitingEnable</td><td>Boolean</td><td>SIPEnable/Disable Call Waiting</td></tr><tr><td>X_000631_ThreewayCallingEnable</td><td>Boolean</td><td>Enable/Disable Three-Way Calling</td></tr><tr><td>MWIEnable</td><td>Boolean</td><td>Enable/disable Message Waiting Indicator</td></tr><tr><td>X_000631_DirectConnectEnable</td><td>Boolean</td><td>Enables/Disables direct connect such as hot/warm line feature.</td></tr><tr><td>X_000631_DirectConnectNumber</td><td>String</td><td>Stores the Hot/Warm line number to be used if the direct connect feature is enabled.<br>If “X_000631_DirectConnectEnable” is set to true, this field must contain a valid phone number.</td></tr><tr><td>X_000631_DirectConnectTimer</td><td>Integer</td><td>Direct connect timer in seconds, 0 indicates hotline, none-zero indicates warm line.<br>Valid Value Range: 0-35</td></tr></table>|\n\n### H.248 Line settings\n|Element			|Type		|Description|\n|-------------------|-----------|------|\n|X_000631_H248				|JSON Object		|H.248 settings for the line, with the following syntax:<br><table><tr><th>Element</th><th>Type</th><th>Description</th></tr><tr><td>TerminationId</td><td>String</td><td>H.248 Termination ID</td></tr></table>|\n\n### MGCP Line settings\n|Element			|Type		|Description|\n|-------------------|-----------|------|\n|MGCP				|JSON Object		|MGCP settings for the line, with the following syntax:<br><table><tr><th>Element</th><th>Type</th><th>Description</th></tr><tr><td>X_000631_GR303</td><td>Boolean</td><td>Enable/Disable GR303</td></tr></table>|\n\n### Calix TDM Gateway Line settings\n|Element			|Type		|Description|\n|-------------------|-----------|------|\n|X_000631_TdmGw				|JSON Object		|TDM Gateway settings for the line, with the following syntax:<br><table><tr><th>Element</th><th>Type</th><th>Description</th></tr><tr><td>Crv</td><td>String</td><td>Identify the line when using TDM gateway signaling.<br>For example “N1-1-IG1-1”</td></tr></table>|\n\n## Voice Provisioning Examples\n### SIP Provisioning Example\n```\n\"voice\": {\n    \"ServiceType\": \"SIP\",\n    \"FaxT38\": {\n        \"Enable\": true\n    },\n    \"DialPlan\": \"system-default\",\n    \"Line\": {\n        \"1\": {\n            \"Enable\": \"Enabled\",\n            \"SIP\": {\n                \"AuthUserName\": \"sip-user\",\n                \"AuthPassword\": \"sip-password\",\n                \"URI\": \"4001\"\n            },\n            \"CallingFeatures\": {\n                \"CallerIDEnable\": true,\n                 \"CallWaitingEnable\": true,\n                 \"X_000631_ThreewayCallingEnable\": true,\n                 \"MWIEnable\": true,\n                 \"X_000631_DirectConnectEnable\": true,\n                 \"X_000631_DirectConnectNumber\": \"7077663113\",\n                 \"X_000631_DirectConnectTimer\": 0\n            },\n            \"VoiceProcessing\": {\n                \"ReceiveGain\": -4,\n                \"TransmitGain\": -2\n            }\n        }, \n        \"2\": {\n            \"Enable\": \"Disabled\"\n        }\n    }\n}\n```\n\n### H.248 Provisioning Example\n```\n\"voice\": {\n    \"ServiceType\": \"H.248\",\n    \"Line\": {\n        \"1\": {\n            \"Enable\": \"Enabled\",\n            \"X_000631_H248\": {\n                \"TerminationId\": \"12345\"\n            },\n            \"VoiceProcessing\": {\n                \"ReceiveGain\": -4,\n                \"TransmitGain\": -2\n            }\n        },\n        \"2\": {\n            \"Enable\": \"Disabled\"\n		}\n	}\n}\n```\n\n### MGCP Provisioning Example\n```\n\"voice\": {\n    \"ServiceType\": \"MGCP\",\n    \"Line\": {\n            \"1\": {\n            \"Enable\": \"Enabled\",\n            \"MGCP\": {\n                \"X_000631_GR303\": true\n            },\n            \"VoiceProcessing\": {\n                \"ReceiveGain\": -4,\n                \"TransmitGain\": -2\n			} \n		},\n        \"2\": {\n            \"Enable\": \"Disabled\"\n		} \n	}\n}\n```\n\n### TDM Gateway Provisioning Example\n```\n\"voice\": {\n    \"ServiceType\": \"X_000631_TDMGW\",\n    \"Line\": {\n        \"1\": {\n            \"Enable\": \"Enabled\",\n            \"X_000631_TdmGw\": {\n                \"Crv\": \"N1-1-IG1-1\"\n            },\n            \"VoiceProcessing\": {\n                \"ReceiveGain\": -4,\n                \"TransmitGain\": -2\n			}\n        },\n        \"2\": {\n            \"Enable\": \"Disabled\"\n		}\n    }\n}\n```"
+- name: TR-69 Device Operations
+  description: >-
+    The TR-069 Device Operation API allows the users to perform various TR-069 operations (a.k.a. “TR-069 RPC Methods”) via the Calix Support Cloud Subscriber/Device API.
+
+
+    See [TR-069 Amendment 5](http://www.broadband-forum.org/technical/download/TR-069_Amendment-5.pdf) for more details on the TR-69 specification.
+
+
+    All Device operations contain a JSON Object specifying the operation details:
+
+
+    |Element			|Type		|Description|
+
+    |-------------------|-----------|-----------|
+
+    |Operation			|String		|One of:<br><ul><li>GetParameterValues</li><li>SetParameterValues</li><li>Reboot</li><li>FactoryReset</li></ul>|
+
+    |cpeIdentifier		|JSON Object	|A JSON object identifying the CPE device to perform the operation against. The object should contain one element to match against, with a value to match. Valid elements to match are:<br><ul><li>serialNumber</li><li>macAddress</li><li>registrationId</li></ul>For example:<br>{ "cpeIdentifier": { "serialNumber" : "CXNK00205240" }  }<br>{ "cpeIdentifier": { "macAddress" : "00:11:22:33:44:55" }  }|
+- name: Device Group Management
+  description: "Device groups are required when performing bulk operations via scheduled workflows, and when executing discovery workflows towards newly discovered devices.\n\n\nThe Device Group API allows the north bound clients to retrieve all or one of the existing device groups. \n\nMembership in groups by a device can be managed via the API, but device group creation and deletion must be done via the graphical user interface (i.e. browser) of Calix Support Cloud.\n\n## Device Group Data Model\nA device group record has the following structure:\n\n| Element		|Type		| Description|\n|---------------|-----------|------------|\n|_id			|String		|Internal identifer for the Device Group, generated by the server upon creation.|\n|name			|String		|The user-visible name of the device group, which must be unique.|\n|description	|String		|Descriptive text related to the device group|\n|type			|String		|Device group type, either \"dynamic\" or \"static\". Devices may only be manually added to static groups; dynamic groups contain rules describing the devices to match automatically.|\n\n## Device Group Membership\nA device or provisioning record's membership in a Static Device Group is described by a Static Group Membership record. The membership record has the structure:\n\n| Element		|Type		| Description|Writable|\n|---------------|-----------|------------|----|\n|_id			|String		|Internal identifer for the Membership Record, generated by the server upon creation.|No|\n|groupId		|String		|The internal _id value of the group to which this device belongs|Yes|\n|Type			|String		|A string describing which device element to bind the membership to. Possible values:<ul><li>FSAN - use the FSAN serial number</li><li>Serial Number - use the device serial number reported via TR-69 INFORM</li><li>Registration ID - use a Calix Registration ID</li><li>MAC Address - use the hardware MAC of the device as reported via TR-69 INFORM</li><li>Provisioning Record - use the _id of the Provisioning Record</li></ul>|Yes|\n|memberInfo		|String		|This string contains the actual value used to select the group member. The format of this value corresponds to the Type field. For example, if Type = FSAN, the memberInfo string should contain an FSAN serial number.|Yes|\n|createTime		|String		|Creation date/time of the Group Membership record|No|\n|subscriberId	|String		|For static group membership records of type \"Provisioning Record\", this value contains the internal _id string of a Subscriber Record that this provisioning record is associated with|No|\n|deviceRecordId	|String		|If the device specified by the “memberInfo” field has already been discovered by the system, this field contains the internal _id string of the device record.|No|"