github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/api_api_info.go (about)

     1  /*
     2   * RingCentral Connect Platform API Explorer
     3   *
     4   * <p>This is a beta interactive API explorer for the RingCentral Connect Platform. To use this service, you will need to have an account with the proper credentials to generate an OAuth2 access token.</p><p><h2>Quick Start</h2></p><ol><li>1) Go to <b>Authentication > /oauth/token</b></li><li>2) Enter <b>app_key, app_secret, username, password</b> fields and then click \"Try it out!\"</li><li>3) Upon success, your access_token is loaded and you can access any form requiring authorization.</li></ol><h2>Links</h2><ul><li><a href=\"https://github.com/ringcentral\" target=\"_blank\">RingCentral SDKs on Github</a></li><li><a href=\"mailto:devsupport@ringcentral.com\">RingCentral Developer Support Email</a></li></ul>
     5   *
     6   * API version: 1.0
     7   * Generated by: OpenAPI Generator (https://openapi-generator.tech)
     8   */
     9  
    10  package ringcentral
    11  
    12  import (
    13  	"context"
    14  	"fmt"
    15  	"io/ioutil"
    16  	"net/http"
    17  	"net/url"
    18  	"strings"
    19  )
    20  
    21  // Linger please
    22  var (
    23  	_ context.Context
    24  )
    25  
    26  type APIInfoApiService service
    27  
    28  /*
    29  APIInfoApiService Get API Versions
    30  &lt;p style&#x3D;&#39;font-style:italic;&#39;&gt;Since 1.0.0&lt;/p&gt;&lt;p&gt;Returns current API version(s) and server info.&lt;/p&gt;&lt;h4&gt;Usage Plan Group&lt;/h4&gt;&lt;p&gt;Light&lt;/p&gt;
    31   * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
    32  @return GetVersionsResponse
    33  */
    34  func (a *APIInfoApiService) GetAPIVersion(ctx context.Context) (GetVersionsResponse, *http.Response, error) {
    35  	var (
    36  		localVarHttpMethod   = strings.ToUpper("Get")
    37  		localVarPostBody     interface{}
    38  		localVarFormFileName string
    39  		localVarFileName     string
    40  		localVarFileBytes    []byte
    41  		localVarReturnValue  GetVersionsResponse
    42  	)
    43  
    44  	// create path and map variables
    45  	localVarPath := a.client.cfg.BasePath + "/restapi"
    46  
    47  	localVarHeaderParams := make(map[string]string)
    48  	localVarQueryParams := url.Values{}
    49  	localVarFormParams := url.Values{}
    50  
    51  	// to determine the Content-Type header
    52  	localVarHttpContentTypes := []string{}
    53  
    54  	// set Content-Type header
    55  	localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
    56  	if localVarHttpContentType != "" {
    57  		localVarHeaderParams["Content-Type"] = localVarHttpContentType
    58  	}
    59  
    60  	// to determine the Accept header
    61  	localVarHttpHeaderAccepts := []string{"application/json"}
    62  
    63  	// set Accept header
    64  	localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
    65  	if localVarHttpHeaderAccept != "" {
    66  		localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
    67  	}
    68  	r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes)
    69  	if err != nil {
    70  		return localVarReturnValue, nil, err
    71  	}
    72  
    73  	localVarHttpResponse, err := a.client.callAPI(r)
    74  	if err != nil || localVarHttpResponse == nil {
    75  		return localVarReturnValue, localVarHttpResponse, err
    76  	}
    77  
    78  	localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
    79  	localVarHttpResponse.Body.Close()
    80  	if err != nil {
    81  		return localVarReturnValue, localVarHttpResponse, err
    82  	}
    83  
    84  	if localVarHttpResponse.StatusCode >= 300 {
    85  		newErr := GenericOpenAPIError{
    86  			body:  localVarBody,
    87  			error: localVarHttpResponse.Status,
    88  		}
    89  		if localVarHttpResponse.StatusCode == 0 {
    90  			var v GetVersionsResponse
    91  			err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
    92  			if err != nil {
    93  				newErr.error = err.Error()
    94  				return localVarReturnValue, localVarHttpResponse, newErr
    95  			}
    96  			newErr.model = v
    97  			return localVarReturnValue, localVarHttpResponse, newErr
    98  		}
    99  		return localVarReturnValue, localVarHttpResponse, newErr
   100  	}
   101  
   102  	err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
   103  	if err != nil {
   104  		newErr := GenericOpenAPIError{
   105  			body:  localVarBody,
   106  			error: err.Error(),
   107  		}
   108  		return localVarReturnValue, localVarHttpResponse, newErr
   109  	}
   110  
   111  	return localVarReturnValue, localVarHttpResponse, nil
   112  }
   113  
   114  /*
   115  APIInfoApiService Get Version Info
   116  &lt;p style&#x3D;&#39;font-style:italic;&#39;&gt;Since 1.0.0&lt;/p&gt;&lt;p&gt;Returns current API version info by apiVersion.&lt;/p&gt;&lt;h4&gt;Usage Plan Group&lt;/h4&gt;&lt;p&gt;Light&lt;/p&gt;
   117   * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
   118   * @param apiVersion API version to be requested, for example 'v1.0'
   119  @return GetVersionResponse
   120  */
   121  func (a *APIInfoApiService) GetVersionInfo(ctx context.Context, apiVersion string) (GetVersionResponse, *http.Response, error) {
   122  	var (
   123  		localVarHttpMethod   = strings.ToUpper("Get")
   124  		localVarPostBody     interface{}
   125  		localVarFormFileName string
   126  		localVarFileName     string
   127  		localVarFileBytes    []byte
   128  		localVarReturnValue  GetVersionResponse
   129  	)
   130  
   131  	// create path and map variables
   132  	localVarPath := a.client.cfg.BasePath + "/restapi/{apiVersion}"
   133  	localVarPath = strings.Replace(localVarPath, "{"+"apiVersion"+"}", fmt.Sprintf("%v", apiVersion), -1)
   134  
   135  	localVarHeaderParams := make(map[string]string)
   136  	localVarQueryParams := url.Values{}
   137  	localVarFormParams := url.Values{}
   138  
   139  	// to determine the Content-Type header
   140  	localVarHttpContentTypes := []string{}
   141  
   142  	// set Content-Type header
   143  	localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
   144  	if localVarHttpContentType != "" {
   145  		localVarHeaderParams["Content-Type"] = localVarHttpContentType
   146  	}
   147  
   148  	// to determine the Accept header
   149  	localVarHttpHeaderAccepts := []string{"application/json"}
   150  
   151  	// set Accept header
   152  	localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
   153  	if localVarHttpHeaderAccept != "" {
   154  		localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
   155  	}
   156  	r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes)
   157  	if err != nil {
   158  		return localVarReturnValue, nil, err
   159  	}
   160  
   161  	localVarHttpResponse, err := a.client.callAPI(r)
   162  	if err != nil || localVarHttpResponse == nil {
   163  		return localVarReturnValue, localVarHttpResponse, err
   164  	}
   165  
   166  	localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
   167  	localVarHttpResponse.Body.Close()
   168  	if err != nil {
   169  		return localVarReturnValue, localVarHttpResponse, err
   170  	}
   171  
   172  	if localVarHttpResponse.StatusCode >= 300 {
   173  		newErr := GenericOpenAPIError{
   174  			body:  localVarBody,
   175  			error: localVarHttpResponse.Status,
   176  		}
   177  		if localVarHttpResponse.StatusCode == 0 {
   178  			var v GetVersionResponse
   179  			err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
   180  			if err != nil {
   181  				newErr.error = err.Error()
   182  				return localVarReturnValue, localVarHttpResponse, newErr
   183  			}
   184  			newErr.model = v
   185  			return localVarReturnValue, localVarHttpResponse, newErr
   186  		}
   187  		return localVarReturnValue, localVarHttpResponse, newErr
   188  	}
   189  
   190  	err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
   191  	if err != nil {
   192  		newErr := GenericOpenAPIError{
   193  			body:  localVarBody,
   194  			error: err.Error(),
   195  		}
   196  		return localVarReturnValue, localVarHttpResponse, newErr
   197  	}
   198  
   199  	return localVarReturnValue, localVarHttpResponse, nil
   200  }
   201  
   202  /*
   203  APIInfoApiService Get Status
   204  &lt;p style&#x3D;&#39;font-style:italic;&#39;&gt;Since 1.0.27 (Release 8.3)&lt;/p&gt;&lt;p&gt;Returns the API status; status &#39;200&#39; means the API is working fine, and &#39;503&#39; means it is temporary unavailable.&lt;/p&gt;&lt;h4&gt;API Group&lt;/h4&gt;&lt;p&gt;Light&lt;/p&gt;
   205   * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
   206  */
   207  func (a *APIInfoApiService) LoadAPIStatus(ctx context.Context) (*http.Response, error) {
   208  	var (
   209  		localVarHttpMethod   = strings.ToUpper("Get")
   210  		localVarPostBody     interface{}
   211  		localVarFormFileName string
   212  		localVarFileName     string
   213  		localVarFileBytes    []byte
   214  	)
   215  
   216  	// create path and map variables
   217  	localVarPath := a.client.cfg.BasePath + "/restapi/v1.0/status"
   218  
   219  	localVarHeaderParams := make(map[string]string)
   220  	localVarQueryParams := url.Values{}
   221  	localVarFormParams := url.Values{}
   222  
   223  	// to determine the Content-Type header
   224  	localVarHttpContentTypes := []string{}
   225  
   226  	// set Content-Type header
   227  	localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
   228  	if localVarHttpContentType != "" {
   229  		localVarHeaderParams["Content-Type"] = localVarHttpContentType
   230  	}
   231  
   232  	// to determine the Accept header
   233  	localVarHttpHeaderAccepts := []string{}
   234  
   235  	// set Accept header
   236  	localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
   237  	if localVarHttpHeaderAccept != "" {
   238  		localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
   239  	}
   240  	r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes)
   241  	if err != nil {
   242  		return nil, err
   243  	}
   244  
   245  	localVarHttpResponse, err := a.client.callAPI(r)
   246  	if err != nil || localVarHttpResponse == nil {
   247  		return localVarHttpResponse, err
   248  	}
   249  
   250  	localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
   251  	localVarHttpResponse.Body.Close()
   252  	if err != nil {
   253  		return localVarHttpResponse, err
   254  	}
   255  
   256  	if localVarHttpResponse.StatusCode >= 300 {
   257  		newErr := GenericOpenAPIError{
   258  			body:  localVarBody,
   259  			error: localVarHttpResponse.Status,
   260  		}
   261  		return localVarHttpResponse, newErr
   262  	}
   263  
   264  	return localVarHttpResponse, nil
   265  }