devto

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig ¶

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

func (*ArticlesApiService) CreateArticle ¶

func (a *ArticlesApiService) CreateArticle(ctx _context.Context, localVarOptionals *ArticlesApiCreateArticleOpts) (ArticleShow, *_nethttp.Response, error)

CreateArticle Create a new article This endpoint allows the client to create a new article. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. ### Rate limiting There is a limit of 10 articles created each 30 seconds by the same user. ### Additional resources - [Rails tests for Articles API](https://github.com/thepracticaldev/dev.to/blob/master/spec/requests/api/v0/articles_spec.rb)

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ArticlesApiCreateArticleOpts - Optional Parameters:
• @param "ArticleCreate" (optional.Interface of ArticleCreate) - Article to create

@return ArticleShow

func (*ArticlesApiService) GetArticleById ¶

func (a *ArticlesApiService) GetArticleById(ctx _context.Context, id int32) (ArticleShow, *_nethttp.Response, error)

GetArticleById A published article This endpoint allows the client to retrieve a single published article given its `id`. Responses are cached for 5 minutes.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param id Id of the article

@return ArticleShow

func (*ArticlesApiService) GetArticles ¶

func (a *ArticlesApiService) GetArticles(ctx _context.Context, localVarOptionals *ArticlesApiGetArticlesOpts) ([]ArticleIndex, *_nethttp.Response, error)

GetArticles Published articles This endpoint allows the client to retrieve a list of articles. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. By default it will return featured, published articles ordered by descending popularity. Each page will contain `30` articles. Responses, according to the combination of params, are cached for 24 hours.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ArticlesApiGetArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page. This param can be used in conjuction with all other params (except when asking for fresh and rising articles by themselves).
• @param "Tag" (optional.String) - Adding this parameter will return articles that contain the requested tag. This param can be used by itself, with `page` or with `top`.
• @param "Username" (optional.String) - Adding this parameter will return articles belonging to a User or Organization ordered by descending `published_at`. If `state=all` the number of items returned will be `1000` instead of the default `30`. This param can be used by itself or only with `page` and `state`.
• @param "State" (optional.String) - Adding this will allow the client to check which articles are fresh or rising. If `state=fresh` the server will return published fresh articles. If `state=rising` the server will return published rising articles. This param can only be used by itself or with `username` if set to `all`.
• @param "Top" (optional.Int32) - Adding this will allow the client to return the most popular articles in the last `N` days. `top` indicates the number of days since publication of the articles returned. This param can only be used by itself or with `tag`.

@return []ArticleIndex

func (*ArticlesApiService) GetUserAllArticles ¶

func (a *ArticlesApiService) GetUserAllArticles(ctx _context.Context, localVarOptionals *ArticlesApiGetUserAllArticlesOpts) ([]ArticleMe, *_nethttp.Response, error)

GetUserAllArticles User's all articles This endpoint allows the client to retrieve a list of all articles on behalf of an authenticated user. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. It will return both published and unpublished articles with pagination. Unpublished articles will be at the top of the list in reverse chronological creation order. Published articles will follow in reverse chronological publication order. By default a page will contain `30` articles.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ArticlesApiGetUserAllArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page.
• @param "PerPage" (optional.Int32) - Page size (defaults to 30 with a maximum of 1000).

@return []ArticleMe

func (*ArticlesApiService) GetUserArticles ¶

func (a *ArticlesApiService) GetUserArticles(ctx _context.Context, localVarOptionals *ArticlesApiGetUserArticlesOpts) ([]ArticleMe, *_nethttp.Response, error)

GetUserArticles User's articles This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Published articles will be in reverse chronological publication order. It will return published articles with pagination. By default a page will contain `30` articles.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ArticlesApiGetUserArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page.
• @param "PerPage" (optional.Int32) - Page size (defaults to 30 with a maximum of 1000).

@return []ArticleMe

func (*ArticlesApiService) GetUserPublishedArticles ¶

func (a *ArticlesApiService) GetUserPublishedArticles(ctx _context.Context, localVarOptionals *ArticlesApiGetUserPublishedArticlesOpts) ([]ArticleMe, *_nethttp.Response, error)

GetUserPublishedArticles User's published articles This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Published articles will be in reverse chronological publication order. It will return published articles with pagination. By default a page will contain `30` articles.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ArticlesApiGetUserPublishedArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page.
• @param "PerPage" (optional.Int32) - Page size (defaults to 30 with a maximum of 1000).

@return []ArticleMe

func (*ArticlesApiService) GetUserUnpublishedArticles ¶

func (a *ArticlesApiService) GetUserUnpublishedArticles(ctx _context.Context, localVarOptionals *ArticlesApiGetUserUnpublishedArticlesOpts) ([]ArticleMe, *_nethttp.Response, error)

GetUserUnpublishedArticles User's unpublished articles This endpoint allows the client to retrieve a list of unpublished articles on behalf of an authenticated user. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Unpublished articles will be in reverse chronological creation order. It will return unpublished articles with pagination. By default a page will contain `30` articles.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ArticlesApiGetUserUnpublishedArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page.
• @param "PerPage" (optional.Int32) - Page size (defaults to 30 with a maximum of 1000).

@return []ArticleMe

func (*ArticlesApiService) UpdateArticle ¶

func (a *ArticlesApiService) UpdateArticle(ctx _context.Context, id int32, localVarOptionals *ArticlesApiUpdateArticleOpts) (ArticleShow, *_nethttp.Response, error)

UpdateArticle Update an article This endpoint allows the client to updated an existing article. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. ### Rate limiting There are no limits on the amount of updates. ### Additional resources - [Rails tests for Articles API](https://github.com/thepracticaldev/dev.to/blob/master/spec/requests/api/v0/articles_spec.rb)

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param id Id of the article
• @param optional nil or *ArticlesApiUpdateArticleOpts - Optional Parameters:
• @param "ArticleUpdate" (optional.Interface of ArticleUpdate) - Article params to update. *Note: if the article contains a front matter in its body, its front matter properties will still take precedence over any JSON equivalent params, which means that the full body_markdown with the modified front matter params needs to be provided for an update to be successful*

@return ArticleShow

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (GenericOpenAPIError) Body ¶

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error ¶

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model ¶

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

func (*UsersApiService) GetUserAllArticles ¶

func (a *UsersApiService) GetUserAllArticles(ctx _context.Context, localVarOptionals *UsersApiGetUserAllArticlesOpts) ([]ArticleMe, *_nethttp.Response, error)

GetUserAllArticles User's all articles This endpoint allows the client to retrieve a list of all articles on behalf of an authenticated user. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. It will return both published and unpublished articles with pagination. Unpublished articles will be at the top of the list in reverse chronological creation order. Published articles will follow in reverse chronological publication order. By default a page will contain `30` articles.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *UsersApiGetUserAllArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page.
• @param "PerPage" (optional.Int32) - Page size (defaults to 30 with a maximum of 1000).

@return []ArticleMe

func (*UsersApiService) GetUserArticles ¶

func (a *UsersApiService) GetUserArticles(ctx _context.Context, localVarOptionals *UsersApiGetUserArticlesOpts) ([]ArticleMe, *_nethttp.Response, error)

GetUserArticles User's articles This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Published articles will be in reverse chronological publication order. It will return published articles with pagination. By default a page will contain `30` articles.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *UsersApiGetUserArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page.
• @param "PerPage" (optional.Int32) - Page size (defaults to 30 with a maximum of 1000).

@return []ArticleMe

func (*UsersApiService) GetUserPublishedArticles ¶

func (a *UsersApiService) GetUserPublishedArticles(ctx _context.Context, localVarOptionals *UsersApiGetUserPublishedArticlesOpts) ([]ArticleMe, *_nethttp.Response, error)

GetUserPublishedArticles User's published articles This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Published articles will be in reverse chronological publication order. It will return published articles with pagination. By default a page will contain `30` articles.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *UsersApiGetUserPublishedArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page.
• @param "PerPage" (optional.Int32) - Page size (defaults to 30 with a maximum of 1000).

@return []ArticleMe

func (*UsersApiService) GetUserUnpublishedArticles ¶

func (a *UsersApiService) GetUserUnpublishedArticles(ctx _context.Context, localVarOptionals *UsersApiGetUserUnpublishedArticlesOpts) ([]ArticleMe, *_nethttp.Response, error)

GetUserUnpublishedArticles User's unpublished articles This endpoint allows the client to retrieve a list of unpublished articles on behalf of an authenticated user. \"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Unpublished articles will be in reverse chronological creation order. It will return unpublished articles with pagination. By default a page will contain `30` articles.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *UsersApiGetUserUnpublishedArticlesOpts - Optional Parameters:
• @param "Page" (optional.Int32) - Pagination page.
• @param "PerPage" (optional.Int32) - Page size (defaults to 30 with a maximum of 1000).

@return []ArticleMe

func (*WebhooksApiService) CreateWebhook ¶

func (a *WebhooksApiService) CreateWebhook(ctx _context.Context, localVarOptionals *WebhooksApiCreateWebhookOpts) (WebhookShow, *_nethttp.Response, error)

CreateWebhook Create a new webhook This endpoint allows the client to create a new webhook. \"Webhooks\" are used to register HTTP endpoints that will be called once a relevant event is triggered inside the web application, events like `article_created`, `article_updated`.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *WebhooksApiCreateWebhookOpts - Optional Parameters:
• @param "WebhookCreate" (optional.Interface of WebhookCreate) - Webhook to create

@return WebhookShow

func (*WebhooksApiService) DeleteWebhook ¶

func (a *WebhooksApiService) DeleteWebhook(ctx _context.Context, id int32) (*_nethttp.Response, error)

DeleteWebhook A webhook endpoint This endpoint allows the client to delete a single webhook given its `id`.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param id Id of the webhook

func (*WebhooksApiService) GetWebhookById ¶

func (a *WebhooksApiService) GetWebhookById(ctx _context.Context, id int32) (WebhookShow, *_nethttp.Response, error)

GetWebhookById A webhook endpoint This endpoint allows the client to retrieve a single webhook given its `id`.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param id Id of the webhook

@return WebhookShow

func (*WebhooksApiService) GetWebhooks ¶

func (a *WebhooksApiService) GetWebhooks(ctx _context.Context) ([]WebhookIndex, *_nethttp.Response, error)

GetWebhooks Webhooks This endpoint allows the client to retrieve a list of webhooks they have previously registered. \"Webhooks\" are used to register HTTP endpoints that will be called once a relevant event is triggered inside the web application, events like `article_created`, `article_updated`. It will return all webhooks, without pagination.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []WebhookIndex