Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/speakeasy-sdks/broadband-one-go

A Go SDK for accessing the Boradband One API.
https://github.com/speakeasy-sdks/broadband-one-go

Last synced: 2 days ago
JSON representation

A Go SDK for accessing the Boradband One API.

Host: GitHub
URL: https://github.com/speakeasy-sdks/broadband-one-go
Owner: speakeasy-sdks
License: mit
Created: 2023-08-29T07:35:08.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-04-02T21:44:56.000Z (7 months ago)
Last Synced: 2024-04-28T05:14:38.285Z (6 months ago)
Language: Makefile
Homepage:
Size: 135 KB
Stars: 0
Watchers: 5
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

Go SDK

Place orders for Broadband One from your systems to The Hub.

![bb1-diagram-h_0 (1)](https://github.com/speakeasy-sdks/broadband-one-go/assets/6267663/bfc886eb-2ab0-4c64-8423-ef6b3e7d21f7)

## SDK Installation

```bash
go get github.com/speakeasy-sdks/broadband-one-go
```

## SDK Example Usage

```go
package main

import(
"context"
"log"
"openapi"
"openapi/pkg/models/operations"
"openapi/pkg/models/shared"
)

func main() {
s := broadbandone.New()
operationSecurity := operations.CreateAppointmentSecurity{
OAuth2: "",
}

ctx := context.Background()
res, err := s.Appointments.Schedule(ctx, operations.CreateAppointmentRequest{
APIGWTrackingHeader: "96bb97fa-b941-46bb-8c4e-86c616c28a13",
PostAppointmentRequest: &shared.PostAppointmentRequest{
RelatedEntity: []shared.PostAppointmentRequestRelatedEntity{
shared.PostAppointmentRequestRelatedEntity{
AtBaseType: "RelatedEntity",
AtReferredType: "BTProductAppointmentSpecification",
AtType: "BTProductAppointmentSpecification",
AppointmentType: shared.PostAppointmentRequestRelatedEntityAppointmentTypeStandard.ToPointer(),
ID: "1234",
NewExchangeLine: broadbandone.Bool(false),
Product: shared.PostAppointmentRequestRelatedEntityProduct{
Characteristic: []shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
},
Place: []shared.PostAppointmentRequestRelatedEntityProductPlace{
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
},
ProductSpecification: shared.PostAppointmentRequestRelatedEntityProductProductSpecification{
ID: "Etherway Superfast GEA",
},
},
Role: "OrderInformation",
SimProvide: broadbandone.Bool(true),
SiteVisitReason: shared.PostAppointmentRequestRelatedEntitySiteVisitReasonStandard.ToPointer(),
},
shared.PostAppointmentRequestRelatedEntity{
AtBaseType: "RelatedEntity",
AtReferredType: "BTProductAppointmentSpecification",
AtType: "BTProductAppointmentSpecification",
AppointmentType: shared.PostAppointmentRequestRelatedEntityAppointmentTypeStandard.ToPointer(),
ID: "1234",
NewExchangeLine: broadbandone.Bool(false),
Product: shared.PostAppointmentRequestRelatedEntityProduct{
Characteristic: []shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
},
Place: []shared.PostAppointmentRequestRelatedEntityProductPlace{
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
},
ProductSpecification: shared.PostAppointmentRequestRelatedEntityProductProductSpecification{
ID: "Etherway Superfast GEA",
},
},
Role: "OrderInformation",
SimProvide: broadbandone.Bool(true),
SiteVisitReason: shared.PostAppointmentRequestRelatedEntitySiteVisitReasonStandard.ToPointer(),
},
shared.PostAppointmentRequestRelatedEntity{
AtBaseType: "RelatedEntity",
AtReferredType: "BTProductAppointmentSpecification",
AtType: "BTProductAppointmentSpecification",
AppointmentType: shared.PostAppointmentRequestRelatedEntityAppointmentTypeStandard.ToPointer(),
ID: "1234",
NewExchangeLine: broadbandone.Bool(false),
Product: shared.PostAppointmentRequestRelatedEntityProduct{
Characteristic: []shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
shared.PostAppointmentRequestRelatedEntityProductCharacteristic{
Name: shared.PostAppointmentRequestRelatedEntityProductCharacteristicNameAccessTechnology.ToPointer(),
Value: broadbandone.String("Generic Ethernet Access"),
},
},
Place: []shared.PostAppointmentRequestRelatedEntityProductPlace{
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
shared.PostAppointmentRequestRelatedEntityProductPlace{
AtReferredType: broadbandone.String("OpenreachAddress"),
ID: broadbandone.String("Z17090800001"),
Role: broadbandone.String("InstallationAddress"),
},
},
ProductSpecification: shared.PostAppointmentRequestRelatedEntityProductProductSpecification{
ID: "Etherway Superfast GEA",
},
},
Role: "OrderInformation",
SimProvide: broadbandone.Bool(true),
SiteVisitReason: shared.PostAppointmentRequestRelatedEntitySiteVisitReasonStandard.ToPointer(),
},
},
ValidFor: shared.PostAppointmentRequestValidFor{
EndDateTime: "2022-03-17T11:00:00Z",
StartDateTime: "2022-03-17T09:00:00Z",
},
},
ProductFamily: shared.ProductFamilyBb1Hub,
}, operationSecurity)
if err != nil {
log.Fatal(err)
}

if res.PostAppointmentResponse != nil {
// handle response
}
}
```

## Available Resources and Operations

### [Appointments](docs/sdks/appointments/README.md)

* [Schedule](docs/sdks/appointments/README.md#schedule) - Create appointment
* [Search](docs/sdks/appointments/README.md#search) - Appointment availability

### Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.

### Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)