{ "openapi": "3.1.0", "info": { "title": "Gigs Connect API", "description": "Manage sessions for Connect.", "contact": { "name": "Gigs Support", "email": "support@gigs.com" }, "version": "2026-01-29.319" }, "servers": [ { "url": "https://api.gigs.com", "description": "production" } ], "paths": { "/projects/{project}/connectSessions": { "parameters": [ { "name": "project", "in": "path", "description": "The unique identifier for the [project](https://developers.gigs.com/core/projects#the-project-resource).", "required": true, "schema": { "type": "string", "examples": [ "gigs" ] } } ], "post": { "tags": [ "Connect Sessions" ], "operationId": "ConnectSessionsCreate", "summary": "Create a connect session", "description": "Creates a new Connect Session for the given parameters.\n\nRelated guide: [Connect Sessions](https://developers.gigs.com/docs/connect/connect-sessions/about)\n\n\n\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "requestBody": { "description": "Optional and required parameters to be passed in the request body to create a new Connect Session.", "content": { "application/json": { "schema": { "type": "object", "properties": { "appearance": { "type": "object", "title": "Appearance", "properties": { "theme": { "type": "string", "enum": [ "light", "dark" ], "description": "The theme setting that will influence the visual appearance during the Connect Session.", "examples": [ "light" ] } }, "required": [] }, "callbackUrl": { "type": [ "string", "null" ], "format": "uri", "description": "The URL to which the user will be redirected after the Connect Session is completed.", "examples": [ "https://example.com" ] }, "intent": { "type": "object", "title": "IntentCreate", "properties": { "type": { "type": "string", "enum": [ "browseDataPackages", "cancelSubscription", "changeSubscription", "checkoutAddon", "checkoutNewSubscription", "completePorting", "confirmPayment", "evergreenRoaming", "manageDataPackages", "replaceSim", "requestSupport", "resumeSubscription", "updatePaymentMethod", "updateUserAddress", "updateUserFullName", "viewEsimInstallation", "viewSubscription", "viewSubscriptions" ], "description": "The type of intent." }, "browseDataPackages": { "type": "object", "properties": { "plan": { "type": "string", "description": "The unique identifier for the plan to browse data packages for.", "examples": [ "pln_0SNlurA049MEWV3V0q7gjQbM4EVo" ] } }, "required": [ "plan" ] }, "cancelSubscription": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to cancel.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "changeSubscription": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to modify.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "checkoutAddon": { "type": "object", "properties": { "addons": { "type": "array", "description": "List of unique identifiers for the add-ons to subscribe.", "items": { "type": "string", "examples": [ "add_0SNlurA049MEWV4VxLfwJc7PJtHc" ] } }, "subscription": { "type": "string", "description": "The unique identifier for the subscription to modify.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "addons", "subscription" ] }, "checkoutNewSubscription": { "type": "object", "properties": { "device": { "type": [ "string", "null" ], "description": "The unique identifier for the existing device to use.", "examples": [ "dev_0SNlurA049MEWV55CrA9qMvI2FVJ" ] }, "plan": { "type": [ "string", "null" ], "description": "The unique identifier for the plan to subscribe.", "examples": [ "pln_0SNlurA049MEWV3V0q7gjQbM4EVo" ] }, "sim": { "type": [ "string", "null" ], "description": "The unique identifier for the SIM to use.", "examples": [ "sim_0SNlurA049MEWV1BAAmWZULA4lf6" ] }, "imei": { "type": [ "string", "null" ], "pattern": "^[0-9]{15,16}$", "description": "The IMEI (international mobile equipment identity) of the corresponding device.", "examples": [ "492388841798923" ] }, "voucherCode": { "type": [ "string", "null" ], "description": "Applies a voucher code to the session. The voucher code is visible to the user in the payment step. It can be overwritten by defining a URL query parameter or by the user directly.", "examples": [ "PROMO10" ] } } }, "completePorting": { "type": "object", "properties": { "behavior": { "type": "object", "title": "Complete Porting: Behavior", "description": "Behavior flags that customize the Complete Porting flow in Connect.", "properties": { "hideIntroPage": { "type": "boolean", "description": "When true, skips the intro screen in the Complete Porting intent and navigates users directly to the first required step.", "examples": [ true ] }, "hideOutroPage": { "type": "boolean", "description": "When true, hides the outro screen after the Complete Porting intent is fullfilled and returns users immediately to the `callbackUrl` (if provided).", "examples": [ true ] } }, "required": [] }, "subscription": { "type": "string", "description": "The unique identifier for the subscription to complete porting.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "confirmPayment": { "type": "object", "properties": { "payment": { "type": "string", "description": "The unique identifier for the payment to be confirmed.", "examples": [ "pay_0SNlurA049MEWV2HRA0slWFuS8DV" ] } }, "required": [ "payment" ] }, "evergreenRoaming": { "type": "object", "properties": { "subscription": { "type": [ "string", "null" ], "description": "The unique identifier for the subscription.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] }, "entryPoint": { "type": [ "string", "null" ], "enum": [ "browseDataPackages", "viewEsimInstallation", "manageDataPackages" ], "description": "The entry point for the evergreen roaming flow.", "examples": [ "browseDataPackages" ] } } }, "manageDataPackages": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to manage data packages for.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "replaceSim": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to replace the SIM in.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "requestSupport": { "type": "object", "properties": { "subscription": { "type": [ "string", "null" ], "description": "The unique identifier for the subscription to request support for.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } } }, "resumeSubscription": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to resume.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "viewEsimInstallation": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to view eSIM installation.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] }, "entryPoint": { "type": [ "string", "null" ], "enum": [ "another-device", "manual" ], "description": "The entry point for the eSIM installation flow.", "examples": [ "manual" ] } }, "required": [ "subscription" ] }, "viewSubscription": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to view.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] } }, "required": [ "type" ] }, "user": { "type": [ "string", "null" ], "description": "The unique identifier of the user.", "examples": [ "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d" ] }, "userDetails": { "type": "object", "properties": { "birthday": { "type": [ "string", "null" ], "format": "date", "description": "The birthday of the user.", "examples": [ "2017-07-21" ] }, "email": { "type": "string", "format": "email", "description": "The primary verified email address of the user.", "examples": [ "jerry@example.com" ] }, "fullName": { "type": [ "string", "null" ], "description": "The user's full name. Some plans require the user name to be present when creating a subscription. Check the plan requirements for that.", "examples": [ "Jerry Seinfeld" ] }, "metadata": { "type": "object", "title": "Metadata", "description": "A set of key-value pairs, to store [metadata](https://developers.gigs.com/docs/core/metadata) related to the resource.", "additionalProperties": { "type": [ "string", "null" ], "maxLength": 255 } }, "preferredLocale": { "type": [ "string", "null" ], "description": "The user's locale preference represented as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). It defaults to the project's preferred locale.", "examples": [ "en-US" ] } }, "required": [ "email" ] } }, "required": [ "intent" ] }, "examples": { "Example": { "summary": "Example", "value": { "appearance": { "theme": "light" }, "callbackUrl": "https://example.com", "intent": { "type": "browseDataPackages", "browseDataPackages": { "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo" } }, "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d", "userDetails": { "birthday": "2017-07-21", "email": "jerry@example.com", "fullName": "Jerry Seinfeld", "metadata": {}, "preferredLocale": "en-US" } } } } } }, "required": true }, "responses": { "201": { "description": "Returns the newly created Connect Session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectSession" }, "examples": { "Example": { "summary": "Example", "value": { "object": "connectSession", "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6", "appearance": { "theme": "light" }, "callbackUrl": "https://example.com", "intent": { "browseDataPackages": { "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo" }, "type": "browseDataPackages" }, "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp", "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d" } } } } } }, "403": { "$ref": "#/components/responses/permissionDenied" }, "422": { "$ref": "#/components/responses/unprocessableEntity" } } } }, "/projects/{project}/connectSessions/{connectSessionId}": { "parameters": [ { "name": "project", "in": "path", "description": "The unique identifier for the [project](https://developers.gigs.com/core/projects#the-project-resource).", "required": true, "schema": { "type": "string", "examples": [ "gigs" ] } }, { "name": "connectSessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "tags": [ "Connect Sessions" ], "operationId": "ConnectSessionsRetrieve", "summary": "Retrieve a connect session", "description": "Retrieves the details of an existing Connect Session.\n\n\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "responses": { "200": { "description": "Returns the Connect Session if it exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectSession" }, "examples": { "Example": { "summary": "Example", "value": { "object": "connectSession", "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6", "appearance": { "theme": "light" }, "callbackUrl": "https://example.com", "intent": { "browseDataPackages": { "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo" }, "type": "browseDataPackages" }, "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp", "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d" } } } } } }, "403": { "$ref": "#/components/responses/permissionDenied" }, "404": { "$ref": "#/components/responses/notFound" } } }, "patch": { "tags": [ "Connect Sessions" ], "operationId": "ConnectSessionsUpdate", "summary": "Update a connect session", "description": "Updates the Connect Session with the given parameters.\n\nThe `user` or `userDetails` attributes can only be set when the session is not associated with a user yet.\n\nRelated guide: [Connect Sessions](https://developers.gigs.com/docs/connect/connect-sessions/about)\n\n\n\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "requestBody": { "description": "The Connect Session parameters to update.", "content": { "application/json": { "schema": { "type": "object", "properties": { "appearance": { "type": "object", "title": "Appearance", "properties": { "theme": { "type": "string", "enum": [ "light", "dark" ], "description": "The theme setting that will influence the visual appearance during the Connect Session.", "examples": [ "light" ] } }, "required": [] }, "callbackUrl": { "type": [ "string", "null" ], "description": "The URL to which the user will be redirected after the Connect Session is completed.", "examples": [ "https://example.com" ] }, "user": { "type": [ "string", "null" ], "description": "The unique identifier of the user.", "examples": [ "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d" ] }, "userDetails": { "type": "object", "properties": { "birthday": { "type": [ "string", "null" ], "format": "date", "description": "The birthday of the user.", "examples": [ "2017-07-21" ] }, "email": { "type": "string", "format": "email", "description": "The primary verified email address of the user.", "examples": [ "jerry@example.com" ] }, "fullName": { "type": [ "string", "null" ], "description": "The user's full name. Some plans require the user name to be present when creating a subscription. Check the plan requirements for that.", "examples": [ "Jerry Seinfeld" ] }, "metadata": { "type": "object", "title": "Metadata", "description": "A set of key-value pairs, to store [metadata](https://developers.gigs.com/docs/core/metadata) related to the resource.", "additionalProperties": { "type": [ "string", "null" ], "maxLength": 255 } }, "preferredLocale": { "type": [ "string", "null" ], "description": "The user's locale preference represented as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). It defaults to the project's preferred locale.", "examples": [ "en-US" ] } }, "required": [ "email" ] } } }, "examples": { "Example - Full": { "summary": "Example - Full", "value": { "appearance": { "theme": "light" }, "callbackUrl": "https://example.com", "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d", "userDetails": { "birthday": "2017-07-21", "email": "jerry@example.com", "fullName": "Jerry Seinfeld", "metadata": {}, "preferredLocale": "en-US" } } }, "Example - Required": { "summary": "Example - Required", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Returns the updated Connect Session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectSession" }, "examples": { "Example": { "summary": "Example", "value": { "object": "connectSession", "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6", "appearance": { "theme": "light" }, "callbackUrl": "https://example.com", "intent": { "browseDataPackages": { "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo" }, "type": "browseDataPackages" }, "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp", "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d" } } } } } }, "403": { "$ref": "#/components/responses/permissionDenied" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" } } } } }, "components": { "schemas": { "connectSession": { "type": "object", "title": "ConnectSession", "properties": { "object": { "type": "string", "const": "connectSession", "description": "Type of object is always `connectSession`." }, "id": { "type": "string", "description": "Unique identifier for the Connect Session.", "examples": [ "csn_0SNlurA049MEWV1GWxpaE5D0t2D6" ] }, "appearance": { "type": "object", "title": "Appearance", "properties": { "theme": { "type": "string", "enum": [ "light", "dark" ], "description": "The theme setting that will influence the visual appearance during the Connect Session.", "examples": [ "light" ] } }, "required": [] }, "callbackUrl": { "type": [ "string", "null" ], "description": "The URL to which the user will be redirected after the Connect Session is completed.", "examples": [ "https://example.com" ] }, "intent": { "type": "object", "title": "Intent", "properties": { "browseDataPackages": { "type": "object", "properties": { "plan": { "type": "string", "description": "The unique identifier for the plan to browse data packages for.", "examples": [ "pln_0SNlurA049MEWV3V0q7gjQbM4EVo" ] } }, "required": [ "plan" ] }, "cancelSubscription": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to cancel.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "changeSubscription": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to modify.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "checkoutAddon": { "type": "object", "properties": { "addons": { "type": "array", "description": "List of unique identifiers for the add-ons to subscribe.", "items": { "type": "string", "examples": [ "add_0SNlurA049MEWV4VxLfwJc7PJtHc" ] } }, "subscription": { "type": "string", "description": "The unique identifier for the subscription to modify.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "addons", "subscription" ] }, "checkoutNewSubscription": { "type": "object", "properties": { "device": { "type": [ "string", "null" ], "description": "The unique identifier for the existing device to use.", "examples": [ "dev_0SNlurA049MEWV55CrA9qMvI2FVJ" ] }, "plan": { "type": [ "string", "null" ], "description": "The unique identifier for the plan to subscribe.", "examples": [ "pln_0SNlurA049MEWV3V0q7gjQbM4EVo" ] }, "sim": { "type": [ "string", "null" ], "description": "The unique identifier for the SIM to use.", "examples": [ "sim_0SNlurA049MEWV1BAAmWZULA4lf6" ] }, "imei": { "type": [ "string", "null" ], "pattern": "^[0-9]{15,16}$", "description": "The IMEI (international mobile equipment identity) of the corresponding device.", "examples": [ "492388841798923" ] }, "voucherCode": { "type": [ "string", "null" ], "description": "Applies a voucher code to the session. The voucher code is visible to the user in the payment step. It can be overwritten by defining a URL query parameter or by the user directly.", "examples": [ "PROMO10" ] } } }, "completePorting": { "type": "object", "properties": { "behavior": { "type": "object", "title": "Complete Porting: Behavior", "description": "Behavior flags that customize the Complete Porting flow in Connect.", "properties": { "hideIntroPage": { "type": "boolean", "description": "When true, skips the intro screen in the Complete Porting intent and navigates users directly to the first required step.", "examples": [ true ] }, "hideOutroPage": { "type": "boolean", "description": "When true, hides the outro screen after the Complete Porting intent is fullfilled and returns users immediately to the `callbackUrl` (if provided).", "examples": [ true ] } }, "required": [] }, "subscription": { "type": "string", "description": "The unique identifier for the subscription to complete porting.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "behavior", "subscription" ] }, "confirmPayment": { "type": "object", "properties": { "payment": { "type": "string", "description": "The unique identifier for the payment to be confirmed.", "examples": [ "pay_0SNlurA049MEWV2HRA0slWFuS8DV" ] } }, "required": [ "payment" ] }, "evergreenRoaming": { "type": "object", "properties": { "subscription": { "type": [ "string", "null" ], "description": "The unique identifier for the subscription.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] }, "entryPoint": { "type": [ "string", "null" ], "enum": [ "browseDataPackages", "viewEsimInstallation", "manageDataPackages" ], "description": "The entry point for the evergreen roaming flow.", "examples": [ "browseDataPackages" ] } } }, "manageDataPackages": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to manage data packages for.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "replaceSim": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to replace the SIM in.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "requestSupport": { "type": "object", "properties": { "subscription": { "type": [ "string", "null" ], "description": "The unique identifier for the subscription to request support for.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } } }, "resumeSubscription": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to resume.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] }, "type": { "type": "string", "enum": [ "browseDataPackages", "cancelSubscription", "changeSubscription", "checkoutAddon", "checkoutNewSubscription", "completePorting", "confirmPayment", "evergreenRoaming", "manageDataPackages", "replaceSim", "requestSupport", "resumeSubscription", "updatePaymentMethod", "updateUserAddress", "updateUserFullName", "viewEsimInstallation", "viewSubscription", "viewSubscriptions" ], "description": "The type of intent." }, "viewEsimInstallation": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to view eSIM installation.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] }, "entryPoint": { "type": [ "string", "null" ], "enum": [ "another-device", "manual" ], "description": "The entry point for the eSIM installation flow.", "examples": [ "manual" ] } }, "required": [ "subscription" ] }, "viewSubscription": { "type": "object", "properties": { "subscription": { "type": "string", "description": "The unique identifier for the subscription to view.", "examples": [ "sub_0SNlurA049MEWV2gSfSxi00xlPIi" ] } }, "required": [ "subscription" ] } }, "required": [ "type" ] }, "url": { "type": [ "string", "null" ], "description": "The session URL. Redirect your users to this URL to take them to Connect. It is only present on all create responses or in the update responses that associate the session with a user. It should not be stored, logged or exposed to anyone other than the user.", "examples": [ "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp" ] }, "user": { "type": [ "string", "null" ], "description": "The unique identifier of the user that the session is for.", "examples": [ "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d" ] } }, "required": [ "object", "id", "appearance", "callbackUrl", "intent", "url", "user" ] } }, "responses": { "badRequest": { "description": "The request has incorrect syntax, such as an unparseable JSON body.", "content": { "application/json": { "schema": { "type": "object", "title": "Error", "properties": { "object": { "type": "string", "const": "error", "description": "Type of object is always `error`." }, "code": { "type": "string", "description": "An optional machine-readable description of the error. Present for errors that could be handled programmatically.", "examples": [ "unknown" ] }, "details": { "type": "array", "description": "Optional array containing specific information for the current error.\n\n\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "items": { "type": "object", "title": "PropertyErrorDetail", "properties": { "object": { "type": "string", "const": "propertyErrorDetail", "description": "Type of object is always `propertyErrorDetail`." }, "code": { "type": "string", "description": "A machine-readable description of the error.", "examples": [ "propertyRequired" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid value for property." ] }, "property": { "type": "string", "description": "Name of the property associated with the error.", "examples": [ "property1" ] }, "suggestion": { "type": [ "string", "null" ], "description": "Suggested alternative value for the field.", "examples": [ "alternative_value" ] } }, "required": [ "object", "code", "message", "property", "suggestion" ] } }, "documentation": { "type": "array", "description": "An optional list of URLs providing further information to resolve the error.", "items": { "type": "string", "examples": [ "https://developers.gigs.com/api/error-handling" ] } }, "hint": { "type": "string", "description": "An optional explanation how to resolve the error.", "examples": [ "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid ICCID format." ] }, "type": { "type": "string", "description": "The type of [error](https://developers.gigs.com/api/error-handling) returned.", "examples": [ "invalid" ] } }, "required": [ "object", "message", "type" ] }, "examples": { "Example - Full": { "summary": "Example - Full", "value": { "object": "error", "code": "unknown", "details": [ { "object": "propertyErrorDetail", "code": "propertyRequired", "message": "Invalid value for property.", "property": "property1", "suggestion": "alternative_value" } ], "documentation": [ "https://developers.gigs.com/api/error-handling" ], "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i", "message": "Invalid ICCID format.", "type": "invalid" } }, "Example - Required": { "summary": "Example - Required", "value": { "object": "error", "message": "Invalid ICCID format.", "type": "invalid" } } } } } }, "notFound": { "description": "The requested resource doesn't exist.", "content": { "application/json": { "schema": { "type": "object", "title": "Error", "properties": { "object": { "type": "string", "const": "error", "description": "Type of object is always `error`." }, "code": { "type": "string", "description": "An optional machine-readable description of the error. Present for errors that could be handled programmatically.", "examples": [ "unknown" ] }, "details": { "type": "array", "description": "Optional array containing specific information for the current error.\n\n\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "items": { "type": "object", "title": "PropertyErrorDetail", "properties": { "object": { "type": "string", "const": "propertyErrorDetail", "description": "Type of object is always `propertyErrorDetail`." }, "code": { "type": "string", "description": "A machine-readable description of the error.", "examples": [ "propertyRequired" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid value for property." ] }, "property": { "type": "string", "description": "Name of the property associated with the error.", "examples": [ "property1" ] }, "suggestion": { "type": [ "string", "null" ], "description": "Suggested alternative value for the field.", "examples": [ "alternative_value" ] } }, "required": [ "object", "code", "message", "property", "suggestion" ] } }, "documentation": { "type": "array", "description": "An optional list of URLs providing further information to resolve the error.", "items": { "type": "string", "examples": [ "https://developers.gigs.com/api/error-handling" ] } }, "hint": { "type": "string", "description": "An optional explanation how to resolve the error.", "examples": [ "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid ICCID format." ] }, "type": { "type": "string", "description": "The type of [error](https://developers.gigs.com/api/error-handling) returned.", "examples": [ "invalid" ] } }, "required": [ "object", "message", "type" ] }, "examples": { "Example - Full": { "summary": "Example - Full", "value": { "object": "error", "code": "unknown", "details": [ { "object": "propertyErrorDetail", "code": "propertyRequired", "message": "Invalid value for property.", "property": "property1", "suggestion": "alternative_value" } ], "documentation": [ "https://developers.gigs.com/api/error-handling" ], "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i", "message": "Invalid ICCID format.", "type": "invalid" } }, "Example - Required": { "summary": "Example - Required", "value": { "object": "error", "message": "Invalid ICCID format.", "type": "invalid" } } } } } }, "permissionDenied": { "description": "The authenticated user doesn't have permissions to perform the request.", "content": { "application/json": { "schema": { "type": "object", "title": "Error", "properties": { "object": { "type": "string", "const": "error", "description": "Type of object is always `error`." }, "code": { "type": "string", "description": "An optional machine-readable description of the error. Present for errors that could be handled programmatically.", "examples": [ "unknown" ] }, "details": { "type": "array", "description": "Optional array containing specific information for the current error.\n\n\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "items": { "type": "object", "title": "PropertyErrorDetail", "properties": { "object": { "type": "string", "const": "propertyErrorDetail", "description": "Type of object is always `propertyErrorDetail`." }, "code": { "type": "string", "description": "A machine-readable description of the error.", "examples": [ "propertyRequired" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid value for property." ] }, "property": { "type": "string", "description": "Name of the property associated with the error.", "examples": [ "property1" ] }, "suggestion": { "type": [ "string", "null" ], "description": "Suggested alternative value for the field.", "examples": [ "alternative_value" ] } }, "required": [ "object", "code", "message", "property", "suggestion" ] } }, "documentation": { "type": "array", "description": "An optional list of URLs providing further information to resolve the error.", "items": { "type": "string", "examples": [ "https://developers.gigs.com/api/error-handling" ] } }, "hint": { "type": "string", "description": "An optional explanation how to resolve the error.", "examples": [ "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid ICCID format." ] }, "type": { "type": "string", "description": "The type of [error](https://developers.gigs.com/api/error-handling) returned.", "examples": [ "invalid" ] } }, "required": [ "object", "message", "type" ] }, "examples": { "Example - Full": { "summary": "Example - Full", "value": { "object": "error", "code": "unknown", "details": [ { "object": "propertyErrorDetail", "code": "propertyRequired", "message": "Invalid value for property.", "property": "property1", "suggestion": "alternative_value" } ], "documentation": [ "https://developers.gigs.com/api/error-handling" ], "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i", "message": "Invalid ICCID format.", "type": "invalid" } }, "Example - Required": { "summary": "Example - Required", "value": { "object": "error", "message": "Invalid ICCID format.", "type": "invalid" } } } } } }, "conflict": { "description": "The request conflicts with another request.", "content": { "application/json": { "schema": { "type": "object", "title": "Error", "properties": { "object": { "type": "string", "const": "error", "description": "Type of object is always `error`." }, "code": { "type": "string", "description": "An optional machine-readable description of the error. Present for errors that could be handled programmatically.", "examples": [ "unknown" ] }, "details": { "type": "array", "description": "Optional array containing specific information for the current error.\n\n\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "items": { "type": "object", "title": "PropertyErrorDetail", "properties": { "object": { "type": "string", "const": "propertyErrorDetail", "description": "Type of object is always `propertyErrorDetail`." }, "code": { "type": "string", "description": "A machine-readable description of the error.", "examples": [ "propertyRequired" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid value for property." ] }, "property": { "type": "string", "description": "Name of the property associated with the error.", "examples": [ "property1" ] }, "suggestion": { "type": [ "string", "null" ], "description": "Suggested alternative value for the field.", "examples": [ "alternative_value" ] } }, "required": [ "object", "code", "message", "property", "suggestion" ] } }, "documentation": { "type": "array", "description": "An optional list of URLs providing further information to resolve the error.", "items": { "type": "string", "examples": [ "https://developers.gigs.com/api/error-handling" ] } }, "hint": { "type": "string", "description": "An optional explanation how to resolve the error.", "examples": [ "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid ICCID format." ] }, "type": { "type": "string", "description": "The type of [error](https://developers.gigs.com/api/error-handling) returned.", "examples": [ "invalid" ] } }, "required": [ "object", "message", "type" ] }, "examples": { "Example - Full": { "summary": "Example - Full", "value": { "object": "error", "code": "unknown", "details": [ { "object": "propertyErrorDetail", "code": "propertyRequired", "message": "Invalid value for property.", "property": "property1", "suggestion": "alternative_value" } ], "documentation": [ "https://developers.gigs.com/api/error-handling" ], "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i", "message": "Invalid ICCID format.", "type": "invalid" } }, "Example - Required": { "summary": "Example - Required", "value": { "object": "error", "message": "Invalid ICCID format.", "type": "invalid" } } } } } }, "unprocessableEntity": { "description": "The request can't be processed, often due to an invalid parameter or incompatible system state.", "content": { "application/json": { "schema": { "type": "object", "title": "Error", "properties": { "object": { "type": "string", "const": "error", "description": "Type of object is always `error`." }, "code": { "type": "string", "description": "An optional machine-readable description of the error. Present for errors that could be handled programmatically.", "examples": [ "unknown" ] }, "details": { "type": "array", "description": "Optional array containing specific information for the current error.\n\n\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "items": { "type": "object", "title": "PropertyErrorDetail", "properties": { "object": { "type": "string", "const": "propertyErrorDetail", "description": "Type of object is always `propertyErrorDetail`." }, "code": { "type": "string", "description": "A machine-readable description of the error.", "examples": [ "propertyRequired" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid value for property." ] }, "property": { "type": "string", "description": "Name of the property associated with the error.", "examples": [ "property1" ] }, "suggestion": { "type": [ "string", "null" ], "description": "Suggested alternative value for the field.", "examples": [ "alternative_value" ] } }, "required": [ "object", "code", "message", "property", "suggestion" ] } }, "documentation": { "type": "array", "description": "An optional list of URLs providing further information to resolve the error.", "items": { "type": "string", "examples": [ "https://developers.gigs.com/api/error-handling" ] } }, "hint": { "type": "string", "description": "An optional explanation how to resolve the error.", "examples": [ "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid ICCID format." ] }, "type": { "type": "string", "description": "The type of [error](https://developers.gigs.com/api/error-handling) returned.", "examples": [ "invalid" ] } }, "required": [ "object", "message", "type" ] }, "examples": { "Example - Full": { "summary": "Example - Full", "value": { "object": "error", "code": "unknown", "details": [ { "object": "propertyErrorDetail", "code": "propertyRequired", "message": "Invalid value for property.", "property": "property1", "suggestion": "alternative_value" } ], "documentation": [ "https://developers.gigs.com/api/error-handling" ], "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i", "message": "Invalid ICCID format.", "type": "invalid" } }, "Example - Required": { "summary": "Example - Required", "value": { "object": "error", "message": "Invalid ICCID format.", "type": "invalid" } } } } } }, "notImplemented": { "description": "The type of request is not supported.", "content": { "application/json": { "schema": { "type": "object", "title": "Error", "properties": { "object": { "type": "string", "const": "error", "description": "Type of object is always `error`." }, "code": { "type": "string", "description": "An optional machine-readable description of the error. Present for errors that could be handled programmatically.", "examples": [ "unknown" ] }, "details": { "type": "array", "description": "Optional array containing specific information for the current error.\n\n\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n", "items": { "type": "object", "title": "PropertyErrorDetail", "properties": { "object": { "type": "string", "const": "propertyErrorDetail", "description": "Type of object is always `propertyErrorDetail`." }, "code": { "type": "string", "description": "A machine-readable description of the error.", "examples": [ "propertyRequired" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid value for property." ] }, "property": { "type": "string", "description": "Name of the property associated with the error.", "examples": [ "property1" ] }, "suggestion": { "type": [ "string", "null" ], "description": "Suggested alternative value for the field.", "examples": [ "alternative_value" ] } }, "required": [ "object", "code", "message", "property", "suggestion" ] } }, "documentation": { "type": "array", "description": "An optional list of URLs providing further information to resolve the error.", "items": { "type": "string", "examples": [ "https://developers.gigs.com/api/error-handling" ] } }, "hint": { "type": "string", "description": "An optional explanation how to resolve the error.", "examples": [ "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i" ] }, "message": { "type": "string", "description": "A human readable description of the error.", "examples": [ "Invalid ICCID format." ] }, "type": { "type": "string", "description": "The type of [error](https://developers.gigs.com/api/error-handling) returned.", "examples": [ "invalid" ] } }, "required": [ "object", "message", "type" ] }, "examples": { "Example - Full": { "summary": "Example - Full", "value": { "object": "error", "code": "unknown", "details": [ { "object": "propertyErrorDetail", "code": "propertyRequired", "message": "Invalid value for property.", "property": "property1", "suggestion": "alternative_value" } ], "documentation": [ "https://developers.gigs.com/api/error-handling" ], "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i", "message": "Invalid ICCID format.", "type": "invalid" } }, "Example - Required": { "summary": "Example - Required", "value": { "object": "error", "message": "Invalid ICCID format.", "type": "invalid" } } } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Connect Sessions", "description": "Operations to manage Connect sessions." } ] }