/
model_single_workspace_200_response.go
127 lines (101 loc) · 9.05 KB
/
model_single_workspace_200_response.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
Postman API
The Postman API lets you to programmatically access data stored in Postman account with ease. ## Getting started The easiest way to get started with the Postman API is to [fork this collection](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) to your own workspace. You can then use Postman to send requests. ## Overview 1. You must use a valid API Key to send requests to the API endpoints. You can get your API key from Postman's [integrations dashboard](https://go.postman.co/settings/me/api-keys). 1. The API has access rate limits. 1. The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP `301` redirect to the corresponding HTTPS resources. 1. The API returns requests responses in [JSON format](https://en.wikipedia.org/wiki/JSON). When an API request returns an error, it is sent in the JSON response as an `\"error\": {}` key. 1. The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman, and `POST` implies you want to save something new to Postman. 1. API calls respond with the appropriate [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for all requests. Within the Postman client, when a response is received, the status code is highlighted and is accompanied by a help text that indicates the possible meaning of the response code. A `200 OK` indicates success, while an HTTP `4XX` or HTTP `5XX` response code indicates an error from the requesting client or our API servers, respectively. 1. Individual resources in your Postman account are accessible using its unique ID (`uid`) value. The `uid` is a simple concatenation of the resource owner's user ID and the resource's ID. For example, a collection's `uid` is `{{owner_id}}-{{collection_id}}` value. ## ID and UID All items in Postman, such as collections, mocks, workspaces, and APIs, have ID and UIDs: - An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`. - The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID: - `12345678` is the user's ID. - `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID. ## Authentication An API key is required to be sent as part of every request to the Postman API, in the form of an `X-Api-Key` request header. To get a Postman API key, you can generate one in the [**API keys**](https://postman.postman.co/settings/me/api-keys) section in your Postman account settings. An API key tells the API server that the received request from you. Everything that you have access to in Postman is accessible with your API key. For ease of use in Postman, you can store your API key as the `postman_api_key` [environment variable](https://www.getpostman.com/docs/environments). The Postman API [collection](https://www.getpostman.com/docs/collections) will automatically use it to make API calls. ### API Key related error response If an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code and the following JSON response: ```json { \"error\": { \"name\": \"AuthenticationError\", \"message\": \"Invalid API Key. Every request requires a valid API Key to be sent.\" } } ``` ### Using the API key as a query parameter Each request that accepts API key as `X-Api-Key` request header also accepts the key when it is sent as the `apikey` query parameter. An API key sent as part of the header has a higher priority when you send the key as both a request header and a query parameter. ## Rate Limits API access rate limits apply at a per-API key basis in unit time. Access to the API using an API key is limited to **60 requests per minute**. In addition, every API response is accompanied by the following set of headers to identify the status of your use: | Header | Description | | ------ | ----------- | | `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per minute. | | `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. | | `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. | Once you reach the rate limit you will receive a response similar to the following HTTP `429 Too Many Requests` response: ```json { \"error\": { \"name\": \"rateLimitError\", \"message\": \"Rate Limit exceeded. Please retry at 1465452702843\" } } ``` In the event you receive an HTTP `503` response from our servers, it indicates that we have had an unexpected spike in API access traffic. This is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/). ## Support For help regarding accessing the Postman API, you can: - Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites. - Reach out to the [Postman community](https://community.postman.com/). - Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/). ## Policies - [Postman Terms of Service](http://www.postman.com/legal/terms/) - [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/)
API version: 1.0
Contact: help@postman.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package postman
import (
"encoding/json"
)
// checks if the SingleWorkspace200Response type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &SingleWorkspace200Response{}
// SingleWorkspace200Response struct for SingleWorkspace200Response
type SingleWorkspace200Response struct {
Workspace *SingleWorkspace200ResponseWorkspace `json:"workspace,omitempty"`
}
// NewSingleWorkspace200Response instantiates a new SingleWorkspace200Response object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewSingleWorkspace200Response() *SingleWorkspace200Response {
this := SingleWorkspace200Response{}
return &this
}
// NewSingleWorkspace200ResponseWithDefaults instantiates a new SingleWorkspace200Response object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewSingleWorkspace200ResponseWithDefaults() *SingleWorkspace200Response {
this := SingleWorkspace200Response{}
return &this
}
// GetWorkspace returns the Workspace field value if set, zero value otherwise.
func (o *SingleWorkspace200Response) GetWorkspace() SingleWorkspace200ResponseWorkspace {
if o == nil || IsNil(o.Workspace) {
var ret SingleWorkspace200ResponseWorkspace
return ret
}
return *o.Workspace
}
// GetWorkspaceOk returns a tuple with the Workspace field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *SingleWorkspace200Response) GetWorkspaceOk() (*SingleWorkspace200ResponseWorkspace, bool) {
if o == nil || IsNil(o.Workspace) {
return nil, false
}
return o.Workspace, true
}
// HasWorkspace returns a boolean if a field has been set.
func (o *SingleWorkspace200Response) HasWorkspace() bool {
if o != nil && !IsNil(o.Workspace) {
return true
}
return false
}
// SetWorkspace gets a reference to the given SingleWorkspace200ResponseWorkspace and assigns it to the Workspace field.
func (o *SingleWorkspace200Response) SetWorkspace(v SingleWorkspace200ResponseWorkspace) {
o.Workspace = &v
}
func (o SingleWorkspace200Response) MarshalJSON() ([]byte, error) {
toSerialize,err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o SingleWorkspace200Response) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
if !IsNil(o.Workspace) {
toSerialize["workspace"] = o.Workspace
}
return toSerialize, nil
}
type NullableSingleWorkspace200Response struct {
value *SingleWorkspace200Response
isSet bool
}
func (v NullableSingleWorkspace200Response) Get() *SingleWorkspace200Response {
return v.value
}
func (v *NullableSingleWorkspace200Response) Set(val *SingleWorkspace200Response) {
v.value = val
v.isSet = true
}
func (v NullableSingleWorkspace200Response) IsSet() bool {
return v.isSet
}
func (v *NullableSingleWorkspace200Response) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableSingleWorkspace200Response(val *SingleWorkspace200Response) *NullableSingleWorkspace200Response {
return &NullableSingleWorkspace200Response{value: val, isSet: true}
}
func (v NullableSingleWorkspace200Response) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableSingleWorkspace200Response) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}